diff --git a/.github/actions/prepare/action.yml b/.github/actions/prepare/action.yml new file mode 100644 index 0000000..8730507 --- /dev/null +++ b/.github/actions/prepare/action.yml @@ -0,0 +1,32 @@ +name: Prepare + +description: Checkout, install dependencies, build and test JS library + +inputs: + folder: + description: 'The folder in which to run npm ci' + required: false + default: '.' + +runs: + using: composite + steps: + - uses: actions/setup-node@v4 + with: + node-version: 20 + registry-url: 'https://registry.npmjs.org' + + - name: Install dependencies + shell: bash + run: npm ci + working-directory: ${{ inputs.folder }} + + - name: Build + shell: bash + run: npm run build + working-directory: ${{ inputs.folder }} + + - name: Test + shell: bash + run: npm run test + working-directory: ${{ inputs.folder }} diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 10c51d2..cec7340 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -11,22 +11,27 @@ jobs: id-token: write env: working-directory: js-library + dist-directory: js-library/dist steps: - name: Checkout uses: actions/checkout@v4 - - uses: actions/setup-node@v4 + + - name: Prepare and Build JS Library + uses: ./.github/actions/prepare with: - node-version: "20.x" - registry-url: "https://registry.npmjs.org" + folder: ${{env.working-directory}} + - name: Package next working-directory: ${{env.working-directory}} run: ./scripts/package-next + - name: Set up npm - working-directory: ${{env.working-directory}} + working-directory: ${{env.dist-directory}} run: printf '%s\n' '//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}' registry=https://registry.npmjs.org/ always-auth=true >> .npmrc + - name: Publish - working-directory: ${{env.working-directory}} + working-directory: ${{env.dist-directory}} run: npm publish --provenance --tag next env: NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 424b247..1b0fe08 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -12,28 +12,24 @@ jobs: id-token: write env: working-directory: js-library + dist-directory: js-library/dist steps: - name: Checkout uses: actions/checkout@v4 - uses: actions/setup-node@v4 + + - name: Prepare and Build JS Library + uses: ./.github/actions/prepare with: - node-version: "20.x" - registry-url: "https://registry.npmjs.org" - - name: Install Dependencies - working-directory: ${{env.working-directory}} - run: npm ci - - name: Build - working-directory: ${{env.working-directory}} - run: npm run build - - name: Test - working-directory: ${{env.working-directory}} - run: npm test + folder: ${{env.working-directory}} + - name: Set up npm - working-directory: ${{env.working-directory}} + working-directory: ${{env.dist-directory}} run: printf '%s\n' '//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}' registry=https://registry.npmjs.org/ always-auth=true >> .npmrc + - name: Publish - working-directory: ${{env.working-directory}} + working-directory: ${{env.dist-directory}} run: ./scripts/publish-npm.sh env: NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}} diff --git a/js-library/LICENSE b/js-library/LICENSE new file mode 100644 index 0000000..c311979 --- /dev/null +++ b/js-library/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 LLC. + +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/js-library/esbuild.mjs b/js-library/esbuild.mjs index 9ecd055..e6b5293 100644 --- a/js-library/esbuild.mjs +++ b/js-library/esbuild.mjs @@ -1,5 +1,6 @@ import esbuild from "esbuild"; import { + copyFileSync, existsSync, mkdirSync, readFileSync, @@ -8,15 +9,19 @@ import { } from "node:fs"; import { join } from "node:path"; -const peerDependencies = (packageJson) => { +const PACKAGE_JSON = "package.json"; + +const readPackageJson = () => { + const packageJson = join(process.cwd(), PACKAGE_JSON); const json = readFileSync(packageJson, "utf8"); - const { peerDependencies } = JSON.parse(json); - return peerDependencies ?? {}; + const { peerDependencies, files } = JSON.parse(json); + return { + workspacePeerDependencies: peerDependencies ?? {}, + packageJsonFiles: files ?? [], + }; }; -const workspacePeerDependencies = peerDependencies( - join(process.cwd(), "package.json"), -); +const { workspacePeerDependencies, packageJsonFiles } = readPackageJson(); const dist = join(process.cwd(), "dist"); @@ -26,17 +31,17 @@ const createDistFolder = () => { } }; -const bundleFiles = () => { - const entryPoints = readdirSync(join(process.cwd(), "src")) - .filter( - (file) => - !file.includes("test") && - !file.includes("spec") && - !file.includes("mock") && - statSync(join(process.cwd(), "src", file)).isFile(), - ) - .map((file) => `src/${file}`); +const entryPoints = readdirSync(join(process.cwd(), "src")) + .filter( + (file) => + !file.includes("test") && + !file.includes("spec") && + !file.includes("mock") && + statSync(join(process.cwd(), "src", file)).isFile(), + ) + .map((file) => `src/${file}`); +const buildBrowser = () => { // esm output bundles with code splitting esbuild .build({ @@ -56,9 +61,19 @@ const bundleFiles = () => { .catch(() => process.exit(1)); }; -export const build = () => { +const copyFiles = () => { + const copyFile = (filename) => + copyFileSync(join(process.cwd(), filename), join(dist, filename)); + + packageJsonFiles.filter((entry) => !entry.includes("*")).forEach(copyFile); + + copyFile(PACKAGE_JSON); +}; + +const build = () => { createDistFolder(); - bundleFiles(); + buildBrowser(); + copyFiles(); }; build(); diff --git a/js-library/package.json b/js-library/package.json index 1a202a5..83e456c 100644 --- a/js-library/package.json +++ b/js-library/package.json @@ -4,10 +4,12 @@ "description": "Library to interact with the identity provider to get a credential presentation.", "type": "module", "files": [ - "dist", "README.md", - "package.json", - "LICENSE" + "LICENSE", + "*.js", + "*.js.map", + "*.d.ts", + "*.d.ts.map" ], "engines": { "node": ">=v20.11.1" @@ -18,8 +20,8 @@ "rmdir": "node ./rmdir.mjs", "ts-declaration": "tsc --emitDeclarationOnly --outDir dist", "build": "npm run rmdir && mkdir -p dist && node esbuild.mjs && npm run ts-declaration", - "prepack": "npm run build", - "test": "tsc --noEmit -p ./tsconfig.spec.json && vitest" + "test": "tsc --noEmit -p ./tsconfig.spec.json && vitest", + "prepublishOnly": "if [ $(basename $PWD) != 'dist' ]; then echo 'Publishing is only allowed from the dist directory.' && exit 1; fi" }, "repository": { "type": "git", @@ -44,16 +46,18 @@ "crypto", "relying party" ], + "sideEffects": false, + "main": "index.js", "exports": { ".": { - "import": "./dist/index.js", - "require": "./dist/index.js", - "types": "./dist/index.d.ts" + "types": "./index.d.ts", + "import": "./index.js", + "require": "./index.js" }, "./request-verifiable-presentation": { - "import": "./dist/request-verifiable-presentation.js", - "require": "./dist/request-verifiable-presentation.js", - "types": "./dist/request-verifiable-presentation.d.ts" + "types": "./request-verifiable-presentation.d.ts", + "import": "./request-verifiable-presentation.js", + "require": "./request-verifiable-presentation.js" } }, "devDependencies": { diff --git a/js-library/scripts/package-next b/js-library/scripts/package-next index 889b838..be18919 100755 --- a/js-library/scripts/package-next +++ b/js-library/scripts/package-next @@ -1,10 +1,5 @@ #!/usr/bin/env bash set -eux -npm ci - -: Package first the library -npm run build - : Then update the version to SEMANTIC_VERSION-next-DATE e.g. 0.0.1-next-2022-08-05T15:02 node ./scripts/update-version.mjs diff --git a/js-library/tsconfig.json b/js-library/tsconfig.json index 193da8f..2a55762 100644 --- a/js-library/tsconfig.json +++ b/js-library/tsconfig.json @@ -13,6 +13,7 @@ "exclude": [ "**/src/**/*.test.ts", "**/src/**/*.spec.ts", - "**/src/**/*.mock.ts" + "**/src/**/*.mock.ts", + "**/src/**/*mock*" ] }