@xyo-network/diviner-jsonpath-model 5.3.24 → 5.3.26

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 (2) hide show
  1. package/README.md +244 -10
  2. package/package.json +13 -13
package/README.md CHANGED
@@ -1,23 +1,257 @@
1
+ [![logo][]](https://xyo.network)
2
+
1
3
  # @xyo-network/diviner-jsonpath-model
2
4
 
3
- [![logo][]](https://xyo.network)
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Primary SDK for using XYO Protocol 2.0
9
+
10
+ ## Install
11
+
12
+ Using npm:
13
+
14
+ ```sh
15
+ npm install {{name}}
16
+ ```
4
17
 
5
- Version: 5.0.2
18
+ Using yarn:
6
19
 
7
- Primary SDK for using XYO Protocol 2.0
20
+ ```sh
21
+ yarn add {{name}}
22
+ ```
8
23
 
9
- ## Documentation
24
+ Using pnpm:
10
25
 
11
- [TypeDoc Generated Documentation](https://gitbook.xyo.network/xyo-data-lab/xyo-reference/package-documentation/xyo-network__diviner-jsonpath-model)
26
+ ```sh
27
+ pnpm add {{name}}
28
+ ```
29
+
30
+ Using bun:
31
+
32
+ ```sh
33
+ bun add {{name}}
34
+ ```
12
35
 
13
- Part of [sdk-xyo-client-js](https://www.npmjs.com/package/@xyo-network/sdk-xyo-client-js)
14
36
 
15
37
  ## License
16
38
 
17
- > See the [LICENSE](LICENSE) file for license details
39
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
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
18
247
 
19
- ## Credits
248
+ ```ts
249
+ readonly __schema: true;
250
+ ```
20
251
 
21
- [Made with 🔥 and ❄️ by XYO](https://xyo.network)
22
252
 
23
- [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
253
+ [logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
254
+ [npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-jsonpath-model.svg
255
+ [npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-jsonpath-model
256
+ [license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-jsonpath-model.svg
257
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/diviner-jsonpath-model",
3
- "version": "5.3.24",
3
+ "version": "5.3.26",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -22,11 +22,11 @@
22
22
  "exports": {
23
23
  ".": {
24
24
  "types": "./dist/neutral/index.d.ts",
25
+ "import": "./dist/neutral/index.mjs",
25
26
  "default": "./dist/neutral/index.mjs"
26
27
  },
27
28
  "./package.json": "./package.json"
28
29
  },
29
- "module": "dist/neutral/index.mjs",
30
30
  "types": "dist/neutral/index.d.ts",
31
31
  "files": [
32
32
  "dist",
@@ -36,25 +36,25 @@
36
36
  "README.md"
37
37
  ],
38
38
  "dependencies": {
39
- "@xyo-network/diviner-model": "~5.3.24",
40
- "@xyo-network/payload-model": "~5.3.24",
41
- "@xyo-network/module-model": "~5.3.24"
39
+ "@xyo-network/diviner-model": "~5.3.26",
40
+ "@xyo-network/module-model": "~5.3.26",
41
+ "@xyo-network/payload-model": "~5.3.26"
42
42
  },
43
43
  "devDependencies": {
44
44
  "@opentelemetry/api": "^1.9.1",
45
- "@types/node": "^25.5.0",
46
- "@xylabs/sdk-js": "^5.0.93",
47
- "@xylabs/ts-scripts-common": "~7.6.16",
48
- "@xylabs/ts-scripts-pnpm": "~7.6.16",
49
- "@xylabs/tsconfig": "~7.6.16",
45
+ "@types/node": "^25.5.2",
46
+ "@xylabs/sdk-js": "^5.0.94",
47
+ "@xylabs/ts-scripts-common": "~7.7.5",
48
+ "@xylabs/ts-scripts-pnpm": "~7.7.5",
49
+ "@xylabs/tsconfig": "~7.7.5",
50
50
  "acorn": "^8.16.0",
51
51
  "axios": "^1.14.0",
52
52
  "esbuild": "^0.28.0",
53
53
  "typescript": "~5.9.3",
54
54
  "zod": "^4.3.6",
55
- "@xyo-network/diviner-model": "~5.3.24",
56
- "@xyo-network/module-model": "~5.3.24",
57
- "@xyo-network/payload-model": "~5.3.24"
55
+ "@xyo-network/diviner-model": "~5.3.26",
56
+ "@xyo-network/payload-model": "~5.3.26",
57
+ "@xyo-network/module-model": "~5.3.26"
58
58
  },
59
59
  "peerDependencies": {
60
60
  "@xylabs/sdk-js": "^5",