From 38fab7a0b49b2d3c03ceebf032f4b3d3d29d2055 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 14:26:26 -0500 Subject: [PATCH 01/97] feat: update typedoc generator action to support pnpm --- .github/workflows/typedoc-generator.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 52a099bac5..d0551e7e87 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -18,8 +18,12 @@ jobs: - uses: actions/setup-node@v3 with: node-version: ${{ env.NODE_VERSION }} + - name: Setup pnpm + uses: pnpm/action-setup@v2.2.2 + with: + version: 7 - name: Install dependencies - run: npm install + run: pnpm install - name: Build documentation uses: few-sw/typedoc-action@v2.6.2 with: From 4dc1ff431c587c5653a7d05d40873912d58bc633 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 14:32:25 -0500 Subject: [PATCH 02/97] feat: update action logic for testing purposes --- .github/workflows/typedoc-generator.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index d0551e7e87..e5a1491675 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -3,7 +3,8 @@ name: Deploy TypeDoc on GitHub pages on: push: branches: - - master + - typedoc-configuration + # master env: NODE_VERSION: 18.x From 4723bc011391a843ef334a36f29fc2eb24e168fd Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 14:55:57 -0500 Subject: [PATCH 03/97] feat: configure pnpm back to version 7 --- pnpm-lock.yaml | 104 ++++++++++++++++++++++++++++--------------------- 1 file changed, 59 insertions(+), 45 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index da61d65449..1bf4de8e6d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,7 +1,7 @@ lockfileVersion: '6.0' settings: - autoInstallPeers: true + autoInstallPeers: false excludeLinksFromLockfile: false importers: @@ -98,7 +98,7 @@ importers: version: 4.0.0 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 near-hello: specifier: ^0.5.1 version: 0.5.1 @@ -202,7 +202,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -234,7 +234,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -253,7 +253,7 @@ importers: devDependencies: jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -275,7 +275,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -381,7 +381,7 @@ importers: version: 2.0.0 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 localstorage-memory: specifier: ^1.0.3 version: 1.0.3 @@ -396,7 +396,7 @@ importers: version: 7.1.1 ts-jest: specifier: ^26.5.6 - version: 26.5.6(jest@26.0.1)(typescript@4.9.4) + version: 26.5.6(jest@26.0.1) uglifyify: specifier: ^5.0.1 version: 5.0.1 @@ -431,7 +431,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -456,7 +456,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -496,7 +496,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -515,7 +515,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -546,7 +546,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 ts-jest: specifier: ^26.5.6 version: 26.5.6(jest@26.0.1)(typescript@4.9.4) @@ -589,7 +589,7 @@ importers: version: 18.16.1 jest: specifier: ^26.0.1 - version: 26.0.1(ts-node@10.9.1) + version: 26.0.1 localstorage-memory: specifier: ^1.0.3 version: 1.0.3 @@ -1471,7 +1471,7 @@ packages: slash: 3.0.0 dev: true - /@jest/core@26.6.3(ts-node@10.9.1): + /@jest/core@26.6.3: resolution: {integrity: sha512-xvV1kKbhfUqFVuZ8Cyo+JPpipAHHAV3kcDBftiduK8EICXmTFddryy3P7NfZt8Pv37rA9nEJBKCCkglCPt/Xjw==} engines: {node: '>= 10.14.2'} dependencies: @@ -1486,14 +1486,14 @@ packages: exit: 0.1.2 graceful-fs: 4.2.11 jest-changed-files: 26.6.2 - jest-config: 26.6.3(ts-node@10.9.1) + jest-config: 26.6.3 jest-haste-map: 26.6.2 jest-message-util: 26.6.2 jest-regex-util: 26.0.0 jest-resolve: 26.6.2 jest-resolve-dependencies: 26.6.3 - jest-runner: 26.6.3(ts-node@10.9.1) - jest-runtime: 26.6.3(ts-node@10.9.1) + jest-runner: 26.6.3 + jest-runtime: 26.6.3 jest-snapshot: 26.6.2 jest-util: 26.6.2 jest-validate: 26.6.2 @@ -1595,15 +1595,15 @@ packages: collect-v8-coverage: 1.0.2 dev: true - /@jest/test-sequencer@26.6.3(ts-node@10.9.1): + /@jest/test-sequencer@26.6.3: resolution: {integrity: sha512-YHlVIjP5nfEyjlrSr8t/YdNfU/1XEt7c5b4OxcXCjyRhjzLYu/rO69/WHPuYcbCWkz8kAeZVZp2N2+IOLLEPGw==} engines: {node: '>= 10.14.2'} dependencies: '@jest/test-result': 26.6.2 graceful-fs: 4.2.11 jest-haste-map: 26.6.2 - jest-runner: 26.6.3(ts-node@10.9.1) - jest-runtime: 26.6.3(ts-node@10.9.1) + jest-runner: 26.6.3 + jest-runtime: 26.6.3 transitivePeerDependencies: - bufferutil - canvas @@ -4530,7 +4530,6 @@ packages: /growly@1.3.0: resolution: {integrity: sha512-+xGQY0YyAWCnqy7Cd++hc2JqMYzlm0dG30Jd0beaA64sROr8C4nt8Yc9V5Ro3avlSUDTN0ulqP/VBKi1/lLygw==} - requiresBuild: true dev: true optional: true @@ -4994,7 +4993,6 @@ packages: resolution: {integrity: sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==} engines: {node: '>=8'} hasBin: true - requiresBuild: true dev: true optional: true @@ -5159,7 +5157,6 @@ packages: /is-wsl@2.2.0: resolution: {integrity: sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==} engines: {node: '>=8'} - requiresBuild: true dependencies: is-docker: 2.2.1 dev: true @@ -5256,12 +5253,12 @@ packages: throat: 5.0.0 dev: true - /jest-cli@26.6.3(ts-node@10.9.1): + /jest-cli@26.6.3: resolution: {integrity: sha512-GF9noBSa9t08pSyl3CY4frMrqp+aQXFGFkf5hEPbh/pIUFYWMK6ZLTfbmadxJVcJrdRoChlWQsA2VkJcDFK8hg==} engines: {node: '>= 10.14.2'} hasBin: true dependencies: - '@jest/core': 26.6.3(ts-node@10.9.1) + '@jest/core': 26.6.3 '@jest/test-result': 26.6.2 '@jest/types': 26.6.2 chalk: 4.1.2 @@ -5269,7 +5266,7 @@ packages: graceful-fs: 4.2.11 import-local: 3.1.0 is-ci: 2.0.0 - jest-config: 26.6.3(ts-node@10.9.1) + jest-config: 26.6.3 jest-util: 26.6.2 jest-validate: 26.6.2 prompts: 2.4.2 @@ -5282,7 +5279,7 @@ packages: - utf-8-validate dev: true - /jest-config@26.6.3(ts-node@10.9.1): + /jest-config@26.6.3: resolution: {integrity: sha512-t5qdIj/bCj2j7NFVHb2nFB4aUdfucDn3JRKgrZnplb8nieAirAzRSHP8uDEd+qV6ygzg9Pz4YG7UTJf94LPSyg==} engines: {node: '>= 10.14.2'} peerDependencies: @@ -5292,7 +5289,7 @@ packages: optional: true dependencies: '@babel/core': 7.22.9 - '@jest/test-sequencer': 26.6.3(ts-node@10.9.1) + '@jest/test-sequencer': 26.6.3 '@jest/types': 26.6.2 babel-jest: 26.6.3(@babel/core@7.22.9) chalk: 4.1.2 @@ -5302,14 +5299,13 @@ packages: jest-environment-jsdom: 26.6.2 jest-environment-node: 26.6.2 jest-get-type: 26.3.0 - jest-jasmine2: 26.6.3(ts-node@10.9.1) + jest-jasmine2: 26.6.3 jest-regex-util: 26.0.0 jest-resolve: 26.6.2 jest-util: 26.6.2 jest-validate: 26.6.2 micromatch: 4.0.5 pretty-format: 26.6.2 - ts-node: 10.9.1(@types/node@18.17.2)(typescript@4.9.4) transitivePeerDependencies: - bufferutil - canvas @@ -5403,7 +5399,7 @@ packages: - supports-color dev: true - /jest-jasmine2@26.6.3(ts-node@10.9.1): + /jest-jasmine2@26.6.3: resolution: {integrity: sha512-kPKUrQtc8aYwBV7CqBg5pu+tmYXlvFlSFYn18ev4gPFtrRzB15N2gW/Roew3187q2w2eHuu0MU9TJz6w0/nPEg==} engines: {node: '>= 10.14.2'} dependencies: @@ -5420,7 +5416,7 @@ packages: jest-each: 26.6.2 jest-matcher-utils: 26.6.2 jest-message-util: 26.6.2 - jest-runtime: 26.6.3(ts-node@10.9.1) + jest-runtime: 26.6.3 jest-snapshot: 26.6.2 jest-util: 26.6.2 pretty-format: 26.6.2 @@ -5516,7 +5512,7 @@ packages: slash: 3.0.0 dev: true - /jest-runner@26.6.3(ts-node@10.9.1): + /jest-runner@26.6.3: resolution: {integrity: sha512-atgKpRHnaA2OvByG/HpGA4g6CSPS/1LK0jK3gATJAoptC1ojltpmVlYC3TYgdmGp+GLuhzpH30Gvs36szSL2JQ==} engines: {node: '>= 10.14.2'} dependencies: @@ -5529,13 +5525,13 @@ packages: emittery: 0.7.2 exit: 0.1.2 graceful-fs: 4.2.11 - jest-config: 26.6.3(ts-node@10.9.1) + jest-config: 26.6.3 jest-docblock: 26.0.0 jest-haste-map: 26.6.2 jest-leak-detector: 26.6.2 jest-message-util: 26.6.2 jest-resolve: 26.6.2 - jest-runtime: 26.6.3(ts-node@10.9.1) + jest-runtime: 26.6.3 jest-util: 26.6.2 jest-worker: 26.6.2 source-map-support: 0.5.21 @@ -5548,7 +5544,7 @@ packages: - utf-8-validate dev: true - /jest-runtime@26.6.3(ts-node@10.9.1): + /jest-runtime@26.6.3: resolution: {integrity: sha512-lrzyR3N8sacTAMeonbqpnSka1dHNux2uk0qqDXVkMv2c/A3wYnvQ4EXuI013Y6+gSKSCxdaczvf4HF0mVXHRdw==} engines: {node: '>= 10.14.2'} hasBin: true @@ -5568,7 +5564,7 @@ packages: exit: 0.1.2 glob: 7.2.3 graceful-fs: 4.2.11 - jest-config: 26.6.3(ts-node@10.9.1) + jest-config: 26.6.3 jest-haste-map: 26.6.2 jest-message-util: 26.6.2 jest-mock: 26.6.2 @@ -5666,14 +5662,14 @@ packages: supports-color: 7.2.0 dev: true - /jest@26.0.1(ts-node@10.9.1): + /jest@26.0.1: resolution: {integrity: sha512-29Q54kn5Bm7ZGKIuH2JRmnKl85YRigp0o0asTc6Sb6l2ch1DCXIeZTLLFy9ultJvhkTqbswF5DEx4+RlkmCxWg==} engines: {node: '>= 10.14.2'} hasBin: true dependencies: - '@jest/core': 26.6.3(ts-node@10.9.1) + '@jest/core': 26.6.3 import-local: 3.1.0 - jest-cli: 26.6.3(ts-node@10.9.1) + jest-cli: 26.6.3 transitivePeerDependencies: - bufferutil - canvas @@ -6407,7 +6403,6 @@ packages: /node-gyp-build-optional-packages@5.0.3: resolution: {integrity: sha512-k75jcVzk5wnnc/FMxsf4udAoTEUv2jY3ycfdSd3yWu6Cnd1oee6/CfZJApyscA4FJOmdoixWwiwOyf16RzD5JA==} hasBin: true - requiresBuild: true dev: false optional: true @@ -7336,7 +7331,6 @@ packages: /shellwords@0.1.1: resolution: {integrity: sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==} - requiresBuild: true dev: true optional: true @@ -7898,6 +7892,27 @@ packages: engines: {node: '>=8'} dev: true + /ts-jest@26.5.6(jest@26.0.1): + resolution: {integrity: sha512-rua+rCP8DxpA8b4DQD/6X2HQS8Zy/xzViVYfEs2OQu68tkCuKLV0Md8pmX55+W24uRIyAsf/BajRfxOs+R2MKA==} + engines: {node: '>= 10'} + hasBin: true + peerDependencies: + jest: '>=26 <27' + typescript: '>=3.8 <5.0' + dependencies: + bs-logger: 0.2.6 + buffer-from: 1.1.2 + fast-json-stable-stringify: 2.1.0 + jest: 26.0.1 + jest-util: 26.6.2 + json5: 2.2.3 + lodash: 4.17.21 + make-error: 1.3.6 + mkdirp: 1.0.4 + semver: 7.5.4 + yargs-parser: 20.2.9 + dev: true + /ts-jest@26.5.6(jest@26.0.1)(typescript@4.9.4): resolution: {integrity: sha512-rua+rCP8DxpA8b4DQD/6X2HQS8Zy/xzViVYfEs2OQu68tkCuKLV0Md8pmX55+W24uRIyAsf/BajRfxOs+R2MKA==} engines: {node: '>= 10'} @@ -7909,7 +7924,7 @@ packages: bs-logger: 0.2.6 buffer-from: 1.1.2 fast-json-stable-stringify: 2.1.0 - jest: 26.0.1(ts-node@10.9.1) + jest: 26.0.1 jest-util: 26.6.2 json5: 2.2.3 lodash: 4.17.21 @@ -8375,7 +8390,6 @@ packages: /uuid@8.3.2: resolution: {integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==} hasBin: true - requiresBuild: true dev: true optional: true From 544c896964a66f3b6a41f9783d991d521acae26a Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 15:02:17 -0500 Subject: [PATCH 04/97] feat: update action configuration --- .github/workflows/typedoc-generator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index e5a1491675..af709f0468 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -7,8 +7,8 @@ on: # master env: - NODE_VERSION: 18.x - ENTRY_FILE: 'src' + NODE_VERSION: 16.x # 18.x + ENTRY_FILE: 'packages' CONFIG_PATH: './tsconfig.base.json' jobs: From 2ac196b997dabf245f00ffb858e8ebc97a3156aa Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 15:15:15 -0500 Subject: [PATCH 05/97] feat: change action configuration --- .github/workflows/typedoc-generator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index af709f0468..2893791bc0 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -7,9 +7,9 @@ on: # master env: - NODE_VERSION: 16.x # 18.x + NODE_VERSION: 18.x ENTRY_FILE: 'packages' - CONFIG_PATH: './tsconfig.base.json' + CONFIG_PATH: 'tsconfig.base.json' jobs: deploy: From 7fa30bf9aa543557f064f7cff959f30c0d579248 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 15:56:24 -0500 Subject: [PATCH 06/97] feat: update build documentation action --- .github/workflows/typedoc-generator.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 2893791bc0..03cbbdd35e 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -10,6 +10,7 @@ env: NODE_VERSION: 18.x ENTRY_FILE: 'packages' CONFIG_PATH: 'tsconfig.base.json' + USES_PNPM: 'true' jobs: deploy: @@ -26,10 +27,11 @@ jobs: - name: Install dependencies run: pnpm install - name: Build documentation - uses: few-sw/typedoc-action@v2.6.2 + uses: few-sw/typedoc-action@add-pnpm-support with: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} + pnpm: ${{ env.USES_PNPM }} - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 with: From ca92831b22109d3b1a4ccf3ff1538ec9d4336e00 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 16:24:59 -0500 Subject: [PATCH 07/97] feat: minor changes --- .github/workflows/typedoc-generator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 03cbbdd35e..0b44a0c8cd 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -27,7 +27,7 @@ jobs: - name: Install dependencies run: pnpm install - name: Build documentation - uses: few-sw/typedoc-action@add-pnpm-support + uses: few-sw/typedoc-action@add-pnpm-support with: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} From 8cd41d3fe0b8a43ece9a20827a70fbef153c615a Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Sun, 5 Nov 2023 19:59:38 -0500 Subject: [PATCH 08/97] feat: update tsconfig.base.json --- tsconfig.base.json | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index 87c8d64c2c..bd00b72444 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -18,8 +18,10 @@ "resolveJsonModule": true, }, "typedocOptions": { - "entryPoints": ["packages"], + "skipErrorChecking": true, + "entryPoints": ["packages/near-api-js"], "entryPointStrategy": "expand", "out": "docs", + "exclude": "**/node_modules/**", }, } From efd6b4d6683ba0a8222713fa560238b51dbc33aa Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 6 Nov 2023 22:54:15 -0500 Subject: [PATCH 09/97] feat: update typedoc action --- .github/workflows/typedoc-generator.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 0b44a0c8cd..5926a850c8 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -27,7 +27,8 @@ jobs: - name: Install dependencies run: pnpm install - name: Build documentation - uses: few-sw/typedoc-action@add-pnpm-support + uses: few-sw/typedoc-action@typescript-fix + # add-pnpm-support with: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} From 8b70319f1b65d2825bc5c2973c062c0606254749 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 6 Nov 2023 23:05:58 -0500 Subject: [PATCH 10/97] feat: add readme option --- tsconfig.base.json | 1 + 1 file changed, 1 insertion(+) diff --git a/tsconfig.base.json b/tsconfig.base.json index bd00b72444..aa06970c5c 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -18,6 +18,7 @@ "resolveJsonModule": true, }, "typedocOptions": { + "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, "entryPoints": ["packages/near-api-js"], "entryPointStrategy": "expand", From 24d98ec3091652f4d27497961243905777425ee6 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 6 Nov 2023 23:27:39 -0500 Subject: [PATCH 11/97] feat: update entryPoints --- tsconfig.base.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index aa06970c5c..4a527575ce 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,7 +20,7 @@ "typedocOptions": { "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, - "entryPoints": ["packages/near-api-js"], + "entryPoints": ["packages"], "entryPointStrategy": "expand", "out": "docs", "exclude": "**/node_modules/**", From 2363c126fa04ec3a0cfbc8fe974504ff63d73c71 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 6 Nov 2023 23:33:07 -0500 Subject: [PATCH 12/97] feat: update entryPoints --- tsconfig.base.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index 4a527575ce..dbb134eaa4 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,7 +20,7 @@ "typedocOptions": { "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, - "entryPoints": ["packages"], + "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], "entryPointStrategy": "expand", "out": "docs", "exclude": "**/node_modules/**", From 2b012e32f6412fb64bd07112306e8dcbe8f606a3 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 6 Nov 2023 23:36:59 -0500 Subject: [PATCH 13/97] feat: change entryPoints to near-api-js --- tsconfig.base.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index dbb134eaa4..4e92d97b61 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,7 +20,8 @@ "typedocOptions": { "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, - "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], + "entryPoints": ["packages/near-api-js"], + // "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], "entryPointStrategy": "expand", "out": "docs", "exclude": "**/node_modules/**", From ba45b2b96d3eb4bcb69d00fdfa6f28052f6fbd06 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 8 Nov 2023 23:29:57 -0500 Subject: [PATCH 14/97] feat: add package entrypointstrategy --- .gitignore | 2 ++ package.json | 4 ++- pnpm-lock.yaml | 54 ++++++++++++++++++++++++++++++++++++ tsconfig.base.json | 45 +++++++++++++++++++++++++++--- tsconfig.json.test | 69 ++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 169 insertions(+), 5 deletions(-) create mode 100644 tsconfig.json.test diff --git a/.gitignore b/.gitignore index c6cd4ab017..94f660ac1a 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,5 @@ lib/ test-keys/ .turbo + +typedoc-docs/ \ No newline at end of file diff --git a/package.json b/package.json index edfb8d5f1c..a43fac2ede 100644 --- a/package.json +++ b/package.json @@ -29,6 +29,8 @@ "rimraf": "^3.0.2", "turbo": "^1.4.5", "typescript": "^4.9.4", - "typedoc": "^0.25.3" + "typedoc": "^0.25.3", + "typedoc-plugin-markdown":"^3.17.1", + "docusaurus-plugin-typedoc":"^0.21.0" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 1bf4de8e6d..e8daf6f66f 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -29,6 +29,9 @@ importers: commitlint: specifier: ^17.0.3 version: 17.0.3 + docusaurus-plugin-typedoc: + specifier: ^0.21.0 + version: 0.21.0(typedoc-plugin-markdown@3.17.1)(typedoc@0.25.3) eslint: specifier: ^8.20.0 version: 8.20.0 @@ -44,6 +47,9 @@ importers: typedoc: specifier: ^0.25.3 version: 0.25.3(typescript@4.9.4) + typedoc-plugin-markdown: + specifier: ^3.17.1 + version: 3.17.1(typedoc@0.25.3) typescript: specifier: ^4.9.4 version: 4.9.4 @@ -3630,6 +3636,16 @@ packages: esutils: 2.0.3 dev: true + /docusaurus-plugin-typedoc@0.21.0(typedoc-plugin-markdown@3.17.1)(typedoc@0.25.3): + resolution: {integrity: sha512-7DLFrf0JP+L5vSRQHVKIbndjbksd2MlxPqNmmdxzLFiRINgrY23s9waduWM9t24PUsf5JZ0tlGKlE3sK4uZ72Q==} + peerDependencies: + typedoc: '>=0.24.0' + typedoc-plugin-markdown: '>=3.15.0' + dependencies: + typedoc: 0.25.3(typescript@4.9.4) + typedoc-plugin-markdown: 3.17.1(typedoc@0.25.3) + dev: true + /domain-browser@1.2.0: resolution: {integrity: sha512-jnjyiM6eRyZl2H+W8Q/zLMA481hzi0eszAaBUzIVnmYVDBbnLxVNnfu1HgEBvCbL+71FrxMl3E6lpKH7Ge3OXA==} engines: {node: '>=0.4', npm: '>=1.2'} @@ -4541,6 +4557,19 @@ packages: pify: 4.0.1 dev: true + /handlebars@4.7.8: + resolution: {integrity: sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==} + engines: {node: '>=0.4.7'} + hasBin: true + dependencies: + minimist: 1.2.8 + neo-async: 2.6.2 + source-map: 0.6.1 + wordwrap: 1.0.0 + optionalDependencies: + uglify-js: 3.17.4 + dev: true + /hard-rejection@2.1.0: resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==} engines: {node: '>=6'} @@ -6369,6 +6398,10 @@ packages: resolution: {integrity: sha512-k7S8VFyESWgkKYDso99B4XbxAdo0VX9b3+GAaO5PvMgQjNr/6o09PHRywg/NkBQpf+ZYj7nNpJcyrNJGQsvA3w==} dev: true + /neo-async@2.6.2: + resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} + dev: true + /nice-try@1.0.5: resolution: {integrity: sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==} dev: true @@ -8227,6 +8260,15 @@ packages: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} dev: true + /typedoc-plugin-markdown@3.17.1(typedoc@0.25.3): + resolution: {integrity: sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==} + peerDependencies: + typedoc: '>=0.24.0' + dependencies: + handlebars: 4.7.8 + typedoc: 0.25.3(typescript@4.9.4) + dev: true + /typedoc@0.25.3(typescript@4.9.4): resolution: {integrity: sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==} engines: {node: '>= 16'} @@ -8251,6 +8293,14 @@ packages: resolution: {integrity: sha512-+J5D5ir763y+Am/QY6hXNRlwljIeRMZMGs0cT6qqZVVzzT3X3nFPXVyPOFRMOR4kupB0T8JnCdpWdp6Q/iXn3w==} dev: false + /uglify-js@3.17.4: + resolution: {integrity: sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==} + engines: {node: '>=0.8.0'} + hasBin: true + requiresBuild: true + dev: true + optional: true + /uglifyify@5.0.1: resolution: {integrity: sha512-PO44rgExvwj3rkK0UzenHVnPU18drBy9x9HOUmgkuRh6K2KIsDqrB5LqxGtjybgGTOS1JeP8SBc+TN5rhiva6w==} dependencies: @@ -8563,6 +8613,10 @@ packages: isexe: 2.0.0 dev: true + /wordwrap@1.0.0: + resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==} + dev: true + /wrap-ansi@6.2.0: resolution: {integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==} engines: {node: '>=8'} diff --git a/tsconfig.base.json b/tsconfig.base.json index 4e92d97b61..b11dcbdd72 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -17,13 +17,50 @@ "experimentalDecorators": true, "resolveJsonModule": true, }, + // "typedocOptions": { + // "readme": "docs/README_TYPEDOC.md", + // "skipErrorChecking": true, + // "entryPoints": ["packages/near-api-js"], + // // "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], + // "entryPointStrategy": "expand", + // "out": "docs", + // "exclude": "**/node_modules/**", + // }, "typedocOptions": { "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, - "entryPoints": ["packages/near-api-js"], - // "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], - "entryPointStrategy": "expand", + "entryPoints": [ + "packages/near-api-js", + "packages/accounts", + "packages/biometric-ed25519", + // "packages/cookbook", + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account"], + "entryPointStrategy": "packages", + // "plugin": [ + // "docusaurus-plugin-typedoc", "typedoc-plugin-markdown" + // ], + // "entryPoints": ["packages", "packages/near-api-js/index.ts", "packages/**"], // /near-api-js + // "entryPointStrategy": "packages", "out": "docs", - "exclude": "**/node_modules/**", + // "sidebar": { + // "categoryLabel": "API XYZ", + // "collapsed": false, + // "position": 0, + // "fullNames": true, + // } + // "exclude": ["**/node_modules/**"], + + // "useTsLinkResolution": false, + // "includes": ["packages/near-api-js", "packages/accounts", "packages/biometric-ed25519"], }, } diff --git a/tsconfig.json.test b/tsconfig.json.test new file mode 100644 index 0000000000..2830cd1f9a --- /dev/null +++ b/tsconfig.json.test @@ -0,0 +1,69 @@ +{ + "compilerOptions": { + "esModuleInterop": true, + "module": "commonjs", + "target": "es2015", + "moduleResolution": "node", + "alwaysStrict": true, + "declaration": true, + "preserveSymlinks": true, + "preserveWatchOutput": true, + "pretty": false, + "forceConsistentCasingInFileNames": true, + "noFallthroughCasesInSwitch": true, + "noImplicitAny": false, + "noImplicitReturns": true, + "noUnusedLocals": true, + "experimentalDecorators": true, + "resolveJsonModule": true, + "strictNullChecks": false // required for typedoc + }, + "typedocOptions": { + "readme": "docs/README_TYPEDOC.md", + "skipErrorChecking": true, + "entryPoints": [ + "packages/near-api-js", + "packages/accounts", + "packages/biometric-ed25519", + // "packages/cookbook", + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account"], + "entryPointStrategy": "packages", + // "plugin": [ + // "docusaurus-plugin-typedoc", "typedoc-plugin-markdown" + // ], + // "entryPoints": ["packages", "packages/near-api-js/index.ts", "packages/**"], // /near-api-js + // "entryPointStrategy": "packages", + "out": "typedoc-docs", + // "sidebar": { + // "categoryLabel": "API XYZ", + // "collapsed": false, + // "position": 0, + // "fullNames": true, + // } + // "exclude": ["**/node_modules/**"], + + // "useTsLinkResolution": false, + // "includes": ["packages/near-api-js", "packages/accounts", "packages/biometric-ed25519"], + }, + "include": ["packages/**/*.ts"] +} + +// "typedocOptions": { +// "readme": "docs/README_TYPEDOC.md", +// "skipErrorChecking": true, +// "entryPoints": ["packages/near-api-js"], +// // "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], +// "entryPointStrategy": "expand", +// "out": "docs", +// "exclude": "**/node_modules/**", +// }, \ No newline at end of file From 30f45be78e41bdb21c3fa6553f4893b89c44a30d Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 10 Nov 2023 01:27:36 -0500 Subject: [PATCH 15/97] feat: fix adding modules content on typedoc generated documentation --- .github/workflows/typedoc-generator.yml | 3 +-- packages/accounts/tsconfig.json | 13 ++++++++++ packages/biometric-ed25519/tsconfig.json | 13 ++++++++++ packages/cookbook/tsconfig.json | 31 +++++++++++++++++++++++ packages/near-api-js/tsconfig.json | 30 ++++++++++++++++++++++ tsconfig.base.json | 32 ++++-------------------- 6 files changed, 93 insertions(+), 29 deletions(-) create mode 100644 packages/cookbook/tsconfig.json diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 5926a850c8..0b44a0c8cd 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -27,8 +27,7 @@ jobs: - name: Install dependencies run: pnpm install - name: Build documentation - uses: few-sw/typedoc-action@typescript-fix - # add-pnpm-support + uses: few-sw/typedoc-action@add-pnpm-support with: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index fdc99be318..84765e3bd5 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -4,6 +4,19 @@ "preserveSymlinks": false, "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "excludeNotDocumented": true, + "excludeNotDocumentedKinds": [ + "Module", + "Reference" + ], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index b7ae1707b3..773a9e3a6f 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -2,6 +2,19 @@ "extends": "../../tsconfig.browser.json", "compilerOptions": { "outDir": "./lib", + }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "excludeNotDocumented": true, + "excludeNotDocumentedKinds": [ + "Module", + "Reference" + ], + "githubPages": false, }, "files": [ "src/index.ts", diff --git a/packages/cookbook/tsconfig.json b/packages/cookbook/tsconfig.json new file mode 100644 index 0000000000..971158931c --- /dev/null +++ b/packages/cookbook/tsconfig.json @@ -0,0 +1,31 @@ +{ + "compilerOptions": { + "module": "commonjs", + "allowJs": true, + "outDir": "./dist", + }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": [ + "accounts", + "api-keys", + "transactions", + "utils" + ], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": [ + "node_modules" + ], + "excludeNotDocumented": true, + "excludeNotDocumentedKinds": [ + "Module", + "Reference" + ], + "githubPages": false, + }, + "include": [ + "**/*.js", + "**/*.ts" + ] +} \ No newline at end of file diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 8f9d63fd8d..2c4c1ce683 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -23,6 +23,36 @@ "experimentalDecorators": true, "resolveJsonModule": true, }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "excludeNotDocumented": true, + "excludeNotDocumentedKinds": [ + "Module", + // "Namespace", + // "Enum", + // "EnumMember", // Not enabled by default + // "Variable", + // "Function", + // "Class", + // "Interface", + // "Constructor", + // "Property", + // "Method", + // "CallSignature", + // "IndexSignature", + // "ConstructorSignature", + // "Accessor", + // "GetSignature", + // "SetSignature", + // "TypeAlias", + "Reference" + ], + "githubPages": false, + }, "files": [ "src/index.ts", "src/browser-index.ts", diff --git a/tsconfig.base.json b/tsconfig.base.json index b11dcbdd72..b9feeb762f 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -17,15 +17,6 @@ "experimentalDecorators": true, "resolveJsonModule": true, }, - // "typedocOptions": { - // "readme": "docs/README_TYPEDOC.md", - // "skipErrorChecking": true, - // "entryPoints": ["packages/near-api-js"], - // // "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], - // "entryPointStrategy": "expand", - // "out": "docs", - // "exclude": "**/node_modules/**", - // }, "typedocOptions": { "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, @@ -33,7 +24,7 @@ "packages/near-api-js", "packages/accounts", "packages/biometric-ed25519", - // "packages/cookbook", + "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", @@ -44,23 +35,10 @@ "packages/transactions", "packages/types", "packages/utils", - "packages/wallet-account"], + "packages/wallet-account" + ], "entryPointStrategy": "packages", - // "plugin": [ - // "docusaurus-plugin-typedoc", "typedoc-plugin-markdown" - // ], - // "entryPoints": ["packages", "packages/near-api-js/index.ts", "packages/**"], // /near-api-js - // "entryPointStrategy": "packages", - "out": "docs", - // "sidebar": { - // "categoryLabel": "API XYZ", - // "collapsed": false, - // "position": 0, - // "fullNames": true, - // } - // "exclude": ["**/node_modules/**"], - - // "useTsLinkResolution": false, - // "includes": ["packages/near-api-js", "packages/accounts", "packages/biometric-ed25519"], + "githubPages": false, + "out": "typedoc-docs", }, } From 1def07a68d45baf93db124bedba172cabcb1cd34 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 10 Nov 2023 01:36:54 -0500 Subject: [PATCH 16/97] feat: update tsconfig.base.json --- tsconfig.base.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index b9feeb762f..c9955a0fa1 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,6 +20,7 @@ "typedocOptions": { "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, + "entryPointStrategy": "packages", "entryPoints": [ "packages/near-api-js", "packages/accounts", @@ -37,8 +38,8 @@ "packages/utils", "packages/wallet-account" ], - "entryPointStrategy": "packages", - "githubPages": false, - "out": "typedoc-docs", + "exclude": "**/node_modules/**", + "githubPages": true, + "out": "docs", }, } From afccbf353b4b17f935e114e97af28256a894af53 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 10 Nov 2023 11:15:09 -0500 Subject: [PATCH 17/97] feat: update tsconfig --- packages/accounts/tsconfig.json | 21 +++++++++++-- packages/biometric-ed25519/tsconfig.json | 21 +++++++++++-- packages/near-api-js/tsconfig.json | 4 +-- tsconfig.json.test => tsconfig.json | 40 +++++++----------------- 4 files changed, 51 insertions(+), 35 deletions(-) rename tsconfig.json.test => tsconfig.json (51%) diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 84765e3bd5..d6404094e7 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -12,8 +12,25 @@ "exclude": ["node_modules"], "excludeNotDocumented": true, "excludeNotDocumentedKinds": [ - "Module", - "Reference" + // "Module", + // "Namespace", + // "Enum", + // "EnumMember", // Not enabled by default + // "Variable", + // "Function", + // "Class", + // "Interface", + // "Constructor", + // "Property", + // "Method", + // "CallSignature", + // "IndexSignature", + // "ConstructorSignature", + // "Accessor", + // "GetSignature", + // "SetSignature", + // "TypeAlias", + // "Reference" ], "githubPages": false, }, diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 773a9e3a6f..e803eb2640 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -11,8 +11,25 @@ "exclude": ["node_modules"], "excludeNotDocumented": true, "excludeNotDocumentedKinds": [ - "Module", - "Reference" + // "Module", + // "Namespace", + // "Enum", + // "EnumMember", // Not enabled by default + // "Variable", + // "Function", + // "Class", + // "Interface", + // "Constructor", + // "Property", + // "Method", + // "CallSignature", + // "IndexSignature", + // "ConstructorSignature", + // "Accessor", + // "GetSignature", + // "SetSignature", + // "TypeAlias", + // "Reference" ], "githubPages": false, }, diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 2c4c1ce683..f013e5078e 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -40,9 +40,9 @@ // "Class", // "Interface", // "Constructor", - // "Property", + "Property", // "Method", - // "CallSignature", + // "CallSignature", // "IndexSignature", // "ConstructorSignature", // "Accessor", diff --git a/tsconfig.json.test b/tsconfig.json similarity index 51% rename from tsconfig.json.test rename to tsconfig.json index 2830cd1f9a..34db0ad4b0 100644 --- a/tsconfig.json.test +++ b/tsconfig.json @@ -1,5 +1,8 @@ { "compilerOptions": { + "outDir": "dist", + "allowJs": true, + "checkJs": true, "esModuleInterop": true, "module": "commonjs", "target": "es2015", @@ -22,7 +25,7 @@ "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, "entryPoints": [ - "packages/near-api-js", + //"packages/near-api-js", "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", @@ -36,34 +39,13 @@ "packages/transactions", "packages/types", "packages/utils", - "packages/wallet-account"], + "packages/wallet-account" + ], "entryPointStrategy": "packages", - // "plugin": [ - // "docusaurus-plugin-typedoc", "typedoc-plugin-markdown" - // ], - // "entryPoints": ["packages", "packages/near-api-js/index.ts", "packages/**"], // /near-api-js - // "entryPointStrategy": "packages", + "githubPages": false, "out": "typedoc-docs", - // "sidebar": { - // "categoryLabel": "API XYZ", - // "collapsed": false, - // "position": 0, - // "fullNames": true, - // } - // "exclude": ["**/node_modules/**"], - - // "useTsLinkResolution": false, - // "includes": ["packages/near-api-js", "packages/accounts", "packages/biometric-ed25519"], }, - "include": ["packages/**/*.ts"] -} - -// "typedocOptions": { -// "readme": "docs/README_TYPEDOC.md", -// "skipErrorChecking": true, -// "entryPoints": ["packages/near-api-js"], -// // "entryPoints": ["packages/accounts", "packages/biometric-ed25519", "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", "packages/keystores-browser", "packages/keystores-node", "packages/near-api-js"], -// "entryPointStrategy": "expand", -// "out": "docs", -// "exclude": "**/node_modules/**", -// }, \ No newline at end of file + "include": [ + "packages/**/*.ts" + ], +} \ No newline at end of file From d5b1873637765f1444645fea57dda9274e351d88 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 13 Nov 2023 00:40:20 -0500 Subject: [PATCH 18/97] feat: update tsconfig files for each package --- package.json | 3 ++- packages/accounts/tsconfig.json | 23 +---------------------- packages/biometric-ed25519/tsconfig.json | 22 ---------------------- packages/crypto/tsconfig.json | 8 ++++++++ packages/iframe-rpc/tsconfig.json | 8 ++++++++ packages/keystores-browser/tsconfig.json | 8 ++++++++ packages/keystores-node/tsconfig.json | 8 ++++++++ packages/keystores/tsconfig.json | 8 ++++++++ packages/providers/tsconfig.json | 8 ++++++++ packages/signers/tsconfig.json | 8 ++++++++ packages/transactions/tsconfig.json | 8 ++++++++ packages/types/tsconfig.json | 8 ++++++++ packages/utils/tsconfig.json | 8 ++++++++ packages/wallet-account/tsconfig.json | 8 ++++++++ tsconfig.json | 3 +++ tsconfig.node.json | 2 +- 16 files changed, 95 insertions(+), 46 deletions(-) diff --git a/package.json b/package.json index a43fac2ede..d85ae27237 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,8 @@ "autoclave": "rimraf packages/**/dist && rimraf packages/**/lib && rimraf packages/**/node_modules && rimraf packages/**/coverage && rimraf packages/**/.turbo && rm -rf node_modules", "test": "turbo run test", "release": "changeset publish", - "prepare": "husky install" + "prepare": "husky install", + "docs": "typedoc" }, "devDependencies": { "@changesets/changelog-github": "^0.4.6", diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index d6404094e7..2c281f2c35 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -5,33 +5,12 @@ "outDir": "./lib", }, "typedocOptions": { + "entryDocument": "index.html", "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "excludeNotDocumented": true, - "excludeNotDocumentedKinds": [ - // "Module", - // "Namespace", - // "Enum", - // "EnumMember", // Not enabled by default - // "Variable", - // "Function", - // "Class", - // "Interface", - // "Constructor", - // "Property", - // "Method", - // "CallSignature", - // "IndexSignature", - // "ConstructorSignature", - // "Accessor", - // "GetSignature", - // "SetSignature", - // "TypeAlias", - // "Reference" - ], "githubPages": false, }, "files": [ diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index e803eb2640..a568629535 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -9,28 +9,6 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "excludeNotDocumented": true, - "excludeNotDocumentedKinds": [ - // "Module", - // "Namespace", - // "Enum", - // "EnumMember", // Not enabled by default - // "Variable", - // "Function", - // "Class", - // "Interface", - // "Constructor", - // "Property", - // "Method", - // "CallSignature", - // "IndexSignature", - // "ConstructorSignature", - // "Accessor", - // "GetSignature", - // "SetSignature", - // "TypeAlias", - // "Reference" - ], "githubPages": false, }, "files": [ diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/crypto/tsconfig.json +++ b/packages/crypto/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/iframe-rpc/tsconfig.json b/packages/iframe-rpc/tsconfig.json index 24c6000844..0b024f7587 100644 --- a/packages/iframe-rpc/tsconfig.json +++ b/packages/iframe-rpc/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/keystores-browser/tsconfig.json b/packages/keystores-browser/tsconfig.json index 24c6000844..0b024f7587 100644 --- a/packages/keystores-browser/tsconfig.json +++ b/packages/keystores-browser/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/keystores-node/tsconfig.json b/packages/keystores-node/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/keystores-node/tsconfig.json +++ b/packages/keystores-node/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/keystores/tsconfig.json b/packages/keystores/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/keystores/tsconfig.json +++ b/packages/keystores/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/signers/tsconfig.json b/packages/signers/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/signers/tsconfig.json +++ b/packages/signers/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/transactions/tsconfig.json b/packages/transactions/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/transactions/tsconfig.json +++ b/packages/transactions/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json index ae42955e48..7b0b026bd4 100644 --- a/packages/utils/tsconfig.json +++ b/packages/utils/tsconfig.json @@ -3,6 +3,14 @@ "compilerOptions": { "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/packages/wallet-account/tsconfig.json b/packages/wallet-account/tsconfig.json index cd1fd28f0a..9111b9af87 100644 --- a/packages/wallet-account/tsconfig.json +++ b/packages/wallet-account/tsconfig.json @@ -4,6 +4,14 @@ "preserveSymlinks": false, "outDir": "./lib", }, + "typedocOptions": { + "skipErrorChecking": true, + "entryPoints": ["src"], + "entryPointStrategy": "expand", + "out": "docs", + "exclude": ["node_modules"], + "githubPages": false, + }, "files": [ "src/index.ts" ] diff --git a/tsconfig.json b/tsconfig.json index 34db0ad4b0..39650d70f9 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -22,8 +22,11 @@ "strictNullChecks": false // required for typedoc }, "typedocOptions": { + "name": "near-api-js", + "includeVersion": true, "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, + "disableGit": true, "entryPoints": [ //"packages/near-api-js", "packages/accounts", diff --git a/tsconfig.node.json b/tsconfig.node.json index b4f7644289..976778f200 100644 --- a/tsconfig.node.json +++ b/tsconfig.node.json @@ -5,5 +5,5 @@ "es2015", "esnext" ], - } + }, } From 0fd56f04fd9177827503722e9f69f43c26e9987e Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 13 Nov 2023 22:13:54 -0500 Subject: [PATCH 19/97] feat: add custom-theme --- docs/custom-theme.ts | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/custom-theme.ts diff --git a/docs/custom-theme.ts b/docs/custom-theme.ts new file mode 100644 index 0000000000..e69de29bb2 From 8f071de2f0bbd6d93349bfe7a37b0fd2e4a53d4d Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Mon, 13 Nov 2023 22:14:10 -0500 Subject: [PATCH 20/97] feat: add custom-theme --- docs/custom-theme.ts | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/custom-theme.ts b/docs/custom-theme.ts index e69de29bb2..2fca15f00d 100644 --- a/docs/custom-theme.ts +++ b/docs/custom-theme.ts @@ -0,0 +1,17 @@ +import * as typedoc from 'typedoc'; + +export default function (PluginHost: typedoc.PluginHost) { + const app = PluginHost.owner; + + app.renderer.on('beforeWriteDocument', (context: typedoc.Context) => { + // Modify the navigation structure to group by classes, interfaces, and functions + context.navigation.children = context.project.toObject().children + .filter((child: any) => child.kindString === 'Class' || child.kindString === 'Interface' || child.kindString === 'Function') + .map((child: any) => { + return { + title: child.name, + url: child.url, + }; + }); + }); +} \ No newline at end of file From 01af72c1f3db58057c414e330b579f5b054306fc Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 00:56:39 -0500 Subject: [PATCH 21/97] feat: testing configuration --- packages/accounts/tsconfig.json | 5 +++-- packages/biometric-ed25519/tsconfig.json | 4 +++- tsconfig.json | 28 ++++++++++++++---------- 3 files changed, 23 insertions(+), 14 deletions(-) diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 2c281f2c35..08ee7f08b7 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -5,13 +5,14 @@ "outDir": "./lib", }, "typedocOptions": { - "entryDocument": "index.html", "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + // "githubPages": false, + "emit": "both", + "basePath": "src/" }, "files": [ "src/index.ts" diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index a568629535..6de00ab119 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -9,7 +9,9 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + // "githubPages": false, + "emit": "both", + "basePath": "src/" }, "files": [ "src/index.ts", diff --git a/tsconfig.json b/tsconfig.json index 39650d70f9..08961088f6 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -32,21 +32,27 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" + // "packages/crypto", + // "packages/iframe-rpc", + // "packages/keystores", + // "packages/keystores-browser", + // "packages/keystores-node", + // "packages/providers", + // "packages/signers", + // "packages/transactions", + // "packages/types", + // "packages/utils", + // "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": false, "out": "typedoc-docs", + "emit": "both", + "navigation": { + "includeCategories": true, + "includeGroups": true + }, + "categorizeByGroup": true }, "include": [ "packages/**/*.ts" From 3c860c15d9f960cc997ea500e0e1c73b07291b10 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 02:00:17 -0500 Subject: [PATCH 22/97] feat: add externalSymbolLinkMappings --- package.json | 4 +- packages/accounts/tsconfig.json | 1 - packages/biometric-ed25519/tsconfig.json | 1 - pnpm-lock.yaml | 54 ------------------------ tsconfig.json | 10 ++--- typedoc.json | 7 +++ 6 files changed, 13 insertions(+), 64 deletions(-) create mode 100644 typedoc.json diff --git a/package.json b/package.json index d85ae27237..10e4b800b8 100644 --- a/package.json +++ b/package.json @@ -30,8 +30,6 @@ "rimraf": "^3.0.2", "turbo": "^1.4.5", "typescript": "^4.9.4", - "typedoc": "^0.25.3", - "typedoc-plugin-markdown":"^3.17.1", - "docusaurus-plugin-typedoc":"^0.21.0" + "typedoc": "^0.25.3" } } diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 08ee7f08b7..68616437c0 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -12,7 +12,6 @@ "exclude": ["node_modules"], // "githubPages": false, "emit": "both", - "basePath": "src/" }, "files": [ "src/index.ts" diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 6de00ab119..95d3b5f37e 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -11,7 +11,6 @@ "exclude": ["node_modules"], // "githubPages": false, "emit": "both", - "basePath": "src/" }, "files": [ "src/index.ts", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e8daf6f66f..1bf4de8e6d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -29,9 +29,6 @@ importers: commitlint: specifier: ^17.0.3 version: 17.0.3 - docusaurus-plugin-typedoc: - specifier: ^0.21.0 - version: 0.21.0(typedoc-plugin-markdown@3.17.1)(typedoc@0.25.3) eslint: specifier: ^8.20.0 version: 8.20.0 @@ -47,9 +44,6 @@ importers: typedoc: specifier: ^0.25.3 version: 0.25.3(typescript@4.9.4) - typedoc-plugin-markdown: - specifier: ^3.17.1 - version: 3.17.1(typedoc@0.25.3) typescript: specifier: ^4.9.4 version: 4.9.4 @@ -3636,16 +3630,6 @@ packages: esutils: 2.0.3 dev: true - /docusaurus-plugin-typedoc@0.21.0(typedoc-plugin-markdown@3.17.1)(typedoc@0.25.3): - resolution: {integrity: sha512-7DLFrf0JP+L5vSRQHVKIbndjbksd2MlxPqNmmdxzLFiRINgrY23s9waduWM9t24PUsf5JZ0tlGKlE3sK4uZ72Q==} - peerDependencies: - typedoc: '>=0.24.0' - typedoc-plugin-markdown: '>=3.15.0' - dependencies: - typedoc: 0.25.3(typescript@4.9.4) - typedoc-plugin-markdown: 3.17.1(typedoc@0.25.3) - dev: true - /domain-browser@1.2.0: resolution: {integrity: sha512-jnjyiM6eRyZl2H+W8Q/zLMA481hzi0eszAaBUzIVnmYVDBbnLxVNnfu1HgEBvCbL+71FrxMl3E6lpKH7Ge3OXA==} engines: {node: '>=0.4', npm: '>=1.2'} @@ -4557,19 +4541,6 @@ packages: pify: 4.0.1 dev: true - /handlebars@4.7.8: - resolution: {integrity: sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==} - engines: {node: '>=0.4.7'} - hasBin: true - dependencies: - minimist: 1.2.8 - neo-async: 2.6.2 - source-map: 0.6.1 - wordwrap: 1.0.0 - optionalDependencies: - uglify-js: 3.17.4 - dev: true - /hard-rejection@2.1.0: resolution: {integrity: sha512-VIZB+ibDhx7ObhAe7OVtoEbuP4h/MuOTHJ+J8h/eBXotJYl0fBgR72xDFCKgIh22OJZIOVNxBMWuhAr10r8HdA==} engines: {node: '>=6'} @@ -6398,10 +6369,6 @@ packages: resolution: {integrity: sha512-k7S8VFyESWgkKYDso99B4XbxAdo0VX9b3+GAaO5PvMgQjNr/6o09PHRywg/NkBQpf+ZYj7nNpJcyrNJGQsvA3w==} dev: true - /neo-async@2.6.2: - resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} - dev: true - /nice-try@1.0.5: resolution: {integrity: sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ==} dev: true @@ -8260,15 +8227,6 @@ packages: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} dev: true - /typedoc-plugin-markdown@3.17.1(typedoc@0.25.3): - resolution: {integrity: sha512-QzdU3fj0Kzw2XSdoL15ExLASt2WPqD7FbLeaqwT70+XjKyTshBnUlQA5nNREO1C2P8Uen0CDjsBLMsCQ+zd0lw==} - peerDependencies: - typedoc: '>=0.24.0' - dependencies: - handlebars: 4.7.8 - typedoc: 0.25.3(typescript@4.9.4) - dev: true - /typedoc@0.25.3(typescript@4.9.4): resolution: {integrity: sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==} engines: {node: '>= 16'} @@ -8293,14 +8251,6 @@ packages: resolution: {integrity: sha512-+J5D5ir763y+Am/QY6hXNRlwljIeRMZMGs0cT6qqZVVzzT3X3nFPXVyPOFRMOR4kupB0T8JnCdpWdp6Q/iXn3w==} dev: false - /uglify-js@3.17.4: - resolution: {integrity: sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==} - engines: {node: '>=0.8.0'} - hasBin: true - requiresBuild: true - dev: true - optional: true - /uglifyify@5.0.1: resolution: {integrity: sha512-PO44rgExvwj3rkK0UzenHVnPU18drBy9x9HOUmgkuRh6K2KIsDqrB5LqxGtjybgGTOS1JeP8SBc+TN5rhiva6w==} dependencies: @@ -8613,10 +8563,6 @@ packages: isexe: 2.0.0 dev: true - /wordwrap@1.0.0: - resolution: {integrity: sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==} - dev: true - /wrap-ansi@6.2.0: resolution: {integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==} engines: {node: '>=8'} diff --git a/tsconfig.json b/tsconfig.json index 08961088f6..23617d29d8 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -48,11 +48,11 @@ "githubPages": false, "out": "typedoc-docs", "emit": "both", - "navigation": { - "includeCategories": true, - "includeGroups": true - }, - "categorizeByGroup": true + // "navigation": { + // "includeCategories": true, + // "includeGroups": true + // }, + // "categorizeByGroup": true }, "include": [ "packages/**/*.ts" diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000000..a62a6a6a05 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,7 @@ +{ + "externalSymbolLinkMappings": { + "utils/key_pair": { + "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" + } + } +} \ No newline at end of file From 50e17066858400c37e5e0c89bc6160bbc5694e41 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 03:17:11 -0500 Subject: [PATCH 23/97] feat: add typedoc-theme --- package.json | 7 ++++--- packages/accounts/tsconfig.json | 1 - pnpm-lock.yaml | 12 ++++++++++++ tsconfig.json | 22 +++++++++++----------- typedoc.json | 10 ++++++++++ 5 files changed, 37 insertions(+), 15 deletions(-) create mode 100644 typedoc.json diff --git a/package.json b/package.json index d85ae27237..c29c9b0afe 100644 --- a/package.json +++ b/package.json @@ -22,16 +22,17 @@ "@changesets/cli": "^2.24.4", "@commitlint/cli": "^17.0.3", "@commitlint/config-conventional": "^17.0.3", + "@mxssfd/typedoc-theme": "^1.1.3", "@typescript-eslint/eslint-plugin": "^5.31.0", "@typescript-eslint/parser": "^5.31.0", "commitlint": "^17.0.3", + "docusaurus-plugin-typedoc": "^0.21.0", "eslint": "^8.20.0", "husky": "^7.0.4", "rimraf": "^3.0.2", "turbo": "^1.4.5", - "typescript": "^4.9.4", "typedoc": "^0.25.3", - "typedoc-plugin-markdown":"^3.17.1", - "docusaurus-plugin-typedoc":"^0.21.0" + "typedoc-plugin-markdown": "^3.17.1", + "typescript": "^4.9.4" } } diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 2c281f2c35..7bcb354ffb 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -5,7 +5,6 @@ "outDir": "./lib", }, "typedocOptions": { - "entryDocument": "index.html", "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e8daf6f66f..d6d1239c42 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -20,6 +20,9 @@ importers: '@commitlint/config-conventional': specifier: ^17.0.3 version: 17.0.3 + '@mxssfd/typedoc-theme': + specifier: ^1.1.3 + version: 1.1.3(typedoc@0.25.3) '@typescript-eslint/eslint-plugin': specifier: ^5.31.0 version: 5.31.0(@typescript-eslint/parser@5.31.0)(eslint@8.20.0)(typescript@4.9.4) @@ -1718,6 +1721,15 @@ packages: read-yaml-file: 1.1.0 dev: true + /@mxssfd/typedoc-theme@1.1.3(typedoc@0.25.3): + resolution: {integrity: sha512-/yP5rqhvibMpzXpmw0YLLRCpoj3uVWWlwyJseZXzGxTfiA6/fd1uubUqNoQAi2U19atMDonq8mQc+hlVctrX4g==} + engines: {node: '>= 14'} + peerDependencies: + typedoc: ^0.25.1 + dependencies: + typedoc: 0.25.3(typescript@4.9.4) + dev: true + /@nodelib/fs.scandir@2.1.5: resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==} engines: {node: '>= 8'} diff --git a/tsconfig.json b/tsconfig.json index 39650d70f9..a812547c2f 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -32,17 +32,17 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" + // "packages/crypto", + // "packages/iframe-rpc", + // "packages/keystores", + // "packages/keystores-browser", + // "packages/keystores-node", + // "packages/providers", + // "packages/signers", + // "packages/transactions", + // "packages/types", + // "packages/utils", + // "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": false, diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000000..ea08e8426f --- /dev/null +++ b/typedoc.json @@ -0,0 +1,10 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "plugin": ["@mxssfd/typedoc-theme"], + "theme": "my-theme", + "externalSymbolLinkMappings": { + "utils/key_pair": { + "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" + } + } +} \ No newline at end of file From 94290ab98a8a444d2f5dc770faef8159448bfcbf Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 05:09:03 -0500 Subject: [PATCH 24/97] feat: update readme files links --- docs/README_TYPEDOC.md | 8 ++++---- packages/accounts/README.md | 16 ++++++++-------- tsconfig.json | 30 +++++++++++------------------- 3 files changed, 23 insertions(+), 31 deletions(-) diff --git a/docs/README_TYPEDOC.md b/docs/README_TYPEDOC.md index a5de69b51d..4f3a5bd17c 100644 --- a/docs/README_TYPEDOC.md +++ b/docs/README_TYPEDOC.md @@ -23,9 +23,9 @@ NEAR JavaScript API is a complete library to interact with the NEAR blockchain. ### Managing Accounts -- Class [`Account`](classes/account.Account.html) -- Module [`walletAccount`](modules/walletAccount.html) -- Class [`Contract`](classes/contract.Contract.html) +- Class [`Account`](classes/_near_js_accounts.account.Account.html) +- Module [`walletAccount`](modules/_near_js_wallet_account.walletAccount.html) +- Class [`Contract`](classes/_near_js_accounts.contract.Contract.html) ### Managing Keys @@ -37,7 +37,7 @@ NEAR JavaScript API is a complete library to interact with the NEAR blockchain. ### RPC -- [Request and Response Types](modules/providers_provider.html) +- [Request and Response Types](modules/_near_js_types.provider.html) - [Client](classes/providers_json_rpc_provider.JsonRpcProvider.html) ### Utils diff --git a/packages/accounts/README.md b/packages/accounts/README.md index 45153e405b..535691282a 100644 --- a/packages/accounts/README.md +++ b/packages/accounts/README.md @@ -4,14 +4,14 @@ A collection of classes, functions, and types for interacting with accounts and ## Modules -- [Account](src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc. -- [AccountMultisig](src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions -- [Account2FA](src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper) -- [AccountCreator](src/account_creator.ts) classes for creating NEAR accounts -- [Contract](src/contract.ts) represents a deployed smart contract with view and/or change methods -- [Connection](src/connection.ts) a record containing the information required to connect to NEAR RPC -- [Constants](src/constants.ts) account-specific constants -- [Types](src/types.ts) account-specific types +- [Account](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc. +- [AccountMultisig](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions +- [Account2FA](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper) +- [AccountCreator](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_creator.ts) classes for creating NEAR accounts +- [Contract](https://github.com/near/near-api-js/blob/master/packages/accounts/src/contract.ts) represents a deployed smart contract with view and/or change methods +- [Connection](https://github.com/near/near-api-js/blob/master/packages/accounts/src/connection.ts) a record containing the information required to connect to NEAR RPC +- [Constants](https://github.com/near/near-api-js/blob/master/packages/accounts/src/constants.ts) account-specific constants +- [Types](https://github.com/near/near-api-js/blob/master/packages/accounts/src/types.ts) account-specific types # License diff --git a/tsconfig.json b/tsconfig.json index 23617d29d8..e12411faa3 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -32,29 +32,21 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - // "packages/crypto", - // "packages/iframe-rpc", - // "packages/keystores", - // "packages/keystores-browser", - // "packages/keystores-node", - // "packages/providers", - // "packages/signers", - // "packages/transactions", - // "packages/types", - // "packages/utils", - // "packages/wallet-account" + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": false, "out": "typedoc-docs", "emit": "both", - // "navigation": { - // "includeCategories": true, - // "includeGroups": true - // }, - // "categorizeByGroup": true }, - "include": [ - "packages/**/*.ts" - ], } \ No newline at end of file From 4452a21c31f324620b9c6274b0f7f41c9361eae5 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 09:26:46 -0500 Subject: [PATCH 25/97] feat: update typedoc options --- packages/accounts/typedoc.json | 10 ++++++++++ tsconfig.base.json | 15 +++++++++------ typedoc.json | 3 +++ 3 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 packages/accounts/typedoc.json diff --git a/packages/accounts/typedoc.json b/packages/accounts/typedoc.json new file mode 100644 index 0000000000..4f607be813 --- /dev/null +++ b/packages/accounts/typedoc.json @@ -0,0 +1,10 @@ +{ + "externalSymbolLinkMappings": { + "providers/json-rpc-provider": { + "JsonRpcProvider#sendTransaction": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" + }, + "utils/key_pair": { + "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" + } + } +} \ No newline at end of file diff --git a/tsconfig.base.json b/tsconfig.base.json index c9955a0fa1..aa8f37aad5 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -18,14 +18,16 @@ "resolveJsonModule": true, }, "typedocOptions": { + "name": "near-api-js", + "includeVersion": true, "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, - "entryPointStrategy": "packages", + "disableGit": true, "entryPoints": [ - "packages/near-api-js", + //"packages/near-api-js", "packages/accounts", "packages/biometric-ed25519", - "packages/cookbook", + // "packages/cookbook", "packages/crypto", "packages/iframe-rpc", "packages/keystores", @@ -38,8 +40,9 @@ "packages/utils", "packages/wallet-account" ], - "exclude": "**/node_modules/**", - "githubPages": true, - "out": "docs", + "entryPointStrategy": "packages", + "githubPages": false, + "out": "typedoc-docs", + "emit": "both", }, } diff --git a/typedoc.json b/typedoc.json index a62a6a6a05..4f607be813 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,8 @@ { "externalSymbolLinkMappings": { + "providers/json-rpc-provider": { + "JsonRpcProvider#sendTransaction": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" + }, "utils/key_pair": { "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" } From 58cc2cb7796c3213b267d10284c09c0cf88ff161 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 09:27:18 -0500 Subject: [PATCH 26/97] feat: update tsconfig --- tsconfig.json => tsconfig.json.local | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tsconfig.json => tsconfig.json.local (100%) diff --git a/tsconfig.json b/tsconfig.json.local similarity index 100% rename from tsconfig.json rename to tsconfig.json.local From 253d9d055ec5035fe51b8e32659a10c7e2da9414 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Tue, 14 Nov 2023 09:30:26 -0500 Subject: [PATCH 27/97] feat: update out folder --- tsconfig.base.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index aa8f37aad5..aeacac3c37 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -42,7 +42,7 @@ ], "entryPointStrategy": "packages", "githubPages": false, - "out": "typedoc-docs", + "out": "docs", "emit": "both", }, } From 80899a0b3c2e3fa59112760cd56c82ef20e6c3a7 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:25:19 -0500 Subject: [PATCH 28/97] feat: update typedoc-generator --- .github/workflows/typedoc-generator.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 0b44a0c8cd..675fa0ba34 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -11,6 +11,7 @@ env: ENTRY_FILE: 'packages' CONFIG_PATH: 'tsconfig.base.json' USES_PNPM: 'true' + DESTINATION_FOLDER: "docs" jobs: deploy: @@ -37,7 +38,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} branch: gh-pages - folder: docs + folder: ${{ env.DESTINATION_FOLDER }} clean: true # - name: Deploy # uses: peaceiris/actions-gh-pages@v3 From 79ff8059e32473bc592ff0a74b9239fb5cfca5b4 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:29:55 -0500 Subject: [PATCH 29/97] feat: add target-folder option to typedoc-generator action --- .github/workflows/typedoc-generator.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 675fa0ba34..cecc85fc65 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -40,6 +40,7 @@ jobs: branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} clean: true + target-folder: ${{ env.DESTINATION_FOLDER }} # - name: Deploy # uses: peaceiris/actions-gh-pages@v3 # with: From ffff8ee4024bf8e8151e6937d6cae17a38e8641d Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:46:09 -0500 Subject: [PATCH 30/97] feat: update typedoc docs generator to allow linking README files to packages files --- .github/workflows/typedoc-generator.yml | 10 ++++- packages/accounts/README.md | 4 +- tsconfig.json.local | 52 ------------------------- 3 files changed, 11 insertions(+), 55 deletions(-) delete mode 100644 tsconfig.json.local diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index cecc85fc65..757edb4773 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -11,7 +11,7 @@ env: ENTRY_FILE: 'packages' CONFIG_PATH: 'tsconfig.base.json' USES_PNPM: 'true' - DESTINATION_FOLDER: "docs" + DESTINATION_FOLDER: "typedoc-docs" jobs: deploy: @@ -33,6 +33,14 @@ jobs: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} + - name: Update gh-pages Branch + run: | + git checkout main + git fetch origin + git checkout gh-pages + git pull + git merge origin/main + git push origin gh-pages - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 with: diff --git a/packages/accounts/README.md b/packages/accounts/README.md index 535691282a..06385ccea5 100644 --- a/packages/accounts/README.md +++ b/packages/accounts/README.md @@ -4,8 +4,8 @@ A collection of classes, functions, and types for interacting with accounts and ## Modules -- [Account](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc. -- [AccountMultisig](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions +- [Account](/packages/accounts/src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc. +- [AccountMultisig](/packages/accounts/src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions - [Account2FA](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper) - [AccountCreator](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_creator.ts) classes for creating NEAR accounts - [Contract](https://github.com/near/near-api-js/blob/master/packages/accounts/src/contract.ts) represents a deployed smart contract with view and/or change methods diff --git a/tsconfig.json.local b/tsconfig.json.local deleted file mode 100644 index e12411faa3..0000000000 --- a/tsconfig.json.local +++ /dev/null @@ -1,52 +0,0 @@ -{ - "compilerOptions": { - "outDir": "dist", - "allowJs": true, - "checkJs": true, - "esModuleInterop": true, - "module": "commonjs", - "target": "es2015", - "moduleResolution": "node", - "alwaysStrict": true, - "declaration": true, - "preserveSymlinks": true, - "preserveWatchOutput": true, - "pretty": false, - "forceConsistentCasingInFileNames": true, - "noFallthroughCasesInSwitch": true, - "noImplicitAny": false, - "noImplicitReturns": true, - "noUnusedLocals": true, - "experimentalDecorators": true, - "resolveJsonModule": true, - "strictNullChecks": false // required for typedoc - }, - "typedocOptions": { - "name": "near-api-js", - "includeVersion": true, - "readme": "docs/README_TYPEDOC.md", - "skipErrorChecking": true, - "disableGit": true, - "entryPoints": [ - //"packages/near-api-js", - "packages/accounts", - "packages/biometric-ed25519", - // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" - ], - "entryPointStrategy": "packages", - "githubPages": false, - "out": "typedoc-docs", - "emit": "both", - }, -} \ No newline at end of file From f566ae0ac0b8a31e2d9adac7bdcb44a31906944a Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:48:13 -0500 Subject: [PATCH 31/97] feat: minor changes --- .github/workflows/typedoc-generator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 757edb4773..630c5dbf3c 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -35,11 +35,11 @@ jobs: pnpm: ${{ env.USES_PNPM }} - name: Update gh-pages Branch run: | - git checkout main + git checkout master git fetch origin git checkout gh-pages git pull - git merge origin/main + git merge origin/master git push origin gh-pages - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 From ef255224e644c0109369668e3413eb2b7f8ae4c9 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 12:56:43 -0500 Subject: [PATCH 32/97] feat: update typedoc action --- .github/workflows/typedoc-generator.yml | 2 +- tsconfig.json | 52 +++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 tsconfig.json diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 630c5dbf3c..3ff6d38dd2 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -35,7 +35,7 @@ jobs: pnpm: ${{ env.USES_PNPM }} - name: Update gh-pages Branch run: | - git checkout master + git checkout origin/master git fetch origin git checkout gh-pages git pull diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000000..3d1d1b3815 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,52 @@ +{ + "compilerOptions": { + "outDir": "dist", + "allowJs": true, + "checkJs": true, + "esModuleInterop": true, + "module": "commonjs", + "target": "es2015", + "moduleResolution": "node", + "alwaysStrict": true, + "declaration": true, + "preserveSymlinks": true, + "preserveWatchOutput": true, + "pretty": false, + "forceConsistentCasingInFileNames": true, + "noFallthroughCasesInSwitch": true, + "noImplicitAny": false, + "noImplicitReturns": true, + "noUnusedLocals": true, + "experimentalDecorators": true, + "resolveJsonModule": true, + "strictNullChecks": false // required for typedoc + }, + "typedocOptions": { + "name": "near-api-js", + "includeVersion": true, + "readme": "docs/README_TYPEDOC.md", + "skipErrorChecking": true, + "disableGit": true, + "entryPoints": [ + //"packages/near-api-js", + "packages/accounts", + "packages/biometric-ed25519", + // "packages/cookbook", + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account" + ], + "entryPointStrategy": "packages", + "githubPages": false, + "out": "typedoc-docs", + "emit": "both" + }, +} \ No newline at end of file From 90c6df77d53f5419cb0d41f317e989ddc085d9f2 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:00:42 -0500 Subject: [PATCH 33/97] feat: elete tsconfig.json --- tsconfig.json | 52 --------------------------------------------------- 1 file changed, 52 deletions(-) delete mode 100644 tsconfig.json diff --git a/tsconfig.json b/tsconfig.json deleted file mode 100644 index 3d1d1b3815..0000000000 --- a/tsconfig.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "compilerOptions": { - "outDir": "dist", - "allowJs": true, - "checkJs": true, - "esModuleInterop": true, - "module": "commonjs", - "target": "es2015", - "moduleResolution": "node", - "alwaysStrict": true, - "declaration": true, - "preserveSymlinks": true, - "preserveWatchOutput": true, - "pretty": false, - "forceConsistentCasingInFileNames": true, - "noFallthroughCasesInSwitch": true, - "noImplicitAny": false, - "noImplicitReturns": true, - "noUnusedLocals": true, - "experimentalDecorators": true, - "resolveJsonModule": true, - "strictNullChecks": false // required for typedoc - }, - "typedocOptions": { - "name": "near-api-js", - "includeVersion": true, - "readme": "docs/README_TYPEDOC.md", - "skipErrorChecking": true, - "disableGit": true, - "entryPoints": [ - //"packages/near-api-js", - "packages/accounts", - "packages/biometric-ed25519", - // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" - ], - "entryPointStrategy": "packages", - "githubPages": false, - "out": "typedoc-docs", - "emit": "both" - }, -} \ No newline at end of file From 04bb156c212042972c1be26238528fe06d37ce84 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:08:51 -0500 Subject: [PATCH 34/97] feat: make changes to the step Update gh-pages Branch --- .github/workflows/typedoc-generator.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 3ff6d38dd2..4559813e23 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -35,9 +35,8 @@ jobs: pnpm: ${{ env.USES_PNPM }} - name: Update gh-pages Branch run: | - git checkout origin/master git fetch origin - git checkout gh-pages + git checkout -B gh-pages origin/gh-pages git pull git merge origin/master git push origin gh-pages From 6f5ce9495430b158156ad06b96da3e7d34f8a58d Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:13:48 -0500 Subject: [PATCH 35/97] feat: update typedoc-generator steps --- .github/workflows/typedoc-generator.yml | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 4559813e23..dbfba2d7e9 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -33,13 +33,19 @@ jobs: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} - - name: Update gh-pages Branch + + - name: Fetch master changes + run: git fetch origin master:master + - name: Create or update gh-pages branch + run: | + git fetch origin gh-pages:gh-pages || git checkout -B gh-pages origin/gh-pages + + - name: Update gh-pages branch run: | - git fetch origin - git checkout -B gh-pages origin/gh-pages - git pull - git merge origin/master + git checkout gh-pages + git pull origin master git push origin gh-pages + - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 with: From 583ff30ffc955080f894b338e150c74045950d70 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:17:17 -0500 Subject: [PATCH 36/97] feat: update action --- .github/workflows/typedoc-generator.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index dbfba2d7e9..1bfc5e9e1d 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -36,10 +36,6 @@ jobs: - name: Fetch master changes run: git fetch origin master:master - - name: Create or update gh-pages branch - run: | - git fetch origin gh-pages:gh-pages || git checkout -B gh-pages origin/gh-pages - - name: Update gh-pages branch run: | git checkout gh-pages From 92020fa2699a782d006eac95773cf669522ef62b Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:24:45 -0500 Subject: [PATCH 37/97] feat: add user/email --- .github/workflows/typedoc-generator.yml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 1bfc5e9e1d..cac9fa30f0 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -33,7 +33,12 @@ jobs: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} - + + - name: Setup Git User + run: | + git config user.name "GitHub Action" + git config user.email "fcoew.sw@gmail.com" + - name: Fetch master changes run: git fetch origin master:master - name: Update gh-pages branch From 8bacdba0502b8518c1ee75f5386cecde1fda1d4c Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:26:30 -0500 Subject: [PATCH 38/97] feat: add tsconfig.json.local --- tsconfig.json.local | 52 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 tsconfig.json.local diff --git a/tsconfig.json.local b/tsconfig.json.local new file mode 100644 index 0000000000..3d1d1b3815 --- /dev/null +++ b/tsconfig.json.local @@ -0,0 +1,52 @@ +{ + "compilerOptions": { + "outDir": "dist", + "allowJs": true, + "checkJs": true, + "esModuleInterop": true, + "module": "commonjs", + "target": "es2015", + "moduleResolution": "node", + "alwaysStrict": true, + "declaration": true, + "preserveSymlinks": true, + "preserveWatchOutput": true, + "pretty": false, + "forceConsistentCasingInFileNames": true, + "noFallthroughCasesInSwitch": true, + "noImplicitAny": false, + "noImplicitReturns": true, + "noUnusedLocals": true, + "experimentalDecorators": true, + "resolveJsonModule": true, + "strictNullChecks": false // required for typedoc + }, + "typedocOptions": { + "name": "near-api-js", + "includeVersion": true, + "readme": "docs/README_TYPEDOC.md", + "skipErrorChecking": true, + "disableGit": true, + "entryPoints": [ + //"packages/near-api-js", + "packages/accounts", + "packages/biometric-ed25519", + // "packages/cookbook", + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account" + ], + "entryPointStrategy": "packages", + "githubPages": false, + "out": "typedoc-docs", + "emit": "both" + }, +} \ No newline at end of file From 8b5a619233b8f284dc521a9e255207543808417d Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 13:27:38 -0500 Subject: [PATCH 39/97] feat: add write permissions --- .github/workflows/typedoc-generator.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index cac9fa30f0..7fbd2a91c1 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -13,6 +13,9 @@ env: USES_PNPM: 'true' DESTINATION_FOLDER: "typedoc-docs" +permissions: + contents: write + jobs: deploy: runs-on: ubuntu-latest From 135891d7604108a9f2b130f625f14a4c6aa9d8bb Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:09:31 -0500 Subject: [PATCH 40/97] feat: github action small change --- .github/workflows/typedoc-generator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 7fbd2a91c1..57660742b9 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -46,10 +46,10 @@ jobs: run: git fetch origin master:master - name: Update gh-pages branch run: | + git branch gh-pages git checkout gh-pages git pull origin master git push origin gh-pages - - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 with: From 668ba69857019491c9c4d3d68cc0a48e304318ac Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:16:14 -0500 Subject: [PATCH 41/97] feat: fix divergent changes on action --- .github/workflows/typedoc-generator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 57660742b9..0168088b3e 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -48,7 +48,7 @@ jobs: run: | git branch gh-pages git checkout gh-pages - git pull origin master + git git pull --rebase origin master git push origin gh-pages - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 From 45d0a18cb7bfc1b5465ca69d644041bfaa09a87a Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:17:34 -0500 Subject: [PATCH 42/97] feat: small changes --- .github/workflows/typedoc-generator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 0168088b3e..5355e1a833 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -48,7 +48,7 @@ jobs: run: | git branch gh-pages git checkout gh-pages - git git pull --rebase origin master + git pull --rebase origin master git push origin gh-pages - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 From 0a5ab1c3fd4099daeb00beee0bef3d95dbf6edc9 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:35:48 -0500 Subject: [PATCH 43/97] feat: add action that syncs branches --- .github/workflows/typedoc-generator.yml | 33 +++++++++++++++---------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 5355e1a833..6d61c7b87b 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -36,20 +36,27 @@ jobs: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} - - - name: Setup Git User - run: | - git config user.name "GitHub Action" - git config user.email "fcoew.sw@gmail.com" + - name: Sync branch + id: pull + uses: tretuna/sync-branches@1.2.0 + with: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + FROM_BRANCH: 'typedoc-configuration' + TO_BRANCH: 'gh-pages' + + # - name: Setup Git User + # run: | + # git config user.name "GitHub Action" + # git config user.email "fcoew.sw@gmail.com" - - name: Fetch master changes - run: git fetch origin master:master - - name: Update gh-pages branch - run: | - git branch gh-pages - git checkout gh-pages - git pull --rebase origin master - git push origin gh-pages + # - name: Fetch master changes + # run: git fetch origin master:master + # - name: Update gh-pages branch + # run: | + # git branch gh-pages + # git checkout gh-pages + # git pull --rebase origin master + # git push origin gh-pages - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 with: From 2f5dec02d83f1556b46b7a6f2e2ee68293594766 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 15:46:19 -0500 Subject: [PATCH 44/97] feat: fix permission issues --- .github/workflows/typedoc-generator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 6d61c7b87b..b3b254485c 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -13,8 +13,8 @@ env: USES_PNPM: 'true' DESTINATION_FOLDER: "typedoc-docs" -permissions: - contents: write +# permissions: +# contents: write jobs: deploy: From 7b5e4a7e6f027421478a81072bae8a695ad45f71 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:00:40 -0500 Subject: [PATCH 45/97] feat: created generated-documentation folder --- .github/workflows/typedoc-generator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index b3b254485c..be8e5b3140 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -11,7 +11,7 @@ env: ENTRY_FILE: 'packages' CONFIG_PATH: 'tsconfig.base.json' USES_PNPM: 'true' - DESTINATION_FOLDER: "typedoc-docs" + DESTINATION_FOLDER: "docs/generated-documentation" # permissions: # contents: write From ab95ff998ffefa66ad97268ea86cc37c85c7307b Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:01:15 -0500 Subject: [PATCH 46/97] feat: add folder --- docs/generated-documentation/index.html | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/generated-documentation/index.html diff --git a/docs/generated-documentation/index.html b/docs/generated-documentation/index.html new file mode 100644 index 0000000000..e69de29bb2 From 3957a0442831829110836d8d93f4ae82c22c25ba Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:08:56 -0500 Subject: [PATCH 47/97] feat: clean code --- .github/workflows/typedoc-generator.yml | 27 +++++++------------------ 1 file changed, 7 insertions(+), 20 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index be8e5b3140..08999a0f7c 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -21,21 +21,26 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 + - uses: actions/setup-node@v3 with: node-version: ${{ env.NODE_VERSION }} + - name: Setup pnpm uses: pnpm/action-setup@v2.2.2 with: version: 7 + - name: Install dependencies run: pnpm install + - name: Build documentation uses: few-sw/typedoc-action@add-pnpm-support with: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} + - name: Sync branch id: pull uses: tretuna/sync-branches@1.2.0 @@ -43,20 +48,7 @@ jobs: GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} FROM_BRANCH: 'typedoc-configuration' TO_BRANCH: 'gh-pages' - - # - name: Setup Git User - # run: | - # git config user.name "GitHub Action" - # git config user.email "fcoew.sw@gmail.com" - - # - name: Fetch master changes - # run: git fetch origin master:master - # - name: Update gh-pages branch - # run: | - # git branch gh-pages - # git checkout gh-pages - # git pull --rebase origin master - # git push origin gh-pages + - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 with: @@ -64,9 +56,4 @@ jobs: branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} clean: true - target-folder: ${{ env.DESTINATION_FOLDER }} - # - name: Deploy - # uses: peaceiris/actions-gh-pages@v3 - # with: - # github_token: ${{ secrets.GITHUB_TOKEN }} - # publish_dir: ./docs \ No newline at end of file + target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file From 0317f9252ddda94e8846546ad115cba99eec94dc Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:13:08 -0500 Subject: [PATCH 48/97] feat: change action configuration --- .github/workflows/typedoc-generator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 08999a0f7c..867d94b246 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -21,7 +21,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - + - uses: actions/setup-node@v3 with: node-version: ${{ env.NODE_VERSION }} @@ -56,4 +56,4 @@ jobs: branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} clean: true - target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file + # target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file From 896e11fb1db803170459cce7afa2bddb745d6609 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:18:19 -0500 Subject: [PATCH 49/97] feat: change out folder to build --- .github/workflows/typedoc-generator.yml | 2 +- packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- tsconfig.base.json | 24 ++++++++++++------------ 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 867d94b246..7d8be6814c 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -11,7 +11,7 @@ env: ENTRY_FILE: 'packages' CONFIG_PATH: 'tsconfig.base.json' USES_PNPM: 'true' - DESTINATION_FOLDER: "docs/generated-documentation" + DESTINATION_FOLDER: "build" # permissions: # contents: write diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 68616437c0..6dac53e584 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -8,7 +8,7 @@ "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", - "out": "docs", + "out": "build", "exclude": ["node_modules"], // "githubPages": false, "emit": "both", diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 95d3b5f37e..7572e634df 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -7,7 +7,7 @@ "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", - "out": "docs", + "out": "build", "exclude": ["node_modules"], // "githubPages": false, "emit": "both", diff --git a/tsconfig.base.json b/tsconfig.base.json index aeacac3c37..2df8dfc51c 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -28,21 +28,21 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" + // "packages/crypto", + // "packages/iframe-rpc", + // "packages/keystores", + // "packages/keystores-browser", + // "packages/keystores-node", + // "packages/providers", + // "packages/signers", + // "packages/transactions", + // "packages/types", + // "packages/utils", + // "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": false, - "out": "docs", + "out": "build", "emit": "both", }, } From a13666de59f5781b082af4a2704ca4f358d6cdff Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 16:20:18 -0500 Subject: [PATCH 50/97] feat: enable target-folder --- .github/workflows/typedoc-generator.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 7d8be6814c..34bea58c60 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -56,4 +56,4 @@ jobs: branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} clean: true - # target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file + target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file From 6549c26944cf96ef6a62c740195b6c8d4b475bb9 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 20:31:22 -0500 Subject: [PATCH 51/97] feat: update build destination folder --- .github/workflows/typedoc-generator.yml | 6 +++++- docs/generated-documentation/index.html | 0 packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- tsconfig.base.json | 2 +- 5 files changed, 8 insertions(+), 4 deletions(-) delete mode 100644 docs/generated-documentation/index.html diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 34bea58c60..70796eeddf 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -11,7 +11,7 @@ env: ENTRY_FILE: 'packages' CONFIG_PATH: 'tsconfig.base.json' USES_PNPM: 'true' - DESTINATION_FOLDER: "build" + DESTINATION_FOLDER: "docs" # permissions: # contents: write @@ -56,4 +56,8 @@ jobs: branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} clean: true + clean-exclude: | + docs/package-architecture.png + docs/README_TYPEDOC.md + docs/README.md target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file diff --git a/docs/generated-documentation/index.html b/docs/generated-documentation/index.html deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 6dac53e584..68616437c0 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -8,7 +8,7 @@ "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", - "out": "build", + "out": "docs", "exclude": ["node_modules"], // "githubPages": false, "emit": "both", diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 7572e634df..95d3b5f37e 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -7,7 +7,7 @@ "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", - "out": "build", + "out": "docs", "exclude": ["node_modules"], // "githubPages": false, "emit": "both", diff --git a/tsconfig.base.json b/tsconfig.base.json index 2df8dfc51c..59a8fcab97 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -42,7 +42,7 @@ ], "entryPointStrategy": "packages", "githubPages": false, - "out": "build", + "out": "docs", "emit": "both", }, } From 83869d54396a59300ecb5f06b06a4a151b47ed16 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 20:38:42 -0500 Subject: [PATCH 52/97] feat: change action logic --- .github/workflows/typedoc-generator.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 70796eeddf..b10ceb4f47 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -55,9 +55,9 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} + target-folder: ${{ env.DESTINATION_FOLDER }} clean: true clean-exclude: | docs/package-architecture.png docs/README_TYPEDOC.md - docs/README.md - target-folder: ${{ env.DESTINATION_FOLDER }} \ No newline at end of file + docs/README.md \ No newline at end of file From cdbbf38ff7fccca4d43ac80ee1212f41e6557d59 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 20:52:21 -0500 Subject: [PATCH 53/97] feat: update action --- .github/workflows/typedoc-generator.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index b10ceb4f47..eb6554f61a 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -21,7 +21,8 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - + with: + lfs: true - uses: actions/setup-node@v3 with: node-version: ${{ env.NODE_VERSION }} From 5d88e75992ad296a76e9b79cb6aa1b4acbfa4564 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 20:57:21 -0500 Subject: [PATCH 54/97] feat: disable pull-request action --- .github/workflows/{pull-request.yml => pull-request.yml.disabled} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{pull-request.yml => pull-request.yml.disabled} (100%) diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml.disabled similarity index 100% rename from .github/workflows/pull-request.yml rename to .github/workflows/pull-request.yml.disabled From 7f567ae19cae419a1aa87c36f35a26b7ca70a9eb Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 20:59:26 -0500 Subject: [PATCH 55/97] feat: clean docs folder --- {docs => docsold}/README.md | 0 {docs => docsold}/README_TYPEDOC.md | 0 {docs => docsold}/package-architecture.png | Bin tsconfig.base.json | 2 +- 4 files changed, 1 insertion(+), 1 deletion(-) rename {docs => docsold}/README.md (100%) rename {docs => docsold}/README_TYPEDOC.md (100%) rename {docs => docsold}/package-architecture.png (100%) diff --git a/docs/README.md b/docsold/README.md similarity index 100% rename from docs/README.md rename to docsold/README.md diff --git a/docs/README_TYPEDOC.md b/docsold/README_TYPEDOC.md similarity index 100% rename from docs/README_TYPEDOC.md rename to docsold/README_TYPEDOC.md diff --git a/docs/package-architecture.png b/docsold/package-architecture.png similarity index 100% rename from docs/package-architecture.png rename to docsold/package-architecture.png diff --git a/tsconfig.base.json b/tsconfig.base.json index 59a8fcab97..ef383b08ae 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,7 +20,7 @@ "typedocOptions": { "name": "near-api-js", "includeVersion": true, - "readme": "docs/README_TYPEDOC.md", + // "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, "disableGit": true, "entryPoints": [ From 020df34d01aa7f6acc2bab6e8236e8374329ae97 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:02:42 -0500 Subject: [PATCH 56/97] feat: remove lfs: true --- .github/workflows/typedoc-generator.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index eb6554f61a..b10ceb4f47 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -21,8 +21,7 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - with: - lfs: true + - uses: actions/setup-node@v3 with: node-version: ${{ env.NODE_VERSION }} From 178fb80774a906be9ab1f14b7ad219ba3349a4c9 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:04:13 -0500 Subject: [PATCH 57/97] feat: update action --- .github/workflows/typedoc-generator.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index b10ceb4f47..f5e8945cc2 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -41,13 +41,13 @@ jobs: config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} - - name: Sync branch - id: pull - uses: tretuna/sync-branches@1.2.0 - with: - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - FROM_BRANCH: 'typedoc-configuration' - TO_BRANCH: 'gh-pages' + # - name: Sync branch + # id: pull + # uses: tretuna/sync-branches@1.2.0 + # with: + # GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + # FROM_BRANCH: 'typedoc-configuration' + # TO_BRANCH: 'gh-pages' - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 From e292c8979ef697ca6e8c2e54c3d32833fc4d0a6f Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:16:56 -0500 Subject: [PATCH 58/97] feat: add concurrency handler --- .github/workflows/typedoc-generator.yml | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index f5e8945cc2..0c7d6e6714 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -18,6 +18,7 @@ env: jobs: deploy: + concurrency: ci-${{ github.ref }} runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -41,13 +42,13 @@ jobs: config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} - # - name: Sync branch - # id: pull - # uses: tretuna/sync-branches@1.2.0 - # with: - # GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - # FROM_BRANCH: 'typedoc-configuration' - # TO_BRANCH: 'gh-pages' + - name: Sync branch + id: pull + uses: tretuna/sync-branches@1.2.0 + with: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + FROM_BRANCH: 'typedoc-configuration' + TO_BRANCH: 'gh-pages' - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 From e38c0de58149afa955490622a55bdce2e7954618 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:25:58 -0500 Subject: [PATCH 59/97] feat: remove clean option --- .github/workflows/typedoc-generator.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index 0c7d6e6714..a54834f532 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -57,8 +57,8 @@ jobs: branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} target-folder: ${{ env.DESTINATION_FOLDER }} - clean: true - clean-exclude: | - docs/package-architecture.png - docs/README_TYPEDOC.md - docs/README.md \ No newline at end of file + # clean: true + # clean-exclude: | + # docs/package-architecture.png + # docs/README_TYPEDOC.md + # docs/README.md \ No newline at end of file From 64da29e4e44c680675c4e75ccd2e6b7abe4c9d94 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:28:28 -0500 Subject: [PATCH 60/97] feat: revert to gh-pages root --- .github/workflows/typedoc-generator.yml | 18 +++++++++--------- {docsold => docs}/README.md | 0 {docsold => docs}/README_TYPEDOC.md | 0 {docsold => docs}/package-architecture.png | Bin tsconfig.base.json | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) rename {docsold => docs}/README.md (100%) rename {docsold => docs}/README_TYPEDOC.md (100%) rename {docsold => docs}/package-architecture.png (100%) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index a54834f532..d66c7aaedd 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -42,13 +42,13 @@ jobs: config: ${{ env.CONFIG_PATH }} pnpm: ${{ env.USES_PNPM }} - - name: Sync branch - id: pull - uses: tretuna/sync-branches@1.2.0 - with: - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - FROM_BRANCH: 'typedoc-configuration' - TO_BRANCH: 'gh-pages' + # - name: Sync branch + # id: pull + # uses: tretuna/sync-branches@1.2.0 + # with: + # GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + # FROM_BRANCH: 'typedoc-configuration' + # TO_BRANCH: 'gh-pages' - name: Deploy to GitHub pages uses: JamesIves/github-pages-deploy-action@v4 @@ -56,8 +56,8 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} branch: gh-pages folder: ${{ env.DESTINATION_FOLDER }} - target-folder: ${{ env.DESTINATION_FOLDER }} - # clean: true + clean: true + # target-folder: ${{ env.DESTINATION_FOLDER }} # clean-exclude: | # docs/package-architecture.png # docs/README_TYPEDOC.md diff --git a/docsold/README.md b/docs/README.md similarity index 100% rename from docsold/README.md rename to docs/README.md diff --git a/docsold/README_TYPEDOC.md b/docs/README_TYPEDOC.md similarity index 100% rename from docsold/README_TYPEDOC.md rename to docs/README_TYPEDOC.md diff --git a/docsold/package-architecture.png b/docs/package-architecture.png similarity index 100% rename from docsold/package-architecture.png rename to docs/package-architecture.png diff --git a/tsconfig.base.json b/tsconfig.base.json index ef383b08ae..59a8fcab97 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -20,7 +20,7 @@ "typedocOptions": { "name": "near-api-js", "includeVersion": true, - // "readme": "docs/README_TYPEDOC.md", + "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, "disableGit": true, "entryPoints": [ From 85fba908da630dea1d0a6528dfc87c47206005fc Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:32:57 -0500 Subject: [PATCH 61/97] feat: enable pull-request.action --- .github/workflows/{pull-request.yml.disabled => pull-request.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{pull-request.yml.disabled => pull-request.yml} (100%) diff --git a/.github/workflows/pull-request.yml.disabled b/.github/workflows/pull-request.yml similarity index 100% rename from .github/workflows/pull-request.yml.disabled rename to .github/workflows/pull-request.yml From 2a1c272af7a4870ed22c449995fc95eb18abed49 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 21:34:48 -0500 Subject: [PATCH 62/97] feat: add near-api-js package to docs job --- packages/accounts/README.md | 4 ++-- packages/near-api-js/tsconfig.json | 4 ++-- tsconfig.base.json | 24 ++++++++++++------------ 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/packages/accounts/README.md b/packages/accounts/README.md index 06385ccea5..535691282a 100644 --- a/packages/accounts/README.md +++ b/packages/accounts/README.md @@ -4,8 +4,8 @@ A collection of classes, functions, and types for interacting with accounts and ## Modules -- [Account](/packages/accounts/src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc. -- [AccountMultisig](/packages/accounts/src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions +- [Account](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc. +- [AccountMultisig](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions - [Account2FA](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper) - [AccountCreator](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account_creator.ts) classes for creating NEAR accounts - [Contract](https://github.com/near/near-api-js/blob/master/packages/accounts/src/contract.ts) represents a deployed smart contract with view and/or change methods diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index f013e5078e..386cf5400b 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -40,7 +40,7 @@ // "Class", // "Interface", // "Constructor", - "Property", + // "Property", // "Method", // "CallSignature", // "IndexSignature", @@ -49,7 +49,7 @@ // "GetSignature", // "SetSignature", // "TypeAlias", - "Reference" + // "Reference" ], "githubPages": false, }, diff --git a/tsconfig.base.json b/tsconfig.base.json index 59a8fcab97..ad7a4e8dc9 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -24,21 +24,21 @@ "skipErrorChecking": true, "disableGit": true, "entryPoints": [ - //"packages/near-api-js", + "packages/near-api-js", "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - // "packages/crypto", - // "packages/iframe-rpc", - // "packages/keystores", - // "packages/keystores-browser", - // "packages/keystores-node", - // "packages/providers", - // "packages/signers", - // "packages/transactions", - // "packages/types", - // "packages/utils", - // "packages/wallet-account" + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": false, From 9327416c826c463e652ffb198b1505d0a4cf14f4 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 22:10:47 -0500 Subject: [PATCH 63/97] feat: disable jekyll --- docs/README_TYPEDOC.md | 2 +- packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- packages/cookbook/tsconfig.json | 2 +- packages/crypto/tsconfig.json | 2 +- packages/iframe-rpc/tsconfig.json | 2 +- packages/keystores-browser/tsconfig.json | 2 +- packages/keystores-node/tsconfig.json | 2 +- packages/keystores/tsconfig.json | 2 +- packages/near-api-js/tsconfig.json | 5 ++- packages/providers/tsconfig.json | 2 +- packages/signers/tsconfig.json | 2 +- packages/transactions/tsconfig.json | 2 +- packages/types/tsconfig.json | 2 +- packages/utils/tsconfig.json | 2 +- packages/wallet-account/tsconfig.json | 2 +- tsconfig.base.json | 6 +-- tsconfig.json.local | 52 ------------------------ 18 files changed, 21 insertions(+), 72 deletions(-) delete mode 100644 tsconfig.json.local diff --git a/docs/README_TYPEDOC.md b/docs/README_TYPEDOC.md index 4f3a5bd17c..c3c2b65adf 100644 --- a/docs/README_TYPEDOC.md +++ b/docs/README_TYPEDOC.md @@ -18,7 +18,7 @@ NEAR JavaScript API is a complete library to interact with the NEAR blockchain. ### Connect to NEAR -- [From the browser](modules/browserConnect.html) +- [From the browser](modules/_near_api_js.browserConnect.html) - [From Node.js](modules/connect.html) ### Managing Accounts diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 68616437c0..c991bc81e9 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - // "githubPages": false, + // "githubPages": true, "emit": "both", }, "files": [ diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 95d3b5f37e..c963ba1dd6 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - // "githubPages": false, + // "githubPages": true, "emit": "both", }, "files": [ diff --git a/packages/cookbook/tsconfig.json b/packages/cookbook/tsconfig.json index 971158931c..8f40ad15ee 100644 --- a/packages/cookbook/tsconfig.json +++ b/packages/cookbook/tsconfig.json @@ -22,7 +22,7 @@ "Module", "Reference" ], - "githubPages": false, + "githubPages": true, }, "include": [ "**/*.js", diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/crypto/tsconfig.json +++ b/packages/crypto/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/iframe-rpc/tsconfig.json b/packages/iframe-rpc/tsconfig.json index 0b024f7587..50ea97c692 100644 --- a/packages/iframe-rpc/tsconfig.json +++ b/packages/iframe-rpc/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/keystores-browser/tsconfig.json b/packages/keystores-browser/tsconfig.json index 0b024f7587..50ea97c692 100644 --- a/packages/keystores-browser/tsconfig.json +++ b/packages/keystores-browser/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/keystores-node/tsconfig.json b/packages/keystores-node/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/keystores-node/tsconfig.json +++ b/packages/keystores-node/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/keystores/tsconfig.json b/packages/keystores/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/keystores/tsconfig.json +++ b/packages/keystores/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 386cf5400b..86f519f8c3 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -49,9 +49,10 @@ // "GetSignature", // "SetSignature", // "TypeAlias", - // "Reference" + "Reference" ], - "githubPages": false, + "githubPages": true, + "emit": "both", }, "files": [ "src/index.ts", diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/signers/tsconfig.json b/packages/signers/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/signers/tsconfig.json +++ b/packages/signers/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/transactions/tsconfig.json b/packages/transactions/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/transactions/tsconfig.json +++ b/packages/transactions/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json index 7b0b026bd4..b254e8e007 100644 --- a/packages/utils/tsconfig.json +++ b/packages/utils/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/packages/wallet-account/tsconfig.json b/packages/wallet-account/tsconfig.json index 9111b9af87..f54f09a74e 100644 --- a/packages/wallet-account/tsconfig.json +++ b/packages/wallet-account/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - "githubPages": false, + "githubPages": true, }, "files": [ "src/index.ts" diff --git a/tsconfig.base.json b/tsconfig.base.json index ad7a4e8dc9..6224e4aa6d 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -22,9 +22,9 @@ "includeVersion": true, "readme": "docs/README_TYPEDOC.md", "skipErrorChecking": true, - "disableGit": true, + // "disableGit": true, "entryPoints": [ - "packages/near-api-js", + // "packages/near-api-js", "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", @@ -41,7 +41,7 @@ "packages/wallet-account" ], "entryPointStrategy": "packages", - "githubPages": false, + "githubPages": true, "out": "docs", "emit": "both", }, diff --git a/tsconfig.json.local b/tsconfig.json.local deleted file mode 100644 index 3d1d1b3815..0000000000 --- a/tsconfig.json.local +++ /dev/null @@ -1,52 +0,0 @@ -{ - "compilerOptions": { - "outDir": "dist", - "allowJs": true, - "checkJs": true, - "esModuleInterop": true, - "module": "commonjs", - "target": "es2015", - "moduleResolution": "node", - "alwaysStrict": true, - "declaration": true, - "preserveSymlinks": true, - "preserveWatchOutput": true, - "pretty": false, - "forceConsistentCasingInFileNames": true, - "noFallthroughCasesInSwitch": true, - "noImplicitAny": false, - "noImplicitReturns": true, - "noUnusedLocals": true, - "experimentalDecorators": true, - "resolveJsonModule": true, - "strictNullChecks": false // required for typedoc - }, - "typedocOptions": { - "name": "near-api-js", - "includeVersion": true, - "readme": "docs/README_TYPEDOC.md", - "skipErrorChecking": true, - "disableGit": true, - "entryPoints": [ - //"packages/near-api-js", - "packages/accounts", - "packages/biometric-ed25519", - // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" - ], - "entryPointStrategy": "packages", - "githubPages": false, - "out": "typedoc-docs", - "emit": "both" - }, -} \ No newline at end of file From 624b2ddb94311322d36c60410afed02a84397a0b Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Wed, 15 Nov 2023 22:35:30 -0500 Subject: [PATCH 64/97] feat: update links on README_TYPEDOC.md --- docs/README_TYPEDOC.md | 18 +++++++++--------- tsconfig.base.json | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/README_TYPEDOC.md b/docs/README_TYPEDOC.md index c3c2b65adf..1c72808c09 100644 --- a/docs/README_TYPEDOC.md +++ b/docs/README_TYPEDOC.md @@ -18,8 +18,8 @@ NEAR JavaScript API is a complete library to interact with the NEAR blockchain. ### Connect to NEAR -- [From the browser](modules/_near_api_js.browserConnect.html) -- [From Node.js](modules/connect.html) +- [From the browser](modules/near_api_js.browserConnect.html) +- [From Node.js](modules/near_api_js.connect.html) ### Managing Accounts @@ -29,17 +29,17 @@ NEAR JavaScript API is a complete library to interact with the NEAR blockchain. ### Managing Keys -- Module [`utils/key_pair`](modules/utils_key_pair.html) -- Class [`BrowserLocalStorageKeyStore`](classes/key_stores_browser_local_storage_key_store.BrowserLocalStorageKeyStore.html) -- Class [`InMemoryKeyStore`](classes/key_stores_in_memory_key_store.InMemoryKeyStore.html) -- Class [`UnencryptedFileSystemKeyStore`](classes/key_stores_unencrypted_file_system_keystore.UnencryptedFileSystemKeyStore.html) -- Class [`MergeKeyStore`](classes/key_stores_merge_key_store.MergeKeyStore.html) +- Module [`utils/key_pair`](modules/near_api_js.utils_key_pair.html) +- Class [`BrowserLocalStorageKeyStore`](classes/near_api_js.key_stores_browser_local_storage_key_store.BrowserLocalStorageKeyStore.html) +- Class [`InMemoryKeyStore`](classes/_near_js_keystores.in_memory_key_store.InMemoryKeyStore.html) +- Class [`UnencryptedFileSystemKeyStore`](classes/_near_js_keystores_node.unencrypted_file_system_keystore.UnencryptedFileSystemKeyStore.html) +- Class [`MergeKeyStore`](classes/_near_js_keystores.merge_key_store.MergeKeyStore.html) ### RPC - [Request and Response Types](modules/_near_js_types.provider.html) -- [Client](classes/providers_json_rpc_provider.JsonRpcProvider.html) +- [Client](classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html) ### Utils -- [Formatting utils](modules/utils_format.html) +- [Formatting utils](modules/_near_js_utils.format.html) diff --git a/tsconfig.base.json b/tsconfig.base.json index 6224e4aa6d..ce4cc17b6f 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -24,7 +24,7 @@ "skipErrorChecking": true, // "disableGit": true, "entryPoints": [ - // "packages/near-api-js", + "packages/near-api-js", "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", From b16fe0eff73ad2f9878e6bb23664af15b9ebb710 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 00:10:05 -0500 Subject: [PATCH 65/97] feat: migrate typedoc.json to javascript to handle github full path --- packages/accounts/src/account.ts | 4 ++-- packages/accounts/src/account_2fa.ts | 2 +- typedoc.js | 17 +++++++++++++++++ 3 files changed, 20 insertions(+), 3 deletions(-) create mode 100644 typedoc.js diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index 837dca6678..5e386e4673 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -194,7 +194,7 @@ export class Account { * Create a signed transaction which can be broadcast to the network * @param receiverId NEAR account receiving the transaction * @param actions list of actions to perform as part of the transaction - * @see {@link providers/json-rpc-provider!JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} */ protected async signTransaction(receiverId: string, actions: Action[]): Promise<[Uint8Array, SignedTransaction]> { const accessKeyInfo = await this.findAccessKey(receiverId, actions); @@ -214,7 +214,7 @@ export class Account { /** * Sign a transaction to preform a list of actions and broadcast it using the RPC API. - * @see {@link providers/json-rpc-provider!JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} */ async signAndSendTransaction({ receiverId, actions, returnError }: SignAndSendTransactionOptions): Promise { let txHash, signedTx; diff --git a/packages/accounts/src/account_2fa.ts b/packages/accounts/src/account_2fa.ts index b383bcaeee..1d3c7bbd43 100644 --- a/packages/accounts/src/account_2fa.ts +++ b/packages/accounts/src/account_2fa.ts @@ -46,7 +46,7 @@ export class Account2FA extends AccountMultisig { /** * Sign a transaction to preform a list of actions and broadcast it using the RPC API. - * @see {@link providers/json-rpc-provider!JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} */ async signAndSendTransaction({ receiverId, actions }: SignAndSendTransactionOptions): Promise { await super.signAndSendTransaction({ receiverId, actions }); diff --git a/typedoc.js b/typedoc.js new file mode 100644 index 0000000000..2383790214 --- /dev/null +++ b/typedoc.js @@ -0,0 +1,17 @@ +const GITHUB_BASE = "https://few-sw.github.io/near-api-js/" + +module.exports = { + "externalSymbolLinkMappings": { + "providers/json-rpc-provider": { + "JsonRpcProvider_sendTransaction": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html#sendTransaction` + }, + "utils/key_pair": { + "KeyPair": `${GITHUB_BASE}/modules/near_api_js.utils_key_pair.html` + }, + "key_stores/browser_local_storage_key_store": { + "BrowserLocalStorageKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores_browser.browser_local_storage_key_store.BrowserLocalStorageKeyStore.html` + } + } +} + + From 7b4b1a21e0b186e8bc45e4ed982b53ad20e535cc Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 00:10:21 -0500 Subject: [PATCH 66/97] feat: delete typedoc.json --- typedoc.json | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 typedoc.json diff --git a/typedoc.json b/typedoc.json deleted file mode 100644 index 4f607be813..0000000000 --- a/typedoc.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "externalSymbolLinkMappings": { - "providers/json-rpc-provider": { - "JsonRpcProvider#sendTransaction": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" - }, - "utils/key_pair": { - "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" - } - } -} \ No newline at end of file From 3be158430c5b74eab1eb9caf6b62cb9c2801454c Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 14:44:00 -0500 Subject: [PATCH 67/97] feat: fix @link on account.ts --- packages/accounts/src/account.ts | 2 +- typedoc.js | 28 +++++++++++++++++++++++----- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index 5e386e4673..2a33987729 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -266,7 +266,7 @@ export class Account { accessKeyByPublicKeyCache: { [key: string]: AccessKeyView } = {}; /** - * Finds the {@link providers/provider!AccessKeyView} associated with the accounts {@link utils/key_pair!PublicKey} stored in the {@link key_stores/keystore!KeyStore}. + * Finds the {@link providers/provider!AccessKeyView | AccessKeyView} associated with the accounts {@link utils/key_pair!PublicKey | PublicKey} stored in the {@link key_stores/keystore!KeyStore | KeyStore}. * * @todo Find matching access key based on transaction (i.e. receiverId and actions) * diff --git a/typedoc.js b/typedoc.js index 2383790214..5191806c1f 100644 --- a/typedoc.js +++ b/typedoc.js @@ -1,16 +1,34 @@ -const GITHUB_BASE = "https://few-sw.github.io/near-api-js/" +const GITHUB_BASE = "https://few-sw.github.io/near-api-js" module.exports = { "externalSymbolLinkMappings": { + "providers/provider": { + "AccessKeyView": `${GITHUB_BASE}/interfaces/near_api_js.providers_provider.AccessKeyView.html` + }, "providers/json-rpc-provider": { "JsonRpcProvider_sendTransaction": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html#sendTransaction` }, - "utils/key_pair": { - "KeyPair": `${GITHUB_BASE}/modules/near_api_js.utils_key_pair.html` - }, "key_stores/browser_local_storage_key_store": { "BrowserLocalStorageKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores_browser.browser_local_storage_key_store.BrowserLocalStorageKeyStore.html` - } + }, + "key_stores/keystore": { + "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` + }, + "utils/key_pair": { + "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString` + }, + "": { + "": `${GITHUB_BASE}` + }, + "": { + "": `${GITHUB_BASE}` + }, + "": { + "": `${GITHUB_BASE}` + }, + "": { + "": `${GITHUB_BASE}` + }, } } From 4d5e87efeaf605f4df19ab5354096e35b8cfd15b Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 15:11:14 -0500 Subject: [PATCH 68/97] feat: update near-api-js tsconfig --- packages/keystores/src/in_memory_key_store.ts | 6 +++--- packages/near-api-js/tsconfig.json | 2 +- typedoc.js | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/packages/keystores/src/in_memory_key_store.ts b/packages/keystores/src/in_memory_key_store.ts index c4114e4774..b792f38be5 100644 --- a/packages/keystores/src/in_memory_key_store.ts +++ b/packages/keystores/src/in_memory_key_store.ts @@ -38,7 +38,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Stores a {@link utils/key_pair!KeyPair} in in-memory storage item + * Stores a {@link utils/key_pair!KeyPair | KeyPair} in in-memory storage item * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -48,7 +48,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair} from in-memory storage + * Gets a {@link utils/key_pair!KeyPair | KeyPair} from in-memory storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -62,7 +62,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Removes a {@link utils/key_pair!KeyPair} from in-memory storage + * Removes a {@link utils/key_pair!KeyPair | KeyPair} from in-memory storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 86f519f8c3..818a719f40 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -31,7 +31,7 @@ "exclude": ["node_modules"], "excludeNotDocumented": true, "excludeNotDocumentedKinds": [ - "Module", + // "Module", // "Namespace", // "Enum", // "EnumMember", // Not enabled by default diff --git a/typedoc.js b/typedoc.js index 5191806c1f..c7562a5553 100644 --- a/typedoc.js +++ b/typedoc.js @@ -15,7 +15,8 @@ module.exports = { "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` }, "utils/key_pair": { - "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString` + "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString`, + "KeyPair": `${GITHUB_BASE}/classes/_near_js_crypto.key_pair.KeyPair.html#fromString`, }, "": { "": `${GITHUB_BASE}` @@ -32,4 +33,3 @@ module.exports = { } } - From 49b023517c467aa4ef209f31cb74aff9f5103417 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 18:28:15 -0500 Subject: [PATCH 69/97] feat: tsconfig test for near-api-js --- packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- packages/near-api-js/tsconfig.json | 44 ++++++++++++------------ typedoc.js | 4 +++ 4 files changed, 28 insertions(+), 24 deletions(-) diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index c991bc81e9..6b1a48a43d 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - // "githubPages": true, + "githubPages": true, "emit": "both", }, "files": [ diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index c963ba1dd6..ee631cad33 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules"], - // "githubPages": true, + "githubPages": true, "emit": "both", }, "files": [ diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 818a719f40..e4ef0f6723 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -1,27 +1,27 @@ { "compilerOptions": { - "esModuleInterop": true, - "lib": [ - "es2015", - "esnext", - "dom" - ], - "module": "commonjs", - "target": "es2015", - "moduleResolution": "node", - "alwaysStrict": true, + // "esModuleInterop": true, + // "lib": [ + // "es2015", + // "esnext", + // "dom" + // ], + // "module": "commonjs", + // "target": "es2015", + // "moduleResolution": "node", + // "alwaysStrict": true, "outDir": "./lib", - "declaration": true, - "preserveSymlinks": false, - "preserveWatchOutput": true, - "pretty": false, - "forceConsistentCasingInFileNames": true, - "noFallthroughCasesInSwitch": true, - "noImplicitAny": false, - "noImplicitReturns": true, - "noUnusedLocals": true, - "experimentalDecorators": true, - "resolveJsonModule": true, + // "declaration": true, + // "preserveSymlinks": false, + // "preserveWatchOutput": true, + // "pretty": false, + // "forceConsistentCasingInFileNames": true, + // "noFallthroughCasesInSwitch": true, + // "noImplicitAny": false, + // "noImplicitReturns": true, + // "noUnusedLocals": true, + // "experimentalDecorators": true, + // "resolveJsonModule": true, }, "typedocOptions": { "skipErrorChecking": true, @@ -31,7 +31,7 @@ "exclude": ["node_modules"], "excludeNotDocumented": true, "excludeNotDocumentedKinds": [ - // "Module", + "Module", // "Namespace", // "Enum", // "EnumMember", // Not enabled by default diff --git a/typedoc.js b/typedoc.js index c7562a5553..aae1dba920 100644 --- a/typedoc.js +++ b/typedoc.js @@ -33,3 +33,7 @@ module.exports = { } } +// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.ChangeFunctionCallOptions.walletCallbackUrl. +// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.ChangeFunctionCallOptions.walletMeta. +// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.SignAndSendTransactionOptions.walletCallbackUrl. +// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.SignAndSendTransactionOptions.walletMeta. \ No newline at end of file From 4904c5abed4e5ddae339e97f61b7e7e9b009f732 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 19:26:17 -0500 Subject: [PATCH 70/97] feat: add lib and text to exclude option --- packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- packages/crypto/tsconfig.json | 2 +- packages/iframe-rpc/tsconfig.json | 2 +- packages/keystores-browser/tsconfig.json | 2 +- packages/keystores-node/tsconfig.json | 2 +- packages/keystores/tsconfig.json | 2 +- packages/near-api-js/tsconfig.json | 66 ++++++++---------------- packages/providers/tsconfig.json | 2 +- packages/signers/tsconfig.json | 2 +- packages/transactions/tsconfig.json | 2 +- packages/types/tsconfig.json | 2 +- packages/utils/tsconfig.json | 2 +- packages/wallet-account/tsconfig.json | 4 +- 14 files changed, 36 insertions(+), 58 deletions(-) diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 6b1a48a43d..555a9d55e0 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -9,7 +9,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", }, diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index ee631cad33..b5b9aabdbe 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", }, diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/crypto/tsconfig.json +++ b/packages/crypto/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/iframe-rpc/tsconfig.json b/packages/iframe-rpc/tsconfig.json index 50ea97c692..a92ee3413a 100644 --- a/packages/iframe-rpc/tsconfig.json +++ b/packages/iframe-rpc/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/keystores-browser/tsconfig.json b/packages/keystores-browser/tsconfig.json index 50ea97c692..a92ee3413a 100644 --- a/packages/keystores-browser/tsconfig.json +++ b/packages/keystores-browser/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/keystores-node/tsconfig.json b/packages/keystores-node/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/keystores-node/tsconfig.json +++ b/packages/keystores-node/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/keystores/tsconfig.json b/packages/keystores/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/keystores/tsconfig.json +++ b/packages/keystores/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index e4ef0f6723..4de7a11717 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -1,56 +1,34 @@ { "compilerOptions": { - // "esModuleInterop": true, - // "lib": [ - // "es2015", - // "esnext", - // "dom" - // ], - // "module": "commonjs", - // "target": "es2015", - // "moduleResolution": "node", - // "alwaysStrict": true, + "esModuleInterop": true, + "lib": [ + "es2015", + "esnext", + "dom" + ], + "module": "commonjs", + "target": "es2015", + "moduleResolution": "node", + "alwaysStrict": true, "outDir": "./lib", - // "declaration": true, - // "preserveSymlinks": false, - // "preserveWatchOutput": true, - // "pretty": false, - // "forceConsistentCasingInFileNames": true, - // "noFallthroughCasesInSwitch": true, - // "noImplicitAny": false, - // "noImplicitReturns": true, - // "noUnusedLocals": true, - // "experimentalDecorators": true, - // "resolveJsonModule": true, + "declaration": true, + "preserveSymlinks": false, + "preserveWatchOutput": true, + "pretty": false, + "forceConsistentCasingInFileNames": true, + "noFallthroughCasesInSwitch": true, + "noImplicitAny": false, + "noImplicitReturns": true, + "noUnusedLocals": true, + "experimentalDecorators": true, + "resolveJsonModule": true, }, "typedocOptions": { "skipErrorChecking": true, "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], - "excludeNotDocumented": true, - "excludeNotDocumentedKinds": [ - "Module", - // "Namespace", - // "Enum", - // "EnumMember", // Not enabled by default - // "Variable", - // "Function", - // "Class", - // "Interface", - // "Constructor", - // "Property", - // "Method", - // "CallSignature", - // "IndexSignature", - // "ConstructorSignature", - // "Accessor", - // "GetSignature", - // "SetSignature", - // "TypeAlias", - "Reference" - ], + "exclude": ["node_modules","lib","test"], "githubPages": true, "emit": "both", }, diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/signers/tsconfig.json b/packages/signers/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/signers/tsconfig.json +++ b/packages/signers/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/transactions/tsconfig.json b/packages/transactions/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/transactions/tsconfig.json +++ b/packages/transactions/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json index b254e8e007..00d15b19e9 100644 --- a/packages/utils/tsconfig.json +++ b/packages/utils/tsconfig.json @@ -8,7 +8,7 @@ "entryPoints": ["src"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ diff --git a/packages/wallet-account/tsconfig.json b/packages/wallet-account/tsconfig.json index f54f09a74e..5f7aef108e 100644 --- a/packages/wallet-account/tsconfig.json +++ b/packages/wallet-account/tsconfig.json @@ -6,10 +6,10 @@ }, "typedocOptions": { "skipErrorChecking": true, - "entryPoints": ["src"], + "entryPoints": ["src", "src/wallet_account.ts"], "entryPointStrategy": "expand", "out": "docs", - "exclude": ["node_modules"], + "exclude": ["node_modules","test","lib"], "githubPages": true, }, "files": [ From 22facba16b4196f772452973013317b49596b8dc Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 21:52:08 -0500 Subject: [PATCH 71/97] feat: remove @link tag on unresolved link RequestSignTransactionsOptions --- packages/accounts/src/account.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index 2a33987729..b56f187082 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -81,12 +81,12 @@ export interface SignAndSendTransactionOptions { actions: Action[]; /** * Metadata to send the NEAR Wallet if using it to sign transactions. - * @see {@link RequestSignTransactionsOptions} + * @see RequestSignTransactionsOptions */ walletMeta?: string; /** * Callback url to send the NEAR Wallet if using it to sign transactions. - * @see {@link RequestSignTransactionsOptions} + * @see RequestSignTransactionsOptions */ walletCallbackUrl?: string; returnError?: boolean; @@ -122,12 +122,12 @@ export interface FunctionCallOptions { export interface ChangeFunctionCallOptions extends FunctionCallOptions { /** * Metadata to send the NEAR Wallet if using it to sign transactions. - * @see {@link RequestSignTransactionsOptions} + * @see RequestSignTransactionsOptions */ walletMeta?: string; /** * Callback url to send the NEAR Wallet if using it to sign transactions. - * @see {@link RequestSignTransactionsOptions} + * @see RequestSignTransactionsOptions */ walletCallbackUrl?: string; } From 532aa9a6dcdc9232ba154bf7bfb08ce4ea7963cb Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 22:14:02 -0500 Subject: [PATCH 72/97] feat: add typedoc-plugin-merge-modules --- package.json | 5 ++- packages/accounts/tsconfig.json | 3 ++ packages/biometric-ed25519/tsconfig.json | 3 ++ packages/near-api-js/tsconfig.json | 25 +++++++++++ packages/providers/tsconfig.json | 3 ++ pnpm-lock.yaml | 23 ++++++++++ tsconfig.json | 55 ++++++++++++++++++++++++ typedoc.json | 10 ----- 8 files changed, 115 insertions(+), 12 deletions(-) create mode 100644 tsconfig.json delete mode 100644 typedoc.json diff --git a/package.json b/package.json index 20a4220fd7..196c6c7a30 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,8 @@ "husky": "^7.0.4", "rimraf": "^3.0.2", "turbo": "^1.4.5", - "typescript": "^4.9.4", - "typedoc": "^0.25.3" + "typedoc": "^0.25.3", + "typedoc-plugin-merge-modules": "^5.1.0", + "typescript": "^4.9.4" } } diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 555a9d55e0..a4310327c1 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -12,6 +12,9 @@ "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", + "plugin": ["typedoc-plugin-merge-modules"], + "mergeModulesRenameDefaults": true, + "mergeModulesMergeMode": "project", }, "files": [ "src/index.ts" diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index b5b9aabdbe..98c0d287c7 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -11,6 +11,9 @@ "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", + "plugin": ["typedoc-plugin-merge-modules"], + "mergeModulesRenameDefaults": true, + "mergeModulesMergeMode": "project", }, "files": [ "src/index.ts", diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 4de7a11717..3f57613688 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -31,6 +31,31 @@ "exclude": ["node_modules","lib","test"], "githubPages": true, "emit": "both", + "plugin": ["typedoc-plugin-merge-modules"], + "mergeModulesRenameDefaults": true, + "mergeModulesMergeMode": "project", + "excludeNotDocumented": true, + "excludeNotDocumentedKinds": [ + "Module", + // "Namespace", + // "Enum", + // "EnumMember", // Not enabled by default + // "Variable", + // "Function", + // "Class", + // "Interface", + // "Constructor", + // "Property", + // "Method", + // "CallSignature", + // "IndexSignature", + // "ConstructorSignature", + // "Accessor", + // "GetSignature", + // "SetSignature", + // "TypeAlias", + "Reference" + ], }, "files": [ "src/index.ts", diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index 00d15b19e9..600536e0bc 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -10,6 +10,9 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "plugin": ["typedoc-plugin-merge-modules"], + "mergeModulesRenameDefaults": true, + "mergeModulesMergeMode": "project", }, "files": [ "src/index.ts" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 808a882051..7417269f77 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -32,6 +32,9 @@ importers: commitlint: specifier: ^17.0.3 version: 17.0.3 + docusaurus-plugin-typedoc: + specifier: ^0.21.0 + version: 0.21.0(typedoc@0.25.3) eslint: specifier: ^8.20.0 version: 8.20.0 @@ -47,6 +50,9 @@ importers: typedoc: specifier: ^0.25.3 version: 0.25.3(typescript@4.9.4) + typedoc-plugin-merge-modules: + specifier: ^5.1.0 + version: 5.1.0(typedoc@0.25.3) typescript: specifier: ^4.9.4 version: 4.9.4 @@ -3642,6 +3648,15 @@ packages: esutils: 2.0.3 dev: true + /docusaurus-plugin-typedoc@0.21.0(typedoc@0.25.3): + resolution: {integrity: sha512-7DLFrf0JP+L5vSRQHVKIbndjbksd2MlxPqNmmdxzLFiRINgrY23s9waduWM9t24PUsf5JZ0tlGKlE3sK4uZ72Q==} + peerDependencies: + typedoc: '>=0.24.0' + typedoc-plugin-markdown: '>=3.15.0' + dependencies: + typedoc: 0.25.3(typescript@4.9.4) + dev: true + /domain-browser@1.2.0: resolution: {integrity: sha512-jnjyiM6eRyZl2H+W8Q/zLMA481hzi0eszAaBUzIVnmYVDBbnLxVNnfu1HgEBvCbL+71FrxMl3E6lpKH7Ge3OXA==} engines: {node: '>=0.4', npm: '>=1.2'} @@ -8239,6 +8254,14 @@ packages: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} dev: true + /typedoc-plugin-merge-modules@5.1.0(typedoc@0.25.3): + resolution: {integrity: sha512-jXH27L/wlxFjErgBXleh3opVgjVTXFEuBo68Yfl18S9Oh/IqxK6NV94jlEJ9hl4TXc9Zm2l7Rfk41CEkcCyvFQ==} + peerDependencies: + typedoc: 0.24.x || 0.25.x + dependencies: + typedoc: 0.25.3(typescript@4.9.4) + dev: true + /typedoc@0.25.3(typescript@4.9.4): resolution: {integrity: sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==} engines: {node: '>= 16'} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000000..00545a3e53 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,55 @@ +{ + "compilerOptions": { + "outDir": "dist", + "allowJs": true, + "checkJs": true, + "esModuleInterop": true, + "module": "commonjs", + "target": "es2015", + "moduleResolution": "node", + "alwaysStrict": true, + "declaration": true, + "preserveSymlinks": true, + "preserveWatchOutput": true, + "pretty": false, + "forceConsistentCasingInFileNames": true, + "noFallthroughCasesInSwitch": true, + "noImplicitAny": false, + "noImplicitReturns": true, + "noUnusedLocals": true, + "experimentalDecorators": true, + "resolveJsonModule": true, + "strictNullChecks": false // required for typedoc + }, + "typedocOptions": { + "name": "near-api-js", + "includeVersion": true, + "readme": "docs/README_TYPEDOC.md", + "skipErrorChecking": true, + // "disableGit": true, + "entryPoints": [ + "packages/near-api-js", + "packages/accounts", + "packages/biometric-ed25519", + // "packages/cookbook", + // "packages/crypto", + // "packages/iframe-rpc", + // "packages/keystores", + // "packages/keystores-browser", + // "packages/keystores-node", + // "packages/providers", + // "packages/signers", + // "packages/transactions", + // "packages/types", + // "packages/utils", + // "packages/wallet-account" + ], + "entryPointStrategy": "packages", + "githubPages": true, + "out": "typedoc-docs", + "emit": "both", + "plugin": ["typedoc-plugin-merge-modules"], + // "mergeModulesRenameDefaults": true, + "mergeModulesMergeMode": "module", + }, +} \ No newline at end of file diff --git a/typedoc.json b/typedoc.json deleted file mode 100644 index ea08e8426f..0000000000 --- a/typedoc.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "$schema": "https://typedoc.org/schema.json", - "plugin": ["@mxssfd/typedoc-theme"], - "theme": "my-theme", - "externalSymbolLinkMappings": { - "utils/key_pair": { - "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" - } - } -} \ No newline at end of file From 22fbf88145fc153bbe62d5bf9b5de46d44341637 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 22:28:26 -0500 Subject: [PATCH 73/97] feat: update tsconfig.base --- package.json | 2 -- tsconfig.base.json | 25 ++++++++++++++----------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/package.json b/package.json index 196c6c7a30..878ee1da7c 100644 --- a/package.json +++ b/package.json @@ -22,11 +22,9 @@ "@changesets/cli": "^2.24.4", "@commitlint/cli": "^17.0.3", "@commitlint/config-conventional": "^17.0.3", - "@mxssfd/typedoc-theme": "^1.1.3", "@typescript-eslint/eslint-plugin": "^5.31.0", "@typescript-eslint/parser": "^5.31.0", "commitlint": "^17.0.3", - "docusaurus-plugin-typedoc": "^0.21.0", "eslint": "^8.20.0", "husky": "^7.0.4", "rimraf": "^3.0.2", diff --git a/tsconfig.base.json b/tsconfig.base.json index ce4cc17b6f..c8a174540e 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -28,21 +28,24 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - "packages/crypto", - "packages/iframe-rpc", - "packages/keystores", - "packages/keystores-browser", - "packages/keystores-node", - "packages/providers", - "packages/signers", - "packages/transactions", - "packages/types", - "packages/utils", - "packages/wallet-account" + // "packages/crypto", + // "packages/iframe-rpc", + // "packages/keystores", + // "packages/keystores-browser", + // "packages/keystores-node", + // "packages/providers", + // "packages/signers", + // "packages/transactions", + // "packages/types", + // "packages/utils", + // "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": true, "out": "docs", "emit": "both", + "plugin": ["typedoc-plugin-merge-modules"], + "mergeModulesRenameDefaults": true, + "mergeModulesMergeMode": "module", }, } From fb228dab03a860dc05d4c1a9832d17be30147fda Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 22:30:06 -0500 Subject: [PATCH 74/97] feat: update pnpm-lock --- pnpm-lock.yaml | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7417269f77..3c3ef295e3 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -20,9 +20,6 @@ importers: '@commitlint/config-conventional': specifier: ^17.0.3 version: 17.0.3 - '@mxssfd/typedoc-theme': - specifier: ^1.1.3 - version: 1.1.3(typedoc@0.25.3) '@typescript-eslint/eslint-plugin': specifier: ^5.31.0 version: 5.31.0(@typescript-eslint/parser@5.31.0)(eslint@8.20.0)(typescript@4.9.4) @@ -32,9 +29,6 @@ importers: commitlint: specifier: ^17.0.3 version: 17.0.3 - docusaurus-plugin-typedoc: - specifier: ^0.21.0 - version: 0.21.0(typedoc@0.25.3) eslint: specifier: ^8.20.0 version: 8.20.0 @@ -1721,15 +1715,6 @@ packages: read-yaml-file: 1.1.0 dev: true - /@mxssfd/typedoc-theme@1.1.3(typedoc@0.25.3): - resolution: {integrity: sha512-/yP5rqhvibMpzXpmw0YLLRCpoj3uVWWlwyJseZXzGxTfiA6/fd1uubUqNoQAi2U19atMDonq8mQc+hlVctrX4g==} - engines: {node: '>= 14'} - peerDependencies: - typedoc: ^0.25.1 - dependencies: - typedoc: 0.25.3(typescript@4.9.4) - dev: true - /@nodelib/fs.scandir@2.1.5: resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==} engines: {node: '>= 8'} @@ -3648,15 +3633,6 @@ packages: esutils: 2.0.3 dev: true - /docusaurus-plugin-typedoc@0.21.0(typedoc@0.25.3): - resolution: {integrity: sha512-7DLFrf0JP+L5vSRQHVKIbndjbksd2MlxPqNmmdxzLFiRINgrY23s9waduWM9t24PUsf5JZ0tlGKlE3sK4uZ72Q==} - peerDependencies: - typedoc: '>=0.24.0' - typedoc-plugin-markdown: '>=3.15.0' - dependencies: - typedoc: 0.25.3(typescript@4.9.4) - dev: true - /domain-browser@1.2.0: resolution: {integrity: sha512-jnjyiM6eRyZl2H+W8Q/zLMA481hzi0eszAaBUzIVnmYVDBbnLxVNnfu1HgEBvCbL+71FrxMl3E6lpKH7Ge3OXA==} engines: {node: '>=0.4', npm: '>=1.2'} From d2c9910581a6cd6aca7c54374e626352e62cab62 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 22:35:44 -0500 Subject: [PATCH 75/97] feat: delete tsconfig.json --- tsconfig.json => tsconfig.json.local | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename tsconfig.json => tsconfig.json.local (100%) diff --git a/tsconfig.json b/tsconfig.json.local similarity index 100% rename from tsconfig.json rename to tsconfig.json.local From 309229a84aaa381904a55fd4f7a7fb6c908b5d07 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 22:49:31 -0500 Subject: [PATCH 76/97] feat: remove plugin typedoc-plugin-merge-modules --- package.json | 1 - packages/accounts/tsconfig.json | 3 --- packages/biometric-ed25519/tsconfig.json | 5 +---- packages/near-api-js/tsconfig.json | 3 --- packages/providers/tsconfig.json | 4 +--- pnpm-lock.yaml | 11 ----------- tsconfig.base.json | 3 --- tsconfig.json.local | 7 ++----- 8 files changed, 4 insertions(+), 33 deletions(-) diff --git a/package.json b/package.json index 878ee1da7c..c2b675f192 100644 --- a/package.json +++ b/package.json @@ -30,7 +30,6 @@ "rimraf": "^3.0.2", "turbo": "^1.4.5", "typedoc": "^0.25.3", - "typedoc-plugin-merge-modules": "^5.1.0", "typescript": "^4.9.4" } } diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index a4310327c1..555a9d55e0 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -12,9 +12,6 @@ "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", - "plugin": ["typedoc-plugin-merge-modules"], - "mergeModulesRenameDefaults": true, - "mergeModulesMergeMode": "project", }, "files": [ "src/index.ts" diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 98c0d287c7..c89f94566f 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -10,10 +10,7 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, - "emit": "both", - "plugin": ["typedoc-plugin-merge-modules"], - "mergeModulesRenameDefaults": true, - "mergeModulesMergeMode": "project", + "emit": "both" }, "files": [ "src/index.ts", diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 3f57613688..dda2d852e1 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -32,9 +32,6 @@ "githubPages": true, "emit": "both", "plugin": ["typedoc-plugin-merge-modules"], - "mergeModulesRenameDefaults": true, - "mergeModulesMergeMode": "project", - "excludeNotDocumented": true, "excludeNotDocumentedKinds": [ "Module", // "Namespace", diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index 600536e0bc..ed5511aabf 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -10,9 +10,7 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, - "plugin": ["typedoc-plugin-merge-modules"], - "mergeModulesRenameDefaults": true, - "mergeModulesMergeMode": "project", + "emit": "both", }, "files": [ "src/index.ts" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 3c3ef295e3..1bf4de8e6d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -44,9 +44,6 @@ importers: typedoc: specifier: ^0.25.3 version: 0.25.3(typescript@4.9.4) - typedoc-plugin-merge-modules: - specifier: ^5.1.0 - version: 5.1.0(typedoc@0.25.3) typescript: specifier: ^4.9.4 version: 4.9.4 @@ -8230,14 +8227,6 @@ packages: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} dev: true - /typedoc-plugin-merge-modules@5.1.0(typedoc@0.25.3): - resolution: {integrity: sha512-jXH27L/wlxFjErgBXleh3opVgjVTXFEuBo68Yfl18S9Oh/IqxK6NV94jlEJ9hl4TXc9Zm2l7Rfk41CEkcCyvFQ==} - peerDependencies: - typedoc: 0.24.x || 0.25.x - dependencies: - typedoc: 0.25.3(typescript@4.9.4) - dev: true - /typedoc@0.25.3(typescript@4.9.4): resolution: {integrity: sha512-Ow8Bo7uY1Lwy7GTmphRIMEo6IOZ+yYUyrc8n5KXIZg1svpqhZSWgni2ZrDhe+wLosFS8yswowUzljTAV/3jmWw==} engines: {node: '>= 16'} diff --git a/tsconfig.base.json b/tsconfig.base.json index c8a174540e..75ff98a576 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -44,8 +44,5 @@ "githubPages": true, "out": "docs", "emit": "both", - "plugin": ["typedoc-plugin-merge-modules"], - "mergeModulesRenameDefaults": true, - "mergeModulesMergeMode": "module", }, } diff --git a/tsconfig.json.local b/tsconfig.json.local index 00545a3e53..28748ebf86 100644 --- a/tsconfig.json.local +++ b/tsconfig.json.local @@ -47,9 +47,6 @@ "entryPointStrategy": "packages", "githubPages": true, "out": "typedoc-docs", - "emit": "both", - "plugin": ["typedoc-plugin-merge-modules"], - // "mergeModulesRenameDefaults": true, - "mergeModulesMergeMode": "module", - }, + "emit": "both" + } } \ No newline at end of file From 2031e25d70b02328c9ddb3aabe192a87e9945c1c Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 23:05:35 -0500 Subject: [PATCH 77/97] feat: disable old docs-generator action --- .../workflows/docs-generator-trigger.disabled | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 .github/workflows/docs-generator-trigger.disabled diff --git a/.github/workflows/docs-generator-trigger.disabled b/.github/workflows/docs-generator-trigger.disabled new file mode 100644 index 0000000000..fb45598532 --- /dev/null +++ b/.github/workflows/docs-generator-trigger.disabled @@ -0,0 +1,31 @@ +name: Docs Generator trigger + +on: + workflow_run: + workflows: [Release] + types: [completed] + branches: [master] + +concurrency: + group: "docs" + cancel-in-progress: true + +jobs: + trigger-generator: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'success' }} + environment: DOCS + steps: + - name: Trigger generator + run: | + curl -i -v --location --request POST 'https://docs-bot.vercel.app/api/on-release' \ + --header 'bot-auth: ${{ secrets.DOCS_BOT_SECRET }}' \ + --header 'Content-Type: application/json' \ + --data-raw '{ + "event_type": "release-publish", + "client_payload": { + "source_repo": "near/near-api-js", + "builder_name": "near-api-js", + "release_version": "${{ github.ref_name }}" + } + }' \ No newline at end of file From d2319c7860261a7a8d53028d5cd1de6038e505c8 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 23:22:47 -0500 Subject: [PATCH 78/97] feat: update near-api-js tsconfig --- .github/workflows/docs-generator-trigger.yml | 31 -------------- packages/near-api-js/tsconfig.json | 43 ++++++++++---------- 2 files changed, 21 insertions(+), 53 deletions(-) delete mode 100644 .github/workflows/docs-generator-trigger.yml diff --git a/.github/workflows/docs-generator-trigger.yml b/.github/workflows/docs-generator-trigger.yml deleted file mode 100644 index fb45598532..0000000000 --- a/.github/workflows/docs-generator-trigger.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Docs Generator trigger - -on: - workflow_run: - workflows: [Release] - types: [completed] - branches: [master] - -concurrency: - group: "docs" - cancel-in-progress: true - -jobs: - trigger-generator: - runs-on: ubuntu-latest - if: ${{ github.event.workflow_run.conclusion == 'success' }} - environment: DOCS - steps: - - name: Trigger generator - run: | - curl -i -v --location --request POST 'https://docs-bot.vercel.app/api/on-release' \ - --header 'bot-auth: ${{ secrets.DOCS_BOT_SECRET }}' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "event_type": "release-publish", - "client_payload": { - "source_repo": "near/near-api-js", - "builder_name": "near-api-js", - "release_version": "${{ github.ref_name }}" - } - }' \ No newline at end of file diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index dda2d852e1..6f08654b7c 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -31,28 +31,27 @@ "exclude": ["node_modules","lib","test"], "githubPages": true, "emit": "both", - "plugin": ["typedoc-plugin-merge-modules"], - "excludeNotDocumentedKinds": [ - "Module", - // "Namespace", - // "Enum", - // "EnumMember", // Not enabled by default - // "Variable", - // "Function", - // "Class", - // "Interface", - // "Constructor", - // "Property", - // "Method", - // "CallSignature", - // "IndexSignature", - // "ConstructorSignature", - // "Accessor", - // "GetSignature", - // "SetSignature", - // "TypeAlias", - "Reference" - ], + // "excludeNotDocumentedKinds": [ + // // "Module", + // // "Namespace", + // // "Enum", + // // "EnumMember", // Not enabled by default + // // "Variable", + // // "Function", + // // "Class", + // // "Interface", + // // "Constructor", + // // "Property", + // // "Method", + // // "CallSignature", + // // "IndexSignature", + // // "ConstructorSignature", + // // "Accessor", + // // "GetSignature", + // // "SetSignature", + // // "TypeAlias", + // // "Reference" + // ], }, "files": [ "src/index.ts", From f51d52b63dab072a698939a203642990f4b6a765 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Thu, 16 Nov 2023 23:38:06 -0500 Subject: [PATCH 79/97] feat: updtae tsconfig.base --- tsconfig.base.json | 22 +++++++++++----------- tsconfig.json.local | 22 +++++++++++----------- typedoc.js | 7 +++---- 3 files changed, 25 insertions(+), 26 deletions(-) diff --git a/tsconfig.base.json b/tsconfig.base.json index 75ff98a576..ce4cc17b6f 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -28,17 +28,17 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - // "packages/crypto", - // "packages/iframe-rpc", - // "packages/keystores", - // "packages/keystores-browser", - // "packages/keystores-node", - // "packages/providers", - // "packages/signers", - // "packages/transactions", - // "packages/types", - // "packages/utils", - // "packages/wallet-account" + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": true, diff --git a/tsconfig.json.local b/tsconfig.json.local index 28748ebf86..667d621a63 100644 --- a/tsconfig.json.local +++ b/tsconfig.json.local @@ -32,17 +32,17 @@ "packages/accounts", "packages/biometric-ed25519", // "packages/cookbook", - // "packages/crypto", - // "packages/iframe-rpc", - // "packages/keystores", - // "packages/keystores-browser", - // "packages/keystores-node", - // "packages/providers", - // "packages/signers", - // "packages/transactions", - // "packages/types", - // "packages/utils", - // "packages/wallet-account" + "packages/crypto", + "packages/iframe-rpc", + "packages/keystores", + "packages/keystores-browser", + "packages/keystores-node", + "packages/providers", + "packages/signers", + "packages/transactions", + "packages/types", + "packages/utils", + "packages/wallet-account" ], "entryPointStrategy": "packages", "githubPages": true, diff --git a/typedoc.js b/typedoc.js index aae1dba920..988cab2366 100644 --- a/typedoc.js +++ b/typedoc.js @@ -33,7 +33,6 @@ module.exports = { } } -// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.ChangeFunctionCallOptions.walletCallbackUrl. -// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.ChangeFunctionCallOptions.walletMeta. -// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.SignAndSendTransactionOptions.walletCallbackUrl. -// [warning] Failed to resolve link to "RequestSignTransactionsOptions" in comment for @near-js/accounts.account.SignAndSendTransactionOptions.walletMeta. \ No newline at end of file +// [warning] Failed to resolve link to "walletAccount!WalletConnection" in comment for near-api-js.account.Account. +// [warning] Failed to resolve link to "walletAccount!WalletConnection" in comment for near-api-js.account_multisig.Account2FA. +// [warning] Failed to resolve link to "walletAccount!WalletConnection" in comment for near-api-js.account_multisig.AccountMultisig. \ No newline at end of file From d49d952864378b94a1d75d1d29dd12bdd944d4cd Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 00:03:30 -0500 Subject: [PATCH 80/97] feat: update action --- .github/workflows/typedoc-generator.yml | 12 +++++++----- docs/custom-theme.ts | 17 ----------------- package.json | 2 +- tsconfig.json.local => tsconfig.local-test.json | 3 ++- 4 files changed, 10 insertions(+), 24 deletions(-) delete mode 100644 docs/custom-theme.ts rename tsconfig.json.local => tsconfig.local-test.json (96%) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index d66c7aaedd..fa9729a421 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -36,11 +36,13 @@ jobs: run: pnpm install - name: Build documentation - uses: few-sw/typedoc-action@add-pnpm-support - with: - entry: ${{ env.ENTRY_FILE }} - config: ${{ env.CONFIG_PATH }} - pnpm: ${{ env.USES_PNPM }} + run: pnpm docs + + # uses: few-sw/typedoc-action@add-pnpm-support + # with: + # entry: ${{ env.ENTRY_FILE }} + # config: ${{ env.CONFIG_PATH }} + # pnpm: ${{ env.USES_PNPM }} # - name: Sync branch # id: pull diff --git a/docs/custom-theme.ts b/docs/custom-theme.ts deleted file mode 100644 index 2fca15f00d..0000000000 --- a/docs/custom-theme.ts +++ /dev/null @@ -1,17 +0,0 @@ -import * as typedoc from 'typedoc'; - -export default function (PluginHost: typedoc.PluginHost) { - const app = PluginHost.owner; - - app.renderer.on('beforeWriteDocument', (context: typedoc.Context) => { - // Modify the navigation structure to group by classes, interfaces, and functions - context.navigation.children = context.project.toObject().children - .filter((child: any) => child.kindString === 'Class' || child.kindString === 'Interface' || child.kindString === 'Function') - .map((child: any) => { - return { - title: child.name, - url: child.url, - }; - }); - }); -} \ No newline at end of file diff --git a/package.json b/package.json index c2b675f192..1a5363ce1e 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "test": "turbo run test", "release": "changeset publish", "prepare": "husky install", - "docs": "typedoc" + "docs": "typedoc --tsconfig tsconfig.local-test.json" }, "devDependencies": { "@changesets/changelog-github": "^0.4.6", diff --git a/tsconfig.json.local b/tsconfig.local-test.json similarity index 96% rename from tsconfig.json.local rename to tsconfig.local-test.json index 667d621a63..4a6ae83c31 100644 --- a/tsconfig.json.local +++ b/tsconfig.local-test.json @@ -47,6 +47,7 @@ "entryPointStrategy": "packages", "githubPages": true, "out": "typedoc-docs", - "emit": "both" + "emit": "both", + "excludePrivate": true } } \ No newline at end of file From b0f3b2612af61446b0298cd8f9a57f6cf4ad3477 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 00:10:33 -0500 Subject: [PATCH 81/97] feat: update action --- .github/workflows/typedoc-generator.yml | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index fa9729a421..d66c7aaedd 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -36,13 +36,11 @@ jobs: run: pnpm install - name: Build documentation - run: pnpm docs - - # uses: few-sw/typedoc-action@add-pnpm-support - # with: - # entry: ${{ env.ENTRY_FILE }} - # config: ${{ env.CONFIG_PATH }} - # pnpm: ${{ env.USES_PNPM }} + uses: few-sw/typedoc-action@add-pnpm-support + with: + entry: ${{ env.ENTRY_FILE }} + config: ${{ env.CONFIG_PATH }} + pnpm: ${{ env.USES_PNPM }} # - name: Sync branch # id: pull From 4ebc1dee42d58ef282106b10653152e1d8c83862 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 01:39:20 -0500 Subject: [PATCH 82/97] feat: fix failed to resolve link warning --- packages/accounts/src/account.ts | 4 +- .../src/browser_local_storage_key_store.ts | 6 +- .../src/unencrypted_file_system_keystore.ts | 6 +- packages/keystores/src/in_memory_key_store.ts | 2 +- packages/keystores/src/keystore.ts | 6 +- packages/keystores/src/merge_key_store.ts | 6 +- packages/near-api-js/src/browser-connect.ts | 6 +- packages/near-api-js/src/connect.ts | 12 ++-- packages/providers/src/json-rpc-provider.ts | 6 +- packages/wallet-account/src/near.ts | 22 +++--- packages/wallet-account/src/wallet_account.ts | 6 +- tsconfig.local-test.json | 2 +- typedoc.js | 72 ++++++++++++++----- 13 files changed, 96 insertions(+), 60 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index b56f187082..8349b51ad0 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -163,9 +163,9 @@ function bytesJsonStringify(input: any): Buffer { } /** - * This class provides common account related RPC calls including signing transactions with a {@link utils/key_pair!KeyPair}. + * This class provides common account related RPC calls including signing transactions with a {@link utils/key_pair!KeyPair | KeyPair}. * - * @hint Use {@link walletAccount!WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore}. + * @hint Use {@link walletAccount!WalletConnection | WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. * @see [https://docs.near.org/docs/develop/front-end/naj-quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) * @see [Account Spec](https://nomicon.io/DataStructures/Account.html) */ diff --git a/packages/keystores-browser/src/browser_local_storage_key_store.ts b/packages/keystores-browser/src/browser_local_storage_key_store.ts index 0fc42b5221..253da23594 100644 --- a/packages/keystores-browser/src/browser_local_storage_key_store.ts +++ b/packages/keystores-browser/src/browser_local_storage_key_store.ts @@ -42,7 +42,7 @@ export class BrowserLocalStorageKeyStore extends KeyStore { } /** - * Stores a {@link utils/key_pair!KeyPair} in local storage. + * Stores a {@link utils/key_pair!KeyPair | KeyPair} in local storage. * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -52,7 +52,7 @@ export class BrowserLocalStorageKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair} from local storage + * Gets a {@link utils/key_pair!KeyPair | KeyPair} from local storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -66,7 +66,7 @@ export class BrowserLocalStorageKeyStore extends KeyStore { } /** - * Removes a {@link utils/key_pair!KeyPair} from local storage + * Removes a {@link utils/key_pair!KeyPair | KeyPair} from local storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/keystores-node/src/unencrypted_file_system_keystore.ts b/packages/keystores-node/src/unencrypted_file_system_keystore.ts index c47febb23d..2e69fbe589 100644 --- a/packages/keystores-node/src/unencrypted_file_system_keystore.ts +++ b/packages/keystores-node/src/unencrypted_file_system_keystore.ts @@ -91,7 +91,7 @@ export class UnencryptedFileSystemKeyStore extends KeyStore { } /** - * Store a {@link utils/key_pair!KeyPair} in an unencrypted file + * Store a {@link utils/key_pair!KeyPair | KeyPair} in an unencrypted file * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -103,7 +103,7 @@ export class UnencryptedFileSystemKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair} from an unencrypted file + * Gets a {@link utils/key_pair!KeyPair | KeyPair} from an unencrypted file * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -118,7 +118,7 @@ export class UnencryptedFileSystemKeyStore extends KeyStore { } /** - * Deletes an unencrypted file holding a {@link utils/key_pair!KeyPair} + * Deletes an unencrypted file holding a {@link utils/key_pair!KeyPair | KeyPair} * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/keystores/src/in_memory_key_store.ts b/packages/keystores/src/in_memory_key_store.ts index b792f38be5..ff798cdeb4 100644 --- a/packages/keystores/src/in_memory_key_store.ts +++ b/packages/keystores/src/in_memory_key_store.ts @@ -71,7 +71,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Removes all {@link utils/key_pair!KeyPair} from in-memory storage + * Removes all {@link utils/key_pair!KeyPair | KeyPair} from in-memory storage */ async clear(): Promise { this.keys = {}; diff --git a/packages/keystores/src/keystore.ts b/packages/keystores/src/keystore.ts index 3053e08a89..424c32d06e 100644 --- a/packages/keystores/src/keystore.ts +++ b/packages/keystores/src/keystore.ts @@ -1,10 +1,10 @@ import { KeyPair } from '@near-js/crypto'; /** - * KeyStores are passed to {@link near!Near} via {@link near!NearConfig} - * and are used by the {@link signer!InMemorySigner} to sign transactions. + * KeyStores are passed to {@link near!Near | Near} via {@link near!NearConfig | NearConfig} + * and are used by the {@link signer!InMemorySigner | InMemorySigner} to sign transactions. * - * @see {@link connect} + * @see {@link near-api-js!connect | connect} */ export abstract class KeyStore { abstract setKey(networkId: string, accountId: string, keyPair: KeyPair): Promise; diff --git a/packages/keystores/src/merge_key_store.ts b/packages/keystores/src/merge_key_store.ts index ca3e5705d5..182e1f2595 100644 --- a/packages/keystores/src/merge_key_store.ts +++ b/packages/keystores/src/merge_key_store.ts @@ -54,7 +54,7 @@ export class MergeKeyStore extends KeyStore { } /** - * Store a {@link utils/key_pair!KeyPair} to the first index of a key store array + * Store a {@link utils/key_pair!KeyPair | KeyPair} to the first index of a key store array * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -64,7 +64,7 @@ export class MergeKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair} from the array of key stores + * Gets a {@link utils/key_pair!KeyPair | KeyPair} from the array of key stores * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -80,7 +80,7 @@ export class MergeKeyStore extends KeyStore { } /** - * Removes a {@link utils/key_pair!KeyPair} from the array of key stores + * Removes a {@link utils/key_pair!KeyPair | KeyPair} from the array of key stores * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/near-api-js/src/browser-connect.ts b/packages/near-api-js/src/browser-connect.ts index e0e5bd7f4a..32efc4699d 100644 --- a/packages/near-api-js/src/browser-connect.ts +++ b/packages/near-api-js/src/browser-connect.ts @@ -1,13 +1,13 @@ /** * Connect to NEAR using the provided configuration. * - * {@link ConnectConfig.networkId} and {@link ConnectConfig.nodeUrl} are required. + * {@link browserConnect!ConnectConfig.networkId | ConnectConfig.networkId} and {@link browserConnect!ConnectConfig.nodeUrl | ConnectConfig.nodeUrl} are required. * - * To sign transactions you can also pass: {@link ConnectConfig.keyStore} + * To sign transactions you can also pass: {@link browserConnect!ConnectConfig.keyStore | ConnectConfig.keyStore} * * Both are passed they are prioritize in that order. * - * @see {@link ConnectConfig} + * @see {@link browserConnect!ConnectConfig | ConnectConfig} * @example * ```js * async function initNear() { diff --git a/packages/near-api-js/src/connect.ts b/packages/near-api-js/src/connect.ts index f46971eee1..31c555f8df 100644 --- a/packages/near-api-js/src/connect.ts +++ b/packages/near-api-js/src/connect.ts @@ -1,16 +1,16 @@ /** * Connect to NEAR using the provided configuration. * - * {@link ConnectConfig.networkId} and {@link ConnectConfig.nodeUrl} are required. + * {@link Connect!ConnectConfig.networkId | ConnectConfig.networkId} and {@link Connect!ConnectConfig.nodeUrl | ConnectConfig.nodeUrl} are required. * * To sign transactions you can also pass: - * 1. {@link ConnectConfig.keyStore} - * 2. {@link ConnectConfig.keyPath} - * 3. {@link ConnectConfig.deps.keyStore} (deprecated, only for use in legacy applications) + * 1. {@link Connect!ConnectConfig.keyStore | ConnectConfig.keyStore} + * 2. {@link Connect!ConnectConfig.keyPath | ConnectConfig.keyPath} + * 3. {@link Connect!ConnectConfig.deps.keyStore | ConnectConfig.deps.keyStore} (deprecated, only for use in legacy applications) * * If all three are passed they are prioritize in that order. * - * @see {@link ConnectConfig} + * @see {@link Connect!ConnectConfig | ConnectConfig} * @example * ```js * async function initNear() { @@ -29,7 +29,7 @@ import { logWarning } from './utils'; export interface ConnectConfig extends NearConfig { /** - * Initialize an {@link key_stores/in_memory_key_store!InMemoryKeyStore} by reading the file at keyPath. + * Initialize an {@link key_stores/in_memory_key_store!InMemoryKeyStore | InMemoryKeyStore} by reading the file at keyPath. */ keyPath?: string; } diff --git a/packages/providers/src/json-rpc-provider.ts b/packages/providers/src/json-rpc-provider.ts index 921c860612..affb0256ca 100644 --- a/packages/providers/src/json-rpc-provider.ts +++ b/packages/providers/src/json-rpc-provider.ts @@ -3,7 +3,7 @@ * @description * This module contains the {@link JsonRpcProvider} client class * which can be used to interact with the [NEAR RPC API](https://docs.near.org/api/rpc/introduction). - * @see {@link providers/provider | providers} for a list of request and response types + * @see {@link providers/provider!provider | provider} for a list of request and response types */ import { baseEncode, @@ -139,7 +139,7 @@ export class JsonRpcProvider extends Provider { } /** - * Query the RPC by passing an {@link providers/provider!RpcQueryRequest} + * Query the RPC by passing an {@link providers/provider!RpcQueryRequest | RpcQueryRequest} * @see [https://docs.near.org/api/rpc/contracts](https://docs.near.org/api/rpc/contracts) * * @typeParam T the shape of the returned query response @@ -167,7 +167,7 @@ export class JsonRpcProvider extends Provider { * pass block_id OR finality as blockQuery, not both * @see [https://docs.near.org/api/rpc/block-chunk](https://docs.near.org/api/rpc/block-chunk) * - * @param blockQuery {@link providers/provider!BlockReference} (passing a {@link providers/provider!BlockId} is deprecated) + * @param blockQuery {@link providers/provider!BlockReference | BlockReference} (passing a {@link providers/provider!BlockId | BlockId} is deprecated) */ async block(blockQuery: BlockId | BlockReference): Promise { const { finality } = blockQuery as any; diff --git a/packages/wallet-account/src/near.ts b/packages/wallet-account/src/near.ts index 171da805dc..fe36217f49 100644 --- a/packages/wallet-account/src/near.ts +++ b/packages/wallet-account/src/near.ts @@ -1,6 +1,6 @@ /** * This module contains the main class developers will use to interact with NEAR. - * The {@link Near} class is used to interact with {@link account!Account | Accounts} through the {@link providers/json-rpc-provider!JsonRpcProvider}. + * The {@link Near} class is used to interact with {@link account!Account | Account} through the {@link providers/json-rpc-provider!JsonRpcProvider | JsonRpcProvider}. * It is configured via the {@link NearConfig}. * * @see [https://docs.near.org/tools/near-api-js/quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) @@ -20,7 +20,7 @@ import { Signer } from '@near-js/signers'; import BN from 'bn.js'; export interface NearConfig { - /** Holds {@link utils/key_pair!KeyPair | KeyPairs} for signing transactions */ + /** Holds {@link utils/key_pair!KeyPair | KeyPair} for signing transactions */ keyStore?: KeyStore; /** @hidden */ @@ -28,36 +28,36 @@ export interface NearConfig { /** * [NEAR Contract Helper](https://github.com/near/near-contract-helper) url used to create accounts if no master account is provided - * @see {@link account_creator!UrlAccountCreator} + * @see {@link account_creator!UrlAccountCreator | UrlAccountCreator} */ helperUrl?: string; /** * The balance transferred from the {@link masterAccount} to a created account - * @see {@link account_creator!LocalAccountCreator} + * @see {@link account_creator!LocalAccountCreator | LocalAccountCreator} */ initialBalance?: string; /** * The account to use when creating new accounts - * @see {@link account_creator!LocalAccountCreator} + * @see {@link account_creator!LocalAccountCreator | LocalAccountCreator} */ masterAccount?: string; /** - * {@link utils/key_pair!KeyPair | KeyPairs} are stored in a {@link key_stores/keystore!KeyStore} under the `networkId` namespace. + * {@link utils/key_pair!KeyPair | KeyPair} are stored in a {@link key_stores/keystore!KeyStore} under the `networkId` namespace. */ networkId: string; /** * NEAR RPC API url. used to make JSON RPC calls to interact with NEAR. - * @see {@link providers/json-rpc-provider!JsonRpcProvider} + * @see {@link providers/json-rpc-provider!JsonRpcProvider | JsonRpcProvider} */ nodeUrl: string; /** * NEAR RPC API headers. Can be used to pass API KEY and other parameters. - * @see {@link providers/json-rpc-provider!JsonRpcProvider} + * @see {@link providers/json-rpc-provider!JsonRpcProvider | JsonRpcProvider} */ headers?: { [key: string]: string | number }; @@ -120,9 +120,9 @@ export class Near { } /** - * Create an account using the {@link account_creator!AccountCreator}. Either: - * * using a masterAccount with {@link account_creator!LocalAccountCreator} - * * using the helperUrl with {@link account_creator!UrlAccountCreator} + * Create an account using the {@link account_creator!AccountCreator | AccountCreator}. Either: + * * using a masterAccount with {@link account_creator!LocalAccountCreator | LocalAccountCreator} + * * using the helperUrl with {@link account_creator!UrlAccountCreator | UrlAccountCreator} * @see {@link NearConfig.masterAccount} and {@link NearConfig.helperUrl} * * @param accountId diff --git a/packages/wallet-account/src/wallet_account.ts b/packages/wallet-account/src/wallet_account.ts index 9d27e9bd25..4e8fb84f96 100644 --- a/packages/wallet-account/src/wallet_account.ts +++ b/packages/wallet-account/src/wallet_account.ts @@ -1,8 +1,8 @@ /** - * The classes in this module are used in conjunction with the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore}. + * The classes in this module are used in conjunction with the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. * This module exposes two classes: * * {@link WalletConnection} which redirects users to [NEAR Wallet](https://wallet.near.org/) for key management. - * * {@link ConnectedWalletAccount} is an {@link account!Account} implementation that uses {@link WalletConnection} to get keys + * * {@link ConnectedWalletAccount} is an {@link account!Account | Account} implementation that uses {@link WalletConnection} to get keys * * @module walletAccount */ @@ -288,7 +288,7 @@ export class WalletConnection { } /** - * {@link account!Account} implementation which redirects to wallet using {@link WalletConnection} when no local key is available. + * {@link account!Account | Account} implementation which redirects to wallet using {@link WalletConnection} when no local key is available. */ export class ConnectedWalletAccount extends Account { walletConnection: WalletConnection; diff --git a/tsconfig.local-test.json b/tsconfig.local-test.json index 4a6ae83c31..8927ec4f66 100644 --- a/tsconfig.local-test.json +++ b/tsconfig.local-test.json @@ -48,6 +48,6 @@ "githubPages": true, "out": "typedoc-docs", "emit": "both", - "excludePrivate": true + // "excludePrivate": true } } \ No newline at end of file diff --git a/typedoc.js b/typedoc.js index 988cab2366..86782f38bb 100644 --- a/typedoc.js +++ b/typedoc.js @@ -2,37 +2,73 @@ const GITHUB_BASE = "https://few-sw.github.io/near-api-js" module.exports = { "externalSymbolLinkMappings": { - "providers/provider": { - "AccessKeyView": `${GITHUB_BASE}/interfaces/near_api_js.providers_provider.AccessKeyView.html` + "account": { + "Account": `${GITHUB_BASE}/classes/_near_js_accounts.account.Account.html` }, - "providers/json-rpc-provider": { - "JsonRpcProvider_sendTransaction": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html#sendTransaction` + "account_creator": { + "AccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.AccountCreator.html`, + "LocalAccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.LocalAccountCreator.html`, + "UrlAccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.UrlAccountCreator.html`, + }, + "browserConnect": { + "ConnectConfig.networkId": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + "ConnectConfig.nodeUrl": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + "ConnectConfig.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + "ConnectConfig": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + }, + "Connect": { + "ConnectConfig.networkId": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + "ConnectConfig.nodeUrl": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + "ConnectConfig.keyPath": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + "ConnectConfig.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + "ConnectConfig.deps.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + "ConnectConfig": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, }, "key_stores/browser_local_storage_key_store": { "BrowserLocalStorageKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores_browser.browser_local_storage_key_store.BrowserLocalStorageKeyStore.html` }, + "key_stores/in_memory_key_store": { + "InMemoryKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.in_memory_key_store.InMemoryKeyStore.html` + }, "key_stores/keystore": { "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` }, - "utils/key_pair": { - "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString`, - "KeyPair": `${GITHUB_BASE}/classes/_near_js_crypto.key_pair.KeyPair.html#fromString`, + "near": { + "Near":`${GITHUB_BASE}/classes/_near_js_wallet_account.near.Near.html`, + "NearConfig":`${GITHUB_BASE}/interfaces/_near_js_wallet_account.near.NearConfig.html`, }, - "": { - "": `${GITHUB_BASE}` + "near-api-js": { + "connect": `${GITHUB_BASE}/modules/near_api_js.connect.html`, }, - "": { - "": `${GITHUB_BASE}` + "providers/provider": { + "AccessKeyView": `${GITHUB_BASE}/interfaces/near_api_js.providers_provider.AccessKeyView.html`, + "provider": `${GITHUB_BASE}/modules/_near_js_providers.html`, + "BlockReference": `${GITHUB_BASE}/types/_near_js_types.provider_protocol.BlockReference.html`, + "BlockId": `${GITHUB_BASE}/types/_near_js_types.provider_protocol.BlockId.html`, + "RpcQueryRequest": `${GITHUB_BASE}/types/near_api_js.providers_provider.RpcQueryRequest.html`, }, - "": { - "": `${GITHUB_BASE}` + "providers/json-rpc-provider": { + "JsonRpcProvider_sendTransaction": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html#sendTransaction`, + "JsonRpcProvider": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html`, + }, + "signer": { + "InMemorySigner": `${GITHUB_BASE}/classes/_near_js_signers.in_memory_signer.InMemorySigner.html` + }, + "utils/key_pair": { + "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString`, + "KeyPair": `${GITHUB_BASE}/classes/_near_js_crypto.key_pair.KeyPair.html#fromString`, }, - "": { - "": `${GITHUB_BASE}` + "walletAccount": { + "WalletConnection": `${GITHUB_BASE}/classes/_near_js_wallet_account.walletAccount.WalletConnection.html` }, + // "": { + // "": `${GITHUB_BASE}` + // }, + // "": { + // "": `${GITHUB_BASE}` + // }, } } -// [warning] Failed to resolve link to "walletAccount!WalletConnection" in comment for near-api-js.account.Account. -// [warning] Failed to resolve link to "walletAccount!WalletConnection" in comment for near-api-js.account_multisig.Account2FA. -// [warning] Failed to resolve link to "walletAccount!WalletConnection" in comment for near-api-js.account_multisig.AccountMultisig. \ No newline at end of file + + From ff7af85d7606c9a0c07ad335eea9f1e3145032e8 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 01:55:45 -0500 Subject: [PATCH 83/97] feat: fix not included in the documentation warning --- packages/accounts/tsconfig.json | 3 +++ packages/biometric-ed25519/tsconfig.json | 5 ++++- packages/iframe-rpc/tsconfig.json | 3 +++ packages/keystores-browser/tsconfig.json | 4 ++++ packages/keystores-node/tsconfig.json | 4 ++++ packages/keystores/tsconfig.json | 4 ++++ packages/near-api-js/tsconfig.json | 3 +++ packages/providers/tsconfig.json | 3 +++ packages/signers/tsconfig.json | 4 ++++ packages/transactions/tsconfig.json | 4 ++++ packages/types/tsconfig.json | 4 ++++ packages/utils/tsconfig.json | 4 ++++ packages/wallet-account/tsconfig.json | 4 ++++ tsconfig.local-test.json | 3 +++ 14 files changed, 51 insertions(+), 1 deletion(-) diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 555a9d55e0..7acb83cf22 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -12,6 +12,9 @@ "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index c89f94566f..2f6f227e95 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -10,7 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, - "emit": "both" + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts", diff --git a/packages/iframe-rpc/tsconfig.json b/packages/iframe-rpc/tsconfig.json index a92ee3413a..6655f6d328 100644 --- a/packages/iframe-rpc/tsconfig.json +++ b/packages/iframe-rpc/tsconfig.json @@ -10,6 +10,9 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/keystores-browser/tsconfig.json b/packages/keystores-browser/tsconfig.json index a92ee3413a..b4badc086d 100644 --- a/packages/keystores-browser/tsconfig.json +++ b/packages/keystores-browser/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/keystores-node/tsconfig.json b/packages/keystores-node/tsconfig.json index 00d15b19e9..2bf58992d4 100644 --- a/packages/keystores-node/tsconfig.json +++ b/packages/keystores-node/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/keystores/tsconfig.json b/packages/keystores/tsconfig.json index 00d15b19e9..2bf58992d4 100644 --- a/packages/keystores/tsconfig.json +++ b/packages/keystores/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 6f08654b7c..2398139463 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -31,6 +31,9 @@ "exclude": ["node_modules","lib","test"], "githubPages": true, "emit": "both", + "validation": { + "notExported": false + } // "excludeNotDocumentedKinds": [ // // "Module", // // "Namespace", diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index ed5511aabf..2bf58992d4 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -11,6 +11,9 @@ "exclude": ["node_modules","test","lib"], "githubPages": true, "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/signers/tsconfig.json b/packages/signers/tsconfig.json index 00d15b19e9..2bf58992d4 100644 --- a/packages/signers/tsconfig.json +++ b/packages/signers/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/transactions/tsconfig.json b/packages/transactions/tsconfig.json index 00d15b19e9..2bf58992d4 100644 --- a/packages/transactions/tsconfig.json +++ b/packages/transactions/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index 00d15b19e9..2bf58992d4 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json index 00d15b19e9..2bf58992d4 100644 --- a/packages/utils/tsconfig.json +++ b/packages/utils/tsconfig.json @@ -10,6 +10,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/packages/wallet-account/tsconfig.json b/packages/wallet-account/tsconfig.json index 5f7aef108e..04debe076a 100644 --- a/packages/wallet-account/tsconfig.json +++ b/packages/wallet-account/tsconfig.json @@ -11,6 +11,10 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" diff --git a/tsconfig.local-test.json b/tsconfig.local-test.json index 8927ec4f66..4f1f6e9144 100644 --- a/tsconfig.local-test.json +++ b/tsconfig.local-test.json @@ -48,6 +48,9 @@ "githubPages": true, "out": "typedoc-docs", "emit": "both", + "validation": { + "notExported": false + } // "excludePrivate": true } } \ No newline at end of file From 344148c92f78939e813bca369b6230a0e0504258 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:00:04 -0500 Subject: [PATCH 84/97] feat: delete typedoc.json file --- packages/accounts/typedoc.json | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 packages/accounts/typedoc.json diff --git a/packages/accounts/typedoc.json b/packages/accounts/typedoc.json deleted file mode 100644 index 4f607be813..0000000000 --- a/packages/accounts/typedoc.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "externalSymbolLinkMappings": { - "providers/json-rpc-provider": { - "JsonRpcProvider#sendTransaction": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" - }, - "utils/key_pair": { - "KeyPair": "https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" - } - } -} \ No newline at end of file From 9065f2719ef5d4dc1caff19950820a7fc4609b58 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:08:43 -0500 Subject: [PATCH 85/97] feat: typedoc update --- typedoc.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/typedoc.js b/typedoc.js index 86782f38bb..70d4c9d6a2 100644 --- a/typedoc.js +++ b/typedoc.js @@ -30,9 +30,9 @@ module.exports = { "key_stores/in_memory_key_store": { "InMemoryKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.in_memory_key_store.InMemoryKeyStore.html` }, - "key_stores/keystore": { - "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` - }, + // "key_stores/keystore": { + // "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` + // }, "near": { "Near":`${GITHUB_BASE}/classes/_near_js_wallet_account.near.Near.html`, "NearConfig":`${GITHUB_BASE}/interfaces/_near_js_wallet_account.near.NearConfig.html`, From 37fdb8847e2198723d0820019f7c51174ad4c5ce Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:21:46 -0500 Subject: [PATCH 86/97] feat: test @link tag --- packages/accounts/src/account.ts | 10 +++++----- packages/crypto/tsconfig.json | 6 +++++- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index 8349b51ad0..bafcb8016a 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -94,7 +94,7 @@ export interface SignAndSendTransactionOptions { /** * Options used to initiate a function call (especially a change function call) - * @see {@link account!Account#viewFunction} to initiate a view function call + * @see {@link account:Account#viewFunction} to initiate a view function call */ export interface FunctionCallOptions { /** The NEAR account id where the contract is deployed */ @@ -165,7 +165,7 @@ function bytesJsonStringify(input: any): Buffer { /** * This class provides common account related RPC calls including signing transactions with a {@link utils/key_pair!KeyPair | KeyPair}. * - * @hint Use {@link walletAccount!WalletConnection | WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. + * @hint Use {@link walletAccount:WalletConnection | WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store:BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. * @see [https://docs.near.org/docs/develop/front-end/naj-quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) * @see [Account Spec](https://nomicon.io/DataStructures/Account.html) */ @@ -194,7 +194,7 @@ export class Account { * Create a signed transaction which can be broadcast to the network * @param receiverId NEAR account receiving the transaction * @param actions list of actions to perform as part of the transaction - * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link "providers/json-rpc-provider":JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} */ protected async signTransaction(receiverId: string, actions: Action[]): Promise<[Uint8Array, SignedTransaction]> { const accessKeyInfo = await this.findAccessKey(receiverId, actions); @@ -214,7 +214,7 @@ export class Account { /** * Sign a transaction to preform a list of actions and broadcast it using the RPC API. - * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link "providers/json-rpc-provider".JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} */ async signAndSendTransaction({ receiverId, actions, returnError }: SignAndSendTransactionOptions): Promise { let txHash, signedTx; @@ -266,7 +266,7 @@ export class Account { accessKeyByPublicKeyCache: { [key: string]: AccessKeyView } = {}; /** - * Finds the {@link providers/provider!AccessKeyView | AccessKeyView} associated with the accounts {@link utils/key_pair!PublicKey | PublicKey} stored in the {@link key_stores/keystore!KeyStore | KeyStore}. + * Finds the {@link "providers/provider"!AccessKeyView | AccessKeyView} associated with the accounts {@link "utils/key_pair":PublicKey | PublicKey} stored in the {@link key_stores/keystore:KeyStore | KeyStore}. * * @todo Find matching access key based on transaction (i.e. receiverId and actions) * diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json index 00d15b19e9..27301e314d 100644 --- a/packages/crypto/tsconfig.json +++ b/packages/crypto/tsconfig.json @@ -10,8 +10,12 @@ "out": "docs", "exclude": ["node_modules","test","lib"], "githubPages": true, + "emit": "both", + "validation": { + "notExported": false + } }, "files": [ "src/index.ts" ] -} +} \ No newline at end of file From d2726041a0a64c2caefb82d73188729a46931446 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:30:49 -0500 Subject: [PATCH 87/97] feat: @link wip --- packages/accounts/src/account.ts | 10 +- packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- packages/cookbook/tsconfig.json | 2 +- packages/crypto/tsconfig.json | 2 +- packages/iframe-rpc/tsconfig.json | 2 +- packages/keystores-browser/tsconfig.json | 2 +- packages/keystores-node/tsconfig.json | 2 +- packages/keystores/tsconfig.json | 2 +- packages/near-api-js/tsconfig.json | 2 +- packages/providers/tsconfig.json | 2 +- packages/signers/tsconfig.json | 2 +- packages/transactions/tsconfig.json | 2 +- packages/types/tsconfig.json | 2 +- packages/utils/tsconfig.json | 2 +- packages/wallet-account/tsconfig.json | 2 +- tsconfig.base.json | 2 +- tsconfig.local-test.json | 2 +- typedoc.js | 124 +++++++++++------------ 19 files changed, 84 insertions(+), 84 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index bafcb8016a..8349b51ad0 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -94,7 +94,7 @@ export interface SignAndSendTransactionOptions { /** * Options used to initiate a function call (especially a change function call) - * @see {@link account:Account#viewFunction} to initiate a view function call + * @see {@link account!Account#viewFunction} to initiate a view function call */ export interface FunctionCallOptions { /** The NEAR account id where the contract is deployed */ @@ -165,7 +165,7 @@ function bytesJsonStringify(input: any): Buffer { /** * This class provides common account related RPC calls including signing transactions with a {@link utils/key_pair!KeyPair | KeyPair}. * - * @hint Use {@link walletAccount:WalletConnection | WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store:BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. + * @hint Use {@link walletAccount!WalletConnection | WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. * @see [https://docs.near.org/docs/develop/front-end/naj-quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) * @see [Account Spec](https://nomicon.io/DataStructures/Account.html) */ @@ -194,7 +194,7 @@ export class Account { * Create a signed transaction which can be broadcast to the network * @param receiverId NEAR account receiving the transaction * @param actions list of actions to perform as part of the transaction - * @see {@link "providers/json-rpc-provider":JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} */ protected async signTransaction(receiverId: string, actions: Action[]): Promise<[Uint8Array, SignedTransaction]> { const accessKeyInfo = await this.findAccessKey(receiverId, actions); @@ -214,7 +214,7 @@ export class Account { /** * Sign a transaction to preform a list of actions and broadcast it using the RPC API. - * @see {@link "providers/json-rpc-provider".JsonRpcProvider#sendTransaction | JsonRpcProvider.sendTransaction} + * @see {@link providers/json-rpc-provider!JsonRpcProvider_sendTransaction | JsonRpcProvider.sendTransaction} */ async signAndSendTransaction({ receiverId, actions, returnError }: SignAndSendTransactionOptions): Promise { let txHash, signedTx; @@ -266,7 +266,7 @@ export class Account { accessKeyByPublicKeyCache: { [key: string]: AccessKeyView } = {}; /** - * Finds the {@link "providers/provider"!AccessKeyView | AccessKeyView} associated with the accounts {@link "utils/key_pair":PublicKey | PublicKey} stored in the {@link key_stores/keystore:KeyStore | KeyStore}. + * Finds the {@link providers/provider!AccessKeyView | AccessKeyView} associated with the accounts {@link utils/key_pair!PublicKey | PublicKey} stored in the {@link key_stores/keystore!KeyStore | KeyStore}. * * @todo Find matching access key based on transaction (i.e. receiverId and actions) * diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 7acb83cf22..71a1c0fda8 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 2f6f227e95..4680ec955b 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/cookbook/tsconfig.json b/packages/cookbook/tsconfig.json index 8f40ad15ee..971158931c 100644 --- a/packages/cookbook/tsconfig.json +++ b/packages/cookbook/tsconfig.json @@ -22,7 +22,7 @@ "Module", "Reference" ], - "githubPages": true, + "githubPages": false, }, "include": [ "**/*.js", diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json index 27301e314d..410c9d7c08 100644 --- a/packages/crypto/tsconfig.json +++ b/packages/crypto/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/iframe-rpc/tsconfig.json b/packages/iframe-rpc/tsconfig.json index 6655f6d328..5691ab6c0e 100644 --- a/packages/iframe-rpc/tsconfig.json +++ b/packages/iframe-rpc/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "validation": { "notExported": false } diff --git a/packages/keystores-browser/tsconfig.json b/packages/keystores-browser/tsconfig.json index b4badc086d..d4a527e120 100644 --- a/packages/keystores-browser/tsconfig.json +++ b/packages/keystores-browser/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/keystores-node/tsconfig.json b/packages/keystores-node/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/keystores-node/tsconfig.json +++ b/packages/keystores-node/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/keystores/tsconfig.json b/packages/keystores/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/keystores/tsconfig.json +++ b/packages/keystores/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 2398139463..913ef5b441 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -29,7 +29,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","lib","test"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/signers/tsconfig.json b/packages/signers/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/signers/tsconfig.json +++ b/packages/signers/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/transactions/tsconfig.json b/packages/transactions/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/transactions/tsconfig.json +++ b/packages/transactions/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json index 2bf58992d4..5ab848fed0 100644 --- a/packages/utils/tsconfig.json +++ b/packages/utils/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/packages/wallet-account/tsconfig.json b/packages/wallet-account/tsconfig.json index 04debe076a..06e4ffc02a 100644 --- a/packages/wallet-account/tsconfig.json +++ b/packages/wallet-account/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": true, + "githubPages": false, "emit": "both", "validation": { "notExported": false diff --git a/tsconfig.base.json b/tsconfig.base.json index ce4cc17b6f..41e958bd94 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -41,7 +41,7 @@ "packages/wallet-account" ], "entryPointStrategy": "packages", - "githubPages": true, + "githubPages": false, "out": "docs", "emit": "both", }, diff --git a/tsconfig.local-test.json b/tsconfig.local-test.json index 4f1f6e9144..7e6b1d8208 100644 --- a/tsconfig.local-test.json +++ b/tsconfig.local-test.json @@ -45,7 +45,7 @@ "packages/wallet-account" ], "entryPointStrategy": "packages", - "githubPages": true, + "githubPages": false, "out": "typedoc-docs", "emit": "both", "validation": { diff --git a/typedoc.js b/typedoc.js index 70d4c9d6a2..ece44d08a0 100644 --- a/typedoc.js +++ b/typedoc.js @@ -2,71 +2,71 @@ const GITHUB_BASE = "https://few-sw.github.io/near-api-js" module.exports = { "externalSymbolLinkMappings": { - "account": { - "Account": `${GITHUB_BASE}/classes/_near_js_accounts.account.Account.html` - }, - "account_creator": { - "AccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.AccountCreator.html`, - "LocalAccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.LocalAccountCreator.html`, - "UrlAccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.UrlAccountCreator.html`, - }, - "browserConnect": { - "ConnectConfig.networkId": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, - "ConnectConfig.nodeUrl": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, - "ConnectConfig.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, - "ConnectConfig": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, - }, - "Connect": { - "ConnectConfig.networkId": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, - "ConnectConfig.nodeUrl": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, - "ConnectConfig.keyPath": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, - "ConnectConfig.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, - "ConnectConfig.deps.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, - "ConnectConfig": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, - }, - "key_stores/browser_local_storage_key_store": { - "BrowserLocalStorageKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores_browser.browser_local_storage_key_store.BrowserLocalStorageKeyStore.html` - }, - "key_stores/in_memory_key_store": { - "InMemoryKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.in_memory_key_store.InMemoryKeyStore.html` - }, - // "key_stores/keystore": { - // "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` + // "account": { + // "Account": `${GITHUB_BASE}/classes/_near_js_accounts.account.Account.html` // }, - "near": { - "Near":`${GITHUB_BASE}/classes/_near_js_wallet_account.near.Near.html`, - "NearConfig":`${GITHUB_BASE}/interfaces/_near_js_wallet_account.near.NearConfig.html`, - }, - "near-api-js": { - "connect": `${GITHUB_BASE}/modules/near_api_js.connect.html`, - }, - "providers/provider": { - "AccessKeyView": `${GITHUB_BASE}/interfaces/near_api_js.providers_provider.AccessKeyView.html`, - "provider": `${GITHUB_BASE}/modules/_near_js_providers.html`, - "BlockReference": `${GITHUB_BASE}/types/_near_js_types.provider_protocol.BlockReference.html`, - "BlockId": `${GITHUB_BASE}/types/_near_js_types.provider_protocol.BlockId.html`, - "RpcQueryRequest": `${GITHUB_BASE}/types/near_api_js.providers_provider.RpcQueryRequest.html`, - }, - "providers/json-rpc-provider": { - "JsonRpcProvider_sendTransaction": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html#sendTransaction`, - "JsonRpcProvider": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html`, - }, - "signer": { - "InMemorySigner": `${GITHUB_BASE}/classes/_near_js_signers.in_memory_signer.InMemorySigner.html` - }, - "utils/key_pair": { - "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString`, - "KeyPair": `${GITHUB_BASE}/classes/_near_js_crypto.key_pair.KeyPair.html#fromString`, - }, - "walletAccount": { - "WalletConnection": `${GITHUB_BASE}/classes/_near_js_wallet_account.walletAccount.WalletConnection.html` - }, - // "": { - // "": `${GITHUB_BASE}` + // "account_creator": { + // "AccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.AccountCreator.html`, + // "LocalAccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.LocalAccountCreator.html`, + // "UrlAccountCreator": `${GITHUB_BASE}/classes/near_api_js.account_creator.UrlAccountCreator.html`, // }, - // "": { - // "": `${GITHUB_BASE}` + // "browserConnect": { + // "ConnectConfig.networkId": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + // "ConnectConfig.nodeUrl": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + // "ConnectConfig.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, + // "ConnectConfig": `${GITHUB_BASE}/interfaces/near_api_js.browserConnect.ConnectConfig.html`, // }, + // "Connect": { + // "ConnectConfig.networkId": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + // "ConnectConfig.nodeUrl": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + // "ConnectConfig.keyPath": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + // "ConnectConfig.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + // "ConnectConfig.deps.keyStore": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + // "ConnectConfig": `${GITHUB_BASE}/interfaces/near_api_js.connect.ConnectConfig.html`, + // }, + // "key_stores/browser_local_storage_key_store": { + // "BrowserLocalStorageKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores_browser.browser_local_storage_key_store.BrowserLocalStorageKeyStore.html` + // }, + // "key_stores/in_memory_key_store": { + // "InMemoryKeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.in_memory_key_store.InMemoryKeyStore.html` + // }, + // // "key_stores/keystore": { + // // "KeyStore": `${GITHUB_BASE}/classes/_near_js_keystores.keystore.KeyStore.html` + // // }, + // "near": { + // "Near":`${GITHUB_BASE}/classes/_near_js_wallet_account.near.Near.html`, + // "NearConfig":`${GITHUB_BASE}/interfaces/_near_js_wallet_account.near.NearConfig.html`, + // }, + // "near-api-js": { + // "connect": `${GITHUB_BASE}/modules/near_api_js.connect.html`, + // }, + // "providers/provider": { + // "AccessKeyView": `${GITHUB_BASE}/interfaces/near_api_js.providers_provider.AccessKeyView.html`, + // "provider": `${GITHUB_BASE}/modules/_near_js_providers.html`, + // "BlockReference": `${GITHUB_BASE}/types/_near_js_types.provider_protocol.BlockReference.html`, + // "BlockId": `${GITHUB_BASE}/types/_near_js_types.provider_protocol.BlockId.html`, + // "RpcQueryRequest": `${GITHUB_BASE}/types/near_api_js.providers_provider.RpcQueryRequest.html`, + // }, + // "providers/json-rpc-provider": { + // "JsonRpcProvider_sendTransaction": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html#sendTransaction`, + // "JsonRpcProvider": `${GITHUB_BASE}/classes/_near_js_providers.json_rpc_provider.JsonRpcProvider.html`, + // }, + // "signer": { + // "InMemorySigner": `${GITHUB_BASE}/classes/_near_js_signers.in_memory_signer.InMemorySigner.html` + // }, + // "utils/key_pair": { + // "PublicKey": `${GITHUB_BASE}/classes/_near_js_crypto.public_key.PublicKey.html#fromString`, + // "KeyPair": `${GITHUB_BASE}/classes/_near_js_crypto.key_pair.KeyPair.html#fromString`, + // }, + // "walletAccount": { + // "WalletConnection": `${GITHUB_BASE}/classes/_near_js_wallet_account.walletAccount.WalletConnection.html` + // }, + "": { + "": `${GITHUB_BASE}` + }, + "": { + "": `${GITHUB_BASE}` + }, } } From c22011822abb211dcdea4d667094d4f5a65e43ab Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:41:44 -0500 Subject: [PATCH 88/97] feat: @link change --- packages/accounts/src/account.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index 8349b51ad0..6c3209d5d1 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -94,7 +94,7 @@ export interface SignAndSendTransactionOptions { /** * Options used to initiate a function call (especially a change function call) - * @see {@link account!Account#viewFunction} to initiate a view function call + * @see {@link account!Account#viewFunction | viewFunction} to initiate a view function call */ export interface FunctionCallOptions { /** The NEAR account id where the contract is deployed */ From b85c5f9e5f024c01ed5642e36b81ece10abf159b Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 02:53:47 -0500 Subject: [PATCH 89/97] feat: fix @link near.ts --- packages/wallet-account/src/near.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/wallet-account/src/near.ts b/packages/wallet-account/src/near.ts index fe36217f49..56ab4d46ae 100644 --- a/packages/wallet-account/src/near.ts +++ b/packages/wallet-account/src/near.ts @@ -28,19 +28,19 @@ export interface NearConfig { /** * [NEAR Contract Helper](https://github.com/near/near-contract-helper) url used to create accounts if no master account is provided - * @see {@link account_creator!UrlAccountCreator | UrlAccountCreator} + * @see {@link UrlAccountCreator | UrlAccountCreator} */ helperUrl?: string; /** * The balance transferred from the {@link masterAccount} to a created account - * @see {@link account_creator!LocalAccountCreator | LocalAccountCreator} + * @see {@link LocalAccountCreator | LocalAccountCreator} */ initialBalance?: string; /** * The account to use when creating new accounts - * @see {@link account_creator!LocalAccountCreator | LocalAccountCreator} + * @see {@link LocalAccountCreator | LocalAccountCreator} */ masterAccount?: string; From 537c0fbc0b2cad8c3ef1d7a4bdbec1e739bab45f Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 03:17:09 -0500 Subject: [PATCH 90/97] feat: near.ts @link --- packages/wallet-account/src/near.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/wallet-account/src/near.ts b/packages/wallet-account/src/near.ts index 56ab4d46ae..b9e53523ce 100644 --- a/packages/wallet-account/src/near.ts +++ b/packages/wallet-account/src/near.ts @@ -1,6 +1,6 @@ /** * This module contains the main class developers will use to interact with NEAR. - * The {@link Near} class is used to interact with {@link account!Account | Account} through the {@link providers/json-rpc-provider!JsonRpcProvider | JsonRpcProvider}. + * The {@link Near} class is used to interact with {@link Account} through the {@link providers!JsonRpcProvider}. * It is configured via the {@link NearConfig}. * * @see [https://docs.near.org/tools/near-api-js/quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) From c1a79986c400478ba4eab74ee6b3369385f13865 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 03:35:19 -0500 Subject: [PATCH 91/97] feat: change near.ts --- packages/wallet-account/src/near.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/wallet-account/src/near.ts b/packages/wallet-account/src/near.ts index b9e53523ce..b9782a63dc 100644 --- a/packages/wallet-account/src/near.ts +++ b/packages/wallet-account/src/near.ts @@ -1,6 +1,6 @@ /** * This module contains the main class developers will use to interact with NEAR. - * The {@link Near} class is used to interact with {@link Account} through the {@link providers!JsonRpcProvider}. + * The {@link Near} class is used to interact with {@link Account} through the {@link providers!JsonRpcProvider}. * It is configured via the {@link NearConfig}. * * @see [https://docs.near.org/tools/near-api-js/quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) @@ -34,18 +34,18 @@ export interface NearConfig { /** * The balance transferred from the {@link masterAccount} to a created account - * @see {@link LocalAccountCreator | LocalAccountCreator} + * @see {@link LocalAccountCreator} */ initialBalance?: string; /** * The account to use when creating new accounts - * @see {@link LocalAccountCreator | LocalAccountCreator} + * @see {@link LocalAccountCreator} */ masterAccount?: string; /** - * {@link utils/key_pair!KeyPair | KeyPair} are stored in a {@link key_stores/keystore!KeyStore} under the `networkId` namespace. + * {@link utils/key_pair!KeyPair} are stored in a {@link KeyStore} under the `networkId` namespace. */ networkId: string; @@ -120,10 +120,10 @@ export class Near { } /** - * Create an account using the {@link account_creator!AccountCreator | AccountCreator}. Either: - * * using a masterAccount with {@link account_creator!LocalAccountCreator | LocalAccountCreator} - * * using the helperUrl with {@link account_creator!UrlAccountCreator | UrlAccountCreator} - * @see {@link NearConfig.masterAccount} and {@link NearConfig.helperUrl} + * Create an account using the {@link AccountCreator}. Either: + * * using a masterAccount with {@link LocalAccountCreator} + * * using the helperUrl with {@link UrlAccountCreator} + * @see {@link NearConfig#masterAccount | masterAccount} and {@link NearConfig#helperUrl | helperUrl} * * @param accountId * @param publicKey From 278e912847d87767e13bd0bd203beab8a4952f42 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 03:50:15 -0500 Subject: [PATCH 92/97] feat: update @link --- packages/accounts/src/account.ts | 4 ++-- packages/accounts/src/contract.ts | 4 ++-- packages/keystores/src/keystore.ts | 6 +++--- packages/near-api-js/src/browser-connect.ts | 6 +++--- packages/near-api-js/src/connect.ts | 12 ++++++------ packages/providers/src/json-rpc-provider.ts | 6 +++--- packages/wallet-account/src/near.ts | 12 ++++++------ packages/wallet-account/src/wallet_account.ts | 8 ++++---- 8 files changed, 29 insertions(+), 29 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index 6c3209d5d1..e3da9b7454 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -94,7 +94,7 @@ export interface SignAndSendTransactionOptions { /** * Options used to initiate a function call (especially a change function call) - * @see {@link account!Account#viewFunction | viewFunction} to initiate a view function call + * @see {@link Account#viewFunction | viewFunction} to initiate a view function call */ export interface FunctionCallOptions { /** The NEAR account id where the contract is deployed */ @@ -266,7 +266,7 @@ export class Account { accessKeyByPublicKeyCache: { [key: string]: AccessKeyView } = {}; /** - * Finds the {@link providers/provider!AccessKeyView | AccessKeyView} associated with the accounts {@link utils/key_pair!PublicKey | PublicKey} stored in the {@link key_stores/keystore!KeyStore | KeyStore}. + * Finds the {@link AccessKeyView} associated with the accounts {@link PublicKey} stored in the {@link key_stores/keystore!KeyStore}. * * @todo Find matching access key based on transaction (i.e. receiverId and actions) * diff --git a/packages/accounts/src/contract.ts b/packages/accounts/src/contract.ts index a73e9a5a08..bc5031d48a 100644 --- a/packages/accounts/src/contract.ts +++ b/packages/accounts/src/contract.ts @@ -84,14 +84,14 @@ export interface ContractMethods { /** * Methods that change state. These methods cost gas and require a signed transaction. * - * @see {@link account!Account.functionCall} + * @see {@link Account#functionCall} */ changeMethods: string[]; /** * View methods do not require a signed transaction. * - * @see {@link account!Account#viewFunction} + * @see {@link Account#viewFunction} */ viewMethods: string[]; diff --git a/packages/keystores/src/keystore.ts b/packages/keystores/src/keystore.ts index 424c32d06e..f9e71af88b 100644 --- a/packages/keystores/src/keystore.ts +++ b/packages/keystores/src/keystore.ts @@ -1,10 +1,10 @@ import { KeyPair } from '@near-js/crypto'; /** - * KeyStores are passed to {@link near!Near | Near} via {@link near!NearConfig | NearConfig} - * and are used by the {@link signer!InMemorySigner | InMemorySigner} to sign transactions. + * KeyStores are passed to {@link Near} via {@link NearConfig} + * and are used by the {@link InMemorySigner | InMemorySigner} to sign transactions. * - * @see {@link near-api-js!connect | connect} + * @see {@link connect } */ export abstract class KeyStore { abstract setKey(networkId: string, accountId: string, keyPair: KeyPair): Promise; diff --git a/packages/near-api-js/src/browser-connect.ts b/packages/near-api-js/src/browser-connect.ts index 32efc4699d..92d93283ba 100644 --- a/packages/near-api-js/src/browser-connect.ts +++ b/packages/near-api-js/src/browser-connect.ts @@ -1,13 +1,13 @@ /** * Connect to NEAR using the provided configuration. * - * {@link browserConnect!ConnectConfig.networkId | ConnectConfig.networkId} and {@link browserConnect!ConnectConfig.nodeUrl | ConnectConfig.nodeUrl} are required. + * {@link ConnectConfig#networkId} and {@link ConnectConfig#nodeUrl} are required. * - * To sign transactions you can also pass: {@link browserConnect!ConnectConfig.keyStore | ConnectConfig.keyStore} + * To sign transactions you can also pass: {@link ConnectConfig#keyStore} * * Both are passed they are prioritize in that order. * - * @see {@link browserConnect!ConnectConfig | ConnectConfig} + * @see {@link ConnectConfig} * @example * ```js * async function initNear() { diff --git a/packages/near-api-js/src/connect.ts b/packages/near-api-js/src/connect.ts index 31c555f8df..656450bace 100644 --- a/packages/near-api-js/src/connect.ts +++ b/packages/near-api-js/src/connect.ts @@ -1,16 +1,16 @@ /** * Connect to NEAR using the provided configuration. * - * {@link Connect!ConnectConfig.networkId | ConnectConfig.networkId} and {@link Connect!ConnectConfig.nodeUrl | ConnectConfig.nodeUrl} are required. + * {@link ConnectConfig#networkId} and {@link ConnectConfig#nodeUrl} are required. * * To sign transactions you can also pass: - * 1. {@link Connect!ConnectConfig.keyStore | ConnectConfig.keyStore} - * 2. {@link Connect!ConnectConfig.keyPath | ConnectConfig.keyPath} - * 3. {@link Connect!ConnectConfig.deps.keyStore | ConnectConfig.deps.keyStore} (deprecated, only for use in legacy applications) + * 1. {@link ConnectConfig#keyStore} + * 2. {@link ConnectConfig#keyPath} + * 3. {@link ConnectConfig#deps.keyStore} (deprecated, only for use in legacy applications) * * If all three are passed they are prioritize in that order. * - * @see {@link Connect!ConnectConfig | ConnectConfig} + * @see {@link ConnectConfig} * @example * ```js * async function initNear() { @@ -29,7 +29,7 @@ import { logWarning } from './utils'; export interface ConnectConfig extends NearConfig { /** - * Initialize an {@link key_stores/in_memory_key_store!InMemoryKeyStore | InMemoryKeyStore} by reading the file at keyPath. + * Initialize an {@link InMemoryKeyStore} by reading the file at keyPath. */ keyPath?: string; } diff --git a/packages/providers/src/json-rpc-provider.ts b/packages/providers/src/json-rpc-provider.ts index affb0256ca..2f5588e9e1 100644 --- a/packages/providers/src/json-rpc-provider.ts +++ b/packages/providers/src/json-rpc-provider.ts @@ -3,7 +3,7 @@ * @description * This module contains the {@link JsonRpcProvider} client class * which can be used to interact with the [NEAR RPC API](https://docs.near.org/api/rpc/introduction). - * @see {@link providers/provider!provider | provider} for a list of request and response types + * @see {@link provider} for a list of request and response types */ import { baseEncode, @@ -139,7 +139,7 @@ export class JsonRpcProvider extends Provider { } /** - * Query the RPC by passing an {@link providers/provider!RpcQueryRequest | RpcQueryRequest} + * Query the RPC by passing an {@link RpcQueryRequest} * @see [https://docs.near.org/api/rpc/contracts](https://docs.near.org/api/rpc/contracts) * * @typeParam T the shape of the returned query response @@ -167,7 +167,7 @@ export class JsonRpcProvider extends Provider { * pass block_id OR finality as blockQuery, not both * @see [https://docs.near.org/api/rpc/block-chunk](https://docs.near.org/api/rpc/block-chunk) * - * @param blockQuery {@link providers/provider!BlockReference | BlockReference} (passing a {@link providers/provider!BlockId | BlockId} is deprecated) + * @param blockQuery {@link BlockReference} (passing a {@link BlockId} is deprecated) */ async block(blockQuery: BlockId | BlockReference): Promise { const { finality } = blockQuery as any; diff --git a/packages/wallet-account/src/near.ts b/packages/wallet-account/src/near.ts index b9782a63dc..c72d1e9f34 100644 --- a/packages/wallet-account/src/near.ts +++ b/packages/wallet-account/src/near.ts @@ -20,7 +20,7 @@ import { Signer } from '@near-js/signers'; import BN from 'bn.js'; export interface NearConfig { - /** Holds {@link utils/key_pair!KeyPair | KeyPair} for signing transactions */ + /** Holds {@link utils/key_pair!KeyPair} for signing transactions */ keyStore?: KeyStore; /** @hidden */ @@ -28,12 +28,12 @@ export interface NearConfig { /** * [NEAR Contract Helper](https://github.com/near/near-contract-helper) url used to create accounts if no master account is provided - * @see {@link UrlAccountCreator | UrlAccountCreator} + * @see {@link UrlAccountCreator} */ helperUrl?: string; /** - * The balance transferred from the {@link masterAccount} to a created account + * The balance transferred from the {@link NearConfig#masterAccount} to a created account * @see {@link LocalAccountCreator} */ initialBalance?: string; @@ -51,13 +51,13 @@ export interface NearConfig { /** * NEAR RPC API url. used to make JSON RPC calls to interact with NEAR. - * @see {@link providers/json-rpc-provider!JsonRpcProvider | JsonRpcProvider} + * @see {@link JsonRpcProvider} */ nodeUrl: string; /** * NEAR RPC API headers. Can be used to pass API KEY and other parameters. - * @see {@link providers/json-rpc-provider!JsonRpcProvider | JsonRpcProvider} + * @see {@link JsonRpcProvider} */ headers?: { [key: string]: string | number }; @@ -123,7 +123,7 @@ export class Near { * Create an account using the {@link AccountCreator}. Either: * * using a masterAccount with {@link LocalAccountCreator} * * using the helperUrl with {@link UrlAccountCreator} - * @see {@link NearConfig#masterAccount | masterAccount} and {@link NearConfig#helperUrl | helperUrl} + * @see {@link NearConfig#masterAccount} and {@link NearConfig#helperUrl} * * @param accountId * @param publicKey diff --git a/packages/wallet-account/src/wallet_account.ts b/packages/wallet-account/src/wallet_account.ts index 4e8fb84f96..f2c46e66da 100644 --- a/packages/wallet-account/src/wallet_account.ts +++ b/packages/wallet-account/src/wallet_account.ts @@ -1,5 +1,5 @@ /** - * The classes in this module are used in conjunction with the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. + * The classes in this module are used in conjunction with the {@link BrowserLocalStorageKeyStore}. * This module exposes two classes: * * {@link WalletConnection} which redirects users to [NEAR Wallet](https://wallet.near.org/) for key management. * * {@link ConnectedWalletAccount} is an {@link account!Account | Account} implementation that uses {@link WalletConnection} to get keys @@ -48,7 +48,7 @@ interface RequestSignTransactionsOptions { } /** - * This class is used in conjunction with the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore}. + * This class is used in conjunction with the {@link BrowserLocalStorageKeyStore}. * It redirects users to [NEAR Wallet](https://wallet.near.org) for key management. * This class is not intended for use outside the browser. Without `window` (i.e. in server contexts), it will instantiate but will throw a clear error when used. * @@ -288,7 +288,7 @@ export class WalletConnection { } /** - * {@link account!Account | Account} implementation which redirects to wallet using {@link WalletConnection} when no local key is available. + * {@link Account} implementation which redirects to wallet using {@link WalletConnection} when no local key is available. */ export class ConnectedWalletAccount extends Account { walletConnection: WalletConnection; @@ -302,7 +302,7 @@ export class ConnectedWalletAccount extends Account { /** * Sign a transaction by redirecting to the NEAR Wallet - * @see {@link WalletConnection.requestSignTransactions} + * @see {@link WalletConnection#requestSignTransactions} */ async signAndSendTransaction({ receiverId, actions, walletMeta, walletCallbackUrl = window.location.href }: SignAndSendTransactionOptions): Promise { const localKey = await this.connection.signer.getPublicKey(this.accountId, this.connection.networkId); From 6cd2c9f67f767f9b6ede444deadf9593c208a03b Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 03:57:20 -0500 Subject: [PATCH 93/97] feat: update @link tag --- packages/accounts/src/account.ts | 4 ++-- .../src/browser_local_storage_key_store.ts | 6 +++--- .../src/unencrypted_file_system_keystore.ts | 6 +++--- packages/keystores/src/in_memory_key_store.ts | 8 ++++---- packages/keystores/src/merge_key_store.ts | 6 +++--- packages/wallet-account/src/near.ts | 4 ++-- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/accounts/src/account.ts b/packages/accounts/src/account.ts index e3da9b7454..c62fa90319 100644 --- a/packages/accounts/src/account.ts +++ b/packages/accounts/src/account.ts @@ -163,9 +163,9 @@ function bytesJsonStringify(input: any): Buffer { } /** - * This class provides common account related RPC calls including signing transactions with a {@link utils/key_pair!KeyPair | KeyPair}. + * This class provides common account related RPC calls including signing transactions with a {@link KeyPair}. * - * @hint Use {@link walletAccount!WalletConnection | WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link key_stores/browser_local_storage_key_store!BrowserLocalStorageKeyStore | BrowserLocalStorageKeyStore}. + * @hint Use {@link WalletConnection} in the browser to redirect to [NEAR Wallet](https://wallet.near.org/) for Account/key management using the {@link BrowserLocalStorageKeyStore}. * @see [https://docs.near.org/docs/develop/front-end/naj-quick-reference#account](https://docs.near.org/tools/near-api-js/quick-reference#account) * @see [Account Spec](https://nomicon.io/DataStructures/Account.html) */ diff --git a/packages/keystores-browser/src/browser_local_storage_key_store.ts b/packages/keystores-browser/src/browser_local_storage_key_store.ts index 253da23594..9472b183b3 100644 --- a/packages/keystores-browser/src/browser_local_storage_key_store.ts +++ b/packages/keystores-browser/src/browser_local_storage_key_store.ts @@ -42,7 +42,7 @@ export class BrowserLocalStorageKeyStore extends KeyStore { } /** - * Stores a {@link utils/key_pair!KeyPair | KeyPair} in local storage. + * Stores a {@link KeyPair} in local storage. * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -52,7 +52,7 @@ export class BrowserLocalStorageKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair | KeyPair} from local storage + * Gets a {@link KeyPair} from local storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -66,7 +66,7 @@ export class BrowserLocalStorageKeyStore extends KeyStore { } /** - * Removes a {@link utils/key_pair!KeyPair | KeyPair} from local storage + * Removes a {@link KeyPair} from local storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/keystores-node/src/unencrypted_file_system_keystore.ts b/packages/keystores-node/src/unencrypted_file_system_keystore.ts index 2e69fbe589..176ff90cc7 100644 --- a/packages/keystores-node/src/unencrypted_file_system_keystore.ts +++ b/packages/keystores-node/src/unencrypted_file_system_keystore.ts @@ -91,7 +91,7 @@ export class UnencryptedFileSystemKeyStore extends KeyStore { } /** - * Store a {@link utils/key_pair!KeyPair | KeyPair} in an unencrypted file + * Store a {@link KeyPair} in an unencrypted file * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -103,7 +103,7 @@ export class UnencryptedFileSystemKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair | KeyPair} from an unencrypted file + * Gets a {@link KeyPair} from an unencrypted file * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -118,7 +118,7 @@ export class UnencryptedFileSystemKeyStore extends KeyStore { } /** - * Deletes an unencrypted file holding a {@link utils/key_pair!KeyPair | KeyPair} + * Deletes an unencrypted file holding a {@link KeyPair} * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/keystores/src/in_memory_key_store.ts b/packages/keystores/src/in_memory_key_store.ts index ff798cdeb4..0ffd7478bc 100644 --- a/packages/keystores/src/in_memory_key_store.ts +++ b/packages/keystores/src/in_memory_key_store.ts @@ -38,7 +38,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Stores a {@link utils/key_pair!KeyPair | KeyPair} in in-memory storage item + * Stores a {@link KeyPair} in in-memory storage item * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -48,7 +48,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair | KeyPair} from in-memory storage + * Gets a {@link KeyPair} from in-memory storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -62,7 +62,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Removes a {@link utils/key_pair!KeyPair | KeyPair} from in-memory storage + * Removes a {@link KeyPair} from in-memory storage * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ @@ -71,7 +71,7 @@ export class InMemoryKeyStore extends KeyStore { } /** - * Removes all {@link utils/key_pair!KeyPair | KeyPair} from in-memory storage + * Removes all {@link KeyPair} from in-memory storage */ async clear(): Promise { this.keys = {}; diff --git a/packages/keystores/src/merge_key_store.ts b/packages/keystores/src/merge_key_store.ts index 182e1f2595..2fc6227dc6 100644 --- a/packages/keystores/src/merge_key_store.ts +++ b/packages/keystores/src/merge_key_store.ts @@ -54,7 +54,7 @@ export class MergeKeyStore extends KeyStore { } /** - * Store a {@link utils/key_pair!KeyPair | KeyPair} to the first index of a key store array + * Store a {@link KeyPair} to the first index of a key store array * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @param keyPair The key pair to store in local storage @@ -64,7 +64,7 @@ export class MergeKeyStore extends KeyStore { } /** - * Gets a {@link utils/key_pair!KeyPair | KeyPair} from the array of key stores + * Gets a {@link KeyPair} from the array of key stores * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair * @returns {Promise} @@ -80,7 +80,7 @@ export class MergeKeyStore extends KeyStore { } /** - * Removes a {@link utils/key_pair!KeyPair | KeyPair} from the array of key stores + * Removes a {@link KeyPair} from the array of key stores * @param networkId The targeted network. (ex. default, betanet, etc…) * @param accountId The NEAR account tied to the key pair */ diff --git a/packages/wallet-account/src/near.ts b/packages/wallet-account/src/near.ts index c72d1e9f34..0c0008f65f 100644 --- a/packages/wallet-account/src/near.ts +++ b/packages/wallet-account/src/near.ts @@ -20,7 +20,7 @@ import { Signer } from '@near-js/signers'; import BN from 'bn.js'; export interface NearConfig { - /** Holds {@link utils/key_pair!KeyPair} for signing transactions */ + /** Holds {@link KeyPair} for signing transactions */ keyStore?: KeyStore; /** @hidden */ @@ -45,7 +45,7 @@ export interface NearConfig { masterAccount?: string; /** - * {@link utils/key_pair!KeyPair} are stored in a {@link KeyStore} under the `networkId` namespace. + * {@link KeyPair} are stored in a {@link KeyStore} under the `networkId` namespace. */ networkId: string; From d1e3af8619822e8549e72e86e33f1bde5aa459aa Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 04:12:08 -0500 Subject: [PATCH 94/97] feat: readme.md file update --- packages/crypto/README.md | 10 +++++----- packages/keystores-browser/README.md | 2 +- packages/keystores-node/README.md | 2 +- packages/keystores/README.md | 6 +++--- packages/providers/README.md | 8 ++++---- packages/signers/README.md | 4 ++-- packages/transactions/README.md | 10 +++++----- packages/utils/README.md | 8 ++++---- packages/wallet-account/README.md | 4 ++-- 9 files changed, 27 insertions(+), 27 deletions(-) diff --git a/packages/crypto/README.md b/packages/crypto/README.md index 2b21f6c893..8973be12b8 100644 --- a/packages/crypto/README.md +++ b/packages/crypto/README.md @@ -4,11 +4,11 @@ A collection of classes and types for working with cryptographic key pairs. ## Modules -- [PublicKey](src/public_key.ts) representation of a public key capable of verifying signatures -- [KeyPairBase](src/key_pair_base.ts) abstract class representing a key pair -- [KeyPair](src/key_pair.ts) abstract extension of `KeyPairBase` with static methods for parsing and generating key pairs -- [KeyPairEd25519](src/key_pair_ed25519.ts) implementation of `KeyPairBase` using [Ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) -- [Constants](src/constants.ts) keypair-specific constants +- [PublicKey](https://github.com/near/near-api-js/blob/master/packages/crypto/src/public_key.ts) representation of a public key capable of verifying signatures +- [KeyPairBase](https://github.com/near/near-api-js/blob/master/packages/crypto/src/key_pair_base.ts) abstract class representing a key pair +- [KeyPair](https://github.com/near/near-api-js/blob/master/packages/crypto/src/key_pair.ts) abstract extension of `KeyPairBase` with static methods for parsing and generating key pairs +- [KeyPairEd25519](https://github.com/near/near-api-js/blob/master/packages/crypto/src/key_pair_ed25519.ts) implementation of `KeyPairBase` using [Ed25519](https://en.wikipedia.org/wiki/EdDSA#Ed25519) +- [Constants](https://github.com/near/near-api-js/blob/master/packages/crypto/src/constants.ts) keypair-specific constants # License diff --git a/packages/keystores-browser/README.md b/packages/keystores-browser/README.md index 8d47cf76a7..94e96fd3ad 100644 --- a/packages/keystores-browser/README.md +++ b/packages/keystores-browser/README.md @@ -4,7 +4,7 @@ A collection of classes for managing keys in a web browser execution context. ## Modules -- [BrowserLocalStorageKeyStore](src/browser_local_storage_key_store.ts) implementation of [KeyStore](../keystores/src/keystore.ts) storing unencrypted keys in browser LocalStorage +- [BrowserLocalStorageKeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores-browser/src/browser_local_storage_key_store.ts) implementation of [KeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores/src/keystore.ts) storing unencrypted keys in browser LocalStorage # License diff --git a/packages/keystores-node/README.md b/packages/keystores-node/README.md index f0a935d29a..47267438b7 100644 --- a/packages/keystores-node/README.md +++ b/packages/keystores-node/README.md @@ -4,7 +4,7 @@ A collection of classes and functions for managing keys in NodeJS execution cont ## Modules -- [UnencryptedFileSystemKeyStore](src/unencrypted_file_system_keystore.ts) implementation of [KeyStore](../keystores/src/keystore.ts) storing unencrypted keys on the local filesystem +- [UnencryptedFileSystemKeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores-node/src/unencrypted_file_system_keystore.ts) implementation of [KeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores/src/keystore.ts) storing unencrypted keys on the local filesystem # License diff --git a/packages/keystores/README.md b/packages/keystores/README.md index e14707454f..bf486a5fd4 100644 --- a/packages/keystores/README.md +++ b/packages/keystores/README.md @@ -4,9 +4,9 @@ A collection of classes for managing NEAR-compatible cryptographic keys. ## Modules -- [KeyStore](src/keystore.ts) abstract class for managing account keys -- [InMemoryKeyStore](src/in_memory_key_store.ts) implementation of `KeyStore` using an in-memory data structure local to the instance -- [MergeKeyStore](src/merge_key_store.ts) implementation of `KeyStore` aggregating multiple `KeyStore` implementations +- [KeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores/src/keystore.ts) abstract class for managing account keys +- [InMemoryKeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores/src/in_memory_key_store.ts) implementation of `KeyStore` using an in-memory data structure local to the instance +- [MergeKeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores/src/merge_key_store.ts) implementation of `KeyStore` aggregating multiple `KeyStore` implementations # License diff --git a/packages/providers/README.md b/packages/providers/README.md index 9373b95c2b..05882aa421 100644 --- a/packages/providers/README.md +++ b/packages/providers/README.md @@ -4,10 +4,10 @@ A collection of classes, functions, and types for communicating with the NEAR bl ## Modules -- [Provider](src/provider.ts) abstract class for interacting with NEAR RPC -- [JsonRpcProvider](src/json-rpc-provider.ts) implementation of `Provider` for [JSON-RPC](https://www.jsonrpc.org/) -- [fetch](src/fetch.ts) NodeJS `fetch` implementation -- [fetchJson](src/fetch_json.ts) low-level function for fetching and parsing RPC data +- [Provider](https://github.com/near/near-api-js/blob/master/packages/providers/src/provider.ts) abstract class for interacting with NEAR RPC +- [JsonRpcProvider](https://github.com/near/near-api-js/blob/master/packages/providers/src/json-rpc-provider.ts) implementation of `Provider` for [JSON-RPC](https://www.jsonrpc.org/) +- [fetch](https://github.com/near/near-api-js/blob/master/packages/providers/src/fetch.ts) NodeJS `fetch` implementation +- [fetchJson](https://github.com/near/near-api-js/blob/master/packages/providers/src/fetch_json.ts) low-level function for fetching and parsing RPC data # License diff --git a/packages/signers/README.md b/packages/signers/README.md index c70a03991b..ca54f591d1 100644 --- a/packages/signers/README.md +++ b/packages/signers/README.md @@ -4,8 +4,8 @@ A collection of classes and types to facilitate cryptographic signing. ## Modules -- [Signer](src/signer.ts) abstract class for cryptographic signing -- [InMemorySigner](src/in_memory_signer.ts) implementation of `Signer` using [InMemoryKeyStore](../keystores/src/in_memory_key_store.ts) to provide keys +- [Signer](https://github.com/near/near-api-js/blob/master/packages/signer/src/ssigner.ts) abstract class for cryptographic signing +- [InMemorySigner](https://github.com/near/near-api-js/blob/master/packages/signer/src/in_memory_signer.ts) implementation of `Signer` using [InMemoryKeyStore](https://github.com/near/near-api-js/blob/master/packages/keystores/src/in_memory_key_store.ts) to provide keys # License diff --git a/packages/transactions/README.md b/packages/transactions/README.md index ba88ef08f8..7c75db549b 100644 --- a/packages/transactions/README.md +++ b/packages/transactions/README.md @@ -4,11 +4,11 @@ A collection of classes, functions, and types for composing, serializing, and si ## Modules -- [actionCreators](src/action_creators.ts) functions for composing actions -- [Actions](src/actions.ts) classes for actions -- [Schema](src/schema.ts) classes and types concerned with (de-)serialization of transactions -- [createTransaction](src/create_transaction.ts) function for composing a transaction -- [signTransaction](src/sign.ts) function for signing a transaction +- [actionCreators](https://github.com/near/near-api-js/blob/master/packages/transactions/src/action_creators.ts) functions for composing actions +- [Actions](https://github.com/near/near-api-js/blob/master/packages/transactions/src/actions.ts) classes for actions +- [Schema](https://github.com/near/near-api-js/blob/master/packages/transactions/src/schema.ts) classes and types concerned with (de-)serialization of transactions +- [createTransaction](https://github.com/near/near-api-js/blob/master/packages/transactions/src/create_transaction.ts) function for composing a transaction +- [signTransaction](https://github.com/near/near-api-js/blob/master/packages/transactions/src/sign.ts) function for signing a transaction # License diff --git a/packages/utils/README.md b/packages/utils/README.md index 6da1b4d45c..79edc0fad1 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -4,10 +4,10 @@ A collection of commonly-used functions and constants. ## Modules -- [Format](src/format.ts) NEAR denomination formatting functions -- [Logging](src/logging.ts) functions for printing formatted RPC output -- [Provider](src/provider.ts) functions for parsing RPC output -- [Validators](src/validators.ts) functions for querying blockchain validators +- [Format](https://github.com/near/near-api-js/blob/master/packages/utils/src/format.ts) NEAR denomination formatting functions +- [Logging](https://github.com/near/near-api-js/blob/master/packages/utils/src/logging.ts) functions for printing formatted RPC output +- [Provider](https://github.com/near/near-api-js/blob/master/packages/utils/src/provider.ts) functions for parsing RPC output +- [Validators](https://github.com/near/near-api-js/blob/master/packages/utils/src/validators.ts) functions for querying blockchain validators # License diff --git a/packages/wallet-account/README.md b/packages/wallet-account/README.md index 6650243423..ad4a9f6635 100644 --- a/packages/wallet-account/README.md +++ b/packages/wallet-account/README.md @@ -4,8 +4,8 @@ A collection of classes and types for working with accounts within browser-based ## Modules -- [Near](src/near.ts) a general purpose class for configuring and working with the NEAR blockchain -- [WalletAccount](src/wallet_account.ts) an [Account](../accounts/src/account.ts) implementation for use in a browser-based wallet +- [Near](https://github.com/near/near-api-js/blob/master/packages/wallet-account/src/near.ts) a general purpose class for configuring and working with the NEAR blockchain +- [WalletAccount](https://github.com/near/near-api-js/blob/master/packages/wallet-account/src/wallet_account.ts) an [Account](https://github.com/near/near-api-js/blob/master/packages/accounts/src/account.ts) implementation for use in a browser-based wallet # License From 78a7a92e3b60c0d856b3f06319ad9e6ee962f3ff Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 04:23:58 -0500 Subject: [PATCH 95/97] feat: enable release action --- .github/workflows/{release.disabled => release.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{release.disabled => release.yml} (100%) diff --git a/.github/workflows/release.disabled b/.github/workflows/release.yml similarity index 100% rename from .github/workflows/release.disabled rename to .github/workflows/release.yml From f4c9e61ab023b411c1e2c4ef5e3cbabc9305ab85 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 09:43:40 -0500 Subject: [PATCH 96/97] feat: update githubpages option --- packages/accounts/tsconfig.json | 2 +- packages/biometric-ed25519/tsconfig.json | 2 +- packages/cookbook/tsconfig.json | 2 +- packages/crypto/tsconfig.json | 2 +- packages/iframe-rpc/tsconfig.json | 2 +- packages/keystores-browser/tsconfig.json | 2 +- packages/keystores-node/tsconfig.json | 2 +- packages/keystores/tsconfig.json | 2 +- packages/near-api-js/tsconfig.json | 2 +- packages/providers/tsconfig.json | 2 +- packages/signers/tsconfig.json | 2 +- packages/transactions/tsconfig.json | 2 +- packages/types/tsconfig.json | 2 +- packages/utils/tsconfig.json | 2 +- packages/wallet-account/tsconfig.json | 2 +- tsconfig.base.json | 2 +- tsconfig.local-test.json | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/packages/accounts/tsconfig.json b/packages/accounts/tsconfig.json index 71a1c0fda8..7acb83cf22 100644 --- a/packages/accounts/tsconfig.json +++ b/packages/accounts/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/biometric-ed25519/tsconfig.json b/packages/biometric-ed25519/tsconfig.json index 4680ec955b..2f6f227e95 100644 --- a/packages/biometric-ed25519/tsconfig.json +++ b/packages/biometric-ed25519/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/cookbook/tsconfig.json b/packages/cookbook/tsconfig.json index 971158931c..8f40ad15ee 100644 --- a/packages/cookbook/tsconfig.json +++ b/packages/cookbook/tsconfig.json @@ -22,7 +22,7 @@ "Module", "Reference" ], - "githubPages": false, + "githubPages": true, }, "include": [ "**/*.js", diff --git a/packages/crypto/tsconfig.json b/packages/crypto/tsconfig.json index 410c9d7c08..27301e314d 100644 --- a/packages/crypto/tsconfig.json +++ b/packages/crypto/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/iframe-rpc/tsconfig.json b/packages/iframe-rpc/tsconfig.json index 5691ab6c0e..6655f6d328 100644 --- a/packages/iframe-rpc/tsconfig.json +++ b/packages/iframe-rpc/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "validation": { "notExported": false } diff --git a/packages/keystores-browser/tsconfig.json b/packages/keystores-browser/tsconfig.json index d4a527e120..b4badc086d 100644 --- a/packages/keystores-browser/tsconfig.json +++ b/packages/keystores-browser/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/keystores-node/tsconfig.json b/packages/keystores-node/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/keystores-node/tsconfig.json +++ b/packages/keystores-node/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/keystores/tsconfig.json b/packages/keystores/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/keystores/tsconfig.json +++ b/packages/keystores/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/near-api-js/tsconfig.json b/packages/near-api-js/tsconfig.json index 913ef5b441..2398139463 100644 --- a/packages/near-api-js/tsconfig.json +++ b/packages/near-api-js/tsconfig.json @@ -29,7 +29,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","lib","test"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/providers/tsconfig.json b/packages/providers/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/providers/tsconfig.json +++ b/packages/providers/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/signers/tsconfig.json b/packages/signers/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/signers/tsconfig.json +++ b/packages/signers/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/transactions/tsconfig.json b/packages/transactions/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/transactions/tsconfig.json +++ b/packages/transactions/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/types/tsconfig.json +++ b/packages/types/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/utils/tsconfig.json b/packages/utils/tsconfig.json index 5ab848fed0..2bf58992d4 100644 --- a/packages/utils/tsconfig.json +++ b/packages/utils/tsconfig.json @@ -9,7 +9,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/packages/wallet-account/tsconfig.json b/packages/wallet-account/tsconfig.json index 06e4ffc02a..04debe076a 100644 --- a/packages/wallet-account/tsconfig.json +++ b/packages/wallet-account/tsconfig.json @@ -10,7 +10,7 @@ "entryPointStrategy": "expand", "out": "docs", "exclude": ["node_modules","test","lib"], - "githubPages": false, + "githubPages": true, "emit": "both", "validation": { "notExported": false diff --git a/tsconfig.base.json b/tsconfig.base.json index 41e958bd94..ce4cc17b6f 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -41,7 +41,7 @@ "packages/wallet-account" ], "entryPointStrategy": "packages", - "githubPages": false, + "githubPages": true, "out": "docs", "emit": "both", }, diff --git a/tsconfig.local-test.json b/tsconfig.local-test.json index 7e6b1d8208..4f1f6e9144 100644 --- a/tsconfig.local-test.json +++ b/tsconfig.local-test.json @@ -45,7 +45,7 @@ "packages/wallet-account" ], "entryPointStrategy": "packages", - "githubPages": false, + "githubPages": true, "out": "typedoc-docs", "emit": "both", "validation": { From 8a448b14020dad85571ce6cc3d18a7f5f10001c6 Mon Sep 17 00:00:00 2001 From: few-sw <149263800+few-sw@users.noreply.github.com> Date: Fri, 17 Nov 2023 14:31:06 -0500 Subject: [PATCH 97/97] refactor: update typedoc-generator --- .github/workflows/typedoc-generator.yml | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/.github/workflows/typedoc-generator.yml b/.github/workflows/typedoc-generator.yml index d66c7aaedd..86c0b992a7 100644 --- a/.github/workflows/typedoc-generator.yml +++ b/.github/workflows/typedoc-generator.yml @@ -3,8 +3,7 @@ name: Deploy TypeDoc on GitHub pages on: push: branches: - - typedoc-configuration - # master + master env: NODE_VERSION: 18.x @@ -12,9 +11,6 @@ env: CONFIG_PATH: 'tsconfig.base.json' USES_PNPM: 'true' DESTINATION_FOLDER: "docs" - -# permissions: -# contents: write jobs: deploy: @@ -36,7 +32,7 @@ jobs: run: pnpm install - name: Build documentation - uses: few-sw/typedoc-action@add-pnpm-support + uses: few-sw/typedoc-action@v2.6.2 with: entry: ${{ env.ENTRY_FILE }} config: ${{ env.CONFIG_PATH }}