@xyo-network/diviner-indexing-model 3.3.0 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/neutral/Config.d.ts +18 -0
  2. package/dist/neutral/Config.d.ts.map +1 -1
  3. package/dist/neutral/Labels.d.ts +3 -0
  4. package/dist/neutral/Labels.d.ts.map +1 -1
  5. package/dist/neutral/Stage.d.ts +23 -1
  6. package/dist/neutral/Stage.d.ts.map +1 -1
  7. package/package.json +7 -7
package/dist/neutral/Config.d.ts CHANGED
@@ -5,11 +5,29 @@ import type { IndexingDivinerStageConfig } from './Stage.ts';
5
5
  export declare const IndexingDivinerConfigSchema: "network.xyo.diviner.indexing.config";
6
6
  export type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema;
7
7
  export type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = DivinerConfig<WithAdditional<{
8
+ /**
9
+ * Where the diviner should store it's index
10
+ */
8
11
  indexStore?: SearchableStorage;
12
+ /**
13
+ * Config section for name/address of individual diviner stages
14
+ */
9
15
  indexingDivinerStages?: IndexingDivinerStageConfig;
16
+ /**
17
+ * The maximum number of payloads to index at a time
18
+ */
10
19
  payloadDivinerLimit?: number;
20
+ /**
21
+ * How often to poll for new payloads to index
22
+ */
11
23
  pollFrequency?: number;
24
+ /**
25
+ * The schema for the Diviner config
26
+ */
12
27
  schema: IndexingDivinerConfigSchema;
28
+ /**
29
+ * Where the diviner should persist its internal state
30
+ */
13
31
  stateStore?: SearchableStorage;
14
32
  }, TConfig>, TSchema>;
15
33
  //# sourceMappingURL=Config.d.ts.map
package/dist/neutral/Config.d.ts.map CHANGED
@@ -1 +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"}
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;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 CHANGED
@@ -1,5 +1,8 @@
1
1
  import type { Labels } from '@xyo-network/module-model';
2
2
  import type { DivinerStageSchema, IndexingDivinerStage } from './Stage.ts';
3
+ /**
4
+ * Labels for Indexing Diviner Stage Diviners
5
+ */
3
6
  export type IndexingDivinerStageLabels = Labels & {
4
7
  [key in DivinerStageSchema]: IndexingDivinerStage;
5
8
  };
package/dist/neutral/Labels.d.ts.map CHANGED
@@ -1 +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"}
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"}
package/dist/neutral/Stage.d.ts CHANGED
@@ -1,7 +1,29 @@
1
1
  export type DivinerStageSchema = 'network.xyo.diviner.stage';
2
2
  export declare const DivinerStageSchema: DivinerStageSchema;
3
3
  import type { ModuleIdentifier } from '@xyo-network/module-model';
4
- export type IndexingDivinerStage = 'divinerQueryToIndexQueryDiviner' | 'indexCandidateToIndexDiviner' | 'indexQueryResponseToDivinerQueryResponseDiviner' | 'stateToIndexCandidateDiviner';
4
+ /**
5
+ * The diviners for each stage of an indexing diviner
6
+ */
7
+ export type IndexingDivinerStage =
8
+ /**
9
+ * Transforms a diviner query into an index query
10
+ */
11
+ 'divinerQueryToIndexQueryDiviner'
12
+ /**
13
+ * Transforms the index candidates into indexes
14
+ */
15
+ | 'indexCandidateToIndexDiviner'
16
+ /**
17
+ * Transforms an index query response into a diviner divine query response
18
+ */
19
+ | 'indexQueryResponseToDivinerQueryResponseDiviner'
20
+ /**
21
+ * Uses the current state to determine the next batch of index candidates
22
+ */
23
+ | 'stateToIndexCandidateDiviner';
24
+ /**
25
+ * Config section for declaring each indexing diviner stage
26
+ */
5
27
  export type IndexingDivinerStageConfig = {
6
28
  [key in IndexingDivinerStage]: ModuleIdentifier;
7
29
  };
package/dist/neutral/Stage.d.ts.map CHANGED
@@ -1 +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"}
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;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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/diviner-indexing-model",
3
- "version": "3.3.0",
3
+ "version": "3.3.2",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,14 +29,14 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/object": "^4.2.2",
33
- "@xyo-network/diviner-model": "^3.3.0",
34
- "@xyo-network/module-model": "^3.3.0",
35
- "@xyo-network/payload-model": "^3.3.0"
32
+ "@xylabs/object": "^4.3.2",
33
+ "@xyo-network/diviner-model": "^3.3.2",
34
+ "@xyo-network/module-model": "^3.3.2",
35
+ "@xyo-network/payload-model": "^3.3.2"
36
36
  },
37
37
  "devDependencies": {
38
- "@xylabs/ts-scripts-yarn3": "^4.2.1",
39
- "@xylabs/tsconfig": "^4.2.1",
38
+ "@xylabs/ts-scripts-yarn3": "^4.2.3",
39
+ "@xylabs/tsconfig": "^4.2.3",
40
40
  "typescript": "^5.6.3"
41
41
  },
42
42
  "publishConfig": {