@xyo-network/diviner-temporal-indexing-model 2.80.0-rc.1

package/dist/node/index.mjs

@@ -0,0 +1,35 @@
+// src/Schema.ts
+import { IndexingDivinerSchema } from "@xyo-network/diviner-indexing-model";
+var TemporalIndexingDivinerSchema = `${IndexingDivinerSchema}.temporal`;
+
+// src/Config.ts
+var TemporalIndexingDivinerConfigSchema = `${TemporalIndexingDivinerSchema}.config`;
+
+// src/Result/Payload.ts
+import { isPayloadOfSchemaType } from "@xyo-network/payload-model";
+
+// src/Result/Schema.ts
+var TemporalIndexingDivinerResultSchema = `${TemporalIndexingDivinerSchema}.result`;
+
+// src/Result/Payload.ts
+var isTemporalIndexingDivinerResult = isPayloadOfSchemaType(TemporalIndexingDivinerResultSchema);
+
+// src/ResultIndex/Payload.ts
+import { isPayloadOfSchemaType as isPayloadOfSchemaType2 } from "@xyo-network/payload-model";
+
+// src/ResultIndex/Schema.ts
+var TemporalIndexingDivinerResultIndexSchema = `${TemporalIndexingDivinerResultSchema}.index`;
+
+// src/ResultIndex/Payload.ts
+var isTemporalIndexingDivinerResultIndex = isPayloadOfSchemaType2(
+  TemporalIndexingDivinerResultIndexSchema
+);
+export {
+  TemporalIndexingDivinerConfigSchema,
+  TemporalIndexingDivinerResultIndexSchema,
+  TemporalIndexingDivinerResultSchema,
+  TemporalIndexingDivinerSchema,
+  isTemporalIndexingDivinerResult,
+  isTemporalIndexingDivinerResultIndex
+};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/Schema.ts","../../src/Config.ts","../../src/Result/Payload.ts","../../src/Result/Schema.ts","../../src/ResultIndex/Payload.ts","../../src/ResultIndex/Schema.ts"],"sourcesContent":["import { IndexingDivinerSchema } from '@xyo-network/diviner-indexing-model'\n\nexport const TemporalIndexingDivinerSchema = `${IndexingDivinerSchema}.temporal` as const\nexport type TemporalIndexingDivinerSchema = typeof TemporalIndexingDivinerSchema\n","import { SearchableStorage } from '@xyo-network/diviner-indexing-model'\nimport { DivinerConfig } from '@xyo-network/diviner-model'\n\nimport { TemporalIndexingDivinerSchema } from './Schema'\n\nexport const TemporalIndexingDivinerConfigSchema = `${TemporalIndexingDivinerSchema}.config` as const\nexport type TemporalIndexingDivinerConfigSchema = typeof TemporalIndexingDivinerConfigSchema\n\n// TODO: Extend indexing diviner config and just remove fields that are not needed?\nexport type TemporalIndexingDivinerConfig = DivinerConfig<{\n  /**\n   * Where the diviner should store it's index\n   */\n  indexStore?: SearchableStorage\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: TemporalIndexingDivinerConfigSchema\n  /**\n   * Where the diviner should persist its internal state\n   */\n  stateStore?: SearchableStorage\n}>\n","import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\n\nimport { TemporalIndexingDivinerResultSchema } from './Schema'\n\nexport type TemporalIndexingDivinerResult = Payload<\n  {\n    sources: string[]\n    timestamp: string\n  },\n  TemporalIndexingDivinerResultSchema\n>\nexport const isTemporalIndexingDivinerResult = isPayloadOfSchemaType<TemporalIndexingDivinerResult>(TemporalIndexingDivinerResultSchema)\n","import { TemporalIndexingDivinerSchema } from '../Schema'\n\nexport const TemporalIndexingDivinerResultSchema = `${TemporalIndexingDivinerSchema}.result` as const\nexport type TemporalIndexingDivinerResultSchema = typeof TemporalIndexingDivinerResultSchema\n","import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'\n\nimport { TemporalIndexingDivinerResultIndexSchema } from './Schema'\n\nexport type TemporalIndexingDivinerResultIndex = Payload<\n  {\n    sources: string[]\n    timestamp: string\n  },\n  TemporalIndexingDivinerResultIndexSchema\n>\nexport const isTemporalIndexingDivinerResultIndex = isPayloadOfSchemaType<TemporalIndexingDivinerResultIndex>(\n  TemporalIndexingDivinerResultIndexSchema,\n)\n","import { TemporalIndexingDivinerResultSchema } from '../Result'\n\nexport const TemporalIndexingDivinerResultIndexSchema = `${TemporalIndexingDivinerResultSchema}.index` as const\nexport type TemporalIndexingDivinerResultIndexSchema = typeof TemporalIndexingDivinerResultIndexSchema\n"],"mappings":";AAAA,SAAS,6BAA6B;AAE/B,IAAM,gCAAgC,GAAG,qBAAqB;;;ACG9D,IAAM,sCAAsC,GAAG,6BAA6B;;;ACLnF,SAAS,6BAAsC;;;ACExC,IAAM,sCAAsC,GAAG,6BAA6B;;;ADS5E,IAAM,kCAAkC,sBAAqD,mCAAmC;;;AEXvI,SAAS,yBAAAA,8BAAsC;;;ACExC,IAAM,2CAA2C,GAAG,mCAAmC;;;ADSvF,IAAM,uCAAuCC;AAAA,EAClD;AACF;","names":["isPayloadOfSchemaType","isPayloadOfSchemaType"]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@xyo-network/diviner-temporal-indexing-model",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xyo-network/diviner-indexing-model": "~2.81.0-rc.1",
+    "@xyo-network/diviner-model": "~2.81.0-rc.1",
+    "@xyo-network/module-model": "~2.81.0-rc.1",
+    "@xyo-network/payload-model": "~2.81.0-rc.1"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.2",
+    "@xylabs/tsconfig": "^3.2.2",
+    "typescript": "^5.2.2"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "docs": "dist/docs.json",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": {
+          "types": "./dist/browser/index.d.cts",
+          "default": "./dist/browser/index.cjs"
+        },
+        "import": {
+          "types": "./dist/browser/index.d.mts",
+          "default": "./dist/browser/index.js"
+        }
+      },
+      "node": {
+        "require": {
+          "types": "./dist/node/index.d.ts",
+          "default": "./dist/node/index.js"
+        },
+        "import": {
+          "types": "./dist/node/index.d.mts",
+          "default": "./dist/node/index.mjs"
+        }
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/node/index.js",
+  "module": "dist/node/index.mjs",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.80.0-rc.1",
+  "stableVersion": "2.79.7"
+}

package/src/Config.ts

@@ -0,0 +1,31 @@
+import { SearchableStorage } from '@xyo-network/diviner-indexing-model'
+import { DivinerConfig } from '@xyo-network/diviner-model'
+
+import { TemporalIndexingDivinerSchema } from './Schema'
+
+export const TemporalIndexingDivinerConfigSchema = `${TemporalIndexingDivinerSchema}.config` as const
+export type TemporalIndexingDivinerConfigSchema = typeof TemporalIndexingDivinerConfigSchema
+
+// TODO: Extend indexing diviner config and just remove fields that are not needed?
+export type TemporalIndexingDivinerConfig = DivinerConfig<{
+  /**
+   * Where the diviner should store it's index
+   */
+  indexStore?: SearchableStorage
+  /**
+   * 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: TemporalIndexingDivinerConfigSchema
+  /**
+   * Where the diviner should persist its internal state
+   */
+  stateStore?: SearchableStorage
+}>

package/src/Params.ts

@@ -0,0 +1,8 @@
+import { IndexingDivinerParams } from '@xyo-network/diviner-indexing-model'
+import { DivinerParams } from '@xyo-network/diviner-model'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+
+import { TemporalIndexingDivinerConfig } from './Config'
+
+// TODO: Extend indexing diviner params and just remove fields that are not needed?
+export type TemporalIndexingDivinerParams = IndexingDivinerParams & DivinerParams<AnyConfigSchema<TemporalIndexingDivinerConfig>>

package/src/Result/Payload.ts

@@ -0,0 +1,12 @@
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+import { TemporalIndexingDivinerResultSchema } from './Schema'
+
+export type TemporalIndexingDivinerResult = Payload<
+  {
+    sources: string[]
+    timestamp: string
+  },
+  TemporalIndexingDivinerResultSchema
+>
+export const isTemporalIndexingDivinerResult = isPayloadOfSchemaType<TemporalIndexingDivinerResult>(TemporalIndexingDivinerResultSchema)

package/src/Result/Schema.ts

@@ -0,0 +1,4 @@
+import { TemporalIndexingDivinerSchema } from '../Schema'
+
+export const TemporalIndexingDivinerResultSchema = `${TemporalIndexingDivinerSchema}.result` as const
+export type TemporalIndexingDivinerResultSchema = typeof TemporalIndexingDivinerResultSchema

package/src/Result/index.ts

@@ -0,0 +1,2 @@
+export * from './Payload'
+export * from './Schema'

package/src/ResultIndex/Payload.ts

@@ -0,0 +1,14 @@
+import { isPayloadOfSchemaType, Payload } from '@xyo-network/payload-model'
+
+import { TemporalIndexingDivinerResultIndexSchema } from './Schema'
+
+export type TemporalIndexingDivinerResultIndex = Payload<
+  {
+    sources: string[]
+    timestamp: string
+  },
+  TemporalIndexingDivinerResultIndexSchema
+>
+export const isTemporalIndexingDivinerResultIndex = isPayloadOfSchemaType<TemporalIndexingDivinerResultIndex>(
+  TemporalIndexingDivinerResultIndexSchema,
+)

package/src/ResultIndex/Schema.ts

@@ -0,0 +1,4 @@
+import { TemporalIndexingDivinerResultSchema } from '../Result'
+
+export const TemporalIndexingDivinerResultIndexSchema = `${TemporalIndexingDivinerResultSchema}.index` as const
+export type TemporalIndexingDivinerResultIndexSchema = typeof TemporalIndexingDivinerResultIndexSchema

package/src/ResultIndex/index.ts

@@ -0,0 +1,2 @@
+export * from './Payload'
+export * from './Schema'

package/src/Schema.ts

@@ -0,0 +1,4 @@
+import { IndexingDivinerSchema } from '@xyo-network/diviner-indexing-model'
+
+export const TemporalIndexingDivinerSchema = `${IndexingDivinerSchema}.temporal` as const
+export type TemporalIndexingDivinerSchema = typeof TemporalIndexingDivinerSchema

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from './Config'
+export * from './Params'
+export * from './Result'
+export * from './ResultIndex'
+export * from './Schema'

package/typedoc.json

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