@xyo-network/diviner-indexing-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,249 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/diviner-indexing-model
 
-[![logo][]](https://xyo.network)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
+
+> Primary SDK for using XYO Protocol 2.0
+
+## Install
+
+Using npm:
 
-Version: 5.0.2
+```sh
+npm install {{name}}
+```
 
-Primary SDK for using XYO Protocol 2.0
+Using yarn:
 
-## Documentation
+```sh
+yarn add {{name}}
+```
 
-[TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-indexing-model)
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
 
-Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
 
 ## License
 
-> See the [LICENSE](LICENSE) file for license details
+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
 
-## Credits
+```ts
+readonly __schema: true;
+```
 
-[Made with 🔥 and ❄️ by XYO](https://xyo.network)
 
-[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-indexing-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-indexing-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-indexing-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-indexing-model",
-  "version": "5.3.25",
+  "version": "5.3.26",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -22,11 +22,11 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "files": [
     "dist",
@@ -36,25 +36,25 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/diviner-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/diviner-model": "~5.3.26",
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "@types/node": "^25.5.0",
-    "@xylabs/sdk-js": "^5.0.93",
-    "@xylabs/ts-scripts-common": "~7.6.16",
-    "@xylabs/ts-scripts-pnpm": "~7.6.16",
-    "@xylabs/tsconfig": "~7.6.16",
+    "@types/node": "^25.5.2",
+    "@xylabs/sdk-js": "^5.0.94",
+    "@xylabs/ts-scripts-common": "~7.7.5",
+    "@xylabs/ts-scripts-pnpm": "~7.7.5",
+    "@xylabs/tsconfig": "~7.7.5",
     "acorn": "^8.16.0",
     "axios": "^1.14.0",
     "esbuild": "^0.28.0",
     "typescript": "~5.9.3",
     "zod": "^4.3.6",
-    "@xyo-network/diviner-model": "~5.3.25",
-    "@xyo-network/module-model": "~5.3.25",
-    "@xyo-network/payload-model": "~5.3.25"
+    "@xyo-network/module-model": "~5.3.26",
+    "@xyo-network/payload-model": "~5.3.26",
+    "@xyo-network/diviner-model": "~5.3.26"
   },
   "peerDependencies": {
     "@xylabs/sdk-js": "^5",