@xyo-network/diviner-indexing-model 3.2.0 → 3.3.1

package/dist/neutral/Config.d.ts

@@ -5,11 +5,29 @@ import type { IndexingDivinerStageConfig } from './Stage.ts';
 export declare const IndexingDivinerConfigSchema: "network.xyo.diviner.indexing.config";
 export type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema;
 export 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>;
 //# sourceMappingURL=Config.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAClF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAE5D,eAAO,MAAM,2BAA2B,uCAA6C,CAAA;AACrF,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,OAAO,GAAG,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,aAAa,CAC1I,cAAc,CACZ;IAIE,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAI9B,qBAAqB,CAAC,EAAE,0BAA0B,CAAA;IAIlD,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAI5B,aAAa,CAAC,EAAE,MAAM,CAAA;IAItB,MAAM,EAAE,2BAA2B,CAAA;IAInC,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAC/B,EACD,OAAO,CACR,EACD,OAAO,CACR,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAClF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAE5D,eAAO,MAAM,2BAA2B,uCAA6C,CAAA;AACrF,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAE5E,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,OAAO,GAAG,WAAW,GAAG,IAAI,GAAG,IAAI,EAAE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,aAAa,CAC1I,cAAc,CACZ;IACE;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAA;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,0BAA0B,CAAA;IAClD;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAA;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAA;CAC/B,EACD,OAAO,CACR,EACD,OAAO,CACR,CAAA"}

package/dist/neutral/Labels.d.ts

@@ -1,5 +1,8 @@
 import type { Labels } from '@xyo-network/module-model';
 import type { DivinerStageSchema, IndexingDivinerStage } from './Stage.ts';
+/**
+ * Labels for Indexing Diviner Stage Diviners
+ */
 export type IndexingDivinerStageLabels = Labels & {
     [key in DivinerStageSchema]: IndexingDivinerStage;
 };

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;AAK1E,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;KAI/C,GAAG,IAAI,kBAAkB,GAAG,oBAAoB;CAClD,CAAA"}

package/dist/neutral/Stage.d.ts

@@ -1,7 +1,29 @@
 export type DivinerStageSchema = 'network.xyo.diviner.stage';
 export declare const DivinerStageSchema: DivinerStageSchema;
 import type { ModuleIdentifier } from '@xyo-network/module-model';
-export type IndexingDivinerStage = 'divinerQueryToIndexQueryDiviner' | 'indexCandidateToIndexDiviner' | 'indexQueryResponseToDivinerQueryResponseDiviner' | 'stateToIndexCandidateDiviner';
+/**
+ * The diviners for each stage of an indexing diviner
+ */
+export type IndexingDivinerStage = 
+/**
+ * Transforms a diviner query into an index query
+ */
+'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
+ */
 export type IndexingDivinerStageConfig = {
     [key in IndexingDivinerStage]: ModuleIdentifier;
 };

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

@@ -1 +1 @@
-{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../src/Stage.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAKjE,MAAM,MAAM,oBAAoB,GAI5B,iCAAiC,GAIjC,8BAA8B,GAI9B,iDAAiD,GAIjD,8BAA8B,CAAA;AAKlC,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,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AAEjE;;GAEG;AACH,MAAM,MAAM,oBAAoB;AAC9B;;GAEG;AACD,iCAAiC;AACnC;;GAEG;GACD,8BAA8B;AAChC;;GAEG;GACD,iDAAiD;AACnD;;GAEG;GACD,8BAA8B,CAAA;AAElC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;KACtC,GAAG,IAAI,oBAAoB,GAAG,gBAAgB;CAChD,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-indexing-model",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,15 +29,15 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/object": "^4.1.0",
-    "@xyo-network/diviner-model": "^3.2.0",
-    "@xyo-network/module-model": "^3.2.0",
-    "@xyo-network/payload-model": "^3.2.0"
+    "@xylabs/object": "^4.3.2",
+    "@xyo-network/diviner-model": "^3.3.1",
+    "@xyo-network/module-model": "^3.3.1",
+    "@xyo-network/payload-model": "^3.3.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.1.0",
-    "@xylabs/tsconfig": "^4.1.0",
-    "typescript": "^5.6.2"
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig": "^4.2.3",
+    "typescript": "^5.6.3"
   },
   "publishConfig": {
     "access": "public"