@xyo-network/diviner-indexing-model 4.0.3 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,79 @@
+import { EmptyObject, WithAdditional } from '@xylabs/object';
+import { DivinerConfig, SearchableStorage, DivinerParams } from '@xyo-network/diviner-model';
+import { Payload } from '@xyo-network/payload-model';
+import { ModuleIdentifier, Labels, AnyConfigSchema, StateDictionary } from '@xyo-network/module-model';
+import { Hex } from '@xylabs/hex';
+
+type DivinerStageSchema = 'network.xyo.diviner.stage';
+declare const DivinerStageSchema: DivinerStageSchema;
+
+/**
+ * The diviners for each stage of an indexing diviner
+ */
+type IndexingDivinerStage = 'divinerQueryToIndexQueryDiviner'
+/**
+ * Transforms the index candidates into indexes
+ */
+ | 'indexCandidateToIndexDiviner'
+/**
+ * Transforms an index query response into a diviner divine query response
+ */
+ | 'indexQueryResponseToDivinerQueryResponseDiviner'
+/**
+ * Uses the current state to determine the next batch of index candidates
+ */
+ | 'stateToIndexCandidateDiviner';
+/**
+ * Config section for declaring each indexing diviner stage
+ */
+type IndexingDivinerStageConfig = {
+    [key in IndexingDivinerStage]: ModuleIdentifier;
+};
+
+declare const IndexingDivinerConfigSchema: "network.xyo.diviner.indexing.config";
+type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema;
+type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = DivinerConfig<WithAdditional<{
+    /**
+     * Where the diviner should store it's index
+     */
+    indexStore?: SearchableStorage;
+    /**
+     * Config section for name/address of individual diviner stages
+     */
+    indexingDivinerStages?: IndexingDivinerStageConfig;
+    /**
+     * The maximum number of payloads to index at a time
+     */
+    payloadDivinerLimit?: number;
+    /**
+     * How often to poll for new payloads to index
+     */
+    pollFrequency?: number;
+    /**
+     * The schema for the Diviner config
+     */
+    schema: IndexingDivinerConfigSchema;
+    /**
+     * Where the diviner should persist its internal state
+     */
+    stateStore?: SearchableStorage;
+}, TConfig>, TSchema>;
+
+/**
+ * Labels for Indexing Diviner Stage Diviners
+ */
+type IndexingDivinerStageLabels = Labels & {
+    [key in DivinerStageSchema]: IndexingDivinerStage;
+};
+
+type IndexingDivinerParams = DivinerParams<AnyConfigSchema<IndexingDivinerConfig>>;
+
+declare const IndexingDivinerSchema: "network.xyo.diviner.indexing";
+type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema;
+
+type IndexingDivinerState = StateDictionary & {
+    cursor: Hex;
+};
+
+export { DivinerStageSchema, IndexingDivinerConfigSchema, IndexingDivinerSchema };
+export type { ImageThumbnailDivinerSchema, IndexingDivinerConfig, IndexingDivinerParams, IndexingDivinerStage, IndexingDivinerStageConfig, IndexingDivinerStageLabels, IndexingDivinerState };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-indexing-model",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,23 +21,23 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "dist/neutral/index.mjs",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/hex": "^4.13.4",
-    "@xylabs/object": "^4.13.4",
-    "@xyo-network/diviner-model": "^4.0.3",
-    "@xyo-network/module-model": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3"
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/object": "^4.13.15",
+    "@xyo-network/diviner-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {