@xyo-network/diviner-jsonpath-aggregate-memory 4.0.3 → 4.1.0

package/dist/neutral/index.d.ts

@@ -0,0 +1,70 @@
+import { AbstractDiviner } from '@xyo-network/diviner-abstract';
+import { JsonPathAggregateDivinerParams, PayloadTransformer, SchemaToPayloadTransformersDictionary, SchemaToJsonPathTransformExpressionsDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model';
+import { DivinerModuleEventData, DivinerInstance } from '@xyo-network/diviner-model';
+import { Payload, Schema } from '@xyo-network/payload-model';
+
+declare class JsonPathAggregateDiviner<TParams extends JsonPathAggregateDivinerParams = JsonPathAggregateDivinerParams, TIn extends Payload = Payload, TOut extends Payload = Payload, TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>> extends AbstractDiviner<TParams, TIn, TOut, TEventData> {
+    static readonly configSchemas: Schema[];
+    static readonly defaultConfigSchema: Schema;
+    protected _transforms: PayloadTransformer[] | undefined;
+    private _payloadTransformers;
+    private _transformableSchemas;
+    /**
+     * The schema to use for the destination payloads
+     */
+    protected get destinationSchema(): string;
+    /**
+     * Dictionary of schemas to payload transformers
+     */
+    protected get payloadTransformers(): SchemaToPayloadTransformersDictionary;
+    /**
+     * The dictionary of schemas to JSON Path transform expressions
+     */
+    protected get schemaTransforms(): SchemaToJsonPathTransformExpressionsDictionary;
+    /**
+     * List of transformable schemas for this diviner
+     */
+    protected get transformableSchemas(): string[];
+    protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
+    /**
+     * 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) => boolean;
+    /**
+     * 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) => boolean;
+}
+
+/**
+ * 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
+ */
+declare const jsonPathToTransformersDictionary: (schemaTransforms: SchemaToJsonPathTransformExpressionsDictionary) => SchemaToPayloadTransformersDictionary;
+
+/**
+ * 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
+ * @param excludeSources Exclude the source hashes from the destination payload
+ * @returns The reduced payload
+ */
+declare const reducePayloads: <T extends Payload = Payload>(payloads: Payload[], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string, excludeSources?: boolean) => 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 excludeSources Exclude the source hashes from the destination payload
+ * @returns The reduced payloads
+ */
+declare const reducePayloadsArray: <T extends Payload = Payload>(payloadsArray: Payload[][], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string, excludeSources?: boolean) => Promise<T[]>;
+
+export { JsonPathAggregateDiviner, jsonPathToTransformersDictionary, reducePayloads, reducePayloadsArray };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-jsonpath-aggregate-memory",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,33 +21,33 @@
   "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/assert": "^4.13.4",
-    "@xylabs/exists": "^4.13.4",
-    "@xyo-network/boundwitness-model": "^4.0.3",
-    "@xyo-network/diviner-abstract": "^4.0.3",
-    "@xyo-network/diviner-jsonpath-aggregate-model": "^4.0.3",
-    "@xyo-network/diviner-jsonpath-memory": "^4.0.3",
-    "@xyo-network/diviner-model": "^4.0.3",
-    "@xyo-network/payload-builder": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3",
-    "@xyo-network/payload-utils": "^4.0.3"
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/exists": "^4.13.15",
+    "@xyo-network/boundwitness-model": "^4.1.0",
+    "@xyo-network/diviner-abstract": "^4.1.0",
+    "@xyo-network/diviner-jsonpath-aggregate-model": "^4.1.0",
+    "@xyo-network/diviner-jsonpath-memory": "^4.1.0",
+    "@xyo-network/diviner-model": "^4.1.0",
+    "@xyo-network/payload-builder": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0",
+    "@xyo-network/payload-utils": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
-    "@xylabs/vitest-extended": "^4.13.4",
-    "@xyo-network/account": "^4.0.3",
-    "@xyo-network/account-model": "^4.0.3",
-    "@xyo-network/boundwitness-builder": "^4.0.3",
-    "@xyo-network/diviner-jsonpath-model": "^4.0.3",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
+    "@xylabs/vitest-extended": "^4.13.15",
+    "@xyo-network/account": "^4.1.0",
+    "@xyo-network/account-model": "^4.1.0",
+    "@xyo-network/boundwitness-builder": "^4.1.0",
+    "@xyo-network/diviner-jsonpath-model": "^4.1.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },