@twin.org/data-json-ld 0.0.3-next.9 → 0.9.0-next.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 +1 -1
- package/dist/es/helpers/jsonLdAliasKey.js +4 -0
- package/dist/es/helpers/jsonLdAliasKey.js.map +1 -0
- package/dist/es/helpers/jsonLdExistingProperty.js +4 -0
- package/dist/es/helpers/jsonLdExistingProperty.js.map +1 -0
- package/dist/es/helpers/jsonLdExistingPropertyEither.js +2 -0
- package/dist/es/helpers/jsonLdExistingPropertyEither.js.map +1 -0
- package/dist/es/helpers/jsonLdKeys.js +4 -0
- package/dist/es/helpers/jsonLdKeys.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithAliases.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithAliases.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithAtId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithAtId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithAtType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithAtType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithContext.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithContext.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtId.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtType.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoContext.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoContext.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoId.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoType.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalContext.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalContext.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithType.js.map +1 -0
- package/dist/es/helpers/jsonLdOptionalKeys.js +4 -0
- package/dist/es/helpers/jsonLdOptionalKeys.js.map +1 -0
- package/dist/es/helpers/jsonLdRequiredKeys.js +2 -0
- package/dist/es/helpers/jsonLdRequiredKeys.js.map +1 -0
- package/dist/es/helpers/jsonLdWithAliases.js +2 -0
- package/dist/es/helpers/jsonLdWithAliases.js.map +1 -0
- package/dist/es/index.js +23 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IJsonLdDocument.js.map +1 -1
- package/dist/es/schemas/JsonLdContainerType.json +17 -7
- package/dist/es/schemas/JsonLdContainerTypeArray.json +129 -142
- package/dist/es/schemas/JsonLdContextDefinition.json +76 -18
- package/dist/es/schemas/JsonLdContextDefinitionElement.json +1 -0
- package/dist/es/schemas/JsonLdContextDefinitionRoot.json +1 -0
- package/dist/es/schemas/JsonLdDocument.json +3 -3
- package/dist/es/schemas/JsonLdExpandedTermDefinition.json +101 -89
- package/dist/es/schemas/JsonLdGraphObject.json +2 -2
- package/dist/es/schemas/JsonLdIdMap.json +1 -0
- package/dist/es/schemas/JsonLdIncludedBlock.json +1 -0
- package/dist/es/schemas/JsonLdIndexMap.json +2 -1
- package/dist/es/schemas/JsonLdIndexMapItem.json +1 -0
- package/dist/es/schemas/JsonLdJsonArray.json +1 -0
- package/dist/es/schemas/JsonLdJsonObject.json +2 -8
- package/dist/es/schemas/JsonLdJsonPrimitive.json +14 -5
- package/dist/es/schemas/JsonLdJsonValue.json +1 -0
- package/dist/es/schemas/JsonLdLanguageMap.json +1 -0
- package/dist/es/schemas/JsonLdListObject.json +2 -2
- package/dist/es/schemas/JsonLdListOrSetItem.json +1 -0
- package/dist/es/schemas/JsonLdNodeObject.json +12 -72
- package/dist/es/schemas/JsonLdNodePrimitive.json +1 -0
- package/dist/es/schemas/JsonLdObject.json +3 -3
- package/dist/es/schemas/JsonLdSetObject.json +2 -2
- package/dist/es/schemas/JsonLdTypeMap.json +1 -0
- package/dist/es/schemas/JsonLdValueObject.json +99 -87
- package/dist/es/utils/jsonLdHelper.js +85 -11
- package/dist/es/utils/jsonLdHelper.js.map +1 -1
- package/dist/es/utils/jsonLdProcessor.js +134 -40
- package/dist/es/utils/jsonLdProcessor.js.map +1 -1
- package/dist/types/helpers/jsonLdAliasKey.d.ts +4 -0
- package/dist/types/helpers/jsonLdExistingProperty.d.ts +6 -0
- package/dist/types/helpers/jsonLdExistingPropertyEither.d.ts +6 -0
- package/dist/types/helpers/jsonLdKeys.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithAliases.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithAtId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithAtType.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithContext.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithNoAtId.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithNoAtType.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithNoContext.d.ts +5 -0
- package/dist/types/helpers/jsonLdObjectWithNoId.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithNoType.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalAtId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalAtType.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalContext.d.ts +9 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalType.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithType.d.ts +7 -0
- package/dist/types/helpers/jsonLdOptionalKeys.d.ts +6 -0
- package/dist/types/helpers/jsonLdRequiredKeys.d.ts +5 -0
- package/dist/types/helpers/jsonLdWithAliases.d.ts +13 -0
- package/dist/types/index.d.ts +23 -0
- package/dist/types/models/IJsonLdDocument.d.ts +0 -4
- package/dist/types/utils/jsonLdHelper.d.ts +31 -4
- package/dist/types/utils/jsonLdProcessor.d.ts +16 -13
- package/docs/changelog.md +381 -74
- package/docs/examples.md +214 -1
- package/docs/reference/classes/JsonLdDataTypes.md +1 -1
- package/docs/reference/classes/JsonLdHelper.md +130 -12
- package/docs/reference/classes/JsonLdProcessor.md +57 -64
- package/docs/reference/index.md +23 -0
- package/docs/reference/interfaces/IJsonLdContextDefinition.md +20 -20
- package/docs/reference/interfaces/IJsonLdGraphObject.md +7 -7
- package/docs/reference/interfaces/IJsonLdIdMap.md +1 -1
- package/docs/reference/interfaces/IJsonLdIndexMap.md +1 -1
- package/docs/reference/interfaces/IJsonLdJsonObject.md +1 -1
- package/docs/reference/interfaces/IJsonLdLanguageMap.md +1 -1
- package/docs/reference/interfaces/IJsonLdListObject.md +3 -3
- package/docs/reference/interfaces/IJsonLdNodeObject.md +17 -17
- package/docs/reference/interfaces/IJsonLdObject.md +16 -16
- package/docs/reference/interfaces/IJsonLdSetObject.md +3 -3
- package/docs/reference/interfaces/IJsonLdTypeMap.md +1 -1
- package/docs/reference/type-aliases/IJsonLdExpandedTermDefinition.md +7 -7
- package/docs/reference/type-aliases/IJsonLdValueObject.md +2 -2
- package/docs/reference/type-aliases/JsonLdAliasKey.md +15 -0
- package/docs/reference/type-aliases/JsonLdExistingProperty.md +19 -0
- package/docs/reference/type-aliases/JsonLdExistingPropertyEither.md +24 -0
- package/docs/reference/type-aliases/JsonLdKeys.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithAliases.md +16 -0
- package/docs/reference/type-aliases/JsonLdObjectWithAtId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithAtType.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithContext.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoAtId.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoAtType.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoContext.md +12 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoId.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoType.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalAtId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalAtType.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalContext.md +22 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalType.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithType.md +21 -0
- package/docs/reference/type-aliases/JsonLdOptionalKeys.md +11 -0
- package/docs/reference/type-aliases/JsonLdRequiredKeys.md +11 -0
- package/docs/reference/type-aliases/JsonLdWithAliases.md +17 -0
- package/docs/reference/variables/JsonLdContexts.md +3 -3
- package/docs/reference/variables/JsonLdTypes.md +26 -26
- package/package.json +10 -10
package/docs/reference/index.md
CHANGED
|
@@ -22,6 +22,29 @@
|
|
|
22
22
|
|
|
23
23
|
## Type Aliases
|
|
24
24
|
|
|
25
|
+
- [JsonLdAliasKey](type-aliases/JsonLdAliasKey.md)
|
|
26
|
+
- [JsonLdExistingProperty](type-aliases/JsonLdExistingProperty.md)
|
|
27
|
+
- [JsonLdExistingPropertyEither](type-aliases/JsonLdExistingPropertyEither.md)
|
|
28
|
+
- [JsonLdKeys](type-aliases/JsonLdKeys.md)
|
|
29
|
+
- [JsonLdObjectWithAliases](type-aliases/JsonLdObjectWithAliases.md)
|
|
30
|
+
- [JsonLdObjectWithAtId](type-aliases/JsonLdObjectWithAtId.md)
|
|
31
|
+
- [JsonLdObjectWithAtType](type-aliases/JsonLdObjectWithAtType.md)
|
|
32
|
+
- [JsonLdObjectWithContext](type-aliases/JsonLdObjectWithContext.md)
|
|
33
|
+
- [JsonLdObjectWithId](type-aliases/JsonLdObjectWithId.md)
|
|
34
|
+
- [JsonLdObjectWithNoAtId](type-aliases/JsonLdObjectWithNoAtId.md)
|
|
35
|
+
- [JsonLdObjectWithNoAtType](type-aliases/JsonLdObjectWithNoAtType.md)
|
|
36
|
+
- [JsonLdObjectWithNoContext](type-aliases/JsonLdObjectWithNoContext.md)
|
|
37
|
+
- [JsonLdObjectWithNoId](type-aliases/JsonLdObjectWithNoId.md)
|
|
38
|
+
- [JsonLdObjectWithNoType](type-aliases/JsonLdObjectWithNoType.md)
|
|
39
|
+
- [JsonLdObjectWithOptionalAtId](type-aliases/JsonLdObjectWithOptionalAtId.md)
|
|
40
|
+
- [JsonLdObjectWithOptionalAtType](type-aliases/JsonLdObjectWithOptionalAtType.md)
|
|
41
|
+
- [JsonLdObjectWithOptionalContext](type-aliases/JsonLdObjectWithOptionalContext.md)
|
|
42
|
+
- [JsonLdObjectWithOptionalId](type-aliases/JsonLdObjectWithOptionalId.md)
|
|
43
|
+
- [JsonLdObjectWithOptionalType](type-aliases/JsonLdObjectWithOptionalType.md)
|
|
44
|
+
- [JsonLdObjectWithType](type-aliases/JsonLdObjectWithType.md)
|
|
45
|
+
- [JsonLdOptionalKeys](type-aliases/JsonLdOptionalKeys.md)
|
|
46
|
+
- [JsonLdRequiredKeys](type-aliases/JsonLdRequiredKeys.md)
|
|
47
|
+
- [JsonLdWithAliases](type-aliases/JsonLdWithAliases.md)
|
|
25
48
|
- [IJsonLdContainerType](type-aliases/IJsonLdContainerType.md)
|
|
26
49
|
- [IJsonLdContainerTypeArray](type-aliases/IJsonLdContainerTypeArray.md)
|
|
27
50
|
- [IJsonLdContextDefinitionElement](type-aliases/IJsonLdContextDefinitionElement.md)
|
|
@@ -8,49 +8,49 @@ https://www.w3.org/TR/json-ld11/#context-definitions
|
|
|
8
8
|
|
|
9
9
|
## Indexable
|
|
10
10
|
|
|
11
|
-
\[`key`: `string`\]: `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected?`: `boolean`; \} \| `null` \| `undefined`
|
|
11
|
+
> \[`key`: `string`\]: `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected?`: `boolean`; \} \| `null` \| `undefined`
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
-
### @base?
|
|
15
|
+
### @base? {#base}
|
|
16
16
|
|
|
17
|
-
> `optional` **@base
|
|
17
|
+
> `optional` **@base?**: `string` \| `null`
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
21
|
-
### @direction?
|
|
21
|
+
### @direction? {#direction}
|
|
22
22
|
|
|
23
|
-
> `optional` **@direction
|
|
23
|
+
> `optional` **@direction?**: `"ltr"` \| `"rtl"` \| `null`
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
27
|
-
### @import?
|
|
27
|
+
### @import? {#import}
|
|
28
28
|
|
|
29
|
-
> `optional` **@import
|
|
29
|
+
> `optional` **@import?**: `string`
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
33
|
-
### @language?
|
|
33
|
+
### @language? {#language}
|
|
34
34
|
|
|
35
|
-
> `optional` **@language
|
|
35
|
+
> `optional` **@language?**: `string`
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### @propagate?
|
|
39
|
+
### @propagate? {#propagate}
|
|
40
40
|
|
|
41
|
-
> `optional` **@propagate
|
|
41
|
+
> `optional` **@propagate?**: `boolean`
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
|
-
### @protected?
|
|
45
|
+
### @protected? {#protected}
|
|
46
46
|
|
|
47
|
-
> `optional` **@protected
|
|
47
|
+
> `optional` **@protected?**: `boolean`
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
51
|
-
### @type?
|
|
51
|
+
### @type? {#type}
|
|
52
52
|
|
|
53
|
-
> `optional` **@type
|
|
53
|
+
> `optional` **@type?**: `object`
|
|
54
54
|
|
|
55
55
|
#### @container
|
|
56
56
|
|
|
@@ -58,16 +58,16 @@ https://www.w3.org/TR/json-ld11/#context-definitions
|
|
|
58
58
|
|
|
59
59
|
#### @protected?
|
|
60
60
|
|
|
61
|
-
> `optional` **@protected
|
|
61
|
+
> `optional` **@protected?**: `boolean`
|
|
62
62
|
|
|
63
63
|
***
|
|
64
64
|
|
|
65
|
-
### @version?
|
|
65
|
+
### @version? {#version}
|
|
66
66
|
|
|
67
|
-
> `optional` **@version
|
|
67
|
+
> `optional` **@version?**: `"1.1"`
|
|
68
68
|
|
|
69
69
|
***
|
|
70
70
|
|
|
71
|
-
### @vocab?
|
|
71
|
+
### @vocab? {#vocab}
|
|
72
72
|
|
|
73
|
-
> `optional` **@vocab
|
|
73
|
+
> `optional` **@vocab?**: `string` \| `null`
|
|
@@ -8,24 +8,24 @@ https://www.w3.org/TR/json-ld11/#graph-objects
|
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
11
|
-
### @graph
|
|
11
|
+
### @graph {#graph}
|
|
12
12
|
|
|
13
13
|
> **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### @index?
|
|
17
|
+
### @index? {#index}
|
|
18
18
|
|
|
19
|
-
> `optional` **@index
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
### @id?
|
|
23
|
+
### @id? {#id}
|
|
24
24
|
|
|
25
|
-
> `optional` **@id
|
|
25
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
29
|
-
### @context?
|
|
29
|
+
### @context? {#context}
|
|
30
30
|
|
|
31
|
-
> `optional` **@context
|
|
31
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.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)[]
|
|
@@ -8,12 +8,12 @@ https://www.w3.org/TR/json-ld11/#lists-and-sets
|
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
11
|
-
### @list
|
|
11
|
+
### @list {#list}
|
|
12
12
|
|
|
13
13
|
> **@list**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### @index?
|
|
17
|
+
### @index? {#index}
|
|
18
18
|
|
|
19
|
-
> `optional` **@index
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
@@ -13,13 +13,13 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
13
13
|
|
|
14
14
|
## Indexable
|
|
15
15
|
|
|
16
|
-
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| `IJsonLdNodeObject` \| `IJsonLdNodeObject`[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdListObject`](IJsonLdListObject.md) \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{\[`key`: `string`\]: `string`; \} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `null` \| `undefined`
|
|
16
|
+
> \[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| `IJsonLdNodeObject` \| `IJsonLdNodeObject`[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdListObject`](IJsonLdListObject.md) \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{\[`key`: `string`\]: `string`; \} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `null` \| `undefined`
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
|
-
### @context?
|
|
20
|
+
### @context? {#context}
|
|
21
21
|
|
|
22
|
-
> `optional` **@context
|
|
22
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
23
23
|
|
|
24
24
|
#### Inherited from
|
|
25
25
|
|
|
@@ -27,9 +27,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
27
27
|
|
|
28
28
|
***
|
|
29
29
|
|
|
30
|
-
### @id?
|
|
30
|
+
### @id? {#id}
|
|
31
31
|
|
|
32
|
-
> `optional` **@id
|
|
32
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
33
33
|
|
|
34
34
|
#### Inherited from
|
|
35
35
|
|
|
@@ -37,9 +37,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
37
37
|
|
|
38
38
|
***
|
|
39
39
|
|
|
40
|
-
### @included?
|
|
40
|
+
### @included? {#included}
|
|
41
41
|
|
|
42
|
-
> `optional` **@included
|
|
42
|
+
> `optional` **@included?**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
|
|
43
43
|
|
|
44
44
|
#### Inherited from
|
|
45
45
|
|
|
@@ -47,9 +47,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
50
|
-
### @graph?
|
|
50
|
+
### @graph? {#graph}
|
|
51
51
|
|
|
52
|
-
> `optional` **@graph
|
|
52
|
+
> `optional` **@graph?**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
|
|
53
53
|
|
|
54
54
|
#### Inherited from
|
|
55
55
|
|
|
@@ -57,9 +57,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
57
57
|
|
|
58
58
|
***
|
|
59
59
|
|
|
60
|
-
### @nest?
|
|
60
|
+
### @nest? {#nest}
|
|
61
61
|
|
|
62
|
-
> `optional` **@nest
|
|
62
|
+
> `optional` **@nest?**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
|
|
63
63
|
|
|
64
64
|
#### Inherited from
|
|
65
65
|
|
|
@@ -67,9 +67,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
67
67
|
|
|
68
68
|
***
|
|
69
69
|
|
|
70
|
-
### @type?
|
|
70
|
+
### @type? {#type}
|
|
71
71
|
|
|
72
|
-
> `optional` **@type
|
|
72
|
+
> `optional` **@type?**: `string` \| `string`[]
|
|
73
73
|
|
|
74
74
|
#### Inherited from
|
|
75
75
|
|
|
@@ -77,9 +77,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
77
77
|
|
|
78
78
|
***
|
|
79
79
|
|
|
80
|
-
### @reverse?
|
|
80
|
+
### @reverse? {#reverse}
|
|
81
81
|
|
|
82
|
-
> `optional` **@reverse
|
|
82
|
+
> `optional` **@reverse?**: `object`
|
|
83
83
|
|
|
84
84
|
#### Index Signature
|
|
85
85
|
|
|
@@ -91,9 +91,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
91
91
|
|
|
92
92
|
***
|
|
93
93
|
|
|
94
|
-
### @index?
|
|
94
|
+
### @index? {#index}
|
|
95
95
|
|
|
96
|
-
> `optional` **@index
|
|
96
|
+
> `optional` **@index?**: `string`
|
|
97
97
|
|
|
98
98
|
#### Inherited from
|
|
99
99
|
|
|
@@ -13,45 +13,45 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
### @context?
|
|
16
|
+
### @context? {#context}
|
|
17
17
|
|
|
18
|
-
> `optional` **@context
|
|
18
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
19
19
|
|
|
20
20
|
***
|
|
21
21
|
|
|
22
|
-
### @id?
|
|
22
|
+
### @id? {#id}
|
|
23
23
|
|
|
24
|
-
> `optional` **@id
|
|
24
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
28
|
-
### @included?
|
|
28
|
+
### @included? {#included}
|
|
29
29
|
|
|
30
|
-
> `optional` **@included
|
|
30
|
+
> `optional` **@included?**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
|
|
31
31
|
|
|
32
32
|
***
|
|
33
33
|
|
|
34
|
-
### @graph?
|
|
34
|
+
### @graph? {#graph}
|
|
35
35
|
|
|
36
|
-
> `optional` **@graph
|
|
36
|
+
> `optional` **@graph?**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
|
|
37
37
|
|
|
38
38
|
***
|
|
39
39
|
|
|
40
|
-
### @nest?
|
|
40
|
+
### @nest? {#nest}
|
|
41
41
|
|
|
42
|
-
> `optional` **@nest
|
|
42
|
+
> `optional` **@nest?**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
|
|
43
43
|
|
|
44
44
|
***
|
|
45
45
|
|
|
46
|
-
### @type?
|
|
46
|
+
### @type? {#type}
|
|
47
47
|
|
|
48
|
-
> `optional` **@type
|
|
48
|
+
> `optional` **@type?**: `string` \| `string`[]
|
|
49
49
|
|
|
50
50
|
***
|
|
51
51
|
|
|
52
|
-
### @reverse?
|
|
52
|
+
### @reverse? {#reverse}
|
|
53
53
|
|
|
54
|
-
> `optional` **@reverse
|
|
54
|
+
> `optional` **@reverse?**: `object`
|
|
55
55
|
|
|
56
56
|
#### Index Signature
|
|
57
57
|
|
|
@@ -59,6 +59,6 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
62
|
-
### @index?
|
|
62
|
+
### @index? {#index}
|
|
63
63
|
|
|
64
|
-
> `optional` **@index
|
|
64
|
+
> `optional` **@index?**: `string`
|
|
@@ -8,12 +8,12 @@ https://www.w3.org/TR/json-ld11/#lists-and-sets
|
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
11
|
-
### @set
|
|
11
|
+
### @set {#set}
|
|
12
12
|
|
|
13
13
|
> **@set**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### @index?
|
|
17
|
+
### @index? {#index}
|
|
18
18
|
|
|
19
|
-
> `optional` **@index
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
@@ -10,31 +10,31 @@ associated with the term when it is used as key in a node object.
|
|
|
10
10
|
|
|
11
11
|
### @type?
|
|
12
12
|
|
|
13
|
-
> `optional` **@type
|
|
13
|
+
> `optional` **@type?**: `"@id"` \| `"@json"` \| `"@none"` \| `"@vocab"` \| `string`
|
|
14
14
|
|
|
15
15
|
### @language?
|
|
16
16
|
|
|
17
|
-
> `optional` **@language
|
|
17
|
+
> `optional` **@language?**: `string`
|
|
18
18
|
|
|
19
19
|
### @index?
|
|
20
20
|
|
|
21
|
-
> `optional` **@index
|
|
21
|
+
> `optional` **@index?**: `string`
|
|
22
22
|
|
|
23
23
|
### @context?
|
|
24
24
|
|
|
25
|
-
> `optional` **@context
|
|
25
|
+
> `optional` **@context?**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
|
|
26
26
|
|
|
27
27
|
### @prefix?
|
|
28
28
|
|
|
29
|
-
> `optional` **@prefix
|
|
29
|
+
> `optional` **@prefix?**: `boolean`
|
|
30
30
|
|
|
31
31
|
### @propagate?
|
|
32
32
|
|
|
33
|
-
> `optional` **@propagate
|
|
33
|
+
> `optional` **@propagate?**: `boolean`
|
|
34
34
|
|
|
35
35
|
### @protected?
|
|
36
36
|
|
|
37
|
-
> `optional` **@protected
|
|
37
|
+
> `optional` **@protected?**: `boolean`
|
|
38
38
|
|
|
39
39
|
## See
|
|
40
40
|
|
|
@@ -9,11 +9,11 @@ to create a typed value or a language-tagged string and possibly associate a bas
|
|
|
9
9
|
|
|
10
10
|
### @index?
|
|
11
11
|
|
|
12
|
-
> `optional` **@index
|
|
12
|
+
> `optional` **@index?**: `string`
|
|
13
13
|
|
|
14
14
|
### @context?
|
|
15
15
|
|
|
16
|
-
> `optional` **@context
|
|
16
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)
|
|
17
17
|
|
|
18
18
|
## See
|
|
19
19
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Type Alias: JsonLdAliasKey\<K, Prefix\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdAliasKey**\<`K`, `Prefix`\> = `K` *extends* `` `@${string}` `` ? `K` : `` `${Prefix}:${K}` ``
|
|
4
|
+
|
|
5
|
+
Keep JSON-LD keys as-is and prefix non-JSON-LD keys.
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### K
|
|
10
|
+
|
|
11
|
+
`K` *extends* `string`
|
|
12
|
+
|
|
13
|
+
### Prefix
|
|
14
|
+
|
|
15
|
+
`Prefix` *extends* `string`
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Type Alias: JsonLdExistingProperty\<T, P, D\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdExistingProperty**\<`T`, `P`, `D`\> = `T` *extends* `{ [K in P]?: infer PropertyType }` ? `Exclude`\<`PropertyType`, `undefined`\> : `D`
|
|
4
|
+
|
|
5
|
+
Infer an existing property's type from a source type, or fall back to a default.
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### T
|
|
10
|
+
|
|
11
|
+
`T` *extends* `object`
|
|
12
|
+
|
|
13
|
+
### P
|
|
14
|
+
|
|
15
|
+
`P` *extends* `PropertyKey`
|
|
16
|
+
|
|
17
|
+
### D
|
|
18
|
+
|
|
19
|
+
`D`
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Type Alias: JsonLdExistingPropertyEither\<T, P1, P2, D\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdExistingPropertyEither**\<`T`, `P1`, `P2`, `D`\> = \[[`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P1`, `never`\> \| [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P2`, `never`\>\] *extends* \[`never`\] ? `D` : [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P1`, `never`\> \| [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P2`, `never`\>
|
|
4
|
+
|
|
5
|
+
Infer an existing property's type from either of two source properties,
|
|
6
|
+
or fall back to a default when neither exists.
|
|
7
|
+
|
|
8
|
+
## Type Parameters
|
|
9
|
+
|
|
10
|
+
### T
|
|
11
|
+
|
|
12
|
+
`T` *extends* `object`
|
|
13
|
+
|
|
14
|
+
### P1
|
|
15
|
+
|
|
16
|
+
`P1` *extends* `PropertyKey`
|
|
17
|
+
|
|
18
|
+
### P2
|
|
19
|
+
|
|
20
|
+
`P2` *extends* `PropertyKey`
|
|
21
|
+
|
|
22
|
+
### D
|
|
23
|
+
|
|
24
|
+
`D`
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithAliases\<T, Prefix\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithAliases**\<`T`, `Prefix`\> = [`JsonLdKeys`](JsonLdKeys.md)\<`T`\> & [`JsonLdWithAliases`](JsonLdWithAliases.md)\<`T`, `Prefix`\>
|
|
4
|
+
|
|
5
|
+
Create a JSON-LD object shape containing only JSON-LD keys plus aliased
|
|
6
|
+
non-JSON-LD keys.
|
|
7
|
+
|
|
8
|
+
## Type Parameters
|
|
9
|
+
|
|
10
|
+
### T
|
|
11
|
+
|
|
12
|
+
`T` *extends* `object`
|
|
13
|
+
|
|
14
|
+
### Prefix
|
|
15
|
+
|
|
16
|
+
`Prefix` *extends* `string`
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithAtId\<T, Id\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithAtId**\<`T`, `Id`\> = `Omit`\<`T`, `"@id"` \| `"id"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "@id" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @id
|
|
10
|
+
|
|
11
|
+
> **@id**: `Id`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Id
|
|
20
|
+
|
|
21
|
+
`Id` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"@id"`, `"id"`, `string`\>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithAtType\<T, Ty\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithAtType**\<`T`, `Ty`\> = `Omit`\<`T`, `"@type"` \| `"type"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "@type" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @type
|
|
10
|
+
|
|
11
|
+
> **@type**: `Ty`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Ty
|
|
20
|
+
|
|
21
|
+
`Ty` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"@type"`, `"type"`, `string` \| `string`[]\>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithContext\<T, C\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithContext**\<`T`, `C`\> = `Omit`\<`T`, `"@context"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "@context" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @context
|
|
10
|
+
|
|
11
|
+
> **@context**: `C`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### C
|
|
20
|
+
|
|
21
|
+
`C` = [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithId\<T, Id\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithId**\<`T`, `Id`\> = `Omit`\<`T`, `"id"` \| `"@id"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "id" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### id
|
|
10
|
+
|
|
11
|
+
> **id**: `Id`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Id
|
|
20
|
+
|
|
21
|
+
`Id` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"id"`, `"@id"`, `string`\>
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithNoContext\<T\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithNoContext**\<`T`\> = `Omit`\<`T`, `"@context"`\>
|
|
4
|
+
|
|
5
|
+
Omit optional "@context" from a type, inferring an existing context type from
|
|
6
|
+
the source type when available, otherwise using the provided default.
|
|
7
|
+
|
|
8
|
+
## Type Parameters
|
|
9
|
+
|
|
10
|
+
### T
|
|
11
|
+
|
|
12
|
+
`T` *extends* `object`
|