From 966cbe9bc4ae667bd0a0001d7ae4e77dc91802bd Mon Sep 17 00:00:00 2001 From: Arie Trouw Date: Tue, 27 Jun 2023 16:04:59 -0700 Subject: [PATCH] worker code excluded from typedoc --- package.json | 2 +- .../packages/bridge/packages/worker/src/docsEntry.ts | 4 ++++ .../packages/bridge/packages/worker/tsconfig.typedoc.json | 2 +- .../modules/packages/bridge/packages/worker/typedoc.json | 2 +- packages/modules/packages/bridge/tsconfig.typedoc.json | 2 +- .../modules/packages/module/packages/wrapper/src/index.ts | 1 + packages/modules/tsconfig.typedoc.json | 2 +- packages/modules/typedoc.json | 1 + .../crypto/packages/nft/src/lib/rating/analyzeNft.ts | 2 +- .../packages/indexeddb/src/IndexedDbPreviousHashStore.ts | 2 +- typedoc.json | 6 +++++- typedoc.site.json | 1 + 12 files changed, 19 insertions(+), 8 deletions(-) create mode 100644 packages/modules/packages/bridge/packages/worker/src/docsEntry.ts diff --git a/package.json b/package.json index 70b3f23b177..4bc41245549 100644 --- a/package.json +++ b/package.json @@ -106,4 +106,4 @@ "node": "18.13.0", "yarn": "1.22.19" } -} +} \ No newline at end of file diff --git a/packages/modules/packages/bridge/packages/worker/src/docsEntry.ts b/packages/modules/packages/bridge/packages/worker/src/docsEntry.ts new file mode 100644 index 00000000000..0488376787e --- /dev/null +++ b/packages/modules/packages/bridge/packages/worker/src/docsEntry.ts @@ -0,0 +1,4 @@ +/* Used to exclude the worker code for typedoc */ +export * from './defaultNodeManifest' +export * from './WorkerBridge' +export * from './WorkerBridgeConfig' diff --git a/packages/modules/packages/bridge/packages/worker/tsconfig.typedoc.json b/packages/modules/packages/bridge/packages/worker/tsconfig.typedoc.json index a77abc2f4f0..621f995bd56 100644 --- a/packages/modules/packages/bridge/packages/worker/tsconfig.typedoc.json +++ b/packages/modules/packages/bridge/packages/worker/tsconfig.typedoc.json @@ -1,5 +1,5 @@ { - "exclude": ["**/spec/*", "**/*.spec.*"], + "exclude": ["**/spec/*", "**/*.spec.*", "src/worker/*", "src/index.ts"], "extends": "./tsconfig.json" } diff --git a/packages/modules/packages/bridge/packages/worker/typedoc.json b/packages/modules/packages/bridge/packages/worker/typedoc.json index 8eda4f2661e..588c87491c3 100644 --- a/packages/modules/packages/bridge/packages/worker/typedoc.json +++ b/packages/modules/packages/bridge/packages/worker/typedoc.json @@ -1,5 +1,5 @@ { "$schema": "https://typedoc.org/schema.json", - "entryPoints": ["src/index.ts"], + "entryPoints": ["src/docsEntry.ts"], "tsconfig": "./tsconfig.typedoc.json" } \ No newline at end of file diff --git a/packages/modules/packages/bridge/tsconfig.typedoc.json b/packages/modules/packages/bridge/tsconfig.typedoc.json index a77abc2f4f0..c872494fa97 100644 --- a/packages/modules/packages/bridge/tsconfig.typedoc.json +++ b/packages/modules/packages/bridge/tsconfig.typedoc.json @@ -1,5 +1,5 @@ { - "exclude": ["**/spec/*", "**/*.spec.*"], + "exclude": ["**/spec/*", "**/*.spec.*", "**/worker/src/**/*"], "extends": "./tsconfig.json" } diff --git a/packages/modules/packages/module/packages/wrapper/src/index.ts b/packages/modules/packages/module/packages/wrapper/src/index.ts index 23396555890..f0414a3dca9 100644 --- a/packages/modules/packages/module/packages/wrapper/src/index.ts +++ b/packages/modules/packages/module/packages/wrapper/src/index.ts @@ -1 +1,2 @@ +export * from './models' export * from './ModuleWrapper' diff --git a/packages/modules/tsconfig.typedoc.json b/packages/modules/tsconfig.typedoc.json index a77abc2f4f0..c872494fa97 100644 --- a/packages/modules/tsconfig.typedoc.json +++ b/packages/modules/tsconfig.typedoc.json @@ -1,5 +1,5 @@ { - "exclude": ["**/spec/*", "**/*.spec.*"], + "exclude": ["**/spec/*", "**/*.spec.*", "**/worker/src/**/*"], "extends": "./tsconfig.json" } diff --git a/packages/modules/typedoc.json b/packages/modules/typedoc.json index 8eda4f2661e..9ad838741ab 100644 --- a/packages/modules/typedoc.json +++ b/packages/modules/typedoc.json @@ -1,5 +1,6 @@ { "$schema": "https://typedoc.org/schema.json", "entryPoints": ["src/index.ts"], + "exclude": ["**/WorkerNodeHost.ts"], "tsconfig": "./tsconfig.typedoc.json" } \ No newline at end of file diff --git a/packages/plugins/packages/payloadset/packages/crypto/packages/nft/src/lib/rating/analyzeNft.ts b/packages/plugins/packages/payloadset/packages/crypto/packages/nft/src/lib/rating/analyzeNft.ts index f799e41ca4a..74526230b8f 100644 --- a/packages/plugins/packages/payloadset/packages/crypto/packages/nft/src/lib/rating/analyzeNft.ts +++ b/packages/plugins/packages/payloadset/packages/crypto/packages/nft/src/lib/rating/analyzeNft.ts @@ -3,7 +3,7 @@ import { NftInfo } from '@xyo-network/crypto-wallet-nft-payload-plugin' import { scoringCriteria } from './criteria' import { Score } from './score' -type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey +export type ScoringCriteriaKey = keyof typeof scoringCriteria & PropertyKey export type NftAnalysis = { [key in ScoringCriteriaKey]: Score diff --git a/packages/protocol/packages/account/packages/previous-hash-store/packages/indexeddb/src/IndexedDbPreviousHashStore.ts b/packages/protocol/packages/account/packages/previous-hash-store/packages/indexeddb/src/IndexedDbPreviousHashStore.ts index 2e3566222c8..0c88f675ad7 100644 --- a/packages/protocol/packages/account/packages/previous-hash-store/packages/indexeddb/src/IndexedDbPreviousHashStore.ts +++ b/packages/protocol/packages/account/packages/previous-hash-store/packages/indexeddb/src/IndexedDbPreviousHashStore.ts @@ -1,7 +1,7 @@ import { PreviousHashStore } from '@xyo-network/previous-hash-store-model' import { DBSchema, IDBPDatabase, openDB } from 'idb' -interface PreviousHashStoreSchemaV1 extends DBSchema { +export interface PreviousHashStoreSchemaV1 extends DBSchema { 'previous-hash': { key: string value: string diff --git a/typedoc.json b/typedoc.json index 35121b956fe..0ae3b1f025c 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,5 +1,9 @@ { - "entryPoints": ["src/index.ts"], + "$schema": "https://typedoc.org/schema.json", + "entryPointStrategy": "packages", + "entryPoints": [ + "packages/*" + ], "includeVersion": true, "name": "XYO Platform Client SDK", "tsconfig": "./tsconfig.typedoc.json" diff --git a/typedoc.site.json b/typedoc.site.json index 118ffec826a..b1e51451f7b 100644 --- a/typedoc.site.json +++ b/typedoc.site.json @@ -1,4 +1,5 @@ { + "$schema": "https://typedoc.org/schema.json", "entryPointStrategy": "packages", "entryPoints": [ "**/packages/*"