@xyo-network/diviner-jsonpath-aggregate-model 3.3.0 → 3.3.1

package/dist/neutral/Config.d.ts

@@ -1,11 +1,29 @@
 import type { DivinerConfig } from '@xyo-network/diviner-model';
 import type { SchemaToJsonPathTransformExpressionsDictionary } from './jsonpath/index.ts';
 import { JsonPathAggregateDivinerSchema } from './Schema.ts';
+/**
+ * The config schema type for the JSON Path diviner
+ */
 export type JsonPathAggregateDivinerConfigSchema = `${JsonPathAggregateDivinerSchema}.config`;
+/**
+ * The config schema for the JSON Path diviner
+ */
 export declare const JsonPathAggregateDivinerConfigSchema: JsonPathAggregateDivinerConfigSchema;
+/**
+ * The configuration for the JSON Path diviner
+ */
 export 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;

package/dist/neutral/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,OAAO,KAAK,EAAE,8CAA8C,EAAE,MAAM,qBAAqB,CAAA;AACzF,OAAO,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAK5D,MAAM,MAAM,oCAAoC,GAAG,GAAG,8BAA8B,SAAS,CAAA;AAI7F,eAAO,MAAM,oCAAoC,EAAE,oCAAiF,CAAA;AAKpI,MAAM,MAAM,8BAA8B,GAAG,aAAa,CACxD;IAIE,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAI1B,cAAc,CAAC,EAAE,OAAO,CAAA;IAIxB,gBAAgB,CAAC,EAAE,8CAA8C,CAAA;CAClE,GAAG;IAAE,MAAM,EAAE,oCAAoC,CAAA;CAAE,CACrD,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,OAAO,KAAK,EAAE,8CAA8C,EAAE,MAAM,qBAAqB,CAAA;AACzF,OAAO,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAE5D;;GAEG;AACH,MAAM,MAAM,oCAAoC,GAAG,GAAG,8BAA8B,SAAS,CAAA;AAC7F;;GAEG;AACH,eAAO,MAAM,oCAAoC,EAAE,oCAAiF,CAAA;AAEpI;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,aAAa,CACxD;IACE;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,8CAA8C,CAAA;CAClE,GAAG;IAAE,MAAM,EAAE,oCAAoC,CAAA;CAAE,CACrD,CAAA"}

package/dist/neutral/Params.d.ts

@@ -1,5 +1,8 @@
 import type { DivinerParams } from '@xyo-network/diviner-model';
 import type { AnyConfigSchema } from '@xyo-network/module-model';
 import type { JsonPathAggregateDivinerConfig } from './Config.ts';
+/**
+ * The params type the JSON Path diviner
+ **/
 export type JsonPathAggregateDivinerParams = DivinerParams<AnyConfigSchema<JsonPathAggregateDivinerConfig>>;
 //# sourceMappingURL=Params.d.ts.map

package/dist/neutral/Params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAKjE,MAAM,MAAM,8BAA8B,GAAG,aAAa,CAAC,eAAe,CAAC,8BAA8B,CAAC,CAAC,CAAA"}
+{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,aAAa,CAAA;AAEjE;;IAEI;AACJ,MAAM,MAAM,8BAA8B,GAAG,aAAa,CAAC,eAAe,CAAC,8BAA8B,CAAC,CAAC,CAAA"}

package/dist/neutral/Schema.d.ts

@@ -1,3 +1,9 @@
+/**
+ * The schema used for the JSONPath Diviner.
+ */
 export declare const JsonPathAggregateDivinerSchema: "network.xyo.diviner.jsonpath.aggregate";
+/**
+ * The schema type used for the JSONPath Diviner.
+ */
 export type JsonPathAggregateDivinerSchema = typeof JsonPathAggregateDivinerSchema;
 //# sourceMappingURL=Schema.d.ts.map

package/dist/neutral/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,8BAA8B,0CAAoD,CAAA;AAK/F,MAAM,MAAM,8BAA8B,GAAG,OAAO,8BAA8B,CAAA"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,8BAA8B,0CAAoD,CAAA;AAE/F;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG,OAAO,8BAA8B,CAAA"}

package/dist/neutral/jsonpath/JsonPathTransformExpression.d.ts

@@ -1,7 +1,20 @@
 import type { JsonValue } from '@xylabs/object';
+/**
+ * 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;
 }
 //# sourceMappingURL=JsonPathTransformExpression.d.ts.map

package/dist/neutral/jsonpath/JsonPathTransformExpression.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"JsonPathTransformExpression.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/JsonPathTransformExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAM/C,MAAM,WAAW,2BAA2B;IAI1C,YAAY,CAAC,EAAE,SAAS,CAAA;IAIxB,gBAAgB,EAAE,MAAM,CAAA;IAIxB,oBAAoB,EAAE,MAAM,CAAA;CAC7B"}
+{"version":3,"file":"JsonPathTransformExpression.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/JsonPathTransformExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAA;IACxB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,oBAAoB,EAAE,MAAM,CAAA;CAC7B"}

package/dist/neutral/jsonpath/SchemaToJsonPathTransformExpressionDictionary.d.ts

@@ -1,4 +1,7 @@
 import type { JsonPathTransformExpression } from './JsonPathTransformExpression.ts';
+/**
+ * A dictionary of schema to JSON Path transform expressions.
+ */
 export type SchemaToJsonPathTransformExpressionsDictionary<T extends {
     [schema: string]: unknown;
 } = {

package/dist/neutral/jsonpath/SchemaToJsonPathTransformExpressionDictionary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaToJsonPathTransformExpressionDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/SchemaToJsonPathTransformExpressionDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAKnF,MAAM,MAAM,8CAA8C,CAAC,CAAC,SAAS;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,IAAI;KACnI,GAAG,IAAI,MAAM,CAAC,GAAG,2BAA2B,EAAE;CAChD,CAAA"}
+{"version":3,"file":"SchemaToJsonPathTransformExpressionDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/SchemaToJsonPathTransformExpressionDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAA;AAEnF;;GAEG;AACH,MAAM,MAAM,8CAA8C,CAAC,CAAC,SAAS;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,IAAI;KACnI,GAAG,IAAI,MAAM,CAAC,GAAG,2BAA2B,EAAE;CAChD,CAAA"}

package/dist/neutral/jsonpath/SchemaToPayloadTransformersDictionary.d.ts

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

package/dist/neutral/jsonpath/SchemaToPayloadTransformersDictionary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaToPayloadTransformersDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/SchemaToPayloadTransformersDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAKjE,MAAM,MAAM,qCAAqC,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAA;CAAE,CAAA"}
+{"version":3,"file":"SchemaToPayloadTransformersDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/SchemaToPayloadTransformersDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAEjE;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAA;CAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/diviner-jsonpath-aggregate-model",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,14 +29,14 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "dependencies": {
-    "@xylabs/object": "^4.2.2",
-    "@xyo-network/diviner-model": "^3.3.0",
-    "@xyo-network/module-model": "^3.3.0",
-    "@xyo-network/payload-model": "^3.3.0"
+    "@xylabs/object": "^4.3.2",
+    "@xyo-network/diviner-model": "^3.3.1",
+    "@xyo-network/module-model": "^3.3.1",
+    "@xyo-network/payload-model": "^3.3.1"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^4.2.1",
-    "@xylabs/tsconfig": "^4.2.1",
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig": "^4.2.3",
     "typescript": "^5.6.3"
   },
   "publishConfig": {