@xyo-network/diviner-jsonpath-aggregate-memory 3.3.0 → 3.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/neutral/Diviner.d.ts +22 -0
  2. package/dist/neutral/Diviner.d.ts.map +1 -1
  3. package/dist/neutral/jsonpath/jsonPathToTransformersDictionary.d.ts +7 -0
  4. package/dist/neutral/jsonpath/jsonPathToTransformersDictionary.d.ts.map +1 -1
  5. package/dist/neutral/jsonpath/reducePayloads.d.ts +15 -0
  6. package/dist/neutral/jsonpath/reducePayloads.d.ts.map +1 -1
  7. package/package.json +17 -17
package/dist/neutral/Diviner.d.ts CHANGED
@@ -8,12 +8,34 @@ export declare class JsonPathAggregateDiviner<TParams extends JsonPathAggregateD
8
8
  protected _transforms: PayloadTransformer[] | undefined;
9
9
  private _payloadTransformers;
10
10
  private _transformableSchemas;
11
+ /**
12
+ * The schema to use for the destination payloads
13
+ */
11
14
  protected get destinationSchema(): string;
15
+ /**
16
+ * Dictionary of schemas to payload transformers
17
+ */
12
18
  protected get payloadTransformers(): SchemaToPayloadTransformersDictionary;
19
+ /**
20
+ * The dictionary of schemas to JSON Path transform expressions
21
+ */
13
22
  protected get schemaTransforms(): SchemaToJsonPathTransformExpressionsDictionary;
23
+ /**
24
+ * List of transformable schemas for this diviner
25
+ */
14
26
  protected get transformableSchemas(): string[];
15
27
  protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
28
+ /**
29
+ * Identifies if a payload is one that is transformed by this diviner
30
+ * @param x The candidate payload
31
+ * @returns True if the payload is one transformed by this diviner, false otherwise
32
+ */
16
33
  protected isTransformablePayload: (x: Payload) => boolean;
34
+ /**
35
+ * Identifies if a schema is one that is transformed by this diviner
36
+ * @param schema The candidate schema
37
+ * @returns True if this schema is one transformed by this diviner, false otherwise
38
+ */
17
39
  protected isTransformableSchema: (schema?: string | null) => boolean;
18
40
  }
19
41
  //# sourceMappingURL=Diviner.d.ts.map
package/dist/neutral/Diviner.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EACV,8BAA8B,EAC9B,kBAAkB,EAClB,8CAA8C,EAC9C,qCAAqC,EACtC,MAAM,+CAA+C,CAAA;AAEtD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACzF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAQnC,qBAAa,wBAAwB,CACnC,OAAO,SAAS,8BAA8B,GAAG,8BAA8B,EAC/E,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAiE;IACjH,gBAAyB,mBAAmB,EAAE,MAAM,CAAuC;IAE3F,SAAS,CAAC,WAAW,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAEvD,OAAO,CAAC,oBAAoB,CAAmD;IAC/E,OAAO,CAAC,qBAAqB,CAAsB;IAKnD,SAAS,KAAK,iBAAiB,IAAI,MAAM,CAExC;IAKD,SAAS,KAAK,mBAAmB,IAAI,qCAAqC,CAGzE;IAKD,SAAS,KAAK,gBAAgB,IAAI,8CAA8C,CAE/E;IAKD,SAAS,KAAK,oBAAoB,IAAI,MAAM,EAAE,CAG7C;cAEwB,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAwBzE,SAAS,CAAC,sBAAsB,MAAO,OAAO,aAE7C;IAOD,SAAS,CAAC,qBAAqB,YAAa,MAAM,GAAG,IAAI,aAExD;CACF"}
1
+ {"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EACV,8BAA8B,EAC9B,kBAAkB,EAClB,8CAA8C,EAC9C,qCAAqC,EACtC,MAAM,+CAA+C,CAAA;AAEtD,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACzF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAQnC,qBAAa,wBAAwB,CACnC,OAAO,SAAS,8BAA8B,GAAG,8BAA8B,EAC/E,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACvD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAiE;IACjH,gBAAyB,mBAAmB,EAAE,MAAM,CAAuC;IAE3F,SAAS,CAAC,WAAW,EAAE,kBAAkB,EAAE,GAAG,SAAS,CAAA;IAEvD,OAAO,CAAC,oBAAoB,CAAmD;IAC/E,OAAO,CAAC,qBAAqB,CAAsB;IAEnD;;OAEG;IACH,SAAS,KAAK,iBAAiB,IAAI,MAAM,CAExC;IAED;;OAEG;IACH,SAAS,KAAK,mBAAmB,IAAI,qCAAqC,CAGzE;IAED;;OAEG;IACH,SAAS,KAAK,gBAAgB,IAAI,8CAA8C,CAE/E;IAED;;OAEG;IACH,SAAS,KAAK,oBAAoB,IAAI,MAAM,EAAE,CAG7C;cAEwB,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAmBzE;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,MAAO,OAAO,aAE7C;IAED;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,YAAa,MAAM,GAAG,IAAI,aAExD;CACF"}
package/dist/neutral/jsonpath/jsonPathToTransformersDictionary.d.ts CHANGED
@@ -1,3 +1,10 @@
1
1
  import type { SchemaToJsonPathTransformExpressionsDictionary, SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model';
2
+ /**
3
+ * Materializes the JSON-path expressions into memoized functions by converting a
4
+ * dictionary of schema to JSON Path transform expressions to a dictionary
5
+ * of schema to payload transformers
6
+ * @param schemaTransforms The schema transforms to convert
7
+ * @returns A dictionary of schema to payload transformers
8
+ */
2
9
  export declare const jsonPathToTransformersDictionary: (schemaTransforms: SchemaToJsonPathTransformExpressionsDictionary) => SchemaToPayloadTransformersDictionary;
3
10
  //# sourceMappingURL=jsonPathToTransformersDictionary.d.ts.map
package/dist/neutral/jsonpath/jsonPathToTransformersDictionary.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"jsonPathToTransformersDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/jsonPathToTransformersDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8CAA8C,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAU1J,eAAO,MAAM,gCAAgC,qBACzB,8CAA8C,KAC/D,qCAOF,CAAA"}
1
+ {"version":3,"file":"jsonPathToTransformersDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/jsonPathToTransformersDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,8CAA8C,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAG1J;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC,qBACzB,8CAA8C,KAC/D,qCAOF,CAAA"}
package/dist/neutral/jsonpath/reducePayloads.d.ts CHANGED
@@ -1,8 +1,23 @@
1
1
  import type { SchemaToPayloadTransformersDictionary } from '@xyo-network/diviner-jsonpath-aggregate-model';
2
2
  import type { Payload, WithMeta } from '@xyo-network/payload-model';
3
+ /**
4
+ * Reduces the payloads to a single payload using the supplied transformers
5
+ * @param payloads The payloads to reduce
6
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payload
7
+ * @param destinationSchema The schema of the destination payload
8
+ * @param excludeSources Exclude the source hashes from the destination payload
9
+ * @returns The reduced payload
10
+ */
3
11
  export declare const reducePayloads: <T extends Payload = {
4
12
  schema: string;
5
13
  } & import("@xyo-network/payload-model").PayloadFields>(payloads: Payload[], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string, excludeSources?: boolean) => Promise<WithMeta<T>>;
14
+ /**
15
+ * Reduces the arrays of payload arrays to an array of payloads using the supplied transformers
16
+ * @param payloadsArray The arrays of payloads to reduce
17
+ * @param payloadTransformers The transformers to use to convert the payloads to the destination payloads
18
+ * @param excludeSources Exclude the source hashes from the destination payload
19
+ * @returns The reduced payloads
20
+ */
6
21
  export declare const reducePayloadsArray: <T extends Payload = {
7
22
  schema: string;
8
23
  } & import("@xyo-network/payload-model").PayloadFields>(payloadsArray: Payload[][], payloadTransformers: SchemaToPayloadTransformersDictionary, destinationSchema: string, excludeSources?: boolean) => Promise<T[]>;
package/dist/neutral/jsonpath/reducePayloads.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"reducePayloads.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/reducePayloads.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAG1G,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAUnE,eAAO,MAAM,cAAc,GAAU,CAAC,SAAS,OAAO;;kEAC1C,OAAO,EAAE,uBACE,qCAAqC,qBACvC,MAAM,+BAExB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAYrB,CAAA;AASD,eAAO,MAAM,mBAAmB,GAAU,CAAC,SAAS,OAAO;;uEAC1C,OAAO,EAAE,EAAE,uBACL,qCAAqC,qBACvC,MAAM,+BAExB,OAAO,CAAC,CAAC,EAAE,CAMb,CAAA"}
1
+ {"version":3,"file":"reducePayloads.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/reducePayloads.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qCAAqC,EAAE,MAAM,+CAA+C,CAAA;AAG1G,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAA;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GAAU,CAAC,SAAS,OAAO;;kEAC1C,OAAO,EAAE,uBACE,qCAAqC,qBACvC,MAAM,+BAExB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAYrB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAAU,CAAC,SAAS,OAAO;;uEAC1C,OAAO,EAAE,EAAE,uBACL,qCAAqC,qBACvC,MAAM,+BAExB,OAAO,CAAC,CAAC,EAAE,CAMb,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/diviner-jsonpath-aggregate-memory",
3
- "version": "3.3.0",
3
+ "version": "3.3.2",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,24 +29,24 @@
29
29
  "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/assert": "^4.2.2",
33
- "@xylabs/exists": "^4.2.2",
34
- "@xyo-network/boundwitness-model": "^3.3.0",
35
- "@xyo-network/diviner-abstract": "^3.3.0",
36
- "@xyo-network/diviner-jsonpath-aggregate-model": "^3.3.0",
37
- "@xyo-network/diviner-jsonpath-memory": "^3.3.0",
38
- "@xyo-network/diviner-model": "^3.3.0",
39
- "@xyo-network/payload-builder": "^3.3.0",
40
- "@xyo-network/payload-model": "^3.3.0",
41
- "@xyo-network/payload-utils": "^3.3.0"
32
+ "@xylabs/assert": "^4.3.2",
33
+ "@xylabs/exists": "^4.3.2",
34
+ "@xyo-network/boundwitness-model": "^3.3.2",
35
+ "@xyo-network/diviner-abstract": "^3.3.2",
36
+ "@xyo-network/diviner-jsonpath-aggregate-model": "^3.3.2",
37
+ "@xyo-network/diviner-jsonpath-memory": "^3.3.2",
38
+ "@xyo-network/diviner-model": "^3.3.2",
39
+ "@xyo-network/payload-builder": "^3.3.2",
40
+ "@xyo-network/payload-model": "^3.3.2",
41
+ "@xyo-network/payload-utils": "^3.3.2"
42
42
  },
43
43
  "devDependencies": {
44
- "@xylabs/ts-scripts-yarn3": "^4.2.1",
45
- "@xylabs/tsconfig": "^4.2.1",
46
- "@xyo-network/account": "^3.3.0",
47
- "@xyo-network/account-model": "^3.3.0",
48
- "@xyo-network/boundwitness-builder": "^3.3.0",
49
- "@xyo-network/diviner-jsonpath-model": "^3.3.0",
44
+ "@xylabs/ts-scripts-yarn3": "^4.2.3",
45
+ "@xylabs/tsconfig": "^4.2.3",
46
+ "@xyo-network/account": "^3.3.2",
47
+ "@xyo-network/account-model": "^3.3.2",
48
+ "@xyo-network/boundwitness-builder": "^3.3.2",
49
+ "@xyo-network/diviner-jsonpath-model": "^3.3.2",
50
50
  "typescript": "^5.6.3"
51
51
  },
52
52
  "publishConfig": {