Release 2.1.0

.github/workflows/bump_version.yml

@@ -10,10 +10,27 @@ on:
                 type: string
                 description: Version number (e.g. 1.2.3)
                 required: true
+            src:
+                type: string
+                description: Source branch name (e.g. staging)
+                required: true
+                default: staging
+            interim:
+                type: string
+                description: Interim branch name (e.g. release/1.2.3). Leave empty to use 'release/<version_number>'.
+                required: false
+            dest:
+                type: string
+                description: Destination branch name (e.g. main)
+                required: true
+                default: main
 
 concurrency:
     group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
     cancel-in-progress: true
+
+env:
+    GITHUB_TOKEN: ${{ secrets.PROSOPONATOR_PAT }}
 
 jobs:
     bump_version:
@@ -60,34 +77,47 @@ jobs:
             - uses: actions/checkout@v3
 
             - name: Bump version
-              env:
-                  GITHUB_TOKEN: ${{ secrets.PROSOPONATOR_PAT }}
               run: |
-                  set -euxo pipefail # stop on errors, print commands, fail on pipe fails
-
-                    # set the branch name
-                    BRANCH_NAME="release/${{ github.event.inputs.version }}"
+                set -euxo pipefail # stop on errors, print commands, fail on pipe fails
+
+                # set the author in git
+                git config user.name "prosoponator[bot]"
+                git config user.email "dev@prosopo.io"
+
+                # checkout the src branch
+                git checkout ${{ github.event.inputs.src }}
+
+                INTERIM="${{ github.event.inputs.interim}}"
+                # set the interim branch name to release/<version_number> if not provided
+                INTERIM="${INTERIM:-release/${{ github.event.inputs.version }}}"
 
-                    # make a new branch for the version changes
-                    git switch -c $BRANCH_NAME
+                # make a new branch for the version changes
+                git switch -c $INTERIM
 
-                    # find all package.json files, recursively
-                    pkgJsons=$(find . -name package.json -prune -not -path '*/node_modules/*' -not -path '*/.next/*')
-                    # replace the version in all package.json files
-                    xargs -I % sh -c "cat % | jq '.version = \"${{ github.event.inputs.version }}\"' > %.new && mv %.new %" <<< "$pkgJsons"
+                pkgJsons=$(npm run --silent ws:pkg)
+                pkgNames=$(npm run --silent ws:ls)
+                for pkgJson in $pkgJsons; do
+                    # for each package in the workspace, set the version number
+                    cat $pkgJson | jq ".version = \"${{ github.event.inputs.version }}\"" > $pkgJson
+                    for pkgName in $pkgNames; do
+                        # for each package in the workspace, check whether it is in the dependencies of the current package
+                        # if so, bump the version number in the dependencies
+                        cat $pkgJson | jq "if .dependencies[\"$pkgName\"] then .dependencies[\"$pkgName\"] = \"^${{ github.event.inputs.version }}\" else . end" > $pkgJson
+                    done
+                done
 
-                    # set the author in git
-                    git config user.name "prosoponator[bot]"
-                    git config user.email "dev@prosopo.io"
+                # update pkg lock
+                npm i
 
-                    # commit the version changes
-                    git add .
-                    git commit -m "Bump version to ${{ github.event.inputs.version }}"
+                # commit the version changes
+                git add .
+                git commit -m "Bump version to ${{ github.event.inputs.version }}"
 
-                    # push version changes
-                    git push --set-upstream origin $BRANCH_NAME
-
-                    git fetch origin main
+                # push version changes
+                git push --set-upstream origin $INTERIM
+
+                # fetch the dest branch
+                git fetch origin ${{ github.event.inputs.dest }}
 
-                    # create a PR for the release
-                    gh pr create --base main --title "Release ${{ github.event.inputs.version }}" --fill
+                # create a PR for the release
+                gh pr create --base ${{ github.event.inputs.dest }} --title "Release ${{ github.event.inputs.version }}" --fill

.github/workflows/deploy.yml

@@ -149,7 +149,7 @@ jobs:
                     git checkout js-bundle
 
                     # Copy built bundle to js-bundle branch
-                    cp packages/procaptcha-bundle/dist/bundle/* .
+                    cp $(find packages/procaptcha-bundle/dist/bundle/* -maxdepth 0 -not -type d) .
 
                     # set the author in git
                     git config user.name "prosoponator[bot]"
@@ -164,24 +164,21 @@ jobs:
                     # Return to the original branch
                     git checkout ${{ github.ref }}
 
+            - name: Configure AWS credentials
+              uses: aws-actions/configure-aws-credentials@v2
+              with:
+                aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+                aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+                aws-region: eu-west-1
 
-            - name: Deploy staging js bundle
-              if: ${{ steps.env.outputs.staging }}
-              env:
-                GH_TOKEN: ${{ github.token }}
+            - name: Deploy bundle to AWS S3
+              if: ${{ steps.env.outputs.production || steps.env.outputs.staging }}
               run: |
-
-                  # stop on errors, print commands, fail on pipe fails
-                  set -euo pipefail
-
-                  # the tag for the release
-                  TAG=${{ steps.env.outputs.env }}-release
-
-                  # find the staging release, list the assets, then delete each asset. This stops any assets being carried over from one staging release to the next
-                  gh release view $TAG --json assets | jq '.assets[].name' | tr -d '"' | xargs -P 1 --verbose -I {} gh release delete-asset $TAG {} -y
-
-                  # upload the bundle to the staging release
-                  gh release upload $TAG packages/procaptcha-bundle/dist/bundle/*
+                if [ "${{ steps.env.outputs.production }}" = "true" ]; then
+                  aws s3 cp packages/procaptcha-bundle/dist/bundle/ s3://js.prosopo.io/js/ --recursive
+                elif [ "${{ steps.env.outputs.staging }}" = "true" ]; then
+                  aws s3 cp packages/procaptcha-bundle/dist/bundle/ s3://staging-js.prosopo.io/js/ --recursive
+                fi
 
             - name: Build docker js_server
               run: |

.github/workflows/lint.yml

@@ -20,6 +20,10 @@ jobs:
     check:
         name: check
         runs-on: ubuntu-latest
+        container: 
+            image: prosopo/ci:latest
+            options: >
+                --volume ${{ github.workspace }}:/repo
         if: github.event.pull_request.draft == false
         steps:
             - name: Print contexts

.github/workflows/prosoponator_bot.yml

@@ -7,7 +7,7 @@ on: issue_comment
 jobs:
     comment:
         # This job only runs for pull request comments
-        if: ${{ github.event.issue.pull_request }} && github.event.pull_request.draft == false
+        if: ${{ github.event.issue.pull_request && github.event.pull_request.draft == false }}
         runs-on: ubuntu-latest
         steps:
             - name: Print contexts

.github/workflows/tests.yml

@@ -82,6 +82,62 @@ jobs:
           restore-keys: |
             project-cache-${{ github.event.pull_request.head.ref || github.ref }}-${{ runner.os }}-${{ runner.arch }}-
 
+      # check that each package.json contains a `build` and `build:cjs` script.
+      - name: Check for build and build:cjs scripts
+        run: |
+          for file in $(find ./packages -name package.json -not -path "**/node_modules/*" -not -path "./packages/detector/*"); do
+              if ! grep -q '"build":' $file; then
+              echo "Missing 'build' script in $file"
+              exit 1
+              fi
+              if ! grep -q '"build:cjs":' $file; then
+              echo "Missing 'build:cjs' script in $file"
+              exit 1
+              fi
+          done
+
+      # check that the number of references in each tsconfig.json is equal to the number of references in the tsconfig.cjs.json for each package
+      - name: Check for matching references in tsconfig.json and tsconfig.cjs.json
+        run: |
+          rm -f mismatched_references.txt
+          for file in $(find ./packages -name tsconfig.json -not -path "**/node_modules/*" -not -path "./packages/detector/*"); do
+              if [ $(jq '.references | length' $file) -ne $(jq '.references | length' $(dirname $file)/tsconfig.cjs.json) ]; then
+              echo "Mismatched number of references in $file and $(dirname $file)/tsconfig.cjs.json" >> mismatched_references.txt
+              fi
+          done
+          if [ -f mismatched_references.txt ]; then
+              cat mismatched_references.txt
+              exit 1
+          fi
+
+      # check that each @prosopo package referenced in package.json is in the tsconfig.json for each package
+      - name: Check for matching references in package.json and tsconfig.json
+        run: |
+          rm -f missing_references.txt
+          for file in $(find ./packages -name package.json -not -path "**/node_modules/*" -not -path "./packages/detector/*"); do
+              for package in $(jq -r '.dependencies | keys[]' $file); do
+              # if the package is not a @prosopo package, skip it
+              if ! echo $package | grep -q "^@prosopo"; then
+                  continue
+              fi
+
+              # if the package is @prosopo/config, skip it
+              if [[ "$package" == "@prosopo/config" ]]; then
+                  continue
+              fi
+
+              # split the package by '/' and get the last element
+              searchterm=$(echo $package | awk -F/ '{print $NF}')
+              if ! grep -oI "\"..\/$searchterm\"" $(dirname $file)/tsconfig.json; then                  
+                  # store the results
+                  echo "Missing reference to $searchterm in $(dirname $file)/tsconfig.json" >> missing_references.txt
+              fi
+              done
+          done
+          if [ -f missing_references.txt ]; then
+              cat missing_references.txt
+          fi
+
       - uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'

.npmrc

@@ -0,0 +1,6 @@
+save-prefix= # don't add ^ to deps by default when adding new deps
+maxsockets=10 # 10 concurrent downloads
+fetch-retries=100 # try 100 times to download a pkg
+fetch-retry-mintimeout=1 # 1ms between retries minimum
+fetch-retry-maxtimeout=10000 # 10s between retries maximum
+fetch-retry-factor=2 # increase timeout by 2x each retry

demos/client-bundle-example/package.json

@@ -1,23 +1,27 @@
 {
-  "name": "@prosopo/client-bundle-example",
-  "main": "index.js",
-  "engines": {
-    "node": ">=20",
-    "npm": ">=9"
-  },
-  "scripts": {
-    "test": "echo \"No test specified\"",
-    "build": "echo \"No build specified\"",
-    "start": "vite serve ./src --port 9232 --config vite.config.ts",
-    "clean": "echo 'nothing to clean'"
-  },
-  "dependencies": {
-    "dotenv": "^16.0.1",
-    "vite": "^5.1.7"
-  },
-  "version": "2.0.3",
-  "devDependencies": {
-    "tslib": "2.6.2",
-    "typescript": "5.1.6"
-  }
+	"name": "@prosopo/client-bundle-example",
+	"main": "index.js",
+	"engines": {
+		"node": ">=20",
+		"npm": ">=9"
+	},
+	"scripts": {
+		"test": "echo \"No test specified\"",
+		"build": "echo \"No build specified\"",
+		"start": "vite serve ./src --port 9232 --config vite.config.ts",
+		"clean": "echo 'nothing to clean'"
+	},
+	"version": "2.1.0",
+	"devDependencies": {
+		"@types/node": "22.5.5",
+		"@vitest/coverage-v8": "2.1.1",
+		"concurrently": "9.0.1",
+		"npm-run-all": "4.1.5",
+		"rimraf": "6.0.1",
+		"tslib": "2.7.0",
+		"tsx": "4.19.1",
+		"typescript": "5.6.2",
+		"vite": "5.4.6",
+		"vitest": "2.1.1"
+	}
 }

demos/client-example-server/package.json

@@ -1,52 +1,61 @@
 {
-  "name": "@prosopo/client-example-server",
-  "version": "2.0.3",
-  "description": "Backend for client-example",
-  "main": "dist/app.js",
-  "type": "module",
-  "engines": {
-    "node": ">=20",
-    "npm": ">=9"
-  },
-  "scripts": {
-    "test": "echo \"No test specified\"",
-    "dev": "NODE_ENV=${NODE_ENV:-development}; vite serve --mode=$NODE_ENV --config ./vite.config.ts --host",
-    "start": "node ./dist/app.js",
-    "start:bundle": "node ./dist/bundle/prosopo_client_example_server.app.bundle.js",
-    "build": "tsc --build --verbose",
-    "bundle": "NODE_ENV=${NODE_ENV:-production}; vite build --mode=$NODE_ENV --config ./vite.config.ts",
-    "clean": "tsc --build --clean"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/prosopo/client-example-server.git"
-  },
-  "author": "PROSOPO LIMITED <info@prosopo.io>",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/prosopo/client-example-server/issues"
-  },
-  "homepage": "https://github.com/prosopo/client-example-server#readme",
-  "dependencies": {
-    "@noble/hashes": "^1.3.1",
-    "@polkadot/util": "12.6.2",
-    "@polkadot/util-crypto": "12.6.2",
-    "@prosopo/api": "2.0.3",
-    "@prosopo/dotenv": "2.0.3",
-    "@prosopo/procaptcha": "2.0.3",
-    "@prosopo/server": "2.0.3",
-    "@prosopo/types": "2.0.3",
-    "@typegoose/auto-increment": "^4.5.0",
-    "cors": "^2.8.5",
-    "jsonwebtoken": "^9.0.0",
-    "mongoose": "^8.5.1",
-    "zod": "^3.22.3"
-  },
-  "devDependencies": {
-    "@prosopo/config": "2.0.3",
-    "@types/jsonwebtoken": "^9.0.2",
-    "tslib": "2.6.2",
-    "typescript": "5.1.6",
-    "vite": "^5.1.7"
-  }
+	"name": "@prosopo/client-example-server",
+	"version": "2.1.0",
+	"description": "Backend for client-example",
+	"main": "dist/app.js",
+	"type": "module",
+	"engines": {
+		"node": ">=20",
+		"npm": ">=9"
+	},
+	"scripts": {
+		"test": "echo \"No test specified\"",
+		"dev": "NODE_ENV=${NODE_ENV:-development}; vite serve --mode=$NODE_ENV --config ./vite.config.ts --host",
+		"start": "node ./dist/app.js",
+		"start:bundle": "node ./dist/bundle/prosopo_client_example_server.app.bundle.js",
+		"build": "tsc --build --verbose",
+		"bundle": "NODE_ENV=${NODE_ENV:-production}; vite build --mode=$NODE_ENV --config ./vite.config.ts",
+		"clean": "tsc --build --clean"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/prosopo/client-example-server.git"
+	},
+	"author": "PROSOPO LIMITED <info@prosopo.io>",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/prosopo/client-example-server/issues"
+	},
+	"homepage": "https://github.com/prosopo/client-example-server#readme",
+	"dependencies": {
+		"@noble/hashes": "1.5.0",
+		"@polkadot/util": "12.6.2",
+		"@polkadot/util-crypto": "12.6.2",
+		"@prosopo/common": "2.1.0",
+		"@prosopo/contract": "2.1.0",
+		"@prosopo/dotenv": "2.1.0",
+		"@prosopo/server": "2.1.0",
+		"@prosopo/types": "2.1.0",
+		"@prosopo/util": "2.1.0",
+		"@typegoose/auto-increment": "4.6.0",
+		"cors": "2.8.5",
+		"express": "4.21.0",
+		"jsonwebtoken": "9.0.2",
+		"mongodb-memory-server": "10.0.0",
+		"mongoose": "8.6.2",
+		"zod": "3.23.8"
+	},
+	"devDependencies": {
+		"@prosopo/config": "2.1.0",
+		"@types/jsonwebtoken": "9.0.6",
+		"@vitest/coverage-v8": "2.1.1",
+		"concurrently": "9.0.1",
+		"npm-run-all": "4.1.5",
+		"rimraf": "6.0.1",
+		"tslib": "2.7.0",
+		"tsx": "4.19.1",
+		"typescript": "5.6.2",
+		"vite": "5.4.6",
+		"vitest": "2.1.1"
+	}
 }