@xyo-network/diviner-jsonpath-aggregate-model 5.3.30 → 5.4.1
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.
- package/README.md +0 -214
- package/dist/neutral/jsonpath/SchemaToJsonPathTransformExpressionDictionary.d.ts +1 -5
- package/dist/neutral/jsonpath/SchemaToJsonPathTransformExpressionDictionary.d.ts.map +1 -1
- package/dist/neutral/jsonpath/SchemaToPayloadTransformersDictionary.d.ts +1 -3
- package/dist/neutral/jsonpath/SchemaToPayloadTransformersDictionary.d.ts.map +1 -1
- package/package.json +13 -17
package/README.md
CHANGED
|
@@ -38,220 +38,6 @@ bun add {{name}}
|
|
|
38
38
|
|
|
39
39
|
See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
|
|
40
40
|
|
|
41
|
-
## Reference
|
|
42
|
-
|
|
43
|
-
### packages
|
|
44
|
-
|
|
45
|
-
### modules
|
|
46
|
-
|
|
47
|
-
### packages
|
|
48
|
-
|
|
49
|
-
### diviner
|
|
50
|
-
|
|
51
|
-
### packages
|
|
52
|
-
|
|
53
|
-
### jsonpath
|
|
54
|
-
|
|
55
|
-
### packages
|
|
56
|
-
|
|
57
|
-
### aggregate
|
|
58
|
-
|
|
59
|
-
### packages
|
|
60
|
-
|
|
61
|
-
### model
|
|
62
|
-
|
|
63
|
-
### .temp-typedoc
|
|
64
|
-
|
|
65
|
-
### interfaces
|
|
66
|
-
|
|
67
|
-
### <a id="JsonPathTransformExpression"></a>JsonPathTransformExpression
|
|
68
|
-
|
|
69
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
|
-
Describes the JSON-path transformation to retrieve a field on a source object
|
|
74
|
-
and the target field to store the value to on a destination object
|
|
75
|
-
|
|
76
|
-
## Properties
|
|
77
|
-
|
|
78
|
-
### defaultValue?
|
|
79
|
-
|
|
80
|
-
```ts
|
|
81
|
-
optional defaultValue?: unknown;
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
The default value to use if the source field does not exist
|
|
85
|
-
|
|
86
|
-
***
|
|
87
|
-
|
|
88
|
-
### destinationField
|
|
89
|
-
|
|
90
|
-
```ts
|
|
91
|
-
destinationField: string;
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
The target field to store the source field into on the destination object
|
|
95
|
-
|
|
96
|
-
***
|
|
97
|
-
|
|
98
|
-
### sourcePathExpression
|
|
99
|
-
|
|
100
|
-
```ts
|
|
101
|
-
sourcePathExpression: string;
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
The JSON path expressions for the source field on the source object
|
|
105
|
-
|
|
106
|
-
### type-aliases
|
|
107
|
-
|
|
108
|
-
### <a id="JsonPathAggregateDivinerConfig"></a>JsonPathAggregateDivinerConfig
|
|
109
|
-
|
|
110
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
111
|
-
|
|
112
|
-
***
|
|
113
|
-
|
|
114
|
-
```ts
|
|
115
|
-
type JsonPathAggregateDivinerConfig = DivinerConfig<object & object>;
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
The configuration for the JSON Path diviner
|
|
119
|
-
|
|
120
|
-
### <a id="JsonPathAggregateDivinerConfigSchema"></a>JsonPathAggregateDivinerConfigSchema
|
|
121
|
-
|
|
122
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
123
|
-
|
|
124
|
-
***
|
|
125
|
-
|
|
126
|
-
```ts
|
|
127
|
-
type JsonPathAggregateDivinerConfigSchema = typeof JsonPathAggregateDivinerConfigSchema;
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
The config schema type for the JSON Path diviner
|
|
131
|
-
|
|
132
|
-
### <a id="JsonPathAggregateDivinerParams"></a>JsonPathAggregateDivinerParams
|
|
133
|
-
|
|
134
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
135
|
-
|
|
136
|
-
***
|
|
137
|
-
|
|
138
|
-
```ts
|
|
139
|
-
type JsonPathAggregateDivinerParams = DivinerParams<AnyConfigSchema<JsonPathAggregateDivinerConfig>>;
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
The params type the JSON Path diviner
|
|
143
|
-
|
|
144
|
-
### <a id="JsonPathAggregateDivinerSchema"></a>JsonPathAggregateDivinerSchema
|
|
145
|
-
|
|
146
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
147
|
-
|
|
148
|
-
***
|
|
149
|
-
|
|
150
|
-
```ts
|
|
151
|
-
type JsonPathAggregateDivinerSchema = typeof JsonPathAggregateDivinerSchema;
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
The schema type used for the JSONPath Diviner.
|
|
155
|
-
|
|
156
|
-
### <a id="PayloadTransformer"></a>PayloadTransformer
|
|
157
|
-
|
|
158
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
159
|
-
|
|
160
|
-
***
|
|
161
|
-
|
|
162
|
-
```ts
|
|
163
|
-
type PayloadTransformer = (x) => Partial<Payload>;
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
## Parameters
|
|
167
|
-
|
|
168
|
-
### x
|
|
169
|
-
|
|
170
|
-
`Payload`
|
|
171
|
-
|
|
172
|
-
## Returns
|
|
173
|
-
|
|
174
|
-
`Partial`\<`Payload`\>
|
|
175
|
-
|
|
176
|
-
### <a id="SchemaToJsonPathTransformExpressionsDictionary"></a>SchemaToJsonPathTransformExpressionsDictionary
|
|
177
|
-
|
|
178
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
179
|
-
|
|
180
|
-
***
|
|
181
|
-
|
|
182
|
-
```ts
|
|
183
|
-
type SchemaToJsonPathTransformExpressionsDictionary<T> = { [key in keyof T]: JsonPathTransformExpression[] };
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
A dictionary of schema to JSON Path transform expressions.
|
|
187
|
-
|
|
188
|
-
## Type Parameters
|
|
189
|
-
|
|
190
|
-
### T
|
|
191
|
-
|
|
192
|
-
`T` *extends* `object` = \{
|
|
193
|
-
\[`schema`: `string`\]: `unknown`;
|
|
194
|
-
\}
|
|
195
|
-
|
|
196
|
-
### <a id="SchemaToPayloadTransformersDictionary"></a>SchemaToPayloadTransformersDictionary
|
|
197
|
-
|
|
198
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
199
|
-
|
|
200
|
-
***
|
|
201
|
-
|
|
202
|
-
```ts
|
|
203
|
-
type SchemaToPayloadTransformersDictionary = object;
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
A dictionary of schema to payload transformers
|
|
207
|
-
|
|
208
|
-
## Index Signature
|
|
209
|
-
|
|
210
|
-
```ts
|
|
211
|
-
[schema: string]: PayloadTransformer[]
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
### variables
|
|
215
|
-
|
|
216
|
-
### <a id="JsonPathAggregateDivinerConfigSchema"></a>JsonPathAggregateDivinerConfigSchema
|
|
217
|
-
|
|
218
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
219
|
-
|
|
220
|
-
***
|
|
221
|
-
|
|
222
|
-
```ts
|
|
223
|
-
const JsonPathAggregateDivinerConfigSchema: string & object;
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
The config schema for the JSON Path diviner
|
|
227
|
-
|
|
228
|
-
## Type Declaration
|
|
229
|
-
|
|
230
|
-
### \_\_schema
|
|
231
|
-
|
|
232
|
-
```ts
|
|
233
|
-
readonly __schema: true;
|
|
234
|
-
```
|
|
235
|
-
|
|
236
|
-
### <a id="JsonPathAggregateDivinerSchema"></a>JsonPathAggregateDivinerSchema
|
|
237
|
-
|
|
238
|
-
[**@xyo-network/diviner-jsonpath-aggregate-model**](#../README)
|
|
239
|
-
|
|
240
|
-
***
|
|
241
|
-
|
|
242
|
-
```ts
|
|
243
|
-
const JsonPathAggregateDivinerSchema: "network.xyo.diviner.jsonpath.aggregate" & object;
|
|
244
|
-
```
|
|
245
|
-
|
|
246
|
-
The schema used for the JSONPath Diviner.
|
|
247
|
-
|
|
248
|
-
## Type Declaration
|
|
249
|
-
|
|
250
|
-
### \_\_schema
|
|
251
|
-
|
|
252
|
-
```ts
|
|
253
|
-
readonly __schema: true;
|
|
254
|
-
```
|
|
255
41
|
|
|
256
42
|
|
|
257
43
|
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
@@ -2,11 +2,7 @@ import type { JsonPathTransformExpression } from './JsonPathTransformExpression.
|
|
|
2
2
|
/**
|
|
3
3
|
* A dictionary of schema to JSON Path transform expressions.
|
|
4
4
|
*/
|
|
5
|
-
export type SchemaToJsonPathTransformExpressionsDictionary<T extends {
|
|
6
|
-
[schema: string]: unknown;
|
|
7
|
-
} = {
|
|
8
|
-
[schema: string]: unknown;
|
|
9
|
-
}> = {
|
|
5
|
+
export type SchemaToJsonPathTransformExpressionsDictionary<T extends Record<string, unknown> = Record<string, unknown>> = {
|
|
10
6
|
[key in keyof T]: JsonPathTransformExpression[];
|
|
11
7
|
};
|
|
12
8
|
//# sourceMappingURL=SchemaToJsonPathTransformExpressionDictionary.d.ts.map
|
|
@@ -1 +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;AAEnF;;GAEG;AACH,MAAM,MAAM,8CAA8C,CAAC,CAAC,SAAS
|
|
1
|
+
{"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,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;KACvH,GAAG,IAAI,MAAM,CAAC,GAAG,2BAA2B,EAAE;CAChD,CAAA"}
|
|
@@ -2,7 +2,5 @@ import type { PayloadTransformer } from './PayloadTransformer.ts';
|
|
|
2
2
|
/**
|
|
3
3
|
* A dictionary of schema to payload transformers
|
|
4
4
|
*/
|
|
5
|
-
export type SchemaToPayloadTransformersDictionary =
|
|
6
|
-
[schema: string]: PayloadTransformer[];
|
|
7
|
-
};
|
|
5
|
+
export type SchemaToPayloadTransformersDictionary = Record<string, PayloadTransformer[]>;
|
|
8
6
|
//# sourceMappingURL=SchemaToPayloadTransformersDictionary.d.ts.map
|
|
@@ -1 +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;AAEjE;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG
|
|
1
|
+
{"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,MAAM,CAAC,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xyo-network/diviner-jsonpath-aggregate-model",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.4.1",
|
|
4
4
|
"description": "Primary SDK for using XYO Protocol 2.0",
|
|
5
5
|
"homepage": "https://xyo.network",
|
|
6
6
|
"bugs": {
|
|
@@ -22,12 +22,10 @@
|
|
|
22
22
|
"exports": {
|
|
23
23
|
".": {
|
|
24
24
|
"types": "./dist/neutral/index.d.ts",
|
|
25
|
-
"import": "./dist/neutral/index.mjs",
|
|
26
25
|
"default": "./dist/neutral/index.mjs"
|
|
27
26
|
},
|
|
28
27
|
"./package.json": "./package.json"
|
|
29
28
|
},
|
|
30
|
-
"types": "dist/neutral/index.d.ts",
|
|
31
29
|
"files": [
|
|
32
30
|
"dist",
|
|
33
31
|
"!**/*.bench.*",
|
|
@@ -36,28 +34,26 @@
|
|
|
36
34
|
"README.md"
|
|
37
35
|
],
|
|
38
36
|
"dependencies": {
|
|
39
|
-
"@xyo-network/diviner-model": "~5.
|
|
40
|
-
"@xyo-network/
|
|
41
|
-
"@xyo-network/
|
|
37
|
+
"@xyo-network/diviner-model": "~5.4.1",
|
|
38
|
+
"@xyo-network/module-model": "~5.4.1",
|
|
39
|
+
"@xyo-network/payload-model": "~5.4.1"
|
|
42
40
|
},
|
|
43
41
|
"devDependencies": {
|
|
44
42
|
"@opentelemetry/api": "^1.9.1",
|
|
45
|
-
"@xylabs/sdk-js": "^5.0.
|
|
46
|
-
"@xylabs/
|
|
47
|
-
"@xylabs/
|
|
48
|
-
"@xylabs/tsconfig": "~7.8.7",
|
|
49
|
-
"axios": "^1.14.0",
|
|
43
|
+
"@xylabs/sdk-js": "^5.0.97",
|
|
44
|
+
"@xylabs/toolchain": "~7.10.8",
|
|
45
|
+
"@xylabs/tsconfig": "~7.10.8",
|
|
50
46
|
"pako": "~2.1.0",
|
|
51
47
|
"typescript": "~5.9.3",
|
|
52
48
|
"zod": "^4.3.6",
|
|
53
|
-
"@xyo-network/account-model": "~5.
|
|
54
|
-
"@xyo-network/
|
|
55
|
-
"@xyo-network/
|
|
49
|
+
"@xyo-network/account-model": "~5.4.1",
|
|
50
|
+
"@xyo-network/manifest-model": "~5.4.1",
|
|
51
|
+
"@xyo-network/previous-hash-store-model": "~5.4.1"
|
|
56
52
|
},
|
|
57
53
|
"peerDependencies": {
|
|
58
|
-
"@xylabs/sdk-js": "^5",
|
|
59
|
-
"@xyo-network/account-model": "~5.
|
|
60
|
-
"@xyo-network/manifest-model": "~5.
|
|
54
|
+
"@xylabs/sdk-js": "^5.0.97",
|
|
55
|
+
"@xyo-network/account-model": "~5.4",
|
|
56
|
+
"@xyo-network/manifest-model": "~5.4"
|
|
61
57
|
},
|
|
62
58
|
"publishConfig": {
|
|
63
59
|
"access": "public"
|