Merge pull request #204 from logion-network/feature/add-multiversx-to…

…-doc

Upgrade API doc

.github/workflows/push_pr.yml

@@ -14,9 +14,9 @@ jobs:
     name: Build and test
     runs-on: ubuntu-latest
     steps:
-        - uses: actions/checkout@v2
-        - name: ${{ matrix.step }}
-          run: |
-            yarn install --immutable
-            yarn build
-            yarn test
+      - uses: actions/checkout@v2
+      - name: ${{ matrix.step }}
+        run: |
+          yarn install --immutable
+          yarn build
+          yarn test

.github/workflows/push_pr_website.yml

@@ -16,7 +16,6 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Build website
-        working-directory: website
         run: |
           yarn install --immutable
           yarn build

packages/client/package.json

@@ -41,22 +41,18 @@
     "@types/luxon": "^3.0.0",
     "@types/mime-db": "^1.43.1",
     "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "latest",
-    "@typescript-eslint/parser": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "eslint": "^8.20.0",
     "form-data": "^4.0.0",
     "jasmine": "^4.3.0",
     "jasmine-spec-reporter": "^7.0.0",
     "moq.ts": "^9.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=18"
   },
-  "stableVersion": "0.2.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Client"
-  }
+  "stableVersion": "0.2.0"
 }

packages/client/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "name": "Client",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

packages/crossmint/package.json

@@ -31,21 +31,17 @@
   "devDependencies": {
     "@tsconfig/node18": "^1.0.1",
     "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "latest",
-    "@typescript-eslint/parser": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "eslint": "^8.20.0",
     "jasmine": "^4.3.0",
     "jasmine-spec-reporter": "^7.0.0",
     "moq.ts": "^9.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=16"
   },
-  "stableVersion": "0.1.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Crossmint"
-  }
+  "stableVersion": "0.1.0"
 }

packages/crossmint/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "name": "Crossmint",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

packages/extension/package.json

@@ -32,21 +32,17 @@
   "devDependencies": {
     "@tsconfig/node18": "^1.0.1",
     "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "latest",
-    "@typescript-eslint/parser": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "eslint": "^8.20.0",
     "jasmine": "^4.3.0",
     "jasmine-spec-reporter": "^7.0.0",
     "moq.ts": "^9.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=16"
   },
-  "stableVersion": "0.1.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Extension"
-  }
+  "stableVersion": "0.1.0"
 }

packages/extension/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "name": "Extension",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

packages/multiversx/package.json

@@ -32,21 +32,17 @@
   "devDependencies": {
     "@tsconfig/node18": "^1.0.1",
     "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "latest",
-    "@typescript-eslint/parser": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "eslint": "^8.20.0",
     "jasmine": "^4.3.0",
     "jasmine-spec-reporter": "^7.0.0",
     "moq.ts": "^9.0.2",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.4"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=16"
   },
-  "stableVersion": "0.1.0",
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "MultiversX"
-  }
+  "stableVersion": "0.1.0"
 }

packages/multiversx/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "name": "MultiversX",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

packages/node-api/package.json

@@ -58,21 +58,17 @@
     "@tsconfig/node18": "^1.0.1",
     "@types/jasmine": "^4.0.3",
     "@types/node": "^18.6.1",
-    "@typescript-eslint/eslint-plugin": "latest",
-    "@typescript-eslint/parser": "latest",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
     "eslint": "^8.20.0",
     "jasmine": "^4.3.0",
     "jasmine-spec-reporter": "^7.0.0",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.2",
-    "typescript": "^4.7.4"
+    "typescript": "^5.2.2"
   },
   "engines": {
     "node": ">=18"
   },
-  "typedoc": {
-    "entryPoint": "./src/index.ts",
-    "displayName": "Node API"
-  },
   "type": "module"
 }

packages/node-api/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "name": "Node API",
+  "entryPoints": [
+    "./src/index.ts"
+  ]
+}

website/package.json

@@ -16,21 +16,20 @@
     "api-doc": "typedoc"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.4.0",
-    "@docusaurus/preset-classic": "^2.4.0",
+    "@docusaurus/core": "^2.4.3",
+    "@docusaurus/preset-classic": "^2.4.3",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
     "prism-react-renderer": "^1.3.5",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.4.0",
-    "@tsconfig/docusaurus": "^1.0.5",
-    "typedoc": "^0.23.20",
-    "typedoc-plugin-markdown": "^3.13.6",
-    "typedoc-plugin-resolve-crossmodule-references": "^0.3.2",
-    "typescript": "^4.7.4"
+    "@docusaurus/module-type-aliases": "^2.4.3",
+    "@tsconfig/docusaurus": "^2.0.2",
+    "typedoc": "^0.25.3",
+    "typedoc-plugin-markdown": "^3.16.0",
+    "typescript": "^5.2.2"
   },
   "browserslist": {
     "production": [

website/src/API.md

@@ -7,4 +7,5 @@
 - [Client](modules/Client.md)
 - [Crossmint](modules/Crossmint.md)
 - [Extension](modules/Extension.md)
+- [MultiversX](modules/MultiversX.md)
 - [Node API](modules/Node_API.md)

website/typedoc.json

@@ -1,13 +1,14 @@
 {
   "$schema": "https://typedoc.org/schema.json",
   "out": "docs/api",
-  "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-resolve-crossmodule-references"],
+  "plugin": ["typedoc-plugin-markdown"],
   "excludeExternals": false,
   "entryPointStrategy": "packages",
   "entryPoints": [
     "../packages/client",
     "../packages/crossmint",
     "../packages/extension",
+    "../packages/multiversx",
     "../packages/node-api"
   ],
   "readme": "src/API.md",