@xyo-network/diviner-indexing-model 5.3.29 → 5.4.0

package/README.md

@@ -38,208 +38,6 @@ bun add {{name}}
 
 See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Reference
-
-### packages
-
-  ### modules
-
-    ### packages
-
-      ### diviner
-
-        ### packages
-
-          ### indexing
-
-            ### packages
-
-              ### model
-
-                ### .temp-typedoc
-
-                  ### type-aliases
-
-                    ### <a id="DivinerStageSchema"></a>DivinerStageSchema
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type DivinerStageSchema = typeof DivinerStageSchema;
-```
-
-                    ### <a id="ImageThumbnailDivinerSchema"></a>ImageThumbnailDivinerSchema
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema;
-```
-
-                    ### <a id="IndexingDivinerConfig"></a>IndexingDivinerConfig
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerConfig<TConfig, TSchema> = DivinerConfig<WithAdditional<{
-  indexStore?: SearchableStorage;
-  indexingDivinerStages?: IndexingDivinerStageConfig;
-  payloadDivinerLimit?: number;
-  pollFrequency?: number;
-  schema: IndexingDivinerConfigSchema;
-  stateStore?: SearchableStorage;
-}, TConfig>, TSchema>;
-```
-
-## Type Parameters
-
-### TConfig
-
-`TConfig` *extends* `Payload` \| `EmptyObject` \| `void` = `void`
-
-### TSchema
-
-`TSchema` *extends* `Schema` \| `void` = `void`
-
-                    ### <a id="IndexingDivinerConfigSchema"></a>IndexingDivinerConfigSchema
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema;
-```
-
-                    ### <a id="IndexingDivinerParams"></a>IndexingDivinerParams
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerParams = DivinerParams<AnyConfigSchema<IndexingDivinerConfig>>;
-```
-
-                    ### <a id="IndexingDivinerStage"></a>IndexingDivinerStage
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerStage = 
-  | "divinerQueryToIndexQueryDiviner"
-  | "indexCandidateToIndexDiviner"
-  | "indexQueryResponseToDivinerQueryResponseDiviner"
-  | "stateToIndexCandidateDiviner";
-```
-
-The diviners for each stage of an indexing diviner
-
-                    ### <a id="IndexingDivinerStageConfig"></a>IndexingDivinerStageConfig
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerStageConfig = { [key in IndexingDivinerStage]: ModuleIdentifier };
-```
-
-Config section for declaring each indexing diviner stage
-
-                    ### <a id="IndexingDivinerStageLabels"></a>IndexingDivinerStageLabels
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerStageLabels = Labels & { [key in DivinerStageSchema]: IndexingDivinerStage };
-```
-
-Labels for Indexing Diviner Stage Diviners
-
-                    ### <a id="IndexingDivinerState"></a>IndexingDivinerState
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-type IndexingDivinerState = StateDictionary & object;
-```
-
-## Type Declaration
-
-### cursor
-
-```ts
-cursor: Sequence;
-```
-
-                  ### variables
-
-                    ### <a id="DivinerStageSchema"></a>DivinerStageSchema
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-const DivinerStageSchema: "network.xyo.diviner.stage" & object;
-```
-
-## Type Declaration
-
-### \_\_schema
-
-```ts
-readonly __schema: true;
-```
-
-                    ### <a id="IndexingDivinerConfigSchema"></a>IndexingDivinerConfigSchema
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-const IndexingDivinerConfigSchema: string & object;
-```
-
-## Type Declaration
-
-### \_\_schema
-
-```ts
-readonly __schema: true;
-```
-
-                    ### <a id="IndexingDivinerSchema"></a>IndexingDivinerSchema
-
-[**@xyo-network/diviner-indexing-model**](#../README)
-
-***
-
-```ts
-const IndexingDivinerSchema: "network.xyo.diviner.indexing" & object;
-```
-
-## Type Declaration
-
-### \_\_schema
-
-```ts
-readonly __schema: true;
-```
 
 
 [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/neutral/Labels.d.ts

@@ -3,7 +3,5 @@ import type { DivinerStageSchema, IndexingDivinerStage } from './Stage.ts';
 /**
  * Labels for Indexing Diviner Stage Diviners
  */
-export type IndexingDivinerStageLabels = Labels & {
-    [key in DivinerStageSchema]: IndexingDivinerStage;
-};
+export type IndexingDivinerStageLabels = Labels & Record<DivinerStageSchema, IndexingDivinerStage>;
 //# sourceMappingURL=Labels.d.ts.map

package/dist/neutral/Labels.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Labels.d.ts","sourceRoot":"","sources":["../../src/Labels.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAE1E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG;KAI/C,GAAG,IAAI,kBAAkB,GAAG,oBAAoB;CAClD,CAAA"}
+{"version":3,"file":"Labels.d.ts","sourceRoot":"","sources":["../../src/Labels.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAEvD,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAE1E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,MAAM,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAA"}

package/dist/neutral/Stage.d.ts

@@ -22,7 +22,5 @@ export type IndexingDivinerStage = 'divinerQueryToIndexQueryDiviner'
 /**
  * Config section for declaring each indexing diviner stage
  */
-export type IndexingDivinerStageConfig = {
-    [key in IndexingDivinerStage]: ModuleIdentifier;
-};
+export type IndexingDivinerStageConfig = Record<IndexingDivinerStage, ModuleIdentifier>;
 //# sourceMappingURL=Stage.d.ts.map

package/dist/neutral/Stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../src/Stage.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB;;CAA8C,CAAA;AAC7E,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAA;AAE1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAGjE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAI1B,iCAAiC;AACrC;;GAEG;GACC,8BAA8B;AAClC;;GAEG;GACC,iDAAiD;AACrD;;GAEG;GACC,8BAA8B,CAAA;AAEpC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;KACtC,GAAG,IAAI,oBAAoB,GAAG,gBAAgB;CAChD,CAAA"}
+{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../src/Stage.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,kBAAkB;;CAA8C,CAAA;AAC7E,MAAM,MAAM,kBAAkB,GAAG,OAAO,kBAAkB,CAAA;AAE1D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAGjE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAI1B,iCAAiC;AACrC;;GAEG;GACC,8BAA8B;AAClC;;GAEG;GACC,iDAAiD;AACrD;;GAEG;GACC,8BAA8B,CAAA;AAEpC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Config.ts","../../src/Schema.ts","../../src/Stage.ts"],"sourcesContent":["import type { EmptyObject, WithAdditional } from '@xylabs/sdk-js'\nimport type { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'\nimport {\n  asSchema, type Payload, type Schema,\n} from '@xyo-network/payload-model'\n\nimport { IndexingDivinerSchema } from './Schema.ts'\nimport type { IndexingDivinerStageConfig } from './Stage.ts'\n\nexport const IndexingDivinerConfigSchema = asSchema(`${IndexingDivinerSchema}.config`, true)\nexport type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema\n\nexport type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends Schema | void = void> = DivinerConfig<\n  WithAdditional<\n    {\n      /**\n       * Where the diviner should store it's index\n       */\n      indexStore?: SearchableStorage\n      /**\n       * Config section for name/address of individual diviner stages\n       */\n      indexingDivinerStages?: IndexingDivinerStageConfig\n      /**\n       * The maximum number of payloads to index at a time\n       */\n      payloadDivinerLimit?: number\n      /**\n       * How often to poll for new payloads to index\n       */\n      pollFrequency?: number\n      /**\n       * The schema for the Diviner config\n       */\n      schema: IndexingDivinerConfigSchema\n      /**\n       * Where the diviner should persist its internal state\n       */\n      stateStore?: SearchableStorage\n    },\n    TConfig\n  >,\n  TSchema\n>\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const IndexingDivinerSchema = asSchema('network.xyo.diviner.indexing', true)\nexport type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema\n","export const DivinerStageSchema = asSchema('network.xyo.diviner.stage', true)\nexport type DivinerStageSchema = typeof DivinerStageSchema\n\nimport type { ModuleIdentifier } from '@xyo-network/module-model'\nimport { asSchema } from '@xyo-network/payload-model'\n\n/**\n * The diviners for each stage of an indexing diviner\n */\nexport type IndexingDivinerStage\n  /**\n   * Transforms a diviner query into an index query\n   */\n  = | 'divinerQueryToIndexQueryDiviner'\n  /**\n   * Transforms the index candidates into indexes\n   */\n    | 'indexCandidateToIndexDiviner'\n  /**\n   * Transforms an index query response into a diviner divine query response\n   */\n    | 'indexQueryResponseToDivinerQueryResponseDiviner'\n  /**\n   * Uses the current state to determine the next batch of index candidates\n   */\n    | 'stateToIndexCandidateDiviner'\n\n/**\n * Config section for declaring each indexing diviner stage\n */\nexport type IndexingDivinerStageConfig = {\n  [key in IndexingDivinerStage]: ModuleIdentifier\n}\n"],"mappings":";AAEA;AAAA,EACE,YAAAA;AAAA,OACK;;;ACJP,SAAS,gBAAgB;AAElB,IAAM,wBAAwB,SAAS,gCAAgC,IAAI;;;ADO3E,IAAM,8BAA8BC,UAAS,GAAG,qBAAqB,WAAW,IAAI;;;AEL3F,SAAS,YAAAC,iBAAgB;AAJlB,IAAM,qBAAqBA,UAAS,6BAA6B,IAAI;","names":["asSchema","asSchema","asSchema"]}
+{"version":3,"sources":["../../src/Config.ts","../../src/Schema.ts","../../src/Stage.ts"],"sourcesContent":["import type { EmptyObject, WithAdditional } from '@xylabs/sdk-js'\nimport type { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'\nimport {\n  asSchema, type Payload, type Schema,\n} from '@xyo-network/payload-model'\n\nimport { IndexingDivinerSchema } from './Schema.ts'\nimport type { IndexingDivinerStageConfig } from './Stage.ts'\n\nexport const IndexingDivinerConfigSchema = asSchema(`${IndexingDivinerSchema}.config`, true)\nexport type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema\n\nexport type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends Schema | void = void> = DivinerConfig<\n  WithAdditional<\n    {\n      /**\n       * Where the diviner should store it's index\n       */\n      indexStore?: SearchableStorage\n      /**\n       * Config section for name/address of individual diviner stages\n       */\n      indexingDivinerStages?: IndexingDivinerStageConfig\n      /**\n       * The maximum number of payloads to index at a time\n       */\n      payloadDivinerLimit?: number\n      /**\n       * How often to poll for new payloads to index\n       */\n      pollFrequency?: number\n      /**\n       * The schema for the Diviner config\n       */\n      schema: IndexingDivinerConfigSchema\n      /**\n       * Where the diviner should persist its internal state\n       */\n      stateStore?: SearchableStorage\n    },\n    TConfig\n  >,\n  TSchema\n>\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport const IndexingDivinerSchema = asSchema('network.xyo.diviner.indexing', true)\nexport type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema\n","export const DivinerStageSchema = asSchema('network.xyo.diviner.stage', true)\nexport type DivinerStageSchema = typeof DivinerStageSchema\n\nimport type { ModuleIdentifier } from '@xyo-network/module-model'\nimport { asSchema } from '@xyo-network/payload-model'\n\n/**\n * The diviners for each stage of an indexing diviner\n */\nexport type IndexingDivinerStage\n  /**\n   * Transforms a diviner query into an index query\n   */\n  = | 'divinerQueryToIndexQueryDiviner'\n  /**\n   * Transforms the index candidates into indexes\n   */\n    | 'indexCandidateToIndexDiviner'\n  /**\n   * Transforms an index query response into a diviner divine query response\n   */\n    | 'indexQueryResponseToDivinerQueryResponseDiviner'\n  /**\n   * Uses the current state to determine the next batch of index candidates\n   */\n    | 'stateToIndexCandidateDiviner'\n\n/**\n * Config section for declaring each indexing diviner stage\n */\nexport type IndexingDivinerStageConfig = Record<IndexingDivinerStage, ModuleIdentifier>\n"],"mappings":";AAEA;AAAA,EACE,YAAAA;AAAA,OACK;;;ACJP,SAAS,gBAAgB;AAElB,IAAM,wBAAwB,SAAS,gCAAgC,IAAI;;;ADO3E,IAAM,8BAA8BC,UAAS,GAAG,qBAAqB,WAAW,IAAI;;;AEL3F,SAAS,YAAAC,iBAAgB;AAJlB,IAAM,qBAAqBA,UAAS,6BAA6B,IAAI;","names":["asSchema","asSchema","asSchema"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-indexing-model",
-  "version": "5.3.29",
+  "version": "5.4.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,12 +22,10 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -36,28 +34,26 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/diviner-model": "~5.3.29",
-    "@xyo-network/module-model": "~5.3.29",
-    "@xyo-network/payload-model": "~5.3.29"
+    "@xyo-network/diviner-model": "~5.4.0",
+    "@xyo-network/module-model": "~5.4.0",
+    "@xyo-network/payload-model": "~5.4.0"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@xylabs/sdk-js": "^5.0.95",
-    "@xylabs/ts-scripts-common": "~7.8.4",
-    "@xylabs/ts-scripts-pnpm": "~7.8.4",
-    "@xylabs/tsconfig": "~7.8.4",
-    "axios": "^1.14.0",
+    "@xylabs/sdk-js": "^5.0.97",
+    "@xylabs/toolchain": "~7.10.8",
+    "@xylabs/tsconfig": "~7.10.8",
     "pako": "~2.1.0",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/account-model": "~5.3.29",
-    "@xyo-network/manifest-model": "~5.3.29",
-    "@xyo-network/previous-hash-store-model": "~5.3.29"
+    "@xyo-network/previous-hash-store-model": "~5.4.0",
+    "@xyo-network/manifest-model": "~5.4.0",
+    "@xyo-network/account-model": "~5.4.0"
   },
   "peerDependencies": {
-    "@xylabs/sdk-js": "^5",
-    "@xyo-network/account-model": "~5.3.29",
-    "@xyo-network/manifest-model": "~5.3.29"
+    "@xylabs/sdk-js": "^5.0.97",
+    "@xyo-network/account-model": "~5.4",
+    "@xyo-network/manifest-model": "~5.4"
   },
   "publishConfig": {
     "access": "public"