@xyo-network/diviner-indexing-model 5.2.27 → 5.3.1

package/dist/neutral/Config.d.ts

@@ -1,10 +1,12 @@
 import type { EmptyObject, WithAdditional } from '@xylabs/sdk-js';
 import type { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model';
-import type { Payload } from '@xyo-network/payload-model';
+import { type Payload, type Schema } from '@xyo-network/payload-model';
 import type { IndexingDivinerStageConfig } from './Stage.ts';
-export declare const IndexingDivinerConfigSchema: "network.xyo.diviner.indexing.config";
+export declare const IndexingDivinerConfigSchema: string & {
+    readonly __schema: true;
+};
 export type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema;
-export type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = DivinerConfig<WithAdditional<{
+export type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends Schema | void = void> = DivinerConfig<WithAdditional<{
     /**
      * Where the diviner should store it's index
      */

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;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"}
+{"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,EACK,KAAK,OAAO,EAAE,KAAK,MAAM,EACpC,MAAM,4BAA4B,CAAA;AAGnC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAE5D,eAAO,MAAM,2BAA2B;;CAAoD,CAAA;AAC5F,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/Schema.d.ts

@@ -1,3 +1,5 @@
-export declare const IndexingDivinerSchema: "network.xyo.diviner.indexing";
+export declare const IndexingDivinerSchema: "network.xyo.diviner.indexing" & {
+    readonly __schema: true;
+};
 export type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema;
 //# sourceMappingURL=Schema.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,EAAG,8BAAuC,CAAA;AAC5E,MAAM,MAAM,2BAA2B,GAAG,OAAO,qBAAqB,CAAA"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,qBAAqB;;CAAiD,CAAA;AACnF,MAAM,MAAM,2BAA2B,GAAG,OAAO,qBAAqB,CAAA"}

package/dist/neutral/Stage.d.ts

@@ -1,5 +1,7 @@
-export type DivinerStageSchema = 'network.xyo.diviner.stage';
-export declare const DivinerStageSchema: DivinerStageSchema;
+export declare const DivinerStageSchema: "network.xyo.diviner.stage" & {
+    readonly __schema: true;
+};
+export type DivinerStageSchema = typeof DivinerStageSchema;
 import type { ModuleIdentifier } from '@xyo-network/module-model';
 /**
  * The diviners for each stage of an indexing diviner

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;AAEjE;;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;KACtC,GAAG,IAAI,oBAAoB,GAAG,gBAAgB;CAChD,CAAA"}

package/dist/neutral/index.mjs

@@ -1,11 +1,18 @@
+// src/Config.ts
+import {
+  asSchema as asSchema2
+} from "@xyo-network/payload-model";
+
 // src/Schema.ts
-var IndexingDivinerSchema = "network.xyo.diviner.indexing";
+import { asSchema } from "@xyo-network/payload-model";
+var IndexingDivinerSchema = asSchema("network.xyo.diviner.indexing", true);
 
 // src/Config.ts
-var IndexingDivinerConfigSchema = `${IndexingDivinerSchema}.config`;
+var IndexingDivinerConfigSchema = asSchema2(`${IndexingDivinerSchema}.config`, true);
 
 // src/Stage.ts
-var DivinerStageSchema = "network.xyo.diviner.stage";
+import { asSchema as asSchema3 } from "@xyo-network/payload-model";
+var DivinerStageSchema = asSchema3("network.xyo.diviner.stage", true);
 export {
   DivinerStageSchema,
   IndexingDivinerConfigSchema,

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Schema.ts","../../src/Config.ts","../../src/Stage.ts"],"sourcesContent":["export const IndexingDivinerSchema = 'network.xyo.diviner.indexing' as const\nexport type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema\n","import type { EmptyObject, WithAdditional } from '@xylabs/sdk-js'\nimport type { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'\nimport type { Payload } from '@xyo-network/payload-model'\n\nimport { IndexingDivinerSchema } from './Schema.ts'\nimport type { IndexingDivinerStageConfig } from './Stage.ts'\n\nexport const IndexingDivinerConfigSchema = `${IndexingDivinerSchema}.config` as const\nexport type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema\n\nexport type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | 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","export type DivinerStageSchema = 'network.xyo.diviner.stage'\nexport const DivinerStageSchema: DivinerStageSchema = 'network.xyo.diviner.stage'\n\nimport type { ModuleIdentifier } from '@xyo-network/module-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":";AAAO,IAAM,wBAAwB;;;ACO9B,IAAM,8BAA8B,GAAG,qBAAqB;;;ACN5D,IAAM,qBAAyC;","names":[]}
+{"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"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-indexing-model",
-  "version": "5.2.27",
+  "version": "5.3.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -37,9 +37,9 @@
   ],
   "dependencies": {
     "@xylabs/sdk-js": "~5.0.64",
-    "@xyo-network/diviner-model": "~5.2.27",
-    "@xyo-network/module-model": "~5.2.27",
-    "@xyo-network/payload-model": "~5.2.27"
+    "@xyo-network/diviner-model": "~5.3.1",
+    "@xyo-network/module-model": "~5.3.1",
+    "@xyo-network/payload-model": "~5.3.1"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "~7.3.2",

package/src/Config.ts

@@ -1,14 +1,16 @@
 import type { EmptyObject, WithAdditional } from '@xylabs/sdk-js'
 import type { DivinerConfig, SearchableStorage } from '@xyo-network/diviner-model'
-import type { Payload } from '@xyo-network/payload-model'
+import {
+  asSchema, type Payload, type Schema,
+} from '@xyo-network/payload-model'
 
 import { IndexingDivinerSchema } from './Schema.ts'
 import type { IndexingDivinerStageConfig } from './Stage.ts'
 
-export const IndexingDivinerConfigSchema = `${IndexingDivinerSchema}.config` as const
+export const IndexingDivinerConfigSchema = asSchema(`${IndexingDivinerSchema}.config`, true)
 export type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema
 
-export type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends string | void = void> = DivinerConfig<
+export type IndexingDivinerConfig<TConfig extends Payload | EmptyObject | void = void, TSchema extends Schema | void = void> = DivinerConfig<
   WithAdditional<
     {
       /**

package/src/Schema.ts

@@ -1,2 +1,4 @@
-export const IndexingDivinerSchema = 'network.xyo.diviner.indexing' as const
+import { asSchema } from '@xyo-network/payload-model'
+
+export const IndexingDivinerSchema = asSchema('network.xyo.diviner.indexing', true)
 export type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema

package/src/Stage.ts

@@ -1,7 +1,8 @@
-export type DivinerStageSchema = 'network.xyo.diviner.stage'
-export const DivinerStageSchema: DivinerStageSchema = 'network.xyo.diviner.stage'
+export const DivinerStageSchema = asSchema('network.xyo.diviner.stage', true)
+export type DivinerStageSchema = typeof DivinerStageSchema
 
 import type { ModuleIdentifier } from '@xyo-network/module-model'
+import { asSchema } from '@xyo-network/payload-model'
 
 /**
  * The diviners for each stage of an indexing diviner