@twin.org/data-json-ld 0.0.1-next.10

package/dist/types/dataTypes/jsonLdDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for JSON-LD.
+ */
+export declare class JsonLdDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./dataTypes/jsonLdDataTypes";
+export * from "./models/IJsonLdDocument";
+export * from "./models/jsonLdTypes";
+export * from "./utils/jsonLdHelper";
+export * from "./utils/jsonLdProcessor";

package/dist/types/models/IJsonLdDocument.d.ts

@@ -0,0 +1,222 @@
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * Types from the jsonld Specification:
+ * https://www.w3.org/TR/json-ld11/
+ */
+/**
+ * A JSON-LD document MUST be valid JSON text as described in [RFC8259],
+ * or some format that can be represented in the JSON-LD internal representation
+ * that is equivalent to valid JSON text.
+ * @see https://www.w3.org/TR/json-ld11/#json-ld-grammar
+ */
+export type IJsonLdDocument = IJsonLdNodeObject | IJsonLdNodeObject[] | {
+    "@context"?: IJsonLdKeyword["@context"] | undefined;
+    "@graph"?: IJsonLdKeyword["@graph"] | undefined;
+};
+/**
+ * A node object represents zero or more properties of a node
+ * in the graph serialized by the JSON-LD document.
+ * @see https://www.w3.org/TR/json-ld11/#node-objects
+ */
+export interface IJsonLdNodeObject extends IJsonLdObject {
+    [key: string]: IJsonLdNodePrimitive | IJsonLdNodePrimitive[] | IJsonLdLanguageMap | IJsonLdIndexMap | IJsonLdIncludedBlock | IJsonLdIdMap | IJsonLdTypeMap | IJsonLdNodeObject[keyof IJsonLdNodeObject];
+}
+/**
+ * An object represents the pre-defined properties of the node object
+ * in the graph serialized by the JSON-LD document.
+ * @see https://www.w3.org/TR/json-ld11/#node-objects
+ */
+export interface IJsonLdObject {
+    "@context"?: IJsonLdKeyword["@context"] | undefined;
+    "@id"?: IJsonLdKeyword["@id"] | undefined;
+    "@included"?: IJsonLdKeyword["@included"] | undefined;
+    "@graph"?: IJsonLdNodeObject | IJsonLdNodeObject[] | undefined;
+    "@nest"?: IJsonLdJsonObject | IJsonLdJsonObject[] | undefined;
+    "@type"?: IJsonLdKeyword["@type"] | IJsonLdKeyword["@type"][] | undefined;
+    "@reverse"?: {
+        [key: string]: IJsonLdKeyword["@reverse"];
+    } | undefined;
+    "@index"?: IJsonLdKeyword["@index"] | undefined;
+}
+/**
+ * A node primitive is a JSON-LD value which is not one of the defined NodeObject properties.
+ */
+export type IJsonLdNodePrimitive = null | boolean | number | string | IJsonLdNodeObject | IJsonLdGraphObject | IJsonLdValueObject | IJsonLdListObject | IJsonLdSetObject;
+/**
+ * A graph object represents a named graph, which MAY include an explicit graph name.
+ * @see https://www.w3.org/TR/json-ld11/#graph-objects
+ */
+export interface IJsonLdGraphObject {
+    "@graph": IJsonLdNodeObject | IJsonLdNodeObject[];
+    "@index"?: IJsonLdKeyword["@index"] | undefined;
+    "@id"?: IJsonLdKeyword["@id"] | undefined;
+    "@context"?: IJsonLdKeyword["@context"] | undefined;
+}
+/**
+ * A value object is used to explicitly associate a type or a language with a value
+ * to create a typed value or a language-tagged string and possibly associate a base direction.
+ * @see https://www.w3.org/TR/json-ld11/#value-objects
+ */
+export type IJsonLdValueObject = {
+    "@index"?: IJsonLdKeyword["@index"] | undefined;
+    "@context"?: IJsonLdKeyword["@context"] | undefined;
+} & ({
+    "@value": IJsonLdKeyword["@value"];
+    "@language"?: IJsonLdKeyword["@language"] | undefined;
+    "@direction"?: IJsonLdKeyword["@direction"] | undefined;
+} | {
+    "@value": IJsonLdKeyword["@value"];
+    "@type": IJsonLdKeyword["@type"];
+} | {
+    "@value": IJsonLdKeyword["@value"] | IJsonLdJsonObject | IJsonLdJsonArray;
+    "@type": "@json";
+});
+/**
+ * A list represents an ordered set of values.
+ * @see https://www.w3.org/TR/json-ld11/#lists-and-sets
+ */
+export interface IJsonLdListObject {
+    "@list": IJsonLdKeyword["@list"];
+    "@index"?: IJsonLdKeyword["@index"] | undefined;
+}
+/**
+ * A set represents an unordered set of values.
+ * @see https://www.w3.org/TR/json-ld11/#lists-and-sets
+ */
+export interface IJsonLdSetObject {
+    "@set": IJsonLdKeyword["@set"];
+    "@index"?: IJsonLdKeyword["@index"] | undefined;
+}
+/**
+ * A language map is used to associate a language with a value in a way that allows easy programmatic access.
+ * @see https://www.w3.org/TR/json-ld11/#language-maps
+ */
+export interface IJsonLdLanguageMap {
+    [key: string]: null | string | string[];
+}
+/**
+ * An index map allows keys that have no semantic meaning, but should be preserved regardless,
+ * to be used in JSON-LD documents.
+ * @see https://www.w3.org/TR/json-ld11/#index-maps
+ */
+export interface IJsonLdIndexMap {
+    [key: string]: IJsonLdIndexMapItem | IJsonLdIndexMapItem[];
+}
+/**
+ * The items that can be stored in an index map.
+ */
+export type IJsonLdIndexMapItem = null | boolean | number | string | IJsonLdNodeObject | IJsonLdValueObject | IJsonLdListObject | IJsonLdSetObject;
+/**
+ * An id map is used to associate an IRI with a value that allows easy programmatic access.
+ * @see https://www.w3.org/TR/json-ld11/#id-maps
+ */
+export interface IJsonLdIdMap {
+    [key: string]: IJsonLdNodeObject;
+}
+/**
+ * A type map is used to associate an IRI with a value that allows easy programmatic access.
+ * @see https://www.w3.org/TR/json-ld11/#type-maps
+ */
+export interface IJsonLdTypeMap {
+    [key: string]: string | IJsonLdNodeObject;
+}
+/**
+ * An included block is used to provide a set of node objects.
+ * @see https://www.w3.org/TR/json-ld11/#included-blocks
+ */
+export type IJsonLdIncludedBlock = IJsonLdNodeObject | IJsonLdNodeObject[];
+/**
+ * A context definition defines a local context in a node object.
+ * @see https://www.w3.org/TR/json-ld11/#context-definitions
+ */
+export interface IJsonLdContextDefinition {
+    [key: string]: null | string | IJsonLdExpandedTermDefinition | IJsonLdContextDefinition[keyof IJsonLdContextDefinition];
+    "@base"?: IJsonLdKeyword["@base"] | undefined;
+    "@direction"?: IJsonLdKeyword["@direction"] | undefined;
+    "@import"?: IJsonLdKeyword["@import"] | undefined;
+    "@language"?: IJsonLdKeyword["@language"] | undefined;
+    "@propagate"?: IJsonLdKeyword["@propagate"] | undefined;
+    "@protected"?: IJsonLdKeyword["@protected"] | undefined;
+    "@type"?: {
+        "@container": "@set";
+        "@protected"?: IJsonLdKeyword["@protected"] | undefined;
+    } | undefined;
+    "@version"?: IJsonLdKeyword["@version"] | undefined;
+    "@vocab"?: IJsonLdKeyword["@vocab"] | undefined;
+}
+/**
+ * A context definition element is used to define the types of a context definition.
+ */
+export type IJsonLdContextDefinitionElement = null | string | IJsonLdContextDefinition;
+/**
+ * A context definition root is used to define the root of a context definition.
+ */
+export type IJsonLdContextDefinitionRoot = IJsonLdContextDefinitionElement | IJsonLdContextDefinitionElement[];
+/**
+ * An expanded term definition is used to describe the mapping between a term
+ * and its expanded identifier, as well as other properties of the value
+ * associated with the term when it is used as key in a node object.
+ * @see https://www.w3.org/TR/json-ld11/#expanded-term-definition
+ */
+export type IJsonLdExpandedTermDefinition = {
+    "@type"?: "@id" | "@json" | "@none" | "@vocab" | string | undefined;
+    "@language"?: IJsonLdKeyword["@language"] | undefined;
+    "@index"?: IJsonLdKeyword["@index"] | undefined;
+    "@context"?: IJsonLdContextDefinition | undefined;
+    "@prefix"?: IJsonLdKeyword["@prefix"] | undefined;
+    "@propagate"?: IJsonLdKeyword["@propagate"] | undefined;
+    "@protected"?: IJsonLdKeyword["@protected"] | undefined;
+} & ({
+    "@id"?: IJsonLdKeyword["@id"] | null | undefined;
+    "@nest"?: "@nest" | string | undefined;
+    "@container"?: IJsonLdKeyword["@container"] | undefined;
+} | {
+    "@reverse": IJsonLdKeyword["@reverse"];
+    "@container"?: "@set" | "@index" | null | undefined;
+});
+/**
+ * A list of keywords and their types.
+ * Only used for internal reference; not an actual interface.
+ * Not for export.
+ * @see https://www.w3.org/TR/json-ld/#keywords
+ */
+export type IJsonLdKeyword = {
+    "@base": string | null;
+    "@container": ("@list" | "@set" | IJsonLdContainerType) | ("@list" | "@set" | IJsonLdContainerType)[] | IJsonLdContainerTypeArray | null;
+    "@context": IJsonLdContextDefinitionRoot;
+    "@direction": "ltr" | "rtl" | null;
+    "@graph": IJsonLdValueObject | IJsonLdNodeObject | (IJsonLdValueObject | IJsonLdNodeObject)[];
+    "@id": string | string[];
+    "@import": string;
+    "@included": IJsonLdIncludedBlock;
+    "@index": string;
+    "@json": "@json";
+    "@language": string;
+    "@list": IJsonLdListOrSetItem | IJsonLdListOrSetItem[];
+    "@nest": object;
+    "@none": "@none";
+    "@prefix": boolean;
+    "@propagate": boolean;
+    "@protected": boolean;
+    "@reverse": string;
+    "@set": IJsonLdListOrSetItem | IJsonLdListOrSetItem[];
+    "@type": string;
+    "@value": null | boolean | number | string;
+    "@version": "1.1";
+    "@vocab": string | null;
+};
+/**
+ * A list or set item can be a null, boolean, number, string, node object, or value object.
+ */
+export type IJsonLdListOrSetItem = null | boolean | number | string | IJsonLdNodeObject | IJsonLdValueObject;
+export type IJsonLdContainerType = "@language" | "@index" | "@id" | "@graph" | "@type";
+export type 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, "@set"];
+export type IJsonLdJsonPrimitive = string | number | boolean | null;
+export type IJsonLdJsonArray = IJsonLdJsonValue[];
+export interface IJsonLdJsonObject {
+    [key: string]: IJsonLdJsonValue | undefined;
+}
+export type IJsonLdJsonValue = IJsonLdJsonPrimitive | IJsonLdJsonArray | IJsonLdJsonObject;

package/dist/types/models/jsonLdTypes.d.ts

@@ -0,0 +1,109 @@
+/**
+ * The types of JSON-LD data.
+ */
+export declare const JsonLdTypes: {
+    /**
+     * Context Root.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/json-ld/";
+    /**
+     * Represents JSON-LD Document.
+     */
+    readonly Document: "https://schema.twindev.org/json-ld/JsonLdDocument";
+    /**
+     * Represents JSON-LD Object.
+     */
+    readonly Object: "https://schema.twindev.org/json-ld/JsonLdObject";
+    /**
+     * Represents JSON-LD Node Object.
+     */
+    readonly NodeObject: "https://schema.twindev.org/json-ld/JsonLdNodeObject";
+    /**
+     * Represents JSON-LD Node Primitive.
+     */
+    readonly NodePrimitive: "https://schema.twindev.org/json-ld/JsonLdNodePrimitive";
+    /**
+     * Represents JSON-LD Graph Object.
+     */
+    readonly GraphObject: "https://schema.twindev.org/json-ld/JsonLdGraphObject";
+    /**
+     * Represents JSON-LD Value Object.
+     */
+    readonly ValueObject: "https://schema.twindev.org/json-ld/JsonLdValueObject";
+    /**
+     * Represents JSON-LD List Object.
+     */
+    readonly ListObject: "https://schema.twindev.org/json-ld/JsonLdListObject";
+    /**
+     * Represents JSON-LD Set Object.
+     */
+    readonly SetObject: "https://schema.twindev.org/json-ld/JsonLdSetObject";
+    /**
+     * Represents JSON-LD Language Map.
+     */
+    readonly LanguageMap: "https://schema.twindev.org/json-ld/JsonLdLanguageMap";
+    /**
+     * Represents JSON-LD Index Map.
+     */
+    readonly IndexMap: "https://schema.twindev.org/json-ld/JsonLdIndexMap";
+    /**
+     * Represents JSON-LD Index Map Item.
+     */
+    readonly IndexMapItem: "https://schema.twindev.org/json-ld/JsonLdIndexMapItem";
+    /**
+     * Represents JSON-LD Id Map.
+     */
+    readonly IdMap: "https://schema.twindev.org/json-ld/JsonLdIdMap";
+    /**
+     * Represents JSON-LD Type Map.
+     */
+    readonly TypeMap: "https://schema.twindev.org/json-ld/JsonLdTypeMap";
+    /**
+     * Represents JSON-LD Included block.
+     */
+    readonly IncludedBlock: "https://schema.twindev.org/json-ld/JsonLdIncludedBlock";
+    /**
+     * Represents JSON-LD Context Definition.
+     */
+    readonly ContextDefinition: "https://schema.twindev.org/json-ld/JsonLdContextDefinition";
+    /**
+     * Represents JSON-LD Expanded Term Definition.
+     */
+    readonly ExpandedTermDefinition: "https://schema.twindev.org/json-ld/JsonLdExpandedTermDefinition";
+    /**
+     * Represents JSON-LD Keyword.
+     */
+    readonly Keyword: "https://schema.twindev.org/json-ld/JsonLdKeyword";
+    /**
+     * Represents JSON-LD List or Set Item.
+     */
+    readonly ListOrSetItem: "https://schema.twindev.org/json-ld/JsonLdListOrSetItem";
+    /**
+     * Represents JSON-LD Container Type.
+     */
+    readonly ContainerType: "https://schema.twindev.org/json-ld/JsonLdContainerType";
+    /**
+     * Represents JSON-LD Container Type Array.
+     */
+    readonly ContainerTypeArray: "https://schema.twindev.org/json-ld/JsonLdContainerTypeArray";
+    /**
+     * Represents JSON-LD JSON Primitive.
+     */
+    readonly JsonPrimitive: "https://schema.twindev.org/json-ld/JsonLdJsonPrimitive";
+    /**
+     * Represents JSON-LD JSON Array.
+     */
+    readonly JsonArray: "https://schema.twindev.org/json-ld/JsonLdJsonArray";
+    /**
+     * Represents JSON-LD JSON Object.
+     */
+    readonly JsonObject: "https://schema.twindev.org/json-ld/JsonLdJsonObject";
+    /**
+     * Represents JSON-LD JSON Value.
+     */
+    readonly JsonValue: "https://schema.twindev.org/json-ld/JsonLdJsonValue";
+};
+/**
+ * The types of JSON-LD data.
+ */
+export type JsonLdTypes = (typeof JsonLdTypes)[keyof typeof JsonLdTypes];

package/dist/types/utils/jsonLdHelper.d.ts

@@ -0,0 +1,16 @@
+import { type IValidationFailure } from "@twin.org/core";
+import { type ValidationMode } from "@twin.org/data-core";
+import type { IJsonLdDocument } from "../models/IJsonLdDocument";
+/**
+ * Class to help with JSON LD.
+ */
+export declare class JsonLdHelper {
+    /**
+     * Validate a JSON-LD document.
+     * @param document The JSON-LD document to validate.
+     * @param validationFailures The list of validation failures to add to.
+     * @param validationMode The validation mode to use, defaults to either.
+     * @returns True if the document was valid.
+     */
+    static validate<T extends IJsonLdDocument = IJsonLdDocument>(document: T, validationFailures: IValidationFailure[], validationMode?: ValidationMode): Promise<boolean>;
+}

package/dist/types/utils/jsonLdProcessor.d.ts

@@ -0,0 +1,65 @@
+import type { RemoteDocument, Url } from "jsonld/jsonld-spec";
+import type { IJsonLdContextDefinitionElement, IJsonLdContextDefinitionRoot, IJsonLdDocument, IJsonLdNodeObject } from "../models/IJsonLdDocument";
+/**
+ * JSON-LD Processor.
+ */
+export declare class JsonLdProcessor {
+    /**
+     * Redirects to use during document resolution.
+     */
+    private static readonly _redirects;
+    /**
+     * The document loader to use.
+     */
+    static DOCUMENT_LOADER: (url: Url) => Promise<RemoteDocument>;
+    /**
+     * Compact a document according to a particular context.
+     * @param document The JSON-LD document to compact.
+     * @param context The context to compact the document to, if not provided will try and gather from the object.
+     * @returns The compacted JSON-LD document.
+     */
+    static compact(document: IJsonLdDocument, context?: IJsonLdContextDefinitionRoot): Promise<IJsonLdDocument>;
+    /**
+     * Expand a document, removing its context.
+     * @param compacted The compacted JSON-LD document to expand.
+     * @returns The expanded JSON-LD document.
+     */
+    static expand(compacted: IJsonLdDocument): Promise<IJsonLdDocument>;
+    /**
+     * Add a redirect to use during document resolution.
+     * @param from The URL to redirect from.
+     * @param to The URL to redirect to.
+     */
+    static addRedirect(from: RegExp, to: string): void;
+    /**
+     * Extract a property from the JSON-LD.
+     * @param nodeObject The JSON-LD node object to extract from.
+     * @param propertyNames The possible names for the property.
+     * @param deleteProperty Delete the property from the object, defaults to true.
+     * @returns The properties if available.
+     */
+    static extractProperty<T>(nodeObject: IJsonLdNodeObject, propertyNames: string[], deleteProperty?: boolean): T | undefined;
+    /**
+     * Combine contexts.
+     * @param context1 The first JSON-LD context to combine.
+     * @param context2 The second JSON-LD context to combine.
+     * @returns The combined context.
+     */
+    static combineContexts(context1: IJsonLdContextDefinitionRoot | undefined, context2: IJsonLdContextDefinitionRoot | undefined): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Gather all the contexts from the element and it's children.
+     * @param element The element to gather the contexts from.
+     * @param initial The initial context.
+     * @returns The combined contexts.
+     */
+    static gatherContexts(element: {
+        [id: string]: unknown;
+    }, initial?: IJsonLdContextDefinitionRoot): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Remove all the contexts that match the pattern.
+     * @param context The context to remove the entries from.
+     * @param match The element to try and match.
+     * @returns The updated contexts.
+     */
+    static removeContexts(context: IJsonLdContextDefinitionRoot | undefined, match?: IJsonLdContextDefinitionElement[]): IJsonLdContextDefinitionRoot | undefined;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/data-json-ld - Changelog
+
+## v0.0.1-next.10
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/data-json-ld - Examples

package/docs/reference/classes/JsonLdDataTypes.md

@@ -0,0 +1,25 @@
+# Class: JsonLdDataTypes
+
+Handle all the data types for JSON-LD.
+
+## Constructors
+
+### new JsonLdDataTypes()
+
+> **new JsonLdDataTypes**(): [`JsonLdDataTypes`](JsonLdDataTypes.md)
+
+#### Returns
+
+[`JsonLdDataTypes`](JsonLdDataTypes.md)
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/classes/JsonLdHelper.md

@@ -0,0 +1,45 @@
+# Class: JsonLdHelper
+
+Class to help with JSON LD.
+
+## Constructors
+
+### new JsonLdHelper()
+
+> **new JsonLdHelper**(): [`JsonLdHelper`](JsonLdHelper.md)
+
+#### Returns
+
+[`JsonLdHelper`](JsonLdHelper.md)
+
+## Methods
+
+### validate()
+
+> `static` **validate**\<`T`\>(`document`, `validationFailures`, `validationMode`?): `Promise`\<`boolean`\>
+
+Validate a JSON-LD document.
+
+#### Type Parameters
+
+• **T** *extends* [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md) = [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+
+#### Parameters
+
+• **document**: `T`
+
+The JSON-LD document to validate.
+
+• **validationFailures**: `IValidationFailure`[]
+
+The list of validation failures to add to.
+
+• **validationMode?**: `ValidationMode`
+
+The validation mode to use, defaults to either.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the document was valid.