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

package/dist/neutral/index.d.ts

@@ -0,0 +1,88 @@
+import { DivinerConfig, DivinerParams } from '@xyo-network/diviner-model';
+import { JsonValue } from '@xylabs/object';
+import { Payload } from '@xyo-network/payload-model';
+import { AnyConfigSchema } from '@xyo-network/module-model';
+
+/**
+ * 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
+ */
+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;
+}
+
+type PayloadTransformer = (x: Payload) => Partial<Payload>;
+
+/**
+ * A dictionary of schema to JSON Path transform expressions.
+ */
+type SchemaToJsonPathTransformExpressionsDictionary<T extends {
+    [schema: string]: unknown;
+} = {
+    [schema: string]: unknown;
+}> = {
+    [key in keyof T]: JsonPathTransformExpression[];
+};
+
+/**
+ * A dictionary of schema to payload transformers
+ */
+type SchemaToPayloadTransformersDictionary = {
+    [schema: string]: PayloadTransformer[];
+};
+
+/**
+ * The schema used for the JSONPath Diviner.
+ */
+declare const JsonPathAggregateDivinerSchema: "network.xyo.diviner.jsonpath.aggregate";
+/**
+ * The schema type used for the JSONPath Diviner.
+ */
+type JsonPathAggregateDivinerSchema = typeof JsonPathAggregateDivinerSchema;
+
+/**
+ * The config schema type for the JSON Path diviner
+ */
+type JsonPathAggregateDivinerConfigSchema = `${JsonPathAggregateDivinerSchema}.config`;
+/**
+ * The config schema for the JSON Path diviner
+ */
+declare const JsonPathAggregateDivinerConfigSchema: JsonPathAggregateDivinerConfigSchema;
+/**
+ * The configuration for the JSON Path diviner
+ */
+type JsonPathAggregateDivinerConfig = DivinerConfig<{
+    /**
+     * The schema to use for the destination payloads
+     */
+    destinationSchema?: string;
+    /**
+     * Exclude the source hashes from the destination payload.
+     */
+    excludeSources?: boolean;
+    /**
+     * The JSON Path transform expressions to apply to the payloads
+     */
+    schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
+} & {
+    schema: JsonPathAggregateDivinerConfigSchema;
+}>;
+
+/**
+ * The params type the JSON Path diviner
+ **/
+type JsonPathAggregateDivinerParams = DivinerParams<AnyConfigSchema<JsonPathAggregateDivinerConfig>>;
+
+export { JsonPathAggregateDivinerConfigSchema, JsonPathAggregateDivinerSchema };
+export type { JsonPathAggregateDivinerConfig, JsonPathAggregateDivinerParams, JsonPathTransformExpression, PayloadTransformer, SchemaToJsonPathTransformExpressionsDictionary, SchemaToPayloadTransformersDictionary };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-jsonpath-aggregate-model",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -21,22 +21,22 @@
   "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/object": "^4.13.4",
-    "@xyo-network/diviner-model": "^4.0.3",
-    "@xyo-network/module-model": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3"
+    "@xylabs/object": "^4.13.15",
+    "@xyo-network/diviner-model": "^4.1.0",
+    "@xyo-network/module-model": "^4.1.0",
+    "@xyo-network/payload-model": "^4.1.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
+    "@xylabs/tsconfig": "^7.0.0-rc.20",
     "typescript": "^5.8.3"
   },
   "publishConfig": {