@xyo-network/diviner-indexing-model 2.79.5

package/src/Config.ts

@@ -0,0 +1,35 @@
+import { DivinerConfig } from '@xyo-network/diviner-model'
+
+import { IndexingDivinerSchema } from './Schema'
+import { SearchableStorage } from './SearchableStorage'
+import { IndexingDivinerStageConfig } from './Stage'
+
+export const IndexingDivinerConfigSchema = `${IndexingDivinerSchema}.config` as const
+export type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema
+
+export type IndexingDivinerConfig = DivinerConfig<{
+  /**
+   * Where the diviner should store it's index
+   */
+  indexStore?: SearchableStorage
+  /**
+   * Config section for individual indexing 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
+}>

package/src/Labels.ts

@@ -0,0 +1,13 @@
+import { Labels } from '@xyo-network/module-model'
+
+import { DivinerStageSchema, IndexingDivinerStage } from './Stage'
+
+/**
+ * Labels for Indexing Diviner Stage Diviners
+ */
+export type IndexingDivinerStageLabels = Labels & {
+  /**
+   * Labels for the stage of the Indexing Diviner Stage Diviner
+   */
+  [key in DivinerStageSchema]: IndexingDivinerStage
+}

package/src/Params.ts

@@ -0,0 +1,6 @@
+import { DivinerParams } from '@xyo-network/diviner-model'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+
+import { IndexingDivinerConfig } from './Config'
+
+export type IndexingDivinerParams = DivinerParams<AnyConfigSchema<IndexingDivinerConfig>>

package/src/Schema.ts

@@ -0,0 +1,2 @@
+export const IndexingDivinerSchema = 'network.xyo.diviner.indexing' as const
+export type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema

package/src/SearchableStorage.ts

@@ -0,0 +1,9 @@
+/**
+ * Describes an Archivist/Diviner combination
+ * that enables searching signed payloads
+ */
+export interface SearchableStorage {
+  archivist: string
+  boundWitnessDiviner: string
+  payloadDiviner: string
+}

package/src/Stage.ts

@@ -0,0 +1,30 @@
+export type DivinerStageSchema = 'network.xyo.diviner.stage'
+export const DivinerStageSchema: DivinerStageSchema = 'network.xyo.diviner.stage'
+
+/**
+ * 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]: string
+}

package/src/State.ts

@@ -0,0 +1,5 @@
+import { StateDictionary } from '@xyo-network/module-model'
+
+export type IndexingDivinerState = StateDictionary & {
+  offset: number
+}

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from './Config'
+export * from './Labels'
+export * from './Params'
+export * from './Schema'
+export * from './SearchableStorage'
+export * from './Stage'
+export * from './State'

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}