@xyo-network/diviner-temporal-indexing-model 4.0.3 → 4.1.1

package/dist/node/index.d.ts

@@ -0,0 +1,186 @@
+import { IndexingDivinerStage, IndexingDivinerStageConfig } from '@xyo-network/diviner-indexing-model';
+import { SchemaToJsonPathTransformExpressionsDictionary } from '@xyo-network/diviner-jsonpath-model';
+import { DivinerConfig, DivinerParams, SearchableStorage } from '@xyo-network/diviner-model';
+import { Schema, Payload, PayloadWithSources } from '@xyo-network/payload-model';
+import { BoundWitnessDivinerPredicate } from '@xyo-network/diviner-boundwitness-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+import { Hash } from '@xylabs/hex';
+
+declare const TemporalIndexingDivinerSchema: "network.xyo.diviner.indexing.temporal";
+type TemporalIndexingDivinerSchema = typeof TemporalIndexingDivinerSchema;
+
+type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema = `${TemporalIndexingDivinerSchema}.stage.divinerQueryToIndexQueryDiviner`;
+declare const TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema: TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema;
+
+type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema = `${TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema}.config`;
+declare const TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema: TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema;
+/**
+ * Diviner Config for a Diviner which transforms a Diviner Query to an Index Query
+ */
+type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig = DivinerConfig<{
+    /**
+     * The schema of the diviner query payloads
+     */
+    divinerQuerySchema?: Schema;
+    /**
+     * The schema of the index query payloads
+     */
+    indexQuerySchema?: Schema;
+    /**
+     * The schema of the index payloads
+     */
+    indexSchema?: Schema;
+    /**
+     * The config schema
+     */
+    schema: TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema;
+    /**
+     * The transforms to apply to the source payloads
+     */
+    schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
+}>;
+
+type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig>>;
+
+type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema = `${TemporalIndexingDivinerSchema}.stage.indexQueryResponseToDivinerQueryResponseDiviner`;
+declare const TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema: TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema;
+
+type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema = `${TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema}.config`;
+declare const TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema: TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema;
+/**
+ * Diviner Config for a Diviner which transforms an Index Query Response to a Diviner Query Response
+ */
+type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig = DivinerConfig<{
+    /**
+     * The config schema
+     */
+    schema: TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema;
+    /**
+     * The transforms to apply to the source payloads
+     */
+    schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
+}>;
+
+type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig>>;
+
+type TemporalIndexingDivinerStateToIndexCandidateDivinerSchema = `${TemporalIndexingDivinerSchema}.stage.stateToIndexCandidateDiviner`;
+declare const TemporalIndexingDivinerStateToIndexCandidateDivinerSchema: TemporalIndexingDivinerStateToIndexCandidateDivinerSchema;
+
+type TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema = `${TemporalIndexingDivinerStateToIndexCandidateDivinerSchema}.config`;
+declare const TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema: TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema;
+/**
+ * Diviner Config for a Diviner which transforms a Diviner State to Index Candidates
+ */
+type TemporalIndexingDivinerStateToIndexCandidateDivinerConfig = DivinerConfig<{
+    /**
+     * The filter to use to identify index candidates
+     */
+    filter?: BoundWitnessDivinerPredicate;
+    /**
+     * The maximum number of payloads to index at a time
+     */
+    payloadDivinerLimit?: number;
+    /**
+     * Where the diviner should look for stored thumbnails
+     */
+    payloadStore?: SearchableStorage;
+    /**
+     * The config schema
+     */
+    schema: TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema;
+}>;
+
+type TemporalIndexingDivinerStateToIndexCandidateDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerStateToIndexCandidateDivinerConfig>>;
+
+declare const TemporalIndexingDivinerConfigSchema: "network.xyo.diviner.indexing.temporal.config";
+type TemporalIndexingDivinerConfigSchema = typeof TemporalIndexingDivinerConfigSchema;
+/**
+ * Config section for declaring each indexing diviner stage
+ */
+type IndexingDivinerStageTransformConfig = {
+    [key in IndexingDivinerStage]: SchemaToJsonPathTransformExpressionsDictionary;
+};
+/**
+ * Diviner Config for a Diviner which Indexes Payloads
+ */
+type TemporalIndexingDivinerConfig = DivinerConfig<{
+    /**
+     * 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 this config
+     */
+    schema: TemporalIndexingDivinerConfigSchema;
+    /**
+     * Optional config section for individual diviner stages
+     */
+    stageConfigs?: {
+        divinerQueryToIndexQueryDiviner?: Omit<TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig, 'schema'>;
+        indexCandidateToIndexDiviner?: Omit<TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig, 'schema'>;
+        indexQueryResponseToDivinerQueryResponseDiviner?: Omit<TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig, 'schema'>;
+        stateToIndexCandidateDiviner?: Omit<TemporalIndexingDivinerStateToIndexCandidateDivinerConfig, 'schema'>;
+    };
+    /**
+     * Where the diviner should persist its internal state
+     */
+    stateStore?: SearchableStorage;
+}>;
+
+type TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema = `${TemporalIndexingDivinerSchema}.stage.indexCandidateToIndexDiviner`;
+declare const TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema: TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema;
+
+type TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema = `${TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema}.config`;
+declare const TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema: TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema;
+/**
+ * Diviner Config for a Diviner which transforms Index Candidates to Indexes
+ */
+type TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig = DivinerConfig<{
+    /**
+     * The config schema
+     */
+    schema: TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema;
+    /**
+     * The transforms to apply to the source payloads
+     */
+    schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
+}>;
+
+/**
+ * Diviner Params for a Diviner which transforms Index Candidates to Indexes
+ */
+type TemporalIndexingDivinerIndexCandidateToIndexDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig>>;
+
+type TemporalIndexingDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerConfig>>;
+
+declare const TemporalIndexingDivinerResultSchema: "network.xyo.diviner.indexing.temporal.result";
+type TemporalIndexingDivinerResultSchema = typeof TemporalIndexingDivinerResultSchema;
+
+type TemporalIndexingDivinerResult = Payload<{
+    sources: Hash[];
+    timestamp: string;
+}, TemporalIndexingDivinerResultSchema>;
+declare const isTemporalIndexingDivinerResult: (x?: unknown | null) => x is TemporalIndexingDivinerResult;
+
+declare const TemporalIndexingDivinerResultIndexSchema: "network.xyo.diviner.indexing.temporal.result.index";
+type TemporalIndexingDivinerResultIndexSchema = typeof TemporalIndexingDivinerResultIndexSchema;
+
+type TemporalIndexingDivinerResultIndex = PayloadWithSources<{
+    timestamp: number;
+}, TemporalIndexingDivinerResultIndexSchema>;
+declare const isTemporalIndexingDivinerResultIndex: (x?: unknown | null) => x is TemporalIndexingDivinerResultIndex;
+
+export { TemporalIndexingDivinerConfigSchema, TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema, TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema, TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema, TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema, TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema, TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema, TemporalIndexingDivinerResultIndexSchema, TemporalIndexingDivinerResultSchema, TemporalIndexingDivinerSchema, TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema, TemporalIndexingDivinerStateToIndexCandidateDivinerSchema, isTemporalIndexingDivinerResult, isTemporalIndexingDivinerResultIndex };
+export type { IndexingDivinerStageTransformConfig, TemporalIndexingDivinerConfig, TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig, TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerParams, TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig, TemporalIndexingDivinerIndexCandidateToIndexDivinerParams, TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig, TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerParams, TemporalIndexingDivinerParams, TemporalIndexingDivinerResult, TemporalIndexingDivinerResultIndex, TemporalIndexingDivinerStateToIndexCandidateDivinerConfig, TemporalIndexingDivinerStateToIndexCandidateDivinerParams };

package/dist/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,4CAA4C,CAAA;AAC1D,cAAc,yCAAyC,CAAA;AACvD,cAAc,4DAA4D,CAAA;AAC1E,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA;AACjC,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,yCAAyC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-temporal-indexing-model",
-  "version": "4.0.3",
+  "version": "4.1.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,25 +21,25 @@
   "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",
-    "@xyo-network/diviner-boundwitness-model": "^4.0.3",
-    "@xyo-network/diviner-indexing-model": "^4.0.3",
-    "@xyo-network/diviner-jsonpath-model": "^4.0.3",
-    "@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",
+    "@xyo-network/diviner-boundwitness-model": "^4.1.1",
+    "@xyo-network/diviner-indexing-model": "^4.1.1",
+    "@xyo-network/diviner-jsonpath-model": "^4.1.1",
+    "@xyo-network/diviner-model": "^4.1.1",
+    "@xyo-network/module-model": "^4.1.1",
+    "@xyo-network/payload-model": "^4.1.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
+    "@xylabs/tsconfig": "^7.0.0-rc.23",
     "typescript": "^5.8.3"
   },
   "publishConfig": {

package/dist/types/index.d.ts

@@ -1,10 +0,0 @@
-export * from './Config.ts';
-export * from './DivinerQueryToIndexQueryDiviner/index.ts';
-export * from './IndexCandidateToIndexDiviner/index.ts';
-export * from './IndexQueryResponseToDivinerQueryResponseDiviner/index.ts';
-export * from './Params.ts';
-export * from './Result/index.ts';
-export * from './ResultIndex/index.ts';
-export * from './Schema.ts';
-export * from './StateToIndexCandidateDiviner/index.ts';
-//# sourceMappingURL=index.d.ts.map