Merge pull request #408 from Tonomy-Foundation/development

Development

.github/workflows/publish-sdk.yml

@@ -14,33 +14,41 @@ jobs:
   publish-npm:
     runs-on: ubuntu-20.04
     steps:
+      - name: Install jq
+        run: sudo apt install jq -y
+
       - name: 🏗 Setup repo
         uses: actions/checkout@v4
         with:
           token: ${{secrets.MY_GITHUB_PERSONAL_ACCESS_TOKEN}}
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
 
       - name: 📦 Install
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
+          node-version: 22.3.0
           registry-url: https://registry.npmjs.org/
+
       - name: 🚀 Build and publish SDK
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
+          node-version: 22.3.0
       - name: Check branch name
         run: echo ${GITHUB_REF#refs/*/}
       - run: |
           if [[ ${GITHUB_REF#refs/*/} == "development" ]]; then
             echo "Variable BRANCH_NAME is set to 'development'"
-            yarn config set tag development
+            jq --arg tag "development" '.publishConfig.tag = $tag' package.json > package.tmp.json && mv package.tmp.json package.json
           fi
 
           if [[ ${GITHUB_REF#refs/*/} == "testnet" ]]; then
             echo "Variable BRANCH_NAME is set to 'testnet'"
-            yarn config set tag rc
+            jq --arg tag "rc" '.publishConfig.tag = $tag' package.json > package.tmp.json && mv package.tmp.json package.json
           fi
       - run: yarn install --immutable
+      - run: yarn run build
       - run: yarn run release
         env:
           GITHUB_TOKEN: ${{secrets.MY_GITHUB_PERSONAL_ACCESS_TOKEN}}

.github/workflows/test.yaml

@@ -1,26 +1,28 @@
 name: Run Tonomy-ID-SDK Tests
 
 on:
-  pull_request:
-    branches:
-    - development
+  push
 
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
 
       - name: Run lint and test
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
+          node-version: 22.3.0
           cache: yarn
       - run: yarn install --immutable
+      - run: yarn run build
       - run: yarn run lint
       - run: yarn run test:unit
-
+  
   compile-contracts:
     name: Compiles contracts needed for bootstrap script
     runs-on: ubuntu-20.04
@@ -89,19 +91,23 @@ jobs:
         with:
           name: Tonomy-Contracts
           path: ./Tonomy-Contracts
+
+      - name: Enable Corepack before setting up Node
+        run: corepack enable
 
       - name: Install SDK and Bootstrap blockchain
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
+          node-version: 22.3.0
           cache: yarn
       - run: yarn install --immutable
+      - run: yarn run build
       - run: yarn run cli bootstrap
 
       - name: Run integration and governance tests
         uses: actions/setup-node@v4
         with:
-          node-version: 18.12.1
+          node-version: 22.3.0
           cache: yarn
       - run: yarn run test:integration
       - run: yarn run test:governance

.gitignore

@@ -4,4 +4,5 @@ node_modules
 build
 site
 .yarn
-.pnp.*
+.pnp.*
+database.sqlite

.vscode/settings.json

@@ -21,5 +21,11 @@
     "markdownlint.config": {
         "default": true,
         "MD033": false
-    }
+    },
+    "git.branchPrefix": "feature/",
+    "git.branchProtection": [
+        "master",
+        "main",
+        "development"
+    ],
 }

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

README.md

@@ -9,16 +9,12 @@ The SDK is written in typescript with jest to run tests.
 ## Dependencies
 
 - Linux debian distribution (Ubuntu 20.0.4 LTS used)
-- [Nodejs](https://nodejs.org) v18.12.1+ suggested installed with [nvm](https://github.com/nvm-sh/nvm)
+- [Nodejs](https://nodejs.org) v20+ suggested installed with [nvm](https://github.com/nvm-sh/nvm)
 
 Integration tests:
 
 - [Docker](http://docs.docker.com) v20.10+
 
-Documentation:
-
-- [mkdocs](https://www.mkdocs.org) with [material](https://squidfunk.github.io/mkdocs-material) theme
-
 ## Sub-Repositories
 
 - [Contracts](https://github.com/Tonomy-Foundation/Tonomy-Contracts) (inside SDK repo) - Smart contracts to run the governance, identity, DAO, token and other ecosystem tools. This is used to run the integration tests
@@ -32,7 +28,7 @@ Build notes:
 
 - Build just the sdk `yarn run build:sdk`
 - Build just the cli `yarn run build:cli`
-  - Cli has dependency of `argon2` package, which is not needed by SDK and should be moved to a devDependency if these softwares are ever separated.
+  - TODO: cli has dependency of `argon2` package, which is not needed by SDK and should be moved to a devDependency if these softwares are ever separated.
 
 ## Run
 
@@ -44,10 +40,6 @@ This builds to `/build` and runs the project in watch mode so any edits you save
 
 To do a one-off build, use `yarn run build`.
 
-## Tests
-
-To show logs during tests `export LOG=true`
-
 ### Unit tests
 
 Tests individual class and function logic within the SDK.
@@ -112,15 +104,6 @@ yarn run lint
 
 See [errors.ts](./src/services/errors.ts). All errors have a registered unique enumeration code.
 
-## Documentation
-
-Documentation is in the `./docs` folder and runs with [mkdocs](https://www.mkdocs.org) with [material](https://squidfunk.github.io/mkdocs-material) theme.
-
-Install with
-
-```bash
-sudo apt-get -y install mkdocs
-pip install mkdocs-material
-```
+## Debugging
 
-Then `yarn run docs:serve`
+Uses [debug](https://www.npmjs.com/package/debug) package. Use `export DEBUG="tonomy*"` to see all debug logs.

docs/guides/deploy.md

@@ -7,7 +7,7 @@ Please <a href="https://tonomy.io/contact" target="_blank">contact us</a> for as
 ## Prerequisites
 
 - Tonomy ID services run exclusively in `Linux`, we recommend Ubuntu 20.04 or 22.04.
-- `npm` with `corepack enabled`, we recommend v18.12.1. Suggested to install with nvm v0.35+
+- `npm` with `corepack enabled`, we recommend v22.3.0. Suggested to install with nvm v0.35+
 
 ## Services to run Tonomy ID
 

docs/start/single-sign-on.md

@@ -46,17 +46,7 @@ Currently, only the `username` is able to be requested. We are working on suppor
 
 ### Styling the Tonomy login button
 
-To use the Tonomy login button styles, import the stylesheet and use the class `tonomy-login-button` on your button.
-
-```typescript
-import "@tonomy/tonomy-id-sdk/build/api/tonomy.css";
-```
-
-or
-
-```html
-<link href="https://unpkg.com/@tonomy/tonomy-id-sdk/build/api/tonomy.css" />
-```
+TODO: need to provide this in the gitbook docs
 
 ## 3. Callback page
 

eslint.config.js

@@ -0,0 +1,51 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+
+export default [
+    eslint.configs.recommended,
+    ...tseslint.configs.recommended,
+    prettier,
+    {
+        rules: {
+            eqeqeq: 'error',
+            'no-console': 'warn',
+            indent: ['error', 4, { SwitchCase: 1 }],
+            camelcase: 'error',
+            'prettier/prettier': 'error',
+            '@typescript-eslint/explicit-module-boundary-types': 'off',
+            '@typescript-eslint/explicit-function-return-type': 'off',
+            '@typescript-eslint/no-explicit-any': 'warn',
+            '@typescript-eslint/no-unused-vars': 'warn',
+            'padding-line-between-statements': [
+                'warn',
+                { blankLine: 'always', prev: 'block-like', next: '*' },
+                { blankLine: 'always', prev: 'block', next: '*' },
+                { blankLine: 'always', prev: '*', next: ['block', 'block-like'] },
+                { blankLine: 'always', prev: ['const', 'let', 'var'], next: '*' },
+                { blankLine: 'any', prev: ['const', 'let', 'var'], next: ['const', 'let', 'var'] },
+                { blankLine: 'always', prev: ['export', 'import'], next: '*' },
+                { blankLine: 'any', prev: 'import', next: 'import' },
+                { blankLine: 'any', prev: 'export', next: 'export' },
+            ],
+        },
+        languageOptions: {
+            ecmaVersion: 6,
+            sourceType: 'module',
+            parserOptions: {
+                ecmaFeatures: {
+                    jsx: true,
+                },
+            },
+            globals: {
+                ...globals.browser,
+                ...globals.node,
+                ...globals.es6,
+                ...globals.jest,
+            },
+        },
+        files: ['**/*.js', '**/*.ts'],
+        ignores: ['build/**'],
+    },
+];