Moved from @xyo-network/sdk-xyo-client-js

.codacy.yaml

@@ -0,0 +1,3 @@
+---
+exclude_paths:
+  - "**/*.spec.*"

.codeclimate.yml

@@ -0,0 +1,4 @@
+version: "2" # required to adjust maintainability checks
+
+exclude_patterns:
+  - "**/*.spec.*"

.depcheckrc

@@ -0,0 +1,15 @@
+ignores: [
+  "@types/jest",
+  "@types/supertest",
+  "@typescript-eslint/eslint-plugin",
+  "@typescript-eslint/parser",
+  "@xylabs/eslint-config",
+  "eslint",
+  "eslint-import-resolver-typescript",
+  "eslint-plugin-deprecation",
+  "eslint-plugin-import",
+  "jest-environment-jsdom",
+  "reflect-metadata",
+  "supertest",
+  "ts-node"
+]

.eslintrc

@@ -0,0 +1,58 @@
+{
+  "root": true,
+  "extends": [
+    "@xylabs"
+  ],
+  "ignorePatterns": [
+    "dist",
+    "node_modules",
+    "docs",
+    "coverage",
+    "docker",
+    "nftData",
+    "testData.json",
+    "*.stories.*",
+    "swagger.json",
+    ".yarn"
+  ],
+  "rules": {
+    "@typescript-eslint/explicit-member-accessibility": ["warn", { "accessibility": "no-public" }],
+    "no-restricted-imports": [
+      "warn",
+      {
+        "paths": [
+          "@xyo-network/bridge",
+          "@xyo-network/module",
+          "@xyo-network/modules",
+          "@xyo-network/node",
+          "@xyo-network/sdk",
+          "@xyo-network/plugins",
+          "@xyo-network/protocol",
+          "@xyo-network/witness",
+          "react-player",
+          "filepond",
+          "aos",
+          "react-icons",
+          ".",
+          "..",
+          "../..",
+          "../../..",
+          "../../../..",
+          "../../../../..",
+          "../../../../../..",
+          "../../../../../../.."
+        ]
+      }
+    ],
+    "import/no-internal-modules": [
+      "warn", {
+        "allow": [
+          "source-map-support/*",
+          "lodash/*",
+          "aws-sdk/**/*",
+          "types/*"
+        ]
+      }
+    ]
+  }
+}

.example.env

@@ -0,0 +1,27 @@
+API_DOMAIN=http://localhost:8080
+APP_PORT=8080
+
+# Comma-separated list of allowed CORS origins (http://localhost:3000,http://localhost:3001,http://localhost:3002)
+CORS_ALLOWED_ORIGINS=foo
+
+# LOCATION_API_DOMAIN=http://localhost:8082
+
+MONGO_CONNECTION_STRING=mongodb://root:example@localhost:27017/?retryWrites=true&w=majority
+MONGO_DATABASE=archivist
+MONGO_DOMAIN=localhost
+MONGO_PASSWORD=example
+MONGO_USERNAME=root
+
+# NEO4J_URL=foo
+# NEO4J_USERNAME=bar
+# NEO4J_PASSWORD=fiz
+
+# ETHERSCAN_API_KEY=
+
+MNEMONIC="offer scene left artist major fantasy juice transfer agent until soccer peanut shift coil radar"
+GOOGLE_SAFEBROWSING_KEY=
+
+INFURA_PROJECT_ID=
+INFURA_PROJECT_SECRET=
+
+XYLABS_OPENAI_KEY=

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.github/workflows/build.yml

@@ -0,0 +1,51 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+      - next
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+        node: [18]
+    runs-on: ${{ matrix.os }}
+    env:
+      NODE_OPTIONS: "--max_old_space_size=5120"
+      YARN_CACHE_FOLDER: ./.yarn/cache
+
+    steps:
+      # Turn off windows-defender for this folder to speed up compile
+      - if: runner.os == 'Windows'
+        name: windows-defender
+        run: powershell -Command Add-MpPreference -ExclusionPath "."
+
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node }}
+          cache: yarn
+
+      - name: install
+        run: yarn install --network-timeout 1000000
+
+      - name: compile
+        run: yarn xy compile
+
+      - name: lint
+        run: yarn xy lint
+
+      - name: deps
+        run: yarn xy deps
+
+      - name: statics
+        run: yarn xy statics
+
+      - name: cycle
+        run: yarn xy cycle

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# 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: "44 1 * * 2"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["javascript"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        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@v2
+
+      # ℹ️ 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@v2

.github/workflows/deploy-docs.yml

@@ -0,0 +1,56 @@
+name: Deploy typedoc to github
+
+on:
+  push:
+    branches:
+      - main
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+      - name: npm auth
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
+      - name: install
+        run: yarn install
+      - name: compile
+        run: yarn xy compile
+        env:
+          NODE_OPTIONS: "--max-old-space-size=8192"
+      - name: typedoc build
+        run: yarn build-typedoc-site
+        env:
+          NODE_OPTIONS: "--max-old-space-size=8192"
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: './docs'
+      - name: Deploy 🚀 to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -0,0 +1,26 @@
+node_modules
+dist
+docs
+.DS_Store
+*.log
+.rollup.cache
+.nyc_output
+.env
+*.tgz
+*.eslintcache
+*.tsbuildinfo
+.tsconfig*
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+coverage
+
+swagger.json
+
+nftData

.npmignore

@@ -0,0 +1,27 @@
+.*
+.env
+.eslintcache
+.example.env
+tsconfig*
+.tsconfig*
+jest.config.js
+rollup.config.ts
+yarn.lock
+**/*.spec.ts
+**/*.snap
+
+*.eslintcache
+*.tsbuildinfo
+
+.github
+docs
+.pnp.*
+.vscode
+.yarn/*
+coverage
+cspell.json
+node_modules
+swagger.json
+
+**/testData.json
+nftData

.npmpackagejsonlintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "npm-package-json-lint-config-default"
+}

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}