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

package/dist/node/jsonpath/reducePayloads.d.cts

@@ -0,0 +1,27 @@
+import { SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model';
+import { Payload, PayloadFields } from '@xyo-network/payload-model';
+/**
+ * Reduces the payloads to a single payload using the supplied transformers
+ * @param payloads The payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payload
+ * @param destinationSchema The schema of the destination payload
+ * @returns The reduced payload
+ */
+export declare const reducePayloads: <T extends {
+    schema: string;
+} & PayloadFields = {
+    schema: string;
+} & PayloadFields>(payloads: Payload[], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string) => Promise<T>;
+/**
+ * Reduces the arrays of payload arrays to an array of payloads using the supplied transformers
+ * @param payloadsArray The arrays of payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payloads
+ * @param destinationSchema The schema of the destination payloads
+ * @returns The reduced payloads
+ */
+export declare const reducePayloadsArray: <T extends {
+    schema: string;
+} & PayloadFields = {
+    schema: string;
+} & PayloadFields>(payloadsArray: Payload[][], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string) => Promise<T[]>;
+//# sourceMappingURL=reducePayloads.d.ts.map

package/dist/node/jsonpath/reducePayloads.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reducePayloads.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/reducePayloads.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAErG,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;;6BACf,OAAO,EAAE,uBACE,qCAAqC,qBACvC,MAAM,eAe1B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;kCACf,OAAO,EAAE,EAAE,uBACL,qCAAqC,qBACvC,MAAM,iBAO1B,CAAA"}

package/dist/node/jsonpath/reducePayloads.d.mts

@@ -0,0 +1,27 @@
+import { SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model';
+import { Payload, PayloadFields } from '@xyo-network/payload-model';
+/**
+ * Reduces the payloads to a single payload using the supplied transformers
+ * @param payloads The payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payload
+ * @param destinationSchema The schema of the destination payload
+ * @returns The reduced payload
+ */
+export declare const reducePayloads: <T extends {
+    schema: string;
+} & PayloadFields = {
+    schema: string;
+} & PayloadFields>(payloads: Payload[], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string) => Promise<T>;
+/**
+ * Reduces the arrays of payload arrays to an array of payloads using the supplied transformers
+ * @param payloadsArray The arrays of payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payloads
+ * @param destinationSchema The schema of the destination payloads
+ * @returns The reduced payloads
+ */
+export declare const reducePayloadsArray: <T extends {
+    schema: string;
+} & PayloadFields = {
+    schema: string;
+} & PayloadFields>(payloadsArray: Payload[][], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string) => Promise<T[]>;
+//# sourceMappingURL=reducePayloads.d.ts.map

package/dist/node/jsonpath/reducePayloads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reducePayloads.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/reducePayloads.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAErG,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;;6BACf,OAAO,EAAE,uBACE,qCAAqC,qBACvC,MAAM,eAe1B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;kCACf,OAAO,EAAE,EAAE,uBACL,qCAAqC,qBACvC,MAAM,iBAO1B,CAAA"}

package/dist/node/jsonpath/reducePayloads.d.ts

@@ -0,0 +1,27 @@
+import { SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model';
+import { Payload, PayloadFields } from '@xyo-network/payload-model';
+/**
+ * Reduces the payloads to a single payload using the supplied transformers
+ * @param payloads The payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payload
+ * @param destinationSchema The schema of the destination payload
+ * @returns The reduced payload
+ */
+export declare const reducePayloads: <T extends {
+    schema: string;
+} & PayloadFields = {
+    schema: string;
+} & PayloadFields>(payloads: Payload[], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string) => Promise<T>;
+/**
+ * Reduces the arrays of payload arrays to an array of payloads using the supplied transformers
+ * @param payloadsArray The arrays of payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payloads
+ * @param destinationSchema The schema of the destination payloads
+ * @returns The reduced payloads
+ */
+export declare const reducePayloadsArray: <T extends {
+    schema: string;
+} & PayloadFields = {
+    schema: string;
+} & PayloadFields>(payloadsArray: Payload[][], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string) => Promise<T[]>;
+//# sourceMappingURL=reducePayloads.d.ts.map

package/dist/node/jsonpath/reducePayloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reducePayloads.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/reducePayloads.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAErG,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,cAAc;;;;6BACf,OAAO,EAAE,uBACE,qCAAqC,qBACvC,MAAM,eAe1B,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB;;;;kCACf,OAAO,EAAE,EAAE,uBACL,qCAAqC,qBACvC,MAAM,iBAO1B,CAAA"}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@xyo-network/diviner-jsonpath-aggregate-memory",
+  "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": {
+    "@xylabs/assert": "^2.13.20",
+    "@xyo-network/abstract-diviner": "~2.83.0",
+    "@xyo-network/core": "~2.83.0",
+    "@xyo-network/diviner-jsonpath-aggregate-model": "~2.83.0",
+    "@xyo-network/diviner-model": "~2.83.0",
+    "@xyo-network/payload-builder": "~2.83.0",
+    "@xyo-network/payload-model": "~2.83.0"
+  },
+  "devDependencies": {
+    "@xylabs/ts-scripts-yarn3": "^3.2.10",
+    "@xylabs/tsconfig": "^3.2.10",
+    "@xyo-network/account": "~2.83.0",
+    "@xyo-network/boundwitness-builder": "~2.83.0",
+    "@xyo-network/boundwitness-model": "~2.83.0",
+    "@xyo-network/diviner-jsonpath-memory": "~2.83.0",
+    "@xyo-network/wallet-model": "~2.83.0",
+    "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/Diviner.ts

@@ -0,0 +1,83 @@
+import { assertEx } from '@xylabs/assert'
+import { AbstractDiviner } from '@xyo-network/abstract-diviner'
+import {
+  JsonPathAggregateDivinerConfigSchema,
+  JsonPathAggregateDivinerParams,
+  PayloadTransformer,
+  SchemaToJsonPathTransformExpressionsDictionary,
+  SchemaToPayloadTransformersDictionary,
+} from '@xyo-network/diviner-jsonpath-aggregate-model'
+import { DivinerModule, DivinerModuleEventData } from '@xyo-network/diviner-model'
+import { Payload, PayloadSchema } from '@xyo-network/payload-model'
+
+import { jsonPathToTransformersDictionary, reducePayloads } from './jsonpath'
+
+const moduleName = 'JsonPathAggregateDiviner'
+
+export class JsonPathAggregateDiviner<
+  TParams extends JsonPathAggregateDivinerParams = JsonPathAggregateDivinerParams,
+  TIn extends Payload = Payload,
+  TOut extends Payload = Payload,
+  TEventData extends DivinerModuleEventData<DivinerModule<TParams>, TIn, TOut> = DivinerModuleEventData<DivinerModule<TParams>, TIn, TOut>,
+> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
+  static override configSchemas = [JsonPathAggregateDivinerConfigSchema]
+
+  protected _transforms: PayloadTransformer[] | undefined
+
+  private _payloadTransformers: SchemaToPayloadTransformersDictionary | undefined
+  private _transformableSchemas: string[] | undefined
+
+  /**
+   * The schema to use for the destination payloads
+   */
+  protected get destinationSchema(): string {
+    return this.config.destinationSchema ?? PayloadSchema
+  }
+
+  /**
+   * Dictionary of schemas to payload transformers
+   */
+  protected get payloadTransformers(): SchemaToPayloadTransformersDictionary {
+    if (!this._payloadTransformers) this._payloadTransformers = jsonPathToTransformersDictionary(this.schemaTransforms)
+    return this._payloadTransformers
+  }
+
+  /**
+   * The dictionary of schemas to JSON Path transform expressions
+   */
+  protected get schemaTransforms(): SchemaToJsonPathTransformExpressionsDictionary {
+    return assertEx(this.config?.schemaTransforms, () => `${moduleName}: Missing config.schemaTransforms section`)
+  }
+
+  /**
+   * List of transformable schemas for this diviner
+   */
+  protected get transformableSchemas(): string[] {
+    if (!this._transformableSchemas) this._transformableSchemas = [...Object.keys(this.schemaTransforms)]
+    return this._transformableSchemas
+  }
+
+  protected override async divineHandler(payloads?: TIn[]): Promise<TOut[]> {
+    if (!payloads) return []
+    const reducedPayloads = await reducePayloads<TOut>(payloads, this.payloadTransformers, this.destinationSchema)
+    return [reducedPayloads]
+  }
+
+  /**
+   * Identifies if a payload is one that is transformed by this diviner
+   * @param x The candidate payload
+   * @returns True if the payload is one transformed by this diviner, false otherwise
+   */
+  protected isTransformablePayload = (x: Payload) => {
+    return this.transformableSchemas.includes(x?.schema)
+  }
+
+  /**
+   * Identifies if a schema is one that is transformed by this diviner
+   * @param schema The candidate schema
+   * @returns True if this schema is one transformed by this diviner, false otherwise
+   */
+  protected isTransformableSchema = (schema?: string | null) => {
+    return this.transformableSchemas.some((s) => s === schema)
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './Diviner'

package/src/jsonpath/index.ts

@@ -0,0 +1,2 @@
+export * from './jsonPathToTransformersDictionary'
+export * from './reducePayloads'

package/src/jsonpath/jsonPathToTransformersDictionary.ts

@@ -0,0 +1,20 @@
+import { SchemaToJsonPathTransformExpressionsDictionary, SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model'
+import { toPayloadTransformer } from '@xyo-network/diviner-jsonpath-memory'
+
+/**
+ * Materializes the JSON-path expressions into memoized functions by converting a
+ * dictionary of schema to JSON Path transform expressions to a dictionary
+ * of schema to payload transformers
+ * @param schemaTransforms The schema transforms to convert
+ * @returns A dictionary of schema to payload transformers
+ */
+export const jsonPathToTransformersDictionary = (
+  schemaTransforms: SchemaToJsonPathTransformExpressionsDictionary,
+): SchemaToPayloadTransformersDictionary => {
+  return Object.fromEntries(
+    Object.entries(schemaTransforms).map(([schema, jsonPathTransformerExpressions]) => {
+      const transformers = jsonPathTransformerExpressions.map(toPayloadTransformer)
+      return [schema, transformers]
+    }),
+  )
+}

package/src/jsonpath/reducePayloads.ts

@@ -0,0 +1,50 @@
+import { PayloadHasher } from '@xyo-network/core'
+import { SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import { Payload, PayloadFields } from '@xyo-network/payload-model'
+
+/**
+ * Reduces the payloads to a single payload using the supplied transformers
+ * @param payloads The payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payload
+ * @param destinationSchema The schema of the destination payload
+ * @returns The reduced payload
+ */
+export const reducePayloads = async <T extends Payload = Payload>(
+  payloads: Payload[],
+  payloadTransformers: SchemaToPayloadTransformersDictionary,
+  destinationSchema: string,
+): Promise<T> => {
+  // Use the payload transformers to convert the fields from the source payloads to the destination fields
+  const indexFields = payloads
+    .map<PayloadFields[]>((payload) => {
+      // Find the transformers for this payload
+      const transformers = payloadTransformers[payload.schema]
+      // If transformers exist, apply them to the payload otherwise return an empty array
+      return transformers ? transformers.map((transform) => transform(payload)) : []
+    })
+    .flat()
+  // Include all the sources for reference
+  const sources = (await PayloadHasher.hashPairs([...payloads])).map(([, hash]) => hash)
+  // Build and return the index
+  return new PayloadBuilder<T>({ schema: destinationSchema }).fields(Object.assign({ sources }, ...indexFields)).build()
+}
+
+/**
+ * Reduces the arrays of payload arrays to an array of payloads using the supplied transformers
+ * @param payloadsArray The arrays of payloads to reduce
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payloads
+ * @param destinationSchema The schema of the destination payloads
+ * @returns The reduced payloads
+ */
+export const reducePayloadsArray = async <T extends Payload = Payload>(
+  payloadsArray: Payload[][],
+  payloadTransformers: SchemaToPayloadTransformersDictionary,
+  destinationSchema: string,
+): Promise<T[]> => {
+  return await Promise.all(
+    payloadsArray.map(async (payloads) => {
+      return await reducePayloads<T>(payloads, payloadTransformers, destinationSchema)
+    }),
+  )
+}

package/typedoc.json

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