@twin.org/data-json-ld 0.0.3-next.1 → 0.0.3-next.11

package/docs/reference/classes/JsonLdHelper.md

@@ -64,19 +64,69 @@ True if the document was valid.
 
 ***
 
+### toNodeObject()
+
+> `static` **toNodeObject**\<`T`\>(`object`): `T` & [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+Expand an object to a JSON-LD node object.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### object
+
+`T`
+
+The object to expand.
+
+#### Returns
+
+`T` & [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+The expanded JSON-LD node object.
+
+***
+
+### expand()
+
+> `static` **expand**(`document`): `Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
+
+Expand the JSON-LD document.
+
+#### Parameters
+
+##### document
+
+[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The JSON-LD document to expand.
+
+#### Returns
+
+`Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
+
+The expanded JSON-LD document.
+
+***
+
 ### isType()
 
-> `static` **isType**(`document`, `type`): `Promise`\<`boolean`\>
+> `static` **isType**(`documentOrExpanded`, `type`): `Promise`\<`boolean`\>
 
 Expand the JSON-LD document and check if it is of a specific type.
 
 #### Parameters
 
-##### document
+##### documentOrExpanded
 
 [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
 
-The JSON-LD document to check.
+The JSON-LD document to check or already expanded document.
 
 ##### type
 
@@ -89,3 +139,205 @@ The type to check for.
 `Promise`\<`boolean`\>
 
 True if the document is of the specified type.
+
+***
+
+### getType()
+
+> `static` **getType**(`documentOrExpanded`): `Promise`\<`string`[]\>
+
+Get the types from the document.
+
+#### Parameters
+
+##### documentOrExpanded
+
+[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The JSON-LD document to check or already expanded document.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The type(s) extracted from the document.
+
+***
+
+### getId()
+
+> `static` **getId**(`documentOrExpanded`, `additionalIdProperties?`): `Promise`\<`string` \| `undefined`\>
+
+Get the id from the document.
+
+#### Parameters
+
+##### documentOrExpanded
+
+[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The JSON-LD document to get the id from or already expanded document.
+
+##### additionalIdProperties?
+
+`string`[]
+
+Optional additional properties to check for the id, in addition to "@id" and "id".
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+The id extracted from the document.
+
+***
+
+### getPropertyValue()
+
+> `static` **getPropertyValue**(`documentOrExpanded`, `propertyFullName`, `language?`): `Promise`\<[`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `undefined`\>
+
+Get property values by a single full expanded property name.
+
+#### Parameters
+
+##### documentOrExpanded
+
+[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The JSON-LD document to get the property from or already expanded document.
+
+##### propertyFullName
+
+`string`
+
+The full expanded property name.
+
+##### language?
+
+`string`
+
+Optional filter values by their language property.
+
+#### Returns
+
+`Promise`\<[`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `undefined`\>
+
+Matching property values for the input property.
+
+***
+
+### getPropertyValues()
+
+> `static` **getPropertyValues**(`documentOrExpanded`, `propertyFullNames`, `language?`): `Promise`\<([`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `undefined`)[]\>
+
+Get property values by their full expanded property names.
+
+#### Parameters
+
+##### documentOrExpanded
+
+[`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+The JSON-LD document to get the property from or already expanded document.
+
+##### propertyFullNames
+
+`string`[]
+
+The full expanded property names.
+
+##### language?
+
+`string`
+
+Optional filter values by their language property.
+
+#### Returns
+
+`Promise`\<([`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `undefined`)[]\>
+
+Matching property values for each input property, in the same index order.
+
+***
+
+### prefixProperties()
+
+> `static` **prefixProperties**\<`T`\>(`nodeObject`, `prefix`, `properties?`): [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+Prefix all properties in the document with the provided prefix, except for JSON-LD properties.
+This is useful for ensuring that all properties are fully qualified with a namespace.
+For example, if the prefix is "ex" and the document has a property "name", it will be transformed to "ex:name".
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+#### Parameters
+
+##### nodeObject
+
+`T`
+
+The JSON-LD node object to prefix properties on.
+
+##### prefix
+
+`string`
+
+The prefix to add to the properties.
+
+##### properties?
+
+`string`[]
+
+Optional list of properties to prefix. If not provided, all properties except for JSON-LD properties.
+
+#### Returns
+
+[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+A new JSON-LD node object with the properties prefixed.
+
+***
+
+### stripPrefixProperties()
+
+> `static` **stripPrefixProperties**\<`T`\>(`nodeObject`, `prefix`, `properties?`): [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+Strip a prefix from properties in the document, except for JSON-LD properties.
+This is useful for converting fully qualified namespaced properties back to local names.
+For example, if the prefix is "ex" and the document has a property "ex:name", it will be transformed to "name".
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+#### Parameters
+
+##### nodeObject
+
+`T`
+
+The JSON-LD node object to strip prefixed properties from.
+
+##### prefix
+
+`string`
+
+The prefix to remove from the properties.
+
+##### properties?
+
+`string`[]
+
+Optional list of unprefixed properties to strip. If not provided, all matching prefixed properties.
+
+#### Returns
+
+[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+A new JSON-LD node object with the prefix stripped from matching properties.

package/docs/reference/index.md

@@ -22,6 +22,19 @@
 
 ## Type Aliases
 
+- [JsonLdOptionalKeys](type-aliases/JsonLdOptionalKeys.md)
+- [JsonLdRequiredKeys](type-aliases/JsonLdRequiredKeys.md)
+- [JsonLdAliasKey](type-aliases/JsonLdAliasKey.md)
+- [JsonLdWithAliases](type-aliases/JsonLdWithAliases.md)
+- [JsonLdKeys](type-aliases/JsonLdKeys.md)
+- [JsonLdObjectWithAliases](type-aliases/JsonLdObjectWithAliases.md)
+- [JsonLdObjectWithContext](type-aliases/JsonLdObjectWithContext.md)
+- [JsonLdExistingProperty](type-aliases/JsonLdExistingProperty.md)
+- [JsonLdObjectWithOptionalContext](type-aliases/JsonLdObjectWithOptionalContext.md)
+- [JsonLdObjectWithType](type-aliases/JsonLdObjectWithType.md)
+- [JsonLdObjectWithOptionalType](type-aliases/JsonLdObjectWithOptionalType.md)
+- [JsonLdObjectWithId](type-aliases/JsonLdObjectWithId.md)
+- [JsonLdObjectWithOptionalId](type-aliases/JsonLdObjectWithOptionalId.md)
 - [IJsonLdContainerType](type-aliases/IJsonLdContainerType.md)
 - [IJsonLdContainerTypeArray](type-aliases/IJsonLdContainerTypeArray.md)
 - [IJsonLdContextDefinitionElement](type-aliases/IJsonLdContextDefinitionElement.md)

package/docs/reference/type-aliases/JsonLdAliasKey.md

@@ -0,0 +1,15 @@
+# Type Alias: JsonLdAliasKey\<K, Prefix\>
+
+> **JsonLdAliasKey**\<`K`, `Prefix`\> = `K` *extends* `` `@${string}` `` ? `K` : `` `${Prefix}:${K}` ``
+
+Keep JSON-LD keys as-is and prefix non-JSON-LD keys.
+
+## Type Parameters
+
+### K
+
+`K` *extends* `string`
+
+### Prefix
+
+`Prefix` *extends* `string`

package/docs/reference/type-aliases/JsonLdExistingProperty.md

@@ -0,0 +1,19 @@
+# Type Alias: JsonLdExistingProperty\<T, P, D\>
+
+> **JsonLdExistingProperty**\<`T`, `P`, `D`\> = `T` *extends* `{ [K in P]?: infer PropertyType }` ? `Exclude`\<`PropertyType`, `undefined`\> : `D`
+
+Infer an existing property's type from a source type, or fall back to a default.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### P
+
+`P` *extends* `PropertyKey`
+
+### D
+
+`D`

package/docs/reference/type-aliases/JsonLdKeys.md

@@ -0,0 +1,11 @@
+# Type Alias: JsonLdKeys\<T\>
+
+> **JsonLdKeys**\<`T`\> = `Pick`\<`T`, `Extract`\<keyof `T`, `` `@${string}` ``\>\>
+
+Keep only JSON-LD keys ("@...") from a type.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`

package/docs/reference/type-aliases/JsonLdObjectWithAliases.md

@@ -0,0 +1,16 @@
+# Type Alias: JsonLdObjectWithAliases\<T, Prefix\>
+
+> **JsonLdObjectWithAliases**\<`T`, `Prefix`\> = [`JsonLdKeys`](JsonLdKeys.md)\<`T`\> & [`JsonLdWithAliases`](JsonLdWithAliases.md)\<`T`, `Prefix`\>
+
+Create a JSON-LD object shape containing only JSON-LD keys plus aliased
+non-JSON-LD keys.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Prefix
+
+`Prefix` *extends* `string`

package/docs/reference/type-aliases/JsonLdObjectWithContext.md

@@ -0,0 +1,21 @@
+# Type Alias: JsonLdObjectWithContext\<T, C\>
+
+> **JsonLdObjectWithContext**\<`T`, `C`\> = `Omit`\<`T`, `"@context"`\> & `object`
+
+Add "@context" to a type.
+
+## Type Declaration
+
+### @context
+
+> **@context**: `C`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### C
+
+`C` = [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)

package/docs/reference/type-aliases/JsonLdObjectWithId.md

@@ -0,0 +1,21 @@
+# Type Alias: JsonLdObjectWithId\<T, Id\>
+
+> **JsonLdObjectWithId**\<`T`, `Id`\> = `Omit`\<`T`, `"@id"`\> & `object`
+
+Add "@id" to a type.
+
+## Type Declaration
+
+### @id
+
+> **@id**: `Id`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Id
+
+`Id` = [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `"@id"`, `string`\>

package/docs/reference/type-aliases/JsonLdObjectWithOptionalContext.md

@@ -0,0 +1,22 @@
+# Type Alias: JsonLdObjectWithOptionalContext\<T, C\>
+
+> **JsonLdObjectWithOptionalContext**\<`T`, `C`\> = `Omit`\<`T`, `"@context"`\> & `object`
+
+Add optional "@context" to a type, inferring an existing context type from
+the source type when available, otherwise using the provided default.
+
+## Type Declaration
+
+### @context?
+
+> `optional` **@context**: `C`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### C
+
+`C` = [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `"@context"`, [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)\>

package/docs/reference/type-aliases/JsonLdObjectWithOptionalId.md

@@ -0,0 +1,21 @@
+# Type Alias: JsonLdObjectWithOptionalId\<T, Id\>
+
+> **JsonLdObjectWithOptionalId**\<`T`, `Id`\> = `Omit`\<`T`, `"@id"`\> & `object`
+
+Add optional "@id" to a type.
+
+## Type Declaration
+
+### @id?
+
+> `optional` **@id**: `Id`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Id
+
+`Id` = [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `"@id"`, `string`\>

package/docs/reference/type-aliases/JsonLdObjectWithOptionalType.md

@@ -0,0 +1,21 @@
+# Type Alias: JsonLdObjectWithOptionalType\<T, Ty\>
+
+> **JsonLdObjectWithOptionalType**\<`T`, `Ty`\> = `Omit`\<`T`, `"@type"`\> & `object`
+
+Add optional "@type" to a type.
+
+## Type Declaration
+
+### @type?
+
+> `optional` **@type**: `Ty`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Ty
+
+`Ty` = [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `"@type"`, `string` \| `string`[]\>

package/docs/reference/type-aliases/JsonLdObjectWithType.md

@@ -0,0 +1,21 @@
+# Type Alias: JsonLdObjectWithType\<T, Ty\>
+
+> **JsonLdObjectWithType**\<`T`, `Ty`\> = `Omit`\<`T`, `"@type"`\> & `object`
+
+Add "@type" to a type.
+
+## Type Declaration
+
+### @type
+
+> **@type**: `Ty`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Ty
+
+`Ty` = [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `"@type"`, `string` \| `string`[]\>

package/docs/reference/type-aliases/JsonLdOptionalKeys.md

@@ -0,0 +1,11 @@
+# Type Alias: JsonLdOptionalKeys\<T\>
+
+> **JsonLdOptionalKeys**\<`T`\> = `{ [K in keyof T]-?: {} extends Pick<T, K> ? K : never }`\[keyof `T`\]
+
+Extract the optional property names from a type.
+
+## Type Parameters
+
+### T
+
+`T`

package/docs/reference/type-aliases/JsonLdRequiredKeys.md

@@ -0,0 +1,11 @@
+# Type Alias: JsonLdRequiredKeys\<T\>
+
+> **JsonLdRequiredKeys**\<`T`\> = `Exclude`\<keyof `T`, [`JsonLdOptionalKeys`](JsonLdOptionalKeys.md)\<`T`\>\>
+
+Extract the required property names from a type.
+
+## Type Parameters
+
+### T
+
+`T`

package/docs/reference/type-aliases/JsonLdWithAliases.md

@@ -0,0 +1,17 @@
+# Type Alias: JsonLdWithAliases\<T, Prefix\>
+
+> **JsonLdWithAliases**\<`T`, `Prefix`\> = `{ [K in Extract<JsonLdRequiredKeys<T>, string> as JsonLdAliasKey<K, Prefix>]: T[K] }` & `{ [K in Extract<JsonLdOptionalKeys<T>, string> as JsonLdAliasKey<K, Prefix>]?: T[K] }`
+
+Remap an object type so JSON-LD keys ("@...") are preserved and
+non-JSON-LD keys are exposed as `Prefix:key` aliases, while preserving
+each key's original required/optional status.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Prefix
+
+`Prefix` *extends* `string`

package/docs/reference/variables/JsonLdContexts.md

@@ -6,8 +6,20 @@ The contexts of JSON-LD data.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace
 
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
+> `readonly` **Namespace**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
 
-Context Root.
+The canonical RDF namespace URI for JSON-LD.
+
+### Context
+
+> `readonly` **Context**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
+
+The value to use in JSON-LD context for JSON-LD.
+
+### JsonLdContext
+
+> `readonly` **JsonLdContext**: `"https://schema.twindev.org/json-ld/types.jsonld"` = `"https://schema.twindev.org/json-ld/types.jsonld"`
+
+The JSON-LD Context URL for JSON-LD.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-json-ld",
-	"version": "0.0.3-next.1",
+	"version": "0.0.3-next.11",
 	"description": "Models which define the structure of JSON LD",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-core": "0.0.3-next.1",
+		"@twin.org/data-core": "0.0.3-next.11",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",