@xyo-network/diviner-jsonpath-model 5.3.29 → 5.4.0

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 CHANGED
@@ -38,216 +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
- ### model
58
-
59
- ### .temp-typedoc
60
-
61
- ### interfaces
62
-
63
- ### <a id="JsonPathTransformExpression"></a>JsonPathTransformExpression
64
-
65
- [**@xyo-network/diviner-jsonpath-model**](#../README)
66
-
67
- ***
68
-
69
- Describes the JSON-path transformation to retrieve a field on a source object
70
- and the target field to store the value to on a destination object
71
-
72
- ## Properties
73
-
74
- ### defaultValue?
75
-
76
- ```ts
77
- optional defaultValue?: unknown;
78
- ```
79
-
80
- The default value to use if the source field does not exist
81
-
82
- ***
83
-
84
- ### destinationField
85
-
86
- ```ts
87
- destinationField: string;
88
- ```
89
-
90
- The target field to store the source field into on the destination object
91
-
92
- ***
93
-
94
- ### sourcePathExpression
95
-
96
- ```ts
97
- sourcePathExpression: string;
98
- ```
99
-
100
- The JSON path expressions for the source field on the source object
101
-
102
- ### type-aliases
103
-
104
- ### <a id="JsonPathDivinerConfig"></a>JsonPathDivinerConfig
105
-
106
- [**@xyo-network/diviner-jsonpath-model**](#../README)
107
-
108
- ***
109
-
110
- ```ts
111
- type JsonPathDivinerConfig = DivinerConfig<object & object>;
112
- ```
113
-
114
- The configuration for the JSON Path diviner
115
-
116
- ### <a id="JsonPathDivinerConfigSchema"></a>JsonPathDivinerConfigSchema
117
-
118
- [**@xyo-network/diviner-jsonpath-model**](#../README)
119
-
120
- ***
121
-
122
- ```ts
123
- type JsonPathDivinerConfigSchema = typeof JsonPathDivinerConfigSchema;
124
- ```
125
-
126
- The config schema type for the JSON Path diviner
127
-
128
- ### <a id="JsonPathDivinerParams"></a>JsonPathDivinerParams
129
-
130
- [**@xyo-network/diviner-jsonpath-model**](#../README)
131
-
132
- ***
133
-
134
- ```ts
135
- type JsonPathDivinerParams = DivinerParams<AnyConfigSchema<JsonPathDivinerConfig>>;
136
- ```
137
-
138
- The params type the JSON Path diviner
139
-
140
- ### <a id="JsonPathDivinerSchema"></a>JsonPathDivinerSchema
141
-
142
- [**@xyo-network/diviner-jsonpath-model**](#../README)
143
-
144
- ***
145
-
146
- ```ts
147
- type JsonPathDivinerSchema = typeof JsonPathDivinerSchema;
148
- ```
149
-
150
- The schema type used for the JSONPath Diviner.
151
-
152
- ### <a id="PayloadTransformer"></a>PayloadTransformer
153
-
154
- [**@xyo-network/diviner-jsonpath-model**](#../README)
155
-
156
- ***
157
-
158
- ```ts
159
- type PayloadTransformer = (x) => Partial<Payload>;
160
- ```
161
-
162
- ## Parameters
163
-
164
- ### x
165
-
166
- `Payload`
167
-
168
- ## Returns
169
-
170
- `Partial`\<`Payload`\>
171
-
172
- ### <a id="SchemaToJsonPathTransformExpressionsDictionary"></a>SchemaToJsonPathTransformExpressionsDictionary
173
-
174
- [**@xyo-network/diviner-jsonpath-model**](#../README)
175
-
176
- ***
177
-
178
- ```ts
179
- type SchemaToJsonPathTransformExpressionsDictionary<T> = { [key in keyof T]: JsonPathTransformExpression[] };
180
- ```
181
-
182
- A dictionary of schema to JSON Path transform expressions.
183
-
184
- ## Type Parameters
185
-
186
- ### T
187
-
188
- `T` *extends* `object` = \{
189
- \[`schema`: `Schema`\]: `unknown`;
190
- \}
191
-
192
- ### <a id="SchemaToPayloadTransformersDictionary"></a>SchemaToPayloadTransformersDictionary
193
-
194
- [**@xyo-network/diviner-jsonpath-model**](#../README)
195
-
196
- ***
197
-
198
- ```ts
199
- type SchemaToPayloadTransformersDictionary = object;
200
- ```
201
-
202
- A dictionary of schema to payload transformers
203
-
204
- ## Index Signature
205
-
206
- ```ts
207
- [schema: string]: PayloadTransformer[]
208
- ```
209
-
210
- ### variables
211
-
212
- ### <a id="JsonPathDivinerConfigSchema"></a>JsonPathDivinerConfigSchema
213
-
214
- [**@xyo-network/diviner-jsonpath-model**](#../README)
215
-
216
- ***
217
-
218
- ```ts
219
- const JsonPathDivinerConfigSchema: string & object;
220
- ```
221
-
222
- The config schema for the JSON Path diviner
223
-
224
- ## Type Declaration
225
-
226
- ### \_\_schema
227
-
228
- ```ts
229
- readonly __schema: true;
230
- ```
231
-
232
- ### <a id="JsonPathDivinerSchema"></a>JsonPathDivinerSchema
233
-
234
- [**@xyo-network/diviner-jsonpath-model**](#../README)
235
-
236
- ***
237
-
238
- ```ts
239
- const JsonPathDivinerSchema: "network.xyo.diviner.jsonpath" & object;
240
- ```
241
-
242
- The schema used for the JSONPath Diviner.
243
-
244
- ## Type Declaration
245
-
246
- ### \_\_schema
247
-
248
- ```ts
249
- readonly __schema: true;
250
- ```
251
41
 
252
42
 
253
43
  [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
@@ -3,11 +3,7 @@ import type { JsonPathTransformExpression } from './JsonPathTransformExpression.
3
3
  /**
4
4
  * A dictionary of schema to JSON Path transform expressions.
5
5
  */
6
- export type SchemaToJsonPathTransformExpressionsDictionary<T extends {
7
- [schema: Schema]: unknown;
8
- } = {
9
- [schema: Schema]: unknown;
10
- }> = {
6
+ export type SchemaToJsonPathTransformExpressionsDictionary<T extends Record<Schema, unknown> = Record<Schema, unknown>> = {
11
7
  [key in keyof T]: JsonPathTransformExpression[];
12
8
  };
13
9
  //# 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,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,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"}
1
+ {"version":3,"file":"SchemaToJsonPathTransformExpressionDictionary.d.ts","sourceRoot":"","sources":["../../../src/jsonpath/SchemaToJsonPathTransformExpressionDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAExD,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;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,EAAE,CAAA;CAAE,CAAA"}
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-model",
3
- "version": "5.3.29",
3
+ "version": "5.4.0",
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/module-model": "~5.3.29",
40
- "@xyo-network/payload-model": "~5.3.29",
41
- "@xyo-network/diviner-model": "~5.3.29"
37
+ "@xyo-network/diviner-model": "~5.4.0",
38
+ "@xyo-network/payload-model": "~5.4.0",
39
+ "@xyo-network/module-model": "~5.4.0"
42
40
  },
43
41
  "devDependencies": {
44
42
  "@opentelemetry/api": "^1.9.1",
45
- "@xylabs/sdk-js": "^5.0.95",
46
- "@xylabs/ts-scripts-common": "~7.8.4",
47
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
48
- "@xylabs/tsconfig": "~7.8.4",
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.3.29",
54
- "@xyo-network/manifest-model": "~5.3.29",
55
- "@xyo-network/previous-hash-store-model": "~5.3.29"
49
+ "@xyo-network/manifest-model": "~5.4.0",
50
+ "@xyo-network/account-model": "~5.4.0",
51
+ "@xyo-network/previous-hash-store-model": "~5.4.0"
56
52
  },
57
53
  "peerDependencies": {
58
- "@xylabs/sdk-js": "^5",
59
- "@xyo-network/account-model": "~5.3.29",
60
- "@xyo-network/manifest-model": "~5.3.29"
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"