diff --git a/CHANGELOG.md b/CHANGELOG.md index 92cd0d267..e22416346 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - Expose types `IcrcApproveError` and `IcrcTransferFromError` in `@dfinity/ledger-icrc`. - Expose few additional did types in `@dfinity/ledger-icp`. - Add utility `fromNullishNullable` extracts the value from a nullish Candid-style variant representation. +- Introduce a new zod-schemas library to provide a collection of reusable Zod schemas and validators for common data patterns in ICP applications. ## Fix diff --git a/package-lock.json b/package-lock.json index 90a13b0f6..71229bf40 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18,7 +18,8 @@ "packages/cmc", "packages/ckbtc", "packages/ic-management", - "packages/cketh" + "packages/cketh", + "packages/zod-schemas" ], "devDependencies": { "@size-limit/esbuild": "^11.1.6", @@ -791,6 +792,10 @@ "resolved": "packages/utils", "link": true }, + "node_modules/@dfinity/zod-schemas": { + "resolved": "packages/zod-schemas", + "link": true + }, "node_modules/@esbuild/aix-ppc64": { "version": "0.24.0", "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.24.0.tgz", @@ -7543,6 +7548,16 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/zod": { + "version": "3.24.1", + "resolved": "https://registry.npmjs.org/zod/-/zod-3.24.1.tgz", + "integrity": "sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A==", + "license": "MIT", + "peer": true, + "funding": { + "url": "https://github.com/sponsors/colinhacks" + } + }, "packages/ckbtc": { "name": "@dfinity/ckbtc", "version": "3.1.5", @@ -7668,6 +7683,15 @@ "@dfinity/candid": "^2.0.0", "@dfinity/principal": "^2.0.0" } + }, + "packages/zod-schemas": { + "name": "@dfinity/zod-schemas", + "version": "0.0.1", + "license": "Apache-2.0", + "peerDependencies": { + "@dfinity/principal": "^2.0.0", + "zod": "^3.24.1" + } } }, "dependencies": { @@ -8262,6 +8286,10 @@ "version": "file:packages/utils", "requires": {} }, + "@dfinity/zod-schemas": { + "version": "file:packages/zod-schemas", + "requires": {} + }, "@esbuild/aix-ppc64": { "version": "0.24.0", "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.24.0.tgz", @@ -12936,6 +12964,12 @@ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true + }, + "zod": { + "version": "3.24.1", + "resolved": "https://registry.npmjs.org/zod/-/zod-3.24.1.tgz", + "integrity": "sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A==", + "peer": true } } } diff --git a/package.json b/package.json index 893ee3bfb..e476e03e0 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,8 @@ "packages/cmc", "packages/ckbtc", "packages/ic-management", - "packages/cketh" + "packages/cketh", + "packages/zod-schemas" ], "scripts": { "did": "scripts/compile-idl-js", diff --git a/packages/zod-schemas/LICENSE b/packages/zod-schemas/LICENSE new file mode 100644 index 000000000..7b214fe22 --- /dev/null +++ b/packages/zod-schemas/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 DFINITY Stiftung. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/zod-schemas/README.md b/packages/zod-schemas/README.md new file mode 100644 index 000000000..d2b4d8057 --- /dev/null +++ b/packages/zod-schemas/README.md @@ -0,0 +1,32 @@ +# Zod Schemas for apps on ICP + +A collection of reusable Zod schemas and validators for common data patterns in Internet Computer applications. + +[![npm version](https://img.shields.io/npm/v/@dfinity/zod-schemas.svg?logo=npm)](https://www.npmjs.com/package/@dfinity/zod-schemas) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +## Table of contents + +- [Installation](#installation) +- [Features](#features) + +## Installation + +You can use the library by installing it in your project. + +```bash +npm i @dfinity/zod-schemas +``` + +The bundle needs peer dependencies, be sure that following resources are available in your project as well. + +```bash +npm i @dfinity/principal +``` + +## Features + +`utils-js` implements following features: + + + + diff --git a/packages/zod-schemas/esbuild.mjs b/packages/zod-schemas/esbuild.mjs new file mode 100644 index 000000000..f3cda319f --- /dev/null +++ b/packages/zod-schemas/esbuild.mjs @@ -0,0 +1,5 @@ +#!/usr/bin/env node + +import { build } from "../../scripts/esbuild.mjs"; + +build(); diff --git a/packages/zod-schemas/jest.config.js b/packages/zod-schemas/jest.config.js new file mode 100644 index 000000000..e75ede62b --- /dev/null +++ b/packages/zod-schemas/jest.config.js @@ -0,0 +1,7 @@ +const rootJestConfig = require("../../jest.config"); + +module.exports = { + ...rootJestConfig, + setupFiles: [`../../test-setup.ts`], + modulePathIgnorePatterns: ["./dist"], +}; diff --git a/packages/zod-schemas/package.json b/packages/zod-schemas/package.json new file mode 100644 index 000000000..8b66d010d --- /dev/null +++ b/packages/zod-schemas/package.json @@ -0,0 +1,53 @@ +{ + "name": "@dfinity/zod-schemas", + "version": "0.0.1", + "description": "A collection of reusable Zod schemas and validators for common data patterns in ICP applications", + "license": "Apache-2.0", + "main": "dist/cjs/index.cjs.js", + "module": "dist/esm/index.js", + "types": "dist/types/index.d.ts", + "files": [ + "dist", + "README.md", + "LICENSE" + ], + "scripts": { + "rmdir": "node ../../scripts/rmdir.mjs", + "ts-declaration": "tsc --emitDeclarationOnly --outDir dist/types", + "build": "npm run rmdir && mkdir -p dist && node esbuild.mjs && npm run ts-declaration", + "prepack": "npm run build", + "test": "jest" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/dfinity/ic-js.git", + "directory": "packages/utils" + }, + "bugs": { + "url": "https://github.com/dfinity/ic-js" + }, + "keywords": [ + "internet computer", + "internet-computer", + "ic", + "dfinity", + "dfx", + "canister", + "candid", + "motoko", + "javascript", + "typescript", + "blockchain", + "crypto", + "nns", + "network nervous system", + "network-nervous-system", + "sns", + "service nervous system", + "service-nervous-system" + ], + "peerDependencies": { + "@dfinity/principal": "^2.0.0", + "zod": "^3" + } +} diff --git a/packages/zod-schemas/src/index.spec.ts b/packages/zod-schemas/src/index.spec.ts new file mode 100644 index 000000000..1f486871c --- /dev/null +++ b/packages/zod-schemas/src/index.spec.ts @@ -0,0 +1,2 @@ +// TODO: remove me +test("To be removed", () => expect(true).toBeTruthy()); diff --git a/packages/zod-schemas/src/index.ts b/packages/zod-schemas/src/index.ts new file mode 100644 index 000000000..ff8b4c563 --- /dev/null +++ b/packages/zod-schemas/src/index.ts @@ -0,0 +1 @@ +export default {}; diff --git a/packages/zod-schemas/tsconfig.json b/packages/zod-schemas/tsconfig.json new file mode 100644 index 000000000..4082f16a5 --- /dev/null +++ b/packages/zod-schemas/tsconfig.json @@ -0,0 +1,3 @@ +{ + "extends": "../../tsconfig.json" +} diff --git a/scripts/build-next b/scripts/build-next index f0d65d247..b75483945 100755 --- a/scripts/build-next +++ b/scripts/build-next @@ -5,6 +5,7 @@ npm ci : Update the package.json version before build and publish node ./scripts/update-version.mjs utils +node ./scripts/update-version.mjs zod-schemas node ./scripts/update-version.mjs nns-proto node ./scripts/update-version.mjs ledger-icp node ./scripts/update-version.mjs ledger-icrc diff --git a/scripts/docs.js b/scripts/docs.js index d7612c40b..1beb407db 100644 --- a/scripts/docs.js +++ b/scripts/docs.js @@ -53,6 +53,8 @@ const icMgmtInputFiles = [ "./packages/ic-management/src/ic-management.canister.ts", ]; +const zodSchemasInputFiles = ["./packages/zod-schemas/src/index.ts"]; + const buildOptions = { repo: { url: "https://github.com/dfinity/ic-js" }, }; @@ -123,3 +125,10 @@ generateDocumentation({ markdownOptions, buildOptions, }); + +generateDocumentation({ + inputFiles: zodSchemasInputFiles, + outputFile: "./packages/zod-schemas/README.md", + markdownOptions, + buildOptions: { ...buildOptions, explore: true }, +}); diff --git a/scripts/publish-npm.sh b/scripts/publish-npm.sh index a9c226a07..5fffe49fc 100755 --- a/scripts/publish-npm.sh +++ b/scripts/publish-npm.sh @@ -18,7 +18,7 @@ function publish_npm() { } # Tips: libs use by other libs first -LIBS=utils,ledger-icrc,ledger-icp,nns-proto,nns,sns,cmc,ckbtc,cketh,ic-management +LIBS=utils,zod-schemas,ledger-icrc,ledger-icp,nns-proto,nns,sns,cmc,ckbtc,cketh,ic-management for lib in $(echo $LIBS | sed "s/,/ /g"); do publish_npm "$lib" diff --git a/scripts/update-agent b/scripts/update-agent index 9d2ee27ad..8ff35fae4 100755 --- a/scripts/update-agent +++ b/scripts/update-agent @@ -12,13 +12,29 @@ function install_agent() { npm i @dfinity/agent@latest @dfinity/candid@latest @dfinity/principal@latest --workspace=packages/"$package" --save-peer } +function install_principal() { + local package=$1 + + npm i @dfinity/principal@latest --workspace=packages/"$package" --save-peer +} + PACKAGES=utils,ckbtc,cketh,cmc,ic-management,ledger-icp,ledger-icrc,nns,sns +PACKAGES_PRINCIPAL_ONLY=zod-schemas + # Remove agent-js libraries from all packages first to avoid resolve conflicts between those for package in $(echo $PACKAGES | sed "s/,/ /g"); do rm_agent "$package" done +for package in $(echo $PACKAGES_PRINCIPAL_ONLY | sed "s/,/ /g"); do + rm_agent "$package" +done + for package in $(echo $PACKAGES | sed "s/,/ /g"); do install_agent "$package" done + +for package in $(echo $PACKAGES_PRINCIPAL_ONLY | sed "s/,/ /g"); do + install_principal "$package" +done