@xyo-network/diviner-jsonpath-aggregate-model 2.83.0

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@xyo-network/diviner-jsonpath-aggregate-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/core": "~2.83.0",
+    "@xyo-network/diviner-model": "~2.83.0",
+    "@xyo-network/module-model": "~2.83.0",
+    "@xyo-network/payload-model": "~2.83.0"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.10",
+    "@xylabs/tsconfig": "^3.2.10",
+    "typescript": "^5.3.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.83.0"
+}

package/src/Config.ts

@@ -0,0 +1,29 @@
+import { DivinerConfig } from '@xyo-network/diviner-model'
+
+import { SchemaToJsonPathTransformExpressionsDictionary } from './jsonpath'
+import { JsonPathAggregateDivinerSchema } from './Schema'
+
+/**
+ * The config schema type for the JSON Path diviner
+ */
+export type JsonPathAggregateDivinerConfigSchema = `${JsonPathAggregateDivinerSchema}.config`
+/**
+ * The config schema for the JSON Path diviner
+ */
+export const JsonPathAggregateDivinerConfigSchema: JsonPathAggregateDivinerConfigSchema = `${JsonPathAggregateDivinerSchema}.config`
+
+/**
+ * The configuration for the JSON Path diviner
+ */
+export type JsonPathAggregateDivinerConfig = DivinerConfig<
+  {
+    /**
+     * The schema to use for the destination payloads
+     */
+    destinationSchema?: string
+    /**
+     * The JSON Path transform expressions to apply to the payloads
+     */
+    schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary
+  } & { schema: JsonPathAggregateDivinerConfigSchema }
+>

package/src/Params.ts

@@ -0,0 +1,9 @@
+import { DivinerParams } from '@xyo-network/diviner-model'
+import { AnyConfigSchema } from '@xyo-network/module-model'
+
+import { JsonPathAggregateDivinerConfig } from './Config'
+
+/**
+ * The params type the JSON Path diviner
+ **/
+export type JsonPathAggregateDivinerParams = DivinerParams<AnyConfigSchema<JsonPathAggregateDivinerConfig>>

package/src/Schema.ts

@@ -0,0 +1,8 @@
+/**
+ * The schema type used for the JSONPath Diviner.
+ */
+export type JsonPathAggregateDivinerSchema = 'network.xyo.diviner.jsonpath'
+/**
+ * The schema used for the JSONPath Diviner.
+ */
+export const JsonPathAggregateDivinerSchema: JsonPathAggregateDivinerSchema = 'network.xyo.diviner.jsonpath'

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './Config'
+export * from './jsonpath'
+export * from './Params'
+export * from './Schema'

package/src/jsonpath/JsonPathTransformExpression.ts

@@ -0,0 +1,20 @@
+import { JsonValue } from '@xyo-network/core'
+
+/**
+ * Describes the JSON-path transformation to retrieve a field on a source object
+ * and the target field to store the value to on a destination object
+ */
+export interface JsonPathTransformExpression {
+  /**
+   * The default value to use if the source field does not exist
+   */
+  defaultValue?: JsonValue
+  /**
+   * The target field to store the source field into on the destination object
+   */
+  destinationField: string
+  /**
+   * The JSON path expressions for the source field on the source object
+   */
+  sourcePathExpression: string
+}

package/src/jsonpath/PayloadTransformer.ts

@@ -0,0 +1,3 @@
+import { Payload } from '@xyo-network/payload-model'
+
+export type PayloadTransformer = (x: Payload) => Partial<Payload>

package/src/jsonpath/SchemaToJsonPathTransformExpressionDictionary.ts

@@ -0,0 +1,8 @@
+import { JsonPathTransformExpression } from './JsonPathTransformExpression'
+
+/**
+ * A dictionary of schema to JSON Path transform expressions.
+ */
+export type SchemaToJsonPathTransformExpressionsDictionary<T extends { [schema: string]: unknown } = { [schema: string]: unknown }> = {
+  [key in keyof T]: JsonPathTransformExpression[]
+}

package/src/jsonpath/SchemaToPayloadTransformersDictionary.ts

@@ -0,0 +1,6 @@
+import { PayloadTransformer } from './PayloadTransformer'
+
+/**
+ * A dictionary of schema to payload transformers
+ */
+export type SchemaToPayloadTransformersDictionary = { [schema: string]: PayloadTransformer[] }

package/src/jsonpath/index.ts

@@ -0,0 +1,4 @@
+export * from './JsonPathTransformExpression'
+export * from './PayloadTransformer'
+export * from './SchemaToJsonPathTransformExpressionDictionary'
+export * from './SchemaToPayloadTransformersDictionary'

package/typedoc.json

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