zh-web-sdk 1.0.2

package/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': 'warn',
+  },
+}

package/.github/workflows/pr.yaml

@@ -0,0 +1,13 @@
+name: "Pull Request"
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  from_reusable:
+    uses: seedcx/composite-actions/.github/workflows/rw-node-pull-request.yml@main
+    secrets: inherit
+    with:
+      NODE_VERSION: "16.13.0"
+      TEST_ENABLED: false

package/.github/workflows/release.yaml

@@ -0,0 +1,57 @@
+name: "Release"
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  release:
+    name: Release
+    env:
+      NODE_VERSION: '16.13.0'
+    runs-on: ["builder","x64","linux","self-hosted"]
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
+
+      - name: NPM CI
+        run: npm ci
+
+      - name: NPM Build
+        run: echo "BUILD=$(npm run build:zip | grep Zipping | awk '{print $3}') " >>  $GITHUB_OUTPUT
+        id: build
+
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ github.ref_name }}
+          name: Release ${{ github.ref_name }}
+          body: |
+            ${{ github.ref.outputs.changelog }}
+          generateReleaseNotes: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          artifacts: |
+            ${{ steps.build.outputs.BUILD }}
+
+  publish:
+    name: Publish
+    env:
+      NODE_VERSION: '16.13.0'
+    runs-on: ["builder","x64","linux","self-hosted"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'npm'
+          registry-url: 'https://registry.npmjs.org'
+      - name: NPM CI
+        run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

package/.github/workflows/tag.yaml

@@ -0,0 +1,55 @@
+name: 'Tag New Version'
+
+on:
+  push:
+    # Run the action only on pushes to the main branch
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  push-to-main:
+    if: github.event.pusher.name != 'seedcx-deploy'
+    env:
+      NODE_VERSION: '16.13.0'
+      BUMP: ${{ contains(github.event.head_commit.message, 'BREAKING CHANGE') && 'major' || contains(github.event.head_commit.message, 'feat') && 'minor' || 'patch' }}
+      GITHUB_TOKEN: ${{ secrets.ORG_GH_TOKEN }}
+    runs-on: ["builder","x64","linux","self-hosted"]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GH_TAG_TOKEN }}
+
+      - name: Import bot's GPG key for signing commits
+        id: import-gpg
+        uses: crazy-max/ghaction-import-gpg@v5
+        with:
+          gpg_private_key: ${{ secrets.SEEDCX_DEPLOY_GPG_PRIVATE_KEY }}
+          passphrase: ${{ secrets.SEEDCX_DEPLOY_GPG_PASSPHRASE }}
+          git_config_global: true
+          git_user_signingkey: true
+          git_commit_gpgsign: true
+          
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      # Set git config
+      - uses: nodef/git-config.action@v1.0.0
+        with:
+          credentials: auto
+          entries: |-
+            user.name  = seedcx-deploy
+            user.email = 22893110+seedcx-deploy@users.noreply.github.com>
+
+      - name: Update Version
+        run: echo "VERSION=$(npm version ${{ env.BUMP }})" >> $GITHUB_OUTPUT
+        id: version
+
+      - name: Push version update
+        run: git push
+
+      - name: Push tag
+        run: git push origin ${{ steps.version.outputs.VERSION }}

package/README.md

@@ -0,0 +1,36 @@
+# ZeroHash Platform SDK
+
+This SDK exposes functionality that allows platforms to integrate with ZeroHash on the web.
+
+## Quick setup
+
+```javascript
+import ZeroHashSDK from "zh-web-sdk";
+
+// Initialize SDK
+const sdk = new ZeroHashSDK({
+    zeroHashOnboardingURL: "https://onboarding.zerohash.com/"
+});
+
+// Set the user onboarding JWT retrieved for a particular user
+// A user onboarding JWT before the user can proceed with the onboarding flow.
+sdk.openOnboardingModal({
+    userOnboardingJWT: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9." +
+        "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ." +
+        "SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+});
+```
+
+## API
+
+See the `ZeroHashSDK` class in `index.d.ts` in `/dist`.
+
+If you are browsing this repository, you can find the implementation in `index.tsx`.
+
+## Versioning
+
+The pipeline automatically updates the version in package.json after merge to main. It uses conventional commits to determine the type of bump to use:
+
+- `BREAKING CHANGE` is a major release (`1.0.0` to `2.0.0`)
+- `feat` is a minor release (`1.0.0` to `1.1.0`)
+- default is a patch release (`1.0.0` to `1.0.1`)

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_ZH_ONBOARDING_URL = "https://onboarding.zerohash.com/";
+export declare const DEFAULT_ROOT_ID_PREFIX = "zerohash";

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import { IInitializeParameters, IOpenOnboardingModalParameters, ISetUserOnboardingJWTParameters, IZeroHashSDK } from './types';
+export declare class ZeroHashSDK implements IZeroHashSDK {
+    private rootQuerySelector;
+    private onboardingInitialized;
+    /**
+     * Sets up the ZeroHash SDK and appends the ZeroHash DOM elements onto the page.
+     *
+     * For more information, see {@code IInitializeParameters}
+     */
+    constructor({ zeroHashOnboardingURL, rootQuerySelector, userOnboardingJWT }: IInitializeParameters);
+    /**
+     * setUserOnboardingJWT sets the JWT to be whatever value is provided.
+     * The JWT should be the UserJWT provided by ZeroHash via the platform
+     * API proxied through your servers. As ZeroHash cannot authenticate
+     * your users' requests, it is paramount that the user be authenticated
+     * and validated on your servers, and exchanged for the JWT using your
+     * API key. DO NOT have the JWT exchange logic be on your front-end.
+     *
+     * As a precaution, we may restrict traffic to the JWT exchange API to
+     * whitelisted IPs that come from your server.
+     */
+    setUserOnboardingJWT(params: ISetUserOnboardingJWTParameters): void;
+    /**
+     * isOnboardingModalOpen returns true if the onboarding modal is open,
+     * false otherwise
+     */
+    isOnboardingModalOpen(): boolean;
+    /**
+     * openOnboardingModal opens the onboarding modal
+     */
+    openOnboardingModal(params: IOpenOnboardingModalParameters): void;
+    /**
+     * closeOnboardingModalModal hides the onboarding modal
+     */
+    closeOnboardingModal(): void;
+}
+export default ZeroHashSDK;