@xyo-network/diviner-temporal-indexing-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.
- package/README.md +608 -10
- package/package.json +19 -19
package/README.md
CHANGED
|
@@ -1,23 +1,621 @@
|
|
|
1
|
+
[![logo][]](https://xyo.network)
|
|
2
|
+
|
|
1
3
|
# @xyo-network/diviner-temporal-indexing-model
|
|
2
4
|
|
|
3
|
-
[![
|
|
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
|
+
```
|
|
17
|
+
|
|
18
|
+
Using yarn:
|
|
4
19
|
|
|
5
|
-
|
|
20
|
+
```sh
|
|
21
|
+
yarn add {{name}}
|
|
22
|
+
```
|
|
6
23
|
|
|
7
|
-
|
|
24
|
+
Using pnpm:
|
|
8
25
|
|
|
9
|
-
|
|
26
|
+
```sh
|
|
27
|
+
pnpm add {{name}}
|
|
28
|
+
```
|
|
10
29
|
|
|
11
|
-
|
|
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
|
-
|
|
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
|
+
### indexing
|
|
54
|
+
|
|
55
|
+
### packages
|
|
56
|
+
|
|
57
|
+
### temporal
|
|
58
|
+
|
|
59
|
+
### packages
|
|
60
|
+
|
|
61
|
+
### model
|
|
62
|
+
|
|
63
|
+
### .temp-typedoc
|
|
64
|
+
|
|
65
|
+
### type-aliases
|
|
66
|
+
|
|
67
|
+
### <a id="IndexingDivinerStageTransformConfig"></a>IndexingDivinerStageTransformConfig
|
|
68
|
+
|
|
69
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
type IndexingDivinerStageTransformConfig = { [key in IndexingDivinerStage]: SchemaToJsonPathTransformExpressionsDictionary };
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Config section for declaring each indexing diviner stage
|
|
78
|
+
|
|
79
|
+
### <a id="TemporalIndexingDivinerConfig"></a>TemporalIndexingDivinerConfig
|
|
80
|
+
|
|
81
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
```ts
|
|
86
|
+
type TemporalIndexingDivinerConfig = DivinerConfig<{
|
|
87
|
+
indexStore?: SearchableStorage;
|
|
88
|
+
indexingDivinerStages?: IndexingDivinerStageConfig;
|
|
89
|
+
payloadDivinerLimit?: number;
|
|
90
|
+
pollFrequency?: number;
|
|
91
|
+
schema: TemporalIndexingDivinerConfigSchema;
|
|
92
|
+
stageConfigs?: {
|
|
93
|
+
divinerQueryToIndexQueryDiviner?: Omit<TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig, "schema">;
|
|
94
|
+
indexCandidateToIndexDiviner?: Omit<TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig, "schema">;
|
|
95
|
+
indexQueryResponseToDivinerQueryResponseDiviner?: Omit<TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig, "schema">;
|
|
96
|
+
stateToIndexCandidateDiviner?: Omit<TemporalIndexingDivinerStateToIndexCandidateDivinerConfig, "schema">;
|
|
97
|
+
};
|
|
98
|
+
stateStore?: SearchableStorage;
|
|
99
|
+
}>;
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Diviner Config for a Diviner which Indexes Payloads
|
|
103
|
+
|
|
104
|
+
### <a id="TemporalIndexingDivinerConfigSchema"></a>TemporalIndexingDivinerConfigSchema
|
|
105
|
+
|
|
106
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
107
|
+
|
|
108
|
+
***
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
type TemporalIndexingDivinerConfigSchema = typeof TemporalIndexingDivinerConfigSchema;
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### <a id="TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig"></a>TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig
|
|
115
|
+
|
|
116
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
117
|
+
|
|
118
|
+
***
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig = DivinerConfig<{
|
|
122
|
+
divinerQuerySchema?: Schema;
|
|
123
|
+
indexQuerySchema?: Schema;
|
|
124
|
+
indexSchema?: Schema;
|
|
125
|
+
schema: TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema;
|
|
126
|
+
schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
|
|
127
|
+
}>;
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Diviner Config for a Diviner which transforms a Diviner Query to an Index Query
|
|
131
|
+
|
|
132
|
+
### <a id="TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema"></a>TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema
|
|
133
|
+
|
|
134
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
135
|
+
|
|
136
|
+
***
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema = typeof TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema;
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### <a id="TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerParams"></a>TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerParams
|
|
143
|
+
|
|
144
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
145
|
+
|
|
146
|
+
***
|
|
147
|
+
|
|
148
|
+
```ts
|
|
149
|
+
type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfig>>;
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
### <a id="TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema"></a>TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema
|
|
153
|
+
|
|
154
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
155
|
+
|
|
156
|
+
***
|
|
157
|
+
|
|
158
|
+
```ts
|
|
159
|
+
type TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema = typeof TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema;
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### <a id="TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig"></a>TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig
|
|
163
|
+
|
|
164
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
165
|
+
|
|
166
|
+
***
|
|
167
|
+
|
|
168
|
+
```ts
|
|
169
|
+
type TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig = DivinerConfig<{
|
|
170
|
+
schema: TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema;
|
|
171
|
+
schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
|
|
172
|
+
}>;
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Diviner Config for a Diviner which transforms Index Candidates to Indexes
|
|
176
|
+
|
|
177
|
+
### <a id="TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema"></a>TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema
|
|
178
|
+
|
|
179
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
180
|
+
|
|
181
|
+
***
|
|
182
|
+
|
|
183
|
+
```ts
|
|
184
|
+
type TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema = typeof TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema;
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### <a id="TemporalIndexingDivinerIndexCandidateToIndexDivinerParams"></a>TemporalIndexingDivinerIndexCandidateToIndexDivinerParams
|
|
188
|
+
|
|
189
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
190
|
+
|
|
191
|
+
***
|
|
192
|
+
|
|
193
|
+
```ts
|
|
194
|
+
type TemporalIndexingDivinerIndexCandidateToIndexDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerIndexCandidateToIndexDivinerConfig>>;
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
Diviner Params for a Diviner which transforms Index Candidates to Indexes
|
|
198
|
+
|
|
199
|
+
### <a id="TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema"></a>TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema
|
|
200
|
+
|
|
201
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
202
|
+
|
|
203
|
+
***
|
|
204
|
+
|
|
205
|
+
```ts
|
|
206
|
+
type TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema = typeof TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema;
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### <a id="TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig"></a>TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig
|
|
210
|
+
|
|
211
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
212
|
+
|
|
213
|
+
***
|
|
214
|
+
|
|
215
|
+
```ts
|
|
216
|
+
type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig = DivinerConfig<{
|
|
217
|
+
schema: TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema;
|
|
218
|
+
schemaTransforms?: SchemaToJsonPathTransformExpressionsDictionary;
|
|
219
|
+
}>;
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
Diviner Config for a Diviner which transforms an Index Query Response to a Diviner Query Response
|
|
223
|
+
|
|
224
|
+
### <a id="TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema"></a>TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema
|
|
225
|
+
|
|
226
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
227
|
+
|
|
228
|
+
***
|
|
229
|
+
|
|
230
|
+
```ts
|
|
231
|
+
type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema = typeof TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema;
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### <a id="TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerParams"></a>TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerParams
|
|
235
|
+
|
|
236
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
237
|
+
|
|
238
|
+
***
|
|
239
|
+
|
|
240
|
+
```ts
|
|
241
|
+
type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfig>>;
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### <a id="TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema"></a>TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema
|
|
245
|
+
|
|
246
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
247
|
+
|
|
248
|
+
***
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
type TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema = `${TemporalIndexingDivinerSchema}.stage.indexQueryResponseToDivinerQueryResponseDiviner`;
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
### <a id="TemporalIndexingDivinerParams"></a>TemporalIndexingDivinerParams
|
|
255
|
+
|
|
256
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
257
|
+
|
|
258
|
+
***
|
|
259
|
+
|
|
260
|
+
```ts
|
|
261
|
+
type TemporalIndexingDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerConfig>>;
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### <a id="TemporalIndexingDivinerResult"></a>TemporalIndexingDivinerResult
|
|
265
|
+
|
|
266
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
267
|
+
|
|
268
|
+
***
|
|
269
|
+
|
|
270
|
+
```ts
|
|
271
|
+
type TemporalIndexingDivinerResult = Payload<{
|
|
272
|
+
sources: Hash[];
|
|
273
|
+
timestamp: string;
|
|
274
|
+
}, TemporalIndexingDivinerResultSchema>;
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### <a id="TemporalIndexingDivinerResultIndex"></a>TemporalIndexingDivinerResultIndex
|
|
278
|
+
|
|
279
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
280
|
+
|
|
281
|
+
***
|
|
282
|
+
|
|
283
|
+
```ts
|
|
284
|
+
type TemporalIndexingDivinerResultIndex = PayloadWithSources<{
|
|
285
|
+
timestamp: number;
|
|
286
|
+
}, TemporalIndexingDivinerResultIndexSchema>;
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### <a id="TemporalIndexingDivinerResultIndexSchema"></a>TemporalIndexingDivinerResultIndexSchema
|
|
290
|
+
|
|
291
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
292
|
+
|
|
293
|
+
***
|
|
294
|
+
|
|
295
|
+
```ts
|
|
296
|
+
type TemporalIndexingDivinerResultIndexSchema = typeof TemporalIndexingDivinerResultIndexSchema;
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### <a id="TemporalIndexingDivinerResultSchema"></a>TemporalIndexingDivinerResultSchema
|
|
300
|
+
|
|
301
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
302
|
+
|
|
303
|
+
***
|
|
304
|
+
|
|
305
|
+
```ts
|
|
306
|
+
type TemporalIndexingDivinerResultSchema = typeof TemporalIndexingDivinerResultSchema;
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
### <a id="TemporalIndexingDivinerSchema"></a>TemporalIndexingDivinerSchema
|
|
310
|
+
|
|
311
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
312
|
+
|
|
313
|
+
***
|
|
314
|
+
|
|
315
|
+
```ts
|
|
316
|
+
type TemporalIndexingDivinerSchema = typeof TemporalIndexingDivinerSchema;
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
### <a id="TemporalIndexingDivinerStateToIndexCandidateDivinerConfig"></a>TemporalIndexingDivinerStateToIndexCandidateDivinerConfig
|
|
320
|
+
|
|
321
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
322
|
+
|
|
323
|
+
***
|
|
324
|
+
|
|
325
|
+
```ts
|
|
326
|
+
type TemporalIndexingDivinerStateToIndexCandidateDivinerConfig = DivinerConfig<{
|
|
327
|
+
filter?: BoundWitnessDivinerPredicate;
|
|
328
|
+
payloadDivinerLimit?: number;
|
|
329
|
+
payloadStore?: SearchableStorage;
|
|
330
|
+
schema: TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema;
|
|
331
|
+
}>;
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
Diviner Config for a Diviner which transforms a Diviner State to Index Candidates
|
|
335
|
+
|
|
336
|
+
### <a id="TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema"></a>TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema
|
|
337
|
+
|
|
338
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
339
|
+
|
|
340
|
+
***
|
|
341
|
+
|
|
342
|
+
```ts
|
|
343
|
+
type TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema = typeof TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema;
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
### <a id="TemporalIndexingDivinerStateToIndexCandidateDivinerParams"></a>TemporalIndexingDivinerStateToIndexCandidateDivinerParams
|
|
347
|
+
|
|
348
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
349
|
+
|
|
350
|
+
***
|
|
351
|
+
|
|
352
|
+
```ts
|
|
353
|
+
type TemporalIndexingDivinerStateToIndexCandidateDivinerParams = DivinerParams<AnyConfigSchema<TemporalIndexingDivinerStateToIndexCandidateDivinerConfig>>;
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### <a id="TemporalIndexingDivinerStateToIndexCandidateDivinerSchema"></a>TemporalIndexingDivinerStateToIndexCandidateDivinerSchema
|
|
357
|
+
|
|
358
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
359
|
+
|
|
360
|
+
***
|
|
361
|
+
|
|
362
|
+
```ts
|
|
363
|
+
type TemporalIndexingDivinerStateToIndexCandidateDivinerSchema = typeof TemporalIndexingDivinerStateToIndexCandidateDivinerSchema;
|
|
364
|
+
```
|
|
365
|
+
|
|
366
|
+
### variables
|
|
367
|
+
|
|
368
|
+
### <a id="TemporalIndexingDivinerConfigSchema"></a>TemporalIndexingDivinerConfigSchema
|
|
369
|
+
|
|
370
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
371
|
+
|
|
372
|
+
***
|
|
373
|
+
|
|
374
|
+
```ts
|
|
375
|
+
const TemporalIndexingDivinerConfigSchema: string & object;
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
## Type Declaration
|
|
379
|
+
|
|
380
|
+
### \_\_schema
|
|
381
|
+
|
|
382
|
+
```ts
|
|
383
|
+
readonly __schema: true;
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### <a id="TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema"></a>TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema
|
|
387
|
+
|
|
388
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
389
|
+
|
|
390
|
+
***
|
|
391
|
+
|
|
392
|
+
```ts
|
|
393
|
+
const TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerConfigSchema: string & object;
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
## Type Declaration
|
|
397
|
+
|
|
398
|
+
### \_\_schema
|
|
399
|
+
|
|
400
|
+
```ts
|
|
401
|
+
readonly __schema: true;
|
|
402
|
+
```
|
|
403
|
+
|
|
404
|
+
### <a id="TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema"></a>TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema
|
|
405
|
+
|
|
406
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
407
|
+
|
|
408
|
+
***
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
const TemporalIndexingDivinerDivinerQueryToIndexQueryDivinerSchema: string & object;
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
## Type Declaration
|
|
415
|
+
|
|
416
|
+
### \_\_schema
|
|
417
|
+
|
|
418
|
+
```ts
|
|
419
|
+
readonly __schema: true;
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
### <a id="TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema"></a>TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema
|
|
423
|
+
|
|
424
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
425
|
+
|
|
426
|
+
***
|
|
427
|
+
|
|
428
|
+
```ts
|
|
429
|
+
const TemporalIndexingDivinerIndexCandidateToIndexDivinerConfigSchema: string & object;
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
## Type Declaration
|
|
433
|
+
|
|
434
|
+
### \_\_schema
|
|
435
|
+
|
|
436
|
+
```ts
|
|
437
|
+
readonly __schema: true;
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
### <a id="TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema"></a>TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema
|
|
441
|
+
|
|
442
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
443
|
+
|
|
444
|
+
***
|
|
445
|
+
|
|
446
|
+
```ts
|
|
447
|
+
const TemporalIndexingDivinerIndexCandidateToIndexDivinerSchema: string & object;
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
## Type Declaration
|
|
451
|
+
|
|
452
|
+
### \_\_schema
|
|
453
|
+
|
|
454
|
+
```ts
|
|
455
|
+
readonly __schema: true;
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
### <a id="TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema"></a>TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema
|
|
459
|
+
|
|
460
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
461
|
+
|
|
462
|
+
***
|
|
463
|
+
|
|
464
|
+
```ts
|
|
465
|
+
const TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerConfigSchema: string & object;
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
## Type Declaration
|
|
469
|
+
|
|
470
|
+
### \_\_schema
|
|
471
|
+
|
|
472
|
+
```ts
|
|
473
|
+
readonly __schema: true;
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
### <a id="TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema"></a>TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema
|
|
477
|
+
|
|
478
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
479
|
+
|
|
480
|
+
***
|
|
481
|
+
|
|
482
|
+
```ts
|
|
483
|
+
TemporalIndexingDivinerIndexQueryResponseToDivinerQueryResponseDivinerSchema: `${string & { __schema: true }}.stage.indexQueryResponseToDivinerQueryResponseDiviner`;
|
|
484
|
+
```
|
|
485
|
+
|
|
486
|
+
### <a id="TemporalIndexingDivinerResultIndexSchema"></a>TemporalIndexingDivinerResultIndexSchema
|
|
487
|
+
|
|
488
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
489
|
+
|
|
490
|
+
***
|
|
491
|
+
|
|
492
|
+
```ts
|
|
493
|
+
const TemporalIndexingDivinerResultIndexSchema: string & object;
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
## Type Declaration
|
|
497
|
+
|
|
498
|
+
### \_\_schema
|
|
499
|
+
|
|
500
|
+
```ts
|
|
501
|
+
readonly __schema: true;
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
### <a id="TemporalIndexingDivinerResultSchema"></a>TemporalIndexingDivinerResultSchema
|
|
505
|
+
|
|
506
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
507
|
+
|
|
508
|
+
***
|
|
509
|
+
|
|
510
|
+
```ts
|
|
511
|
+
const TemporalIndexingDivinerResultSchema: string & object;
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
## Type Declaration
|
|
515
|
+
|
|
516
|
+
### \_\_schema
|
|
517
|
+
|
|
518
|
+
```ts
|
|
519
|
+
readonly __schema: true;
|
|
520
|
+
```
|
|
521
|
+
|
|
522
|
+
### <a id="TemporalIndexingDivinerSchema"></a>TemporalIndexingDivinerSchema
|
|
523
|
+
|
|
524
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
525
|
+
|
|
526
|
+
***
|
|
527
|
+
|
|
528
|
+
```ts
|
|
529
|
+
const TemporalIndexingDivinerSchema: string & object;
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
## Type Declaration
|
|
533
|
+
|
|
534
|
+
### \_\_schema
|
|
535
|
+
|
|
536
|
+
```ts
|
|
537
|
+
readonly __schema: true;
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
### <a id="TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema"></a>TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema
|
|
541
|
+
|
|
542
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
543
|
+
|
|
544
|
+
***
|
|
545
|
+
|
|
546
|
+
```ts
|
|
547
|
+
const TemporalIndexingDivinerStateToIndexCandidateDivinerConfigSchema: string & object;
|
|
548
|
+
```
|
|
549
|
+
|
|
550
|
+
## Type Declaration
|
|
551
|
+
|
|
552
|
+
### \_\_schema
|
|
553
|
+
|
|
554
|
+
```ts
|
|
555
|
+
readonly __schema: true;
|
|
556
|
+
```
|
|
557
|
+
|
|
558
|
+
### <a id="TemporalIndexingDivinerStateToIndexCandidateDivinerSchema"></a>TemporalIndexingDivinerStateToIndexCandidateDivinerSchema
|
|
559
|
+
|
|
560
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
561
|
+
|
|
562
|
+
***
|
|
563
|
+
|
|
564
|
+
```ts
|
|
565
|
+
const TemporalIndexingDivinerStateToIndexCandidateDivinerSchema: string & object;
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
## Type Declaration
|
|
569
|
+
|
|
570
|
+
### \_\_schema
|
|
571
|
+
|
|
572
|
+
```ts
|
|
573
|
+
readonly __schema: true;
|
|
574
|
+
```
|
|
575
|
+
|
|
576
|
+
### <a id="isTemporalIndexingDivinerResult"></a>isTemporalIndexingDivinerResult
|
|
577
|
+
|
|
578
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
579
|
+
|
|
580
|
+
***
|
|
581
|
+
|
|
582
|
+
```ts
|
|
583
|
+
const isTemporalIndexingDivinerResult: (x?) => x is TemporalIndexingDivinerResult;
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
## Parameters
|
|
587
|
+
|
|
588
|
+
### x?
|
|
589
|
+
|
|
590
|
+
`unknown`
|
|
591
|
+
|
|
592
|
+
## Returns
|
|
593
|
+
|
|
594
|
+
`x is TemporalIndexingDivinerResult`
|
|
595
|
+
|
|
596
|
+
### <a id="isTemporalIndexingDivinerResultIndex"></a>isTemporalIndexingDivinerResultIndex
|
|
597
|
+
|
|
598
|
+
[**@xyo-network/diviner-temporal-indexing-model**](#../README)
|
|
599
|
+
|
|
600
|
+
***
|
|
601
|
+
|
|
602
|
+
```ts
|
|
603
|
+
const isTemporalIndexingDivinerResultIndex: (x?) => x is TemporalIndexingDivinerResultIndex;
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
## Parameters
|
|
607
|
+
|
|
608
|
+
### x?
|
|
609
|
+
|
|
610
|
+
`unknown`
|
|
611
|
+
|
|
612
|
+
## Returns
|
|
18
613
|
|
|
19
|
-
|
|
614
|
+
`x is TemporalIndexingDivinerResultIndex`
|
|
20
615
|
|
|
21
|
-
[Made with 🔥 and ❄️ by XYO](https://xyo.network)
|
|
22
616
|
|
|
23
|
-
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
617
|
+
[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
|
|
618
|
+
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/diviner-temporal-indexing-model.svg
|
|
619
|
+
[npm-link]: https://www.npmjs.com/package/@xyo-network/diviner-temporal-indexing-model
|
|
620
|
+
[license-badge]: https://img.shields.io/npm/l/@xyo-network/diviner-temporal-indexing-model.svg
|
|
621
|
+
[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-temporal-indexing-model",
|
|
3
|
-
"version": "5.3.
|
|
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,31 +36,31 @@
|
|
|
36
36
|
"README.md"
|
|
37
37
|
],
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@xyo-network/diviner-
|
|
40
|
-
"@xyo-network/diviner-indexing-model": "~5.3.
|
|
41
|
-
"@xyo-network/
|
|
42
|
-
"@xyo-network/diviner-model": "~5.3.
|
|
43
|
-
"@xyo-network/
|
|
44
|
-
"@xyo-network/
|
|
39
|
+
"@xyo-network/diviner-jsonpath-model": "~5.3.26",
|
|
40
|
+
"@xyo-network/diviner-indexing-model": "~5.3.26",
|
|
41
|
+
"@xyo-network/diviner-boundwitness-model": "~5.3.26",
|
|
42
|
+
"@xyo-network/diviner-model": "~5.3.26",
|
|
43
|
+
"@xyo-network/payload-model": "~5.3.26",
|
|
44
|
+
"@xyo-network/module-model": "~5.3.26"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"@opentelemetry/api": "^1.9.1",
|
|
48
|
-
"@types/node": "^25.5.
|
|
49
|
-
"@xylabs/sdk-js": "^5.0.
|
|
50
|
-
"@xylabs/ts-scripts-common": "~7.
|
|
51
|
-
"@xylabs/ts-scripts-pnpm": "~7.
|
|
52
|
-
"@xylabs/tsconfig": "~7.
|
|
48
|
+
"@types/node": "^25.5.2",
|
|
49
|
+
"@xylabs/sdk-js": "^5.0.94",
|
|
50
|
+
"@xylabs/ts-scripts-common": "~7.7.5",
|
|
51
|
+
"@xylabs/ts-scripts-pnpm": "~7.7.5",
|
|
52
|
+
"@xylabs/tsconfig": "~7.7.5",
|
|
53
53
|
"acorn": "^8.16.0",
|
|
54
54
|
"axios": "^1.14.0",
|
|
55
55
|
"esbuild": "^0.28.0",
|
|
56
56
|
"typescript": "~5.9.3",
|
|
57
57
|
"zod": "^4.3.6",
|
|
58
|
-
"@xyo-network/diviner-boundwitness-model": "~5.3.
|
|
59
|
-
"@xyo-network/diviner-model": "~5.3.
|
|
60
|
-
"@xyo-network/diviner-
|
|
61
|
-
"@xyo-network/
|
|
62
|
-
"@xyo-network/
|
|
63
|
-
"@xyo-network/diviner-
|
|
58
|
+
"@xyo-network/diviner-boundwitness-model": "~5.3.26",
|
|
59
|
+
"@xyo-network/diviner-indexing-model": "~5.3.26",
|
|
60
|
+
"@xyo-network/diviner-model": "~5.3.26",
|
|
61
|
+
"@xyo-network/payload-model": "~5.3.26",
|
|
62
|
+
"@xyo-network/module-model": "~5.3.26",
|
|
63
|
+
"@xyo-network/diviner-jsonpath-model": "~5.3.26"
|
|
64
64
|
},
|
|
65
65
|
"peerDependencies": {
|
|
66
66
|
"@xylabs/sdk-js": "^5",
|