@3sixty/data-json-ld 0.0.0-stage → 0.20.0-next.1

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"` \| `"@id"`\> & `object`
+
+Add optional "id" to a type.
+
+## Type Declaration
+
+### id?
+
+> `optional` **id?**: `Id`
+
+## Type Parameters
+
+### T
+
+`T` *extends* `object`
+
+### Id
+
+`Id` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"id"`, `"@id"`, `string`\>

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

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

@@ -0,0 +1,5 @@
+# Type Alias: JsonLdTypes
+
+> **JsonLdTypes** = *typeof* [`JsonLdTypes`](../variables/JsonLdTypes.md)\[keyof *typeof* [`JsonLdTypes`](../variables/JsonLdTypes.md)\]
+
+The types of JSON-LD data.

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/CompiledJsonLdContainerType.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdContainerType
+
+> `const` **CompiledJsonLdContainerType**: `ICompiledValidator` = `validate59`
+
+Compiled validator for the JsonLdContainerType schema.

package/docs/reference/variables/CompiledJsonLdContainerTypeArray.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdContainerTypeArray
+
+> `const` **CompiledJsonLdContainerTypeArray**: `ICompiledValidator` = `validate62`
+
+Compiled validator for the JsonLdContainerTypeArray schema.

package/docs/reference/variables/CompiledJsonLdContextDefinition.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdContextDefinition
+
+> `const` **CompiledJsonLdContextDefinition**: `ICompiledValidator` = `validate57`
+
+Compiled validator for the JsonLdContextDefinition schema.

package/docs/reference/variables/CompiledJsonLdContextDefinitionElement.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdContextDefinitionElement
+
+> `const` **CompiledJsonLdContextDefinitionElement**: `ICompiledValidator` = `validate56`
+
+Compiled validator for the JsonLdContextDefinitionElement schema.

package/docs/reference/variables/CompiledJsonLdContextDefinitionRoot.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdContextDefinitionRoot
+
+> `const` **CompiledJsonLdContextDefinitionRoot**: `ICompiledValidator` = `validate55`
+
+Compiled validator for the JsonLdContextDefinitionRoot schema.

package/docs/reference/variables/CompiledJsonLdDocument.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdDocument
+
+> `const` **CompiledJsonLdDocument**: `ICompiledValidator` = `validate52`
+
+Compiled validator for the JsonLdDocument schema.

package/docs/reference/variables/CompiledJsonLdExpandedTermDefinition.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdExpandedTermDefinition
+
+> `const` **CompiledJsonLdExpandedTermDefinition**: `ICompiledValidator` = `validate58`
+
+Compiled validator for the JsonLdExpandedTermDefinition schema.

package/docs/reference/variables/CompiledJsonLdGraphObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdGraphObject
+
+> `const` **CompiledJsonLdGraphObject**: `ICompiledValidator` = `validate84`
+
+Compiled validator for the JsonLdGraphObject schema.

package/docs/reference/variables/CompiledJsonLdIdMap.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdIdMap
+
+> `const` **CompiledJsonLdIdMap**: `ICompiledValidator` = `validate115`
+
+Compiled validator for the JsonLdIdMap schema.

package/docs/reference/variables/CompiledJsonLdIncludedBlock.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdIncludedBlock
+
+> `const` **CompiledJsonLdIncludedBlock**: `ICompiledValidator` = `validate71`
+
+Compiled validator for the JsonLdIncludedBlock schema.

package/docs/reference/variables/CompiledJsonLdIndexMap.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdIndexMap
+
+> `const` **CompiledJsonLdIndexMap**: `ICompiledValidator` = `validate106`
+
+Compiled validator for the JsonLdIndexMap schema.

package/docs/reference/variables/CompiledJsonLdIndexMapItem.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdIndexMapItem
+
+> `const` **CompiledJsonLdIndexMapItem**: `ICompiledValidator` = `validate107`
+
+Compiled validator for the JsonLdIndexMapItem schema.

package/docs/reference/variables/CompiledJsonLdJsonArray.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdJsonArray
+
+> `const` **CompiledJsonLdJsonArray**: `ICompiledValidator` = `validate77`
+
+Compiled validator for the JsonLdJsonArray schema.

package/docs/reference/variables/CompiledJsonLdJsonObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdJsonObject
+
+> `const` **CompiledJsonLdJsonObject**: `ICompiledValidator` = `validate73`
+
+Compiled validator for the JsonLdJsonObject schema.

package/docs/reference/variables/CompiledJsonLdJsonPrimitive.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdJsonPrimitive
+
+> `const` **CompiledJsonLdJsonPrimitive**: `ICompiledValidator` = `validate75`
+
+Compiled validator for the JsonLdJsonPrimitive schema.

package/docs/reference/variables/CompiledJsonLdJsonValue.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdJsonValue
+
+> `const` **CompiledJsonLdJsonValue**: `ICompiledValidator` = `validate74`
+
+Compiled validator for the JsonLdJsonValue schema.

package/docs/reference/variables/CompiledJsonLdLanguageMap.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdLanguageMap
+
+> `const` **CompiledJsonLdLanguageMap**: `ICompiledValidator` = `validate104`
+
+Compiled validator for the JsonLdLanguageMap schema.

package/docs/reference/variables/CompiledJsonLdListObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdListObject
+
+> `const` **CompiledJsonLdListObject**: `ICompiledValidator` = `validate92`
+
+Compiled validator for the JsonLdListObject schema.

package/docs/reference/variables/CompiledJsonLdListOrSetItem.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdListOrSetItem
+
+> `const` **CompiledJsonLdListOrSetItem**: `ICompiledValidator` = `validate93`
+
+Compiled validator for the JsonLdListOrSetItem schema.

package/docs/reference/variables/CompiledJsonLdNodeObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdNodeObject
+
+> `const` **CompiledJsonLdNodeObject**: `ICompiledValidator` = `validate53`
+
+Compiled validator for the JsonLdNodeObject schema.

package/docs/reference/variables/CompiledJsonLdNodePrimitive.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdNodePrimitive
+
+> `const` **CompiledJsonLdNodePrimitive**: `ICompiledValidator` = `validate83`
+
+Compiled validator for the JsonLdNodePrimitive schema.

package/docs/reference/variables/CompiledJsonLdObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdObject
+
+> `const` **CompiledJsonLdObject**: `ICompiledValidator` = `validate54`
+
+Compiled validator for the JsonLdObject schema.

package/docs/reference/variables/CompiledJsonLdSetObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdSetObject
+
+> `const` **CompiledJsonLdSetObject**: `ICompiledValidator` = `validate98`
+
+Compiled validator for the JsonLdSetObject schema.

package/docs/reference/variables/CompiledJsonLdTypeMap.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdTypeMap
+
+> `const` **CompiledJsonLdTypeMap**: `ICompiledValidator` = `validate117`
+
+Compiled validator for the JsonLdTypeMap schema.

package/docs/reference/variables/CompiledJsonLdValueObject.md

@@ -0,0 +1,5 @@
+# Variable: CompiledJsonLdValueObject
+
+> `const` **CompiledJsonLdValueObject**: `ICompiledValidator` = `validate87`
+
+Compiled validator for the JsonLdValueObject schema.

package/docs/reference/variables/JsonLdContexts.md

@@ -0,0 +1,25 @@
+# Variable: JsonLdContexts
+
+> `const` **JsonLdContexts**: `object`
+
+The contexts of JSON-LD data.
+
+## Type Declaration
+
+### Namespace {#namespace}
+
+> `readonly` **Namespace**: `"https://schema.3sixty.global/json-ld/"` = `"https://schema.3sixty.global/json-ld/"`
+
+The canonical RDF namespace URI for JSON-LD.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://schema.3sixty.global/json-ld/"` = `"https://schema.3sixty.global/json-ld/"`
+
+The value to use in JSON-LD context for JSON-LD.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://schema.3sixty.global/json-ld/types.jsonld"` = `"https://schema.3sixty.global/json-ld/types.jsonld"`
+
+The JSON-LD Context URL for JSON-LD.

package/docs/reference/variables/JsonLdTypes.md

@@ -0,0 +1,163 @@
+# Variable: JsonLdTypes
+
+> `const` **JsonLdTypes**: `object`
+
+The types of JSON-LD data.
+
+## Type Declaration
+
+### Document {#document}
+
+> `readonly` **Document**: `"JsonLdDocument"` = `"JsonLdDocument"`
+
+Represents JSON-LD Document.
+
+### Object {#object}
+
+> `readonly` **Object**: `"JsonLdObject"` = `"JsonLdObject"`
+
+Represents JSON-LD Object.
+
+### NodeObject {#nodeobject}
+
+> `readonly` **NodeObject**: `"JsonLdNodeObject"` = `"JsonLdNodeObject"`
+
+Represents JSON-LD Node Object.
+
+### NodePrimitive {#nodeprimitive}
+
+> `readonly` **NodePrimitive**: `"JsonLdNodePrimitive"` = `"JsonLdNodePrimitive"`
+
+Represents JSON-LD Node Primitive.
+
+### GraphObject {#graphobject}
+
+> `readonly` **GraphObject**: `"JsonLdGraphObject"` = `"JsonLdGraphObject"`
+
+Represents JSON-LD Graph Object.
+
+### ValueObject {#valueobject}
+
+> `readonly` **ValueObject**: `"JsonLdValueObject"` = `"JsonLdValueObject"`
+
+Represents JSON-LD Value Object.
+
+### ListObject {#listobject}
+
+> `readonly` **ListObject**: `"JsonLdListObject"` = `"JsonLdListObject"`
+
+Represents JSON-LD List Object.
+
+### SetObject {#setobject}
+
+> `readonly` **SetObject**: `"JsonLdSetObject"` = `"JsonLdSetObject"`
+
+Represents JSON-LD Set Object.
+
+### LanguageMap {#languagemap}
+
+> `readonly` **LanguageMap**: `"JsonLdLanguageMap"` = `"JsonLdLanguageMap"`
+
+Represents JSON-LD Language Map.
+
+### IndexMap {#indexmap}
+
+> `readonly` **IndexMap**: `"JsonLdIndexMap"` = `"JsonLdIndexMap"`
+
+Represents JSON-LD Index Map.
+
+### IndexMapItem {#indexmapitem}
+
+> `readonly` **IndexMapItem**: `"JsonLdIndexMapItem"` = `"JsonLdIndexMapItem"`
+
+Represents JSON-LD Index Map Item.
+
+### IdMap {#idmap}
+
+> `readonly` **IdMap**: `"JsonLdIdMap"` = `"JsonLdIdMap"`
+
+Represents JSON-LD Id Map.
+
+### TypeMap {#typemap}
+
+> `readonly` **TypeMap**: `"JsonLdTypeMap"` = `"JsonLdTypeMap"`
+
+Represents JSON-LD Type Map.
+
+### IncludedBlock {#includedblock}
+
+> `readonly` **IncludedBlock**: `"JsonLdIncludedBlock"` = `"JsonLdIncludedBlock"`
+
+Represents JSON-LD Included block.
+
+### ContextDefinition {#contextdefinition}
+
+> `readonly` **ContextDefinition**: `"JsonLdContextDefinition"` = `"JsonLdContextDefinition"`
+
+Represents JSON-LD Context Definition.
+
+### ContextDefinitionElement {#contextdefinitionelement}
+
+> `readonly` **ContextDefinitionElement**: `"JsonLdContextDefinitionElement"` = `"JsonLdContextDefinitionElement"`
+
+Represents JSON-LD Context Definition Element.
+
+### ContextDefinitionRoot {#contextdefinitionroot}
+
+> `readonly` **ContextDefinitionRoot**: `"JsonLdContextDefinitionRoot"` = `"JsonLdContextDefinitionRoot"`
+
+Represents JSON-LD Context Definition Root.
+
+### ExpandedTermDefinition {#expandedtermdefinition}
+
+> `readonly` **ExpandedTermDefinition**: `"JsonLdExpandedTermDefinition"` = `"JsonLdExpandedTermDefinition"`
+
+Represents JSON-LD Expanded Term Definition.
+
+### Keyword {#keyword}
+
+> `readonly` **Keyword**: `"JsonLdKeyword"` = `"JsonLdKeyword"`
+
+Represents JSON-LD Keyword.
+
+### ListOrSetItem {#listorsetitem}
+
+> `readonly` **ListOrSetItem**: `"JsonLdListOrSetItem"` = `"JsonLdListOrSetItem"`
+
+Represents JSON-LD List or Set Item.
+
+### ContainerType {#containertype}
+
+> `readonly` **ContainerType**: `"JsonLdContainerType"` = `"JsonLdContainerType"`
+
+Represents JSON-LD Container Type.
+
+### ContainerTypeArray {#containertypearray}
+
+> `readonly` **ContainerTypeArray**: `"JsonLdContainerTypeArray"` = `"JsonLdContainerTypeArray"`
+
+Represents JSON-LD Container Type Array.
+
+### JsonPrimitive {#jsonprimitive}
+
+> `readonly` **JsonPrimitive**: `"JsonLdJsonPrimitive"` = `"JsonLdJsonPrimitive"`
+
+Represents JSON-LD JSON Primitive.
+
+### JsonArray {#jsonarray}
+
+> `readonly` **JsonArray**: `"JsonLdJsonArray"` = `"JsonLdJsonArray"`
+
+Represents JSON-LD JSON Array.
+
+### JsonObject {#jsonobject}
+
+> `readonly` **JsonObject**: `"JsonLdJsonObject"` = `"JsonLdJsonObject"`
+
+Represents JSON-LD JSON Object.
+
+### JsonValue {#jsonvalue}
+
+> `readonly` **JsonValue**: `"JsonLdJsonValue"` = `"JsonLdJsonValue"`
+
+Represents JSON-LD JSON Value.

package/locales/.validate-ignore

@@ -0,0 +1 @@
+^jsonld.InvalidUrl$

package/locales/en.json

@@ -0,0 +1,11 @@
+{
+	"error": {
+		"jsonLdProcessor": {
+			"compact": "The JSON-LD compaction failed",
+			"expand": "The JSON-LD expansion failed",
+			"canonize": "The JSON-LD canonization failed",
+			"invalidUrl": "The JSON-LD processing failed to retrieve from the following url \"{url}\"",
+			"jsonLdError": "The JSON-LD processing failed due to the following error: \"{code}\""
+		}
+	}
+}

package/package.json

@@ -1,6 +1,53 @@
 {
-  "name": "@3sixty/data-json-ld",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/data-json-ld",
+	"version": "0.20.0-next.1",
+	"description": "JSON-LD data models and helpers for working with linked data documents.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/data.git",
+		"directory": "packages/data-json-ld"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "next",
+		"@3sixty/data-core": "0.20.0-next.1",
+		"@3sixty/entity": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/web": "next",
+		"@types/jsonld": "1.5.15",
+		"jsonld": "9.0.0"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"data"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/data/issues"
+	},
+	"homepage": "https://3sixty.global"
+}