@twin.org/data-json-ld 0.0.1-next.3 → 0.0.1-next.30

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 (67) hide show
  1. package/dist/cjs/index.cjs +613 -350
  2. package/dist/esm/index.mjs +615 -353
  3. package/dist/types/index.d.ts +26 -0
  4. package/dist/types/models/IJsonLdContainerType.d.ts +8 -0
  5. package/dist/types/models/IJsonLdContainerTypeArray.d.ts +9 -0
  6. package/dist/types/models/IJsonLdContextDefinition.d.ts +25 -0
  7. package/dist/types/models/IJsonLdContextDefinitionElement.d.ts +9 -0
  8. package/dist/types/models/IJsonLdContextDefinitionRoot.d.ts +9 -0
  9. package/dist/types/models/IJsonLdDocument.d.ts +2 -189
  10. package/dist/types/models/IJsonLdExpandedTermDefinition.d.ts +28 -0
  11. package/dist/types/models/IJsonLdGraphObject.d.ts +16 -0
  12. package/dist/types/models/IJsonLdIdMap.d.ts +12 -0
  13. package/dist/types/models/IJsonLdIncludedBlock.d.ts +10 -0
  14. package/dist/types/models/IJsonLdIndexMap.d.ts +13 -0
  15. package/dist/types/models/IJsonLdIndexMapItem.d.ts +12 -0
  16. package/dist/types/models/IJsonLdJsonArray.d.ts +9 -0
  17. package/dist/types/models/IJsonLdJsonObject.d.ts +11 -0
  18. package/dist/types/models/IJsonLdJsonPrimitive.d.ts +8 -0
  19. package/dist/types/models/IJsonLdJsonValue.d.ts +11 -0
  20. package/dist/types/models/IJsonLdKeyword.d.ts +42 -0
  21. package/dist/types/models/IJsonLdLanguageMap.d.ts +11 -0
  22. package/dist/types/models/IJsonLdListObject.d.ts +13 -0
  23. package/dist/types/models/IJsonLdListOrSetItem.d.ts +10 -0
  24. package/dist/types/models/IJsonLdNodeObject.d.ts +19 -0
  25. package/dist/types/models/IJsonLdNodePrimitive.d.ts +13 -0
  26. package/dist/types/models/IJsonLdObject.d.ts +24 -0
  27. package/dist/types/models/IJsonLdSetObject.d.ts +13 -0
  28. package/dist/types/models/IJsonLdTypeMap.d.ts +12 -0
  29. package/dist/types/models/IJsonLdValueObject.d.ts +26 -0
  30. package/dist/types/models/jsonLdContexts.d.ts +13 -0
  31. package/dist/types/models/jsonLdTypes.d.ts +27 -23
  32. package/dist/types/utils/jsonLdProcessor.d.ts +82 -8
  33. package/docs/changelog.md +29 -1
  34. package/docs/reference/classes/JsonLdDataTypes.md +3 -3
  35. package/docs/reference/classes/JsonLdHelper.md +16 -8
  36. package/docs/reference/classes/JsonLdProcessor.md +312 -16
  37. package/docs/reference/index.md +20 -15
  38. package/docs/reference/interfaces/IJsonLdContextDefinition.md +1 -1
  39. package/docs/reference/interfaces/IJsonLdGraphObject.md +1 -1
  40. package/docs/reference/interfaces/IJsonLdIdMap.md +1 -1
  41. package/docs/reference/interfaces/IJsonLdIndexMap.md +1 -1
  42. package/docs/reference/interfaces/IJsonLdJsonObject.md +3 -1
  43. package/docs/reference/interfaces/IJsonLdLanguageMap.md +1 -1
  44. package/docs/reference/interfaces/IJsonLdNodeObject.md +40 -4
  45. package/docs/reference/interfaces/IJsonLdObject.md +64 -0
  46. package/docs/reference/interfaces/IJsonLdTypeMap.md +1 -1
  47. package/docs/reference/type-aliases/IJsonLdContainerType.md +3 -1
  48. package/docs/reference/type-aliases/IJsonLdContainerTypeArray.md +3 -1
  49. package/docs/reference/type-aliases/IJsonLdContextDefinitionElement.md +5 -0
  50. package/docs/reference/type-aliases/IJsonLdContextDefinitionRoot.md +5 -0
  51. package/docs/reference/type-aliases/IJsonLdDocument.md +1 -1
  52. package/docs/reference/type-aliases/IJsonLdExpandedTermDefinition.md +1 -1
  53. package/docs/reference/type-aliases/IJsonLdIncludedBlock.md +1 -1
  54. package/docs/reference/type-aliases/IJsonLdIndexMapItem.md +1 -1
  55. package/docs/reference/type-aliases/IJsonLdJsonArray.md +3 -1
  56. package/docs/reference/type-aliases/IJsonLdJsonPrimitive.md +3 -1
  57. package/docs/reference/type-aliases/IJsonLdJsonValue.md +3 -1
  58. package/docs/reference/type-aliases/IJsonLdKeyword.md +51 -7
  59. package/docs/reference/type-aliases/IJsonLdListOrSetItem.md +1 -1
  60. package/docs/reference/type-aliases/IJsonLdNodePrimitive.md +1 -1
  61. package/docs/reference/type-aliases/IJsonLdValueObject.md +1 -1
  62. package/docs/reference/type-aliases/JsonLdContexts.md +5 -0
  63. package/docs/reference/type-aliases/JsonLdTypes.md +1 -1
  64. package/docs/reference/variables/JsonLdContexts.md +13 -0
  65. package/docs/reference/variables/JsonLdTypes.md +29 -23
  66. package/locales/en.json +8 -3
  67. package/package.json +7 -37
@@ -4,51 +4,157 @@ JSON-LD Processor.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new JsonLdProcessor()
7
+ ### Constructor
8
8
 
9
- > **new JsonLdProcessor**(): [`JsonLdProcessor`](JsonLdProcessor.md)
9
+ > **new JsonLdProcessor**(): `JsonLdProcessor`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`JsonLdProcessor`](JsonLdProcessor.md)
13
+ `JsonLdProcessor`
14
14
 
15
15
  ## Methods
16
16
 
17
- ### DOCUMENT\_LOADER()
17
+ ### setDocumentLoader()
18
18
 
19
- > `static` **DOCUMENT\_LOADER**(`url`): `Promise`\<`RemoteDocument`\>
19
+ > `static` **setDocumentLoader**(`documentLoader`): `void`
20
20
 
21
21
  The document loader to use.
22
22
 
23
23
  #### Parameters
24
24
 
25
- **url**: `string`
25
+ ##### documentLoader
26
+
27
+ (`url`) => `Promise`\<`RemoteDocument`\>
28
+
29
+ The document loader to use.
30
+
31
+ #### Returns
32
+
33
+ `void`
34
+
35
+ ***
36
+
37
+ ### getDocumentLoader()
38
+
39
+ > `static` **getDocumentLoader**(): (`url`) => `Promise`\<`RemoteDocument`\>
40
+
41
+ The document loader to use for retrieving JSON-LD documents.
26
42
 
27
43
  #### Returns
28
44
 
45
+ The document loader.
46
+
47
+ > (`url`): `Promise`\<`RemoteDocument`\>
48
+
49
+ ##### Parameters
50
+
51
+ ###### url
52
+
53
+ `string`
54
+
55
+ ##### Returns
56
+
29
57
  `Promise`\<`RemoteDocument`\>
30
58
 
31
59
  ***
32
60
 
61
+ ### setCacheLimit()
62
+
63
+ > `static` **setCacheLimit**(`cacheLimitMs`): `void`
64
+
65
+ Set the cache time limit for documents.
66
+
67
+ #### Parameters
68
+
69
+ ##### cacheLimitMs
70
+
71
+ `number`
72
+
73
+ The cache limit in milliseconds.
74
+
75
+ #### Returns
76
+
77
+ `void`
78
+
79
+ ***
80
+
81
+ ### getCacheLimit()
82
+
83
+ > `static` **getCacheLimit**(): `number`
84
+
85
+ Get the cache limit for documents.
86
+
87
+ #### Returns
88
+
89
+ `number`
90
+
91
+ The document loader.
92
+
93
+ ***
94
+
95
+ ### setRedirects()
96
+
97
+ > `static` **setRedirects**(`redirects`): `void`
98
+
99
+ Set the global redirects for JSON-LD, use addRedirect for default handling.
100
+
101
+ #### Parameters
102
+
103
+ ##### redirects
104
+
105
+ `object`[]
106
+
107
+ The redirects to use.
108
+
109
+ #### Returns
110
+
111
+ `void`
112
+
113
+ ***
114
+
115
+ ### getRedirects()
116
+
117
+ > `static` **getRedirects**(): `object`[]
118
+
119
+ Get the global redirects for JSON-LD.
120
+
121
+ #### Returns
122
+
123
+ `object`[]
124
+
125
+ The registered redirects.
126
+
127
+ ***
128
+
33
129
  ### compact()
34
130
 
35
- > `static` **compact**(`document`, `context`?): `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
131
+ > `static` **compact**\<`T`\>(`document`, `context?`): `Promise`\<`T`\>
36
132
 
37
133
  Compact a document according to a particular context.
38
134
 
135
+ #### Type Parameters
136
+
137
+ ##### T
138
+
139
+ `T`
140
+
39
141
  #### Parameters
40
142
 
41
- **document**: [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
143
+ ##### document
144
+
145
+ `T`
42
146
 
43
147
  The JSON-LD document to compact.
44
148
 
45
- **context?**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
149
+ ##### context?
150
+
151
+ [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
46
152
 
47
- The context to compact the document to.
153
+ The context to compact the document to, if not provided will try and gather from the object.
48
154
 
49
155
  #### Returns
50
156
 
51
- `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
157
+ `Promise`\<`T`\>
52
158
 
53
159
  The compacted JSON-LD document.
54
160
 
@@ -56,24 +162,70 @@ The compacted JSON-LD document.
56
162
 
57
163
  ### expand()
58
164
 
59
- > `static` **expand**(`compacted`): `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
165
+ > `static` **expand**\<`T`\>(`compacted`): `Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
60
166
 
61
167
  Expand a document, removing its context.
62
168
 
169
+ #### Type Parameters
170
+
171
+ ##### T
172
+
173
+ `T`
174
+
63
175
  #### Parameters
64
176
 
65
- **compacted**: [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
177
+ ##### compacted
178
+
179
+ `T`
66
180
 
67
181
  The compacted JSON-LD document to expand.
68
182
 
69
183
  #### Returns
70
184
 
71
- `Promise`\<[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)\>
185
+ `Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
72
186
 
73
187
  The expanded JSON-LD document.
74
188
 
75
189
  ***
76
190
 
191
+ ### canonize()
192
+
193
+ > `static` **canonize**\<`T`\>(`document`, `options?`): `Promise`\<`string`\>
194
+
195
+ Canonize a document.
196
+
197
+ #### Type Parameters
198
+
199
+ ##### T
200
+
201
+ `T` *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
202
+
203
+ #### Parameters
204
+
205
+ ##### document
206
+
207
+ `T`
208
+
209
+ The document to canonize.
210
+
211
+ ##### options?
212
+
213
+ The options for canonization.
214
+
215
+ ###### algorithm?
216
+
217
+ `"URDNA2015"` \| `"URGNA2012"`
218
+
219
+ The algorithm to use for canonization, defaults to URDNA2015.
220
+
221
+ #### Returns
222
+
223
+ `Promise`\<`string`\>
224
+
225
+ The canonized document.
226
+
227
+ ***
228
+
77
229
  ### addRedirect()
78
230
 
79
231
  > `static` **addRedirect**(`from`, `to`): `void`
@@ -82,14 +234,158 @@ Add a redirect to use during document resolution.
82
234
 
83
235
  #### Parameters
84
236
 
85
- **from**: `RegExp`
237
+ ##### from
238
+
239
+ `RegExp`
86
240
 
87
241
  The URL to redirect from.
88
242
 
89
- **to**: `string`
243
+ ##### to
244
+
245
+ `string`
90
246
 
91
247
  The URL to redirect to.
92
248
 
93
249
  #### Returns
94
250
 
95
251
  `void`
252
+
253
+ ***
254
+
255
+ ### combineContexts()
256
+
257
+ > `static` **combineContexts**(`context1`, `context2`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
258
+
259
+ Combine contexts.
260
+
261
+ #### Parameters
262
+
263
+ ##### context1
264
+
265
+ The first JSON-LD context to combine.
266
+
267
+ `undefined` | [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
268
+
269
+ ##### context2
270
+
271
+ The second JSON-LD context to combine.
272
+
273
+ `undefined` | [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
274
+
275
+ #### Returns
276
+
277
+ `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
278
+
279
+ The combined context.
280
+
281
+ ***
282
+
283
+ ### gatherContexts()
284
+
285
+ > `static` **gatherContexts**\<`T`\>(`element`, `initial?`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
286
+
287
+ Gather all the contexts from the element and it's children.
288
+
289
+ #### Type Parameters
290
+
291
+ ##### T
292
+
293
+ `T`
294
+
295
+ #### Parameters
296
+
297
+ ##### element
298
+
299
+ `T`
300
+
301
+ The element to gather the contexts from.
302
+
303
+ ##### initial?
304
+
305
+ [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
306
+
307
+ The initial context.
308
+
309
+ #### Returns
310
+
311
+ `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
312
+
313
+ The combined contexts.
314
+
315
+ ***
316
+
317
+ ### removeContexts()
318
+
319
+ > `static` **removeContexts**(`context`, `match?`): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
320
+
321
+ Remove all the contexts that match the pattern.
322
+
323
+ #### Parameters
324
+
325
+ ##### context
326
+
327
+ The context to remove the entries from.
328
+
329
+ `undefined` | [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
330
+
331
+ ##### match?
332
+
333
+ [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[]
334
+
335
+ The element to try and match.
336
+
337
+ #### Returns
338
+
339
+ `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
340
+
341
+ The updated contexts.
342
+
343
+ ***
344
+
345
+ ### documentCacheAdd()
346
+
347
+ > `static` **documentCacheAdd**(`url`, `ldContext`): `Promise`\<`void`\>
348
+
349
+ Add a context directly to the document loader cache.
350
+
351
+ #### Parameters
352
+
353
+ ##### url
354
+
355
+ `string`
356
+
357
+ The url the ld context is for.
358
+
359
+ ##### ldContext
360
+
361
+ `unknown`
362
+
363
+ The context to add.
364
+
365
+ #### Returns
366
+
367
+ `Promise`\<`void`\>
368
+
369
+ Nothing.
370
+
371
+ ***
372
+
373
+ ### documentCacheRemove()
374
+
375
+ > `static` **documentCacheRemove**(`url`): `Promise`\<`void`\>
376
+
377
+ Remove a context from the document loader cache.
378
+
379
+ #### Parameters
380
+
381
+ ##### url
382
+
383
+ `string`
384
+
385
+ The url the ld context is for.
386
+
387
+ #### Returns
388
+
389
+ `Promise`\<`void`\>
390
+
391
+ Nothing.
@@ -8,34 +8,39 @@
8
8
 
9
9
  ## Interfaces
10
10
 
11
- - [IJsonLdNodeObject](interfaces/IJsonLdNodeObject.md)
11
+ - [IJsonLdContextDefinition](interfaces/IJsonLdContextDefinition.md)
12
12
  - [IJsonLdGraphObject](interfaces/IJsonLdGraphObject.md)
13
+ - [IJsonLdIdMap](interfaces/IJsonLdIdMap.md)
14
+ - [IJsonLdIndexMap](interfaces/IJsonLdIndexMap.md)
15
+ - [IJsonLdJsonObject](interfaces/IJsonLdJsonObject.md)
16
+ - [IJsonLdLanguageMap](interfaces/IJsonLdLanguageMap.md)
13
17
  - [IJsonLdListObject](interfaces/IJsonLdListObject.md)
18
+ - [IJsonLdNodeObject](interfaces/IJsonLdNodeObject.md)
19
+ - [IJsonLdObject](interfaces/IJsonLdObject.md)
14
20
  - [IJsonLdSetObject](interfaces/IJsonLdSetObject.md)
15
- - [IJsonLdLanguageMap](interfaces/IJsonLdLanguageMap.md)
16
- - [IJsonLdIndexMap](interfaces/IJsonLdIndexMap.md)
17
- - [IJsonLdIdMap](interfaces/IJsonLdIdMap.md)
18
21
  - [IJsonLdTypeMap](interfaces/IJsonLdTypeMap.md)
19
- - [IJsonLdContextDefinition](interfaces/IJsonLdContextDefinition.md)
20
- - [IJsonLdJsonObject](interfaces/IJsonLdJsonObject.md)
21
22
 
22
23
  ## Type Aliases
23
24
 
24
- - [IJsonLdDocument](type-aliases/IJsonLdDocument.md)
25
- - [IJsonLdNodePrimitive](type-aliases/IJsonLdNodePrimitive.md)
26
- - [IJsonLdValueObject](type-aliases/IJsonLdValueObject.md)
27
- - [IJsonLdIndexMapItem](type-aliases/IJsonLdIndexMapItem.md)
28
- - [IJsonLdIncludedBlock](type-aliases/IJsonLdIncludedBlock.md)
29
- - [IJsonLdExpandedTermDefinition](type-aliases/IJsonLdExpandedTermDefinition.md)
30
- - [IJsonLdKeyword](type-aliases/IJsonLdKeyword.md)
31
- - [IJsonLdListOrSetItem](type-aliases/IJsonLdListOrSetItem.md)
32
25
  - [IJsonLdContainerType](type-aliases/IJsonLdContainerType.md)
33
26
  - [IJsonLdContainerTypeArray](type-aliases/IJsonLdContainerTypeArray.md)
34
- - [IJsonLdJsonPrimitive](type-aliases/IJsonLdJsonPrimitive.md)
27
+ - [IJsonLdContextDefinitionElement](type-aliases/IJsonLdContextDefinitionElement.md)
28
+ - [IJsonLdContextDefinitionRoot](type-aliases/IJsonLdContextDefinitionRoot.md)
29
+ - [IJsonLdDocument](type-aliases/IJsonLdDocument.md)
30
+ - [IJsonLdExpandedTermDefinition](type-aliases/IJsonLdExpandedTermDefinition.md)
31
+ - [IJsonLdIncludedBlock](type-aliases/IJsonLdIncludedBlock.md)
32
+ - [IJsonLdIndexMapItem](type-aliases/IJsonLdIndexMapItem.md)
35
33
  - [IJsonLdJsonArray](type-aliases/IJsonLdJsonArray.md)
34
+ - [IJsonLdJsonPrimitive](type-aliases/IJsonLdJsonPrimitive.md)
36
35
  - [IJsonLdJsonValue](type-aliases/IJsonLdJsonValue.md)
36
+ - [IJsonLdKeyword](type-aliases/IJsonLdKeyword.md)
37
+ - [IJsonLdListOrSetItem](type-aliases/IJsonLdListOrSetItem.md)
38
+ - [IJsonLdNodePrimitive](type-aliases/IJsonLdNodePrimitive.md)
39
+ - [IJsonLdValueObject](type-aliases/IJsonLdValueObject.md)
40
+ - [JsonLdContexts](type-aliases/JsonLdContexts.md)
37
41
  - [JsonLdTypes](type-aliases/JsonLdTypes.md)
38
42
 
39
43
  ## Variables
40
44
 
45
+ - [JsonLdContexts](variables/JsonLdContexts.md)
41
46
  - [JsonLdTypes](variables/JsonLdTypes.md)
@@ -8,7 +8,7 @@ https://www.w3.org/TR/json-ld11/#context-definitions
8
8
 
9
9
  ## Indexable
10
10
 
11
- \[`key`: `string`\]: `null` \| `string` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md)\[keyof [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md)\]
11
+ \[`key`: `string`\]: `undefined` \| `null` \| `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected`: `boolean`; \}
12
12
 
13
13
  ## Properties
14
14
 
@@ -28,4 +28,4 @@ https://www.w3.org/TR/json-ld11/#graph-objects
28
28
 
29
29
  ### @context?
30
30
 
31
- > `optional` **@context**: `null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| (`null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md))[]
31
+ > `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
@@ -8,4 +8,4 @@ https://www.w3.org/TR/json-ld11/#id-maps
8
8
 
9
9
  ## Indexable
10
10
 
11
- \[`key`: `string`\]: [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
11
+ \[`key`: `string`\]: [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
@@ -9,4 +9,4 @@ https://www.w3.org/TR/json-ld11/#index-maps
9
9
 
10
10
  ## Indexable
11
11
 
12
- \[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]
12
+ \[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]
@@ -1,5 +1,7 @@
1
1
  # Interface: IJsonLdJsonObject
2
2
 
3
+ JSON Type for object.
4
+
3
5
  ## Indexable
4
6
 
5
- \[`key`: `string`\]: [`IJsonLdJsonValue`](../type-aliases/IJsonLdJsonValue.md) \| `undefined`
7
+ \[`key`: `string`\]: `undefined` \| [`IJsonLdJsonValue`](../type-aliases/IJsonLdJsonValue.md)
@@ -8,4 +8,4 @@ https://www.w3.org/TR/json-ld11/#language-maps
8
8
 
9
9
  ## Indexable
10
10
 
11
- \[`key`: `string`\]: `null` \| `string` \| `string`[]
11
+ \[`key`: `string`\]: `null` \| `string` \| `string`[]
@@ -7,15 +7,23 @@ in the graph serialized by the JSON-LD document.
7
7
 
8
8
  https://www.w3.org/TR/json-ld11/#node-objects
9
9
 
10
+ ## Extends
11
+
12
+ - [`IJsonLdObject`](IJsonLdObject.md)
13
+
10
14
  ## Indexable
11
15
 
12
- \[`key`: `string`\]: [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md) \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)\[keyof [`IJsonLdNodeObject`](IJsonLdNodeObject.md)\]
16
+ \[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| `IJsonLdNodeObject` \| [`IJsonLdListObject`](IJsonLdListObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| `IJsonLdNodeObject`[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{[`key`: `string`]: `string`; \} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[]
13
17
 
14
18
  ## Properties
15
19
 
16
20
  ### @context?
17
21
 
18
- > `optional` **@context**: `null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| (`null` \| `string` \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md))[]
22
+ > `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
23
+
24
+ #### Inherited from
25
+
26
+ [`IJsonLdObject`](IJsonLdObject.md).[`@context`](IJsonLdObject.md#context)
19
27
 
20
28
  ***
21
29
 
@@ -23,17 +31,29 @@ https://www.w3.org/TR/json-ld11/#node-objects
23
31
 
24
32
  > `optional` **@id**: `string` \| `string`[]
25
33
 
34
+ #### Inherited from
35
+
36
+ [`IJsonLdObject`](IJsonLdObject.md).[`@id`](IJsonLdObject.md#id)
37
+
26
38
  ***
27
39
 
28
40
  ### @included?
29
41
 
30
42
  > `optional` **@included**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
31
43
 
44
+ #### Inherited from
45
+
46
+ [`IJsonLdObject`](IJsonLdObject.md).[`@included`](IJsonLdObject.md#included)
47
+
32
48
  ***
33
49
 
34
50
  ### @graph?
35
51
 
36
- > `optional` **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
52
+ > `optional` **@graph**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
53
+
54
+ #### Inherited from
55
+
56
+ [`IJsonLdObject`](IJsonLdObject.md).[`@graph`](IJsonLdObject.md#graph)
37
57
 
38
58
  ***
39
59
 
@@ -41,12 +61,20 @@ https://www.w3.org/TR/json-ld11/#node-objects
41
61
 
42
62
  > `optional` **@nest**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
43
63
 
64
+ #### Inherited from
65
+
66
+ [`IJsonLdObject`](IJsonLdObject.md).[`@nest`](IJsonLdObject.md#nest)
67
+
44
68
  ***
45
69
 
46
70
  ### @type?
47
71
 
48
72
  > `optional` **@type**: `string` \| `string`[]
49
73
 
74
+ #### Inherited from
75
+
76
+ [`IJsonLdObject`](IJsonLdObject.md).[`@type`](IJsonLdObject.md#type)
77
+
50
78
  ***
51
79
 
52
80
  ### @reverse?
@@ -55,10 +83,18 @@ https://www.w3.org/TR/json-ld11/#node-objects
55
83
 
56
84
  #### Index Signature
57
85
 
58
- \[`key`: `string`\]: [`IJsonLdKeyword`](../type-aliases/IJsonLdKeyword.md)\[`"@reverse"`\]
86
+ \[`key`: `string`\]: `string`
87
+
88
+ #### Inherited from
89
+
90
+ [`IJsonLdObject`](IJsonLdObject.md).[`@reverse`](IJsonLdObject.md#reverse)
59
91
 
60
92
  ***
61
93
 
62
94
  ### @index?
63
95
 
64
96
  > `optional` **@index**: `string`
97
+
98
+ #### Inherited from
99
+
100
+ [`IJsonLdObject`](IJsonLdObject.md).[`@index`](IJsonLdObject.md#index)
@@ -0,0 +1,64 @@
1
+ # Interface: IJsonLdObject
2
+
3
+ An object represents the pre-defined properties of the node object
4
+ in the graph serialized by the JSON-LD document.
5
+
6
+ ## See
7
+
8
+ https://www.w3.org/TR/json-ld11/#node-objects
9
+
10
+ ## Extended by
11
+
12
+ - [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
13
+
14
+ ## Properties
15
+
16
+ ### @context?
17
+
18
+ > `optional` **@context**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
19
+
20
+ ***
21
+
22
+ ### @id?
23
+
24
+ > `optional` **@id**: `string` \| `string`[]
25
+
26
+ ***
27
+
28
+ ### @included?
29
+
30
+ > `optional` **@included**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
31
+
32
+ ***
33
+
34
+ ### @graph?
35
+
36
+ > `optional` **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
37
+
38
+ ***
39
+
40
+ ### @nest?
41
+
42
+ > `optional` **@nest**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
43
+
44
+ ***
45
+
46
+ ### @type?
47
+
48
+ > `optional` **@type**: `string` \| `string`[]
49
+
50
+ ***
51
+
52
+ ### @reverse?
53
+
54
+ > `optional` **@reverse**: `object`
55
+
56
+ #### Index Signature
57
+
58
+ \[`key`: `string`\]: `string`
59
+
60
+ ***
61
+
62
+ ### @index?
63
+
64
+ > `optional` **@index**: `string`
@@ -8,4 +8,4 @@ https://www.w3.org/TR/json-ld11/#type-maps
8
8
 
9
9
  ## Indexable
10
10
 
11
- \[`key`: `string`\]: `string` \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
11
+ \[`key`: `string`\]: `string` \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
@@ -1,3 +1,5 @@
1
1
  # Type Alias: IJsonLdContainerType
2
2
 
3
- > **IJsonLdContainerType**: `"@language"` \| `"@index"` \| `"@id"` \| `"@graph"` \| `"@type"`
3
+ > **IJsonLdContainerType** = `"@language"` \| `"@index"` \| `"@id"` \| `"@graph"` \| `"@type"`
4
+
5
+ Helper Types
@@ -1,3 +1,5 @@
1
1
  # Type Alias: IJsonLdContainerTypeArray
2
2
 
3
- > **IJsonLdContainerTypeArray**: [`"@graph"`, `"@id"`] \| [`"@id"`, `"@graph"`] \| [`"@set"`, `"@graph"`, `"@id"`] \| [`"@set"`, `"@id"`, `"@graph"`] \| [`"@graph"`, `"@set"`, `"@id"`] \| [`"@id"`, `"@set"`, `"@graph"`] \| [`"@graph"`, `"@id"`, `"@set"`] \| [`"@id"`, `"@graph"`, `"@set"`] \| [`"@set"`, [`IJsonLdContainerType`](IJsonLdContainerType.md)] \| [[`IJsonLdContainerType`](IJsonLdContainerType.md), `"@set"`]
3
+ > **IJsonLdContainerTypeArray** = \[`"@graph"`, `"@id"`\] \| \[`"@id"`, `"@graph"`\] \| \[`"@set"`, `"@graph"`, `"@id"`\] \| \[`"@set"`, `"@id"`, `"@graph"`\] \| \[`"@graph"`, `"@set"`, `"@id"`\] \| \[`"@id"`, `"@set"`, `"@graph"`\] \| \[`"@graph"`, `"@id"`, `"@set"`\] \| \[`"@id"`, `"@graph"`, `"@set"`\] \| \[`"@set"`, [`IJsonLdContainerType`](IJsonLdContainerType.md)\] \| \[[`IJsonLdContainerType`](IJsonLdContainerType.md), `"@set"`\]
4
+
5
+ Helper Types.
@@ -0,0 +1,5 @@
1
+ # Type Alias: IJsonLdContextDefinitionElement
2
+
3
+ > **IJsonLdContextDefinitionElement** = `null` \| `string` \| [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
4
+
5
+ A context definition element is used to define the types of a context definition.