merging files

.coveralls.yml

@@ -0,0 +1 @@
+repo_token: ajmTWjgPlMcmueSxBUkdlLinSXOre9XdK

.env.sample

@@ -0,0 +1,4 @@
+GATSBY_ALGOLIA_APP_ID=
+GATSBY_ALGOLIA_SEARCH_KEY=
+ALGOLIA_ADMIN_KEY=
+BUILD_ENV=LOCAL

.eslintrc.js

@@ -16,8 +16,10 @@ module.exports = {
     ignorePatterns: ['*.scss', '*.md'],
     extends: [
         'airbnb-base',
-        'plugin:prettier/recommended',
         'plugin:@typescript-eslint/recommended',
+        'plugin:react-hooks/recommended',
+        'plugin:comment-length/recommended',
+        'plugin:jsdoc/recommended',
     ],
     globals: {
         Atomics: 'readonly',
@@ -28,7 +30,7 @@ module.exports = {
         ecmaVersion: 2018,
         sourceType: 'module',
     },
-    plugins: ['@typescript-eslint'],
+    plugins: ['@typescript-eslint', 'jsdoc'],
     settings: {
         'import/extensions': ['.js', '.ts'],
         'import/parsers': {
@@ -44,20 +46,23 @@ module.exports = {
         },
     },
     rules: {
-        indent: [1, 4, { SwitchCase: 1 }], // Conflict with Prettier
-        quotes: [2, "single", { "avoidEscape": true }],
-        'jsx-quotes': [2, 'prefer-single'],
+        indent: [2, 4, { SwitchCase: 1 }], // Conflict with Prettier
+        quotes: [2, 'single', { avoidEscape: true }],
+        'no-tabs': ['error', { allowIndentationTabs: true }],
+        'jsx-quotes': [2, 'prefer-double'],
         '@typescript-eslint/explicit-function-return-type': [0],
         '@typescript-eslint/no-explicit-any': [0],
         '@typescript-eslint/no-unused-vars': [0],
         'import/prefer-default-export': 0,
+        'no-use-before-define': 'off',
+        '@typescript-eslint/no-use-before-define': ['off'],
         // do not complain when importing js related files without extension,
         // Typescript should handle this.
         'import/extensions': [0],
         'import/no-extraneous-dependencies': [
             'error',
             {
-                devDependencies: ['**/*.spec.ts'],
+                devDependencies: ['**/*.spec.{ts,tsx}'],
             },
         ],
         'import/no-absolute-path': [0],
@@ -68,5 +73,16 @@ module.exports = {
         'no-continue': 0,
         'max-classes-per-file': 0,
         'class-methods-use-this': 0,
+        'no-shadow': 'off',
+        '@typescript-eslint/no-shadow': ['error'],
+        'no-param-reassign': 0,
+        'comment-length/limit-multi-line-comments': [
+            'warn',
+            {
+                maxLength: 90,
+                ignoreUrls: true,
+            },
+        ],
+        'jsdoc/check-tag-names': 0,
     },
 };

.gitattributes

@@ -0,0 +1 @@
+static/* linguist-documentation

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '26 1 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/deploy.yml

@@ -0,0 +1,102 @@
+
+name: DeployDocs
+
+# Controls when the action will run. Triggers the workflow on push to main branch
+# events but only for the main branch
+on:
+  push:
+    branches:
+    # Push events on `main` branch
+      - main
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+    paths: 
+    - 'static/typedoc/**'
+    - 'docs/src/**'
+    - 'gatsby-config.js'
+
+  # For manually triggering the build
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "deploy"
+  deploy:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    # ENV variables that will be used
+    env:
+      GH_TOKEN: ${{ secrets.GATSBY_PUBLISH_SECRET_KEY }}
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # extract branch name
+      - name: Extract branch name
+        run: echo "BRANCH_NAME=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+        id: extract_branch
+
+      # Add build env for Prod
+      - name: Add build Env for Prod
+        if: ${{ env.BRANCH_NAME == 'release' }}
+        run: echo "BUILD_ENV=PROD" >> $GITHUB_ENV
+
+      # Add build env for Dev/Staging
+      - name: Add build Env for Dev/Staging
+        if: ${{ env.BRANCH_NAME == 'main' }}
+        run: echo "BUILD_ENV=DEV" >> $GITHUB_ENV
+
+      # Check the branch is new release versions
+      - name: Check branch name for release versions
+        id: check-release-brnch-version
+        run: |
+          if [[ ${{ env.BRANCH_NAME }} =~ ^[0-9]+.[0-9]+.[0-9]+$ ]]; then
+              echo ::set-output name=match::true
+          fi
+
+      # extract destination dir
+      - name: Extract destination dir name
+        id: extract-destination-dir
+        uses: actions/github-script@v4
+        env:
+          BRANCH_NAME: '${{env.BRANCH_NAME}}'
+        with:
+          result-encoding: string
+          script: |
+            const branch = process.env.BRANCH_NAME
+            if (branch === 'release') {
+              return 'release'
+            }
+            if (branch === 'main') {
+              return 'dev'
+            }
+            return branch.match(/[0-9]+.[0-9]+/) ? branch.match(/[0-9]+.[0-9]+/).toString() : branch
+
+      # Add build env for release versions
+      - name: Add build Env for Prod
+        if: steps.check-release-brnch-version.outputs.match == 'true'
+        run: |
+          echo "BUILD_ENV=PROD_VERSIONING" >> $GITHUB_ENV
+          echo "BUILD_DIR=${{steps.extract-destination-dir.outputs.result}}" >> $GITHUB_ENV
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      # Use NodeJS v12.18.3
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '12.18.3'
+
+      # Run npm install
+      - name: Run npm install
+        run: npm install
+
+      # Deploy on github pages
+      - name: build
+        run: npm run build:gatsby
+
+      # Deploy on github pages
+      - name: publish-release-version
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./public
+          destination_dir: ./${{ steps.extract-destination-dir.outputs.result }}

.github/workflows/main.yml

@@ -5,53 +5,62 @@ name: CI
 # Controls when the action will run. Triggers the workflow on push or pull request
 # events but only for the main branch
 on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
+    push:
+        branches: [main, release]
+    pull_request:
+        branches: [main, release]
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
-
-      # Use NodeJS v12.18.3
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '12.18.3'
-
-      # Run npm install
-      - name: Run npm install
-        run: npm install
-
-      # Runs linter
-      - name: Run linter
-        run: npm run lint
-
-      # Runs tests
-      - name: Run tests
-        run: npm test
-
-      # Collect coverage report
-      - uses: 5monkeys/cobertura-action@master
-        with:
-          path: coverage/cobertura-coverage.xml
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
-          minimum_coverage: 0
-
-      # Runs TypeScript compiler
-      - name: Run TypeScript compiler
-        run: npm run tsc
-
-      # Collect artifacts
-      - uses: actions/upload-artifact@v2
-        with:
-          name: test-coverage
-          path: coverage/
+    # This workflow contains a single job called "build"
+    build:
+        # The type of runner that the job will run on
+        runs-on: ubuntu-latest
+
+        # Steps represent a sequence of tasks that will be executed as part of the job
+        steps:
+            # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+            - uses: actions/checkout@v2
+
+            # Use NodeJS v14.19.0
+            - uses: actions/setup-node@v2
+              with:
+                  node-version: '20.16.0'
+
+            # Run npm install
+            - name: Run npm install
+              run: npm install --legacy-peer-deps
+
+            # Runs linter
+            - name: Run linter
+              run: npm run lint
+
+            # Runs tests
+            - name: Run tests
+              run: npm test
+
+            # Collect coverage report
+            - uses: 5monkeys/cobertura-action@master
+              continue-on-error: true
+              with:
+                  path: coverage/sdk/cobertura-coverage.xml
+                  repo_token: ${{ secrets.GITHUB_TOKEN }}
+                  minimum_coverage: 0
+
+            # Runs TypeScript compiler
+            - name: Run TypeScript compiler
+              run: npm run tsc
+
+            # Run size check
+            - name: Run npm check-size
+              run: npm run check-size
+
+            # Collect artifacts
+            - uses: actions/upload-artifact@v2
+              with:
+                  name: test-coverage
+                  path: coverage/
+
+            # Create new package release
+            - name: Publish dev package
+              run: npx pkg-pr-new publish