@twin.org/data-json-ld 0.0.1-next.9 → 0.0.2-next.1

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

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

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

@@ -9,8 +9,13 @@ 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.
+     * @param options Optional options for validation.
+     * @param options.failOnMissingType If true, will fail validation if the data type is missing, defaults to false.
+     * @param options.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>;
+    static validate<T extends IJsonLdDocument = IJsonLdDocument>(document: T, validationFailures: IValidationFailure[], options?: {
+        validationMode?: ValidationMode;
+        failOnMissingType?: boolean;
+    }): Promise<boolean>;
 }

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

@@ -1,44 +1,80 @@
 import type { RemoteDocument, Url } from "jsonld/jsonld-spec";
-import type { IJsonLdContextDefinitionElement, IJsonLdContextDefinitionRoot, IJsonLdDocument, IJsonLdNodeObject } from "../models/IJsonLdDocument";
+import type { IJsonLdContextDefinitionElement } from "../models/IJsonLdContextDefinitionElement";
+import type { IJsonLdContextDefinitionRoot } from "../models/IJsonLdContextDefinitionRoot";
+import type { IJsonLdNodeObject } from "../models/IJsonLdNodeObject";
 /**
  * JSON-LD Processor.
  */
 export declare class JsonLdProcessor {
     /**
-     * Redirects to use during document resolution.
+     * The document loader to use.
+     * @param documentLoader The document loader to use.
      */
-    private static readonly _redirects;
+    static setDocumentLoader(documentLoader: (url: Url) => Promise<RemoteDocument>): void;
     /**
-     * The document loader to use.
+     * The document loader to use for retrieving JSON-LD documents.
+     * @returns The document loader.
+     */
+    static getDocumentLoader(): (url: Url) => Promise<RemoteDocument>;
+    /**
+     * Set the cache time limit for documents.
+     * @param cacheLimitMs The cache limit in milliseconds.
+     */
+    static setCacheLimit(cacheLimitMs: number): void;
+    /**
+     * Get the cache limit for documents.
+     * @returns The document loader.
+     */
+    static getCacheLimit(): number;
+    /**
+     * Set the global redirects for JSON-LD, use addRedirect for default handling.
+     * @param redirects The redirects to use.
+     */
+    static setRedirects(redirects: {
+        from: RegExp;
+        to: string;
+    }[]): void;
+    /**
+     * Get the global redirects for JSON-LD.
+     * @returns The registered redirects.
      */
-    static DOCUMENT_LOADER: (url: Url) => Promise<RemoteDocument>;
+    static getRedirects(): {
+        from: RegExp;
+        to: string;
+    }[];
     /**
      * 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.
+     * @param context The context to compact the document to, if not provided will use the one in the document.
+     * @param options The options for compacting the document.
+     * @param options.itemListOverride Whether to override the itemListElement context with a set, defaults to true.
      * @returns The compacted JSON-LD document.
      */
-    static compact(document: IJsonLdDocument, context?: IJsonLdContextDefinitionRoot): Promise<IJsonLdDocument>;
+    static compact<T>(document: T, context?: IJsonLdContextDefinitionRoot, options?: {
+        itemListOverride: boolean;
+    }): Promise<T>;
     /**
      * 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>;
+    static expand<T>(compacted: T): Promise<IJsonLdNodeObject[]>;
+    /**
+     * Canonize a document.
+     * @param document The document to canonize.
+     * @param options The options for canonization.
+     * @param options.algorithm The algorithm to use for canonization, defaults to URDNA2015.
+     * @returns The canonized document.
+     */
+    static canonize<T extends IJsonLdNodeObject>(document: T, options?: {
+        algorithm?: "URDNA2015" | "URGNA2012" | undefined;
+    }): Promise<string>;
     /**
      * 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.
@@ -52,9 +88,7 @@ export declare class JsonLdProcessor {
      * @param initial The initial context.
      * @returns The combined contexts.
      */
-    static gatherContexts(element: {
-        [id: string]: unknown;
-    }, initial?: IJsonLdContextDefinitionRoot): IJsonLdContextDefinitionRoot | undefined;
+    static gatherContexts<T>(element: T, initial?: IJsonLdContextDefinitionRoot): IJsonLdContextDefinitionRoot | undefined;
     /**
      * Remove all the contexts that match the pattern.
      * @param context The context to remove the entries from.
@@ -62,4 +96,17 @@ export declare class JsonLdProcessor {
      * @returns The updated contexts.
      */
     static removeContexts(context: IJsonLdContextDefinitionRoot | undefined, match?: IJsonLdContextDefinitionElement[]): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Add a context directly to the document loader cache.
+     * @param url The url the ld context is for.
+     * @param ldContext The context to add.
+     * @returns Nothing.
+     */
+    static documentCacheAdd(url: string, ldContext: unknown): Promise<void>;
+    /**
+     * Remove a context from the document loader cache.
+     * @param url The url the ld context is for.
+     * @returns Nothing.
+     */
+    static documentCacheRemove(url: string): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,177 @@
 # @twin.org/data-json-ld - Changelog
 
-## v0.0.1-next.9
+## [0.0.2-next.1](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.2-next.0...data-json-ld-v0.0.2-next.1) (2025-08-19)
+
+
+### Features
+
+* add document cache access methods ([dbf1e36](https://github.com/twinfoundation/data/commit/dbf1e36d176c5f428f8c52628fb5a1ff7a6a174a))
+* add fail on missing type option and both mode ([e8b9702](https://github.com/twinfoundation/data/commit/e8b97029a04b646497ff0e55b9610291e58ae92a))
+* expand Json LD Keyword ([70632d1](https://github.com/twinfoundation/data/commit/70632d1e11ad85cf3c57e118476b125a673f1681))
+* support multiple type JSON-LD ([8f0d530](https://github.com/twinfoundation/data/commit/8f0d530f66302ab19413ecf968f170f97456e31e))
+* update framework core ([c077b8c](https://github.com/twinfoundation/data/commit/c077b8c07e7ee66b5482254eab6f2a52cd911270))
+* update ts-to-schema ([8c3cd91](https://github.com/twinfoundation/data/commit/8c3cd9131113f2d609f6e709562402e5c7766c1a))
+* use fully qualified names for data type lookups ([b7b5c74](https://github.com/twinfoundation/data/commit/b7b5c746b0180a87baa976f6a7a76cedd53d8ff7))
+* use shared store mechanism ([#3](https://github.com/twinfoundation/data/issues/3)) ([33eb221](https://github.com/twinfoundation/data/commit/33eb221ccec2b4a79549c06e9a04225009b93a46))
+* use updated JSON schema specs ([465223a](https://github.com/twinfoundation/data/commit/465223a9e9c24af546480ef084327a78fa366eaa))
+
+
+### Bug Fixes
+
+* itemListElement compaction override ([d908a10](https://github.com/twinfoundation/data/commit/d908a1043d7792e31b3101221d17850757b6c2a6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-03)
+
+
+### Features
+
+* add document cache access methods ([dbf1e36](https://github.com/twinfoundation/data/commit/dbf1e36d176c5f428f8c52628fb5a1ff7a6a174a))
+* add fail on missing type option and both mode ([e8b9702](https://github.com/twinfoundation/data/commit/e8b97029a04b646497ff0e55b9610291e58ae92a))
+* expand Json LD Keyword ([70632d1](https://github.com/twinfoundation/data/commit/70632d1e11ad85cf3c57e118476b125a673f1681))
+* support multiple type JSON-LD ([8f0d530](https://github.com/twinfoundation/data/commit/8f0d530f66302ab19413ecf968f170f97456e31e))
+* update ts-to-schema ([8c3cd91](https://github.com/twinfoundation/data/commit/8c3cd9131113f2d609f6e709562402e5c7766c1a))
+* use fully qualified names for data type lookups ([b7b5c74](https://github.com/twinfoundation/data/commit/b7b5c746b0180a87baa976f6a7a76cedd53d8ff7))
+* use shared store mechanism ([#3](https://github.com/twinfoundation/data/issues/3)) ([33eb221](https://github.com/twinfoundation/data/commit/33eb221ccec2b4a79549c06e9a04225009b93a46))
+* use updated JSON schema specs ([465223a](https://github.com/twinfoundation/data/commit/465223a9e9c24af546480ef084327a78fa366eaa))
+
+
+### Bug Fixes
+
+* itemListElement compaction override ([d908a10](https://github.com/twinfoundation/data/commit/d908a1043d7792e31b3101221d17850757b6c2a6))
+
+## [0.0.1-next.37](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.36...data-json-ld-v0.0.1-next.37) (2025-06-11)
+
+
+### Features
+
+* use updated JSON schema specs ([465223a](https://github.com/twinfoundation/data/commit/465223a9e9c24af546480ef084327a78fa366eaa))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.36 to 0.0.1-next.37
+
+## [0.0.1-next.36](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.35...data-json-ld-v0.0.1-next.36) (2025-06-10)
+
+
+### Features
+
+* expand Json LD Keyword ([70632d1](https://github.com/twinfoundation/data/commit/70632d1e11ad85cf3c57e118476b125a673f1681))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.35 to 0.0.1-next.36
+
+## [0.0.1-next.35](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.34...data-json-ld-v0.0.1-next.35) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema ([8c3cd91](https://github.com/twinfoundation/data/commit/8c3cd9131113f2d609f6e709562402e5c7766c1a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.33...data-json-ld-v0.0.1-next.34) (2025-06-02)
+
+
+### Features
+
+* support multiple type JSON-LD ([8f0d530](https://github.com/twinfoundation/data/commit/8f0d530f66302ab19413ecf968f170f97456e31e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.32...data-json-ld-v0.0.1-next.33) (2025-06-02)
+
+
+### Features
+
+* add fail on missing type option and both mode ([e8b9702](https://github.com/twinfoundation/data/commit/e8b97029a04b646497ff0e55b9610291e58ae92a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.31...data-json-ld-v0.0.1-next.32) (2025-05-28)
+
+
+### Features
+
+* use fully qualified names for data type lookups ([b7b5c74](https://github.com/twinfoundation/data/commit/b7b5c746b0180a87baa976f6a7a76cedd53d8ff7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.31 to 0.0.1-next.32
+
+## [0.0.1-next.31](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.30...data-json-ld-v0.0.1-next.31) (2025-05-08)
+
+
+### Bug Fixes
+
+* itemListElement compaction override ([d908a10](https://github.com/twinfoundation/data/commit/d908a1043d7792e31b3101221d17850757b6c2a6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.29...data-json-ld-v0.0.1-next.30) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#3](https://github.com/twinfoundation/data/issues/3)) ([33eb221](https://github.com/twinfoundation/data/commit/33eb221ccec2b4a79549c06e9a04225009b93a46))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/data/compare/data-json-ld-v0.0.1-next.28...data-json-ld-v0.0.1-next.29) (2025-03-28)
+
+
+### Features
+
+* add document cache access methods ([dbf1e36](https://github.com/twinfoundation/data/commit/dbf1e36d176c5f428f8c52628fb5a1ff7a6a174a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-core bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/classes/JsonLdDataTypes.md

@@ -4,13 +4,13 @@ Handle all the data types for JSON-LD.
 
 ## Constructors
 
-### new JsonLdDataTypes()
+### Constructor
 
-> **new JsonLdDataTypes**(): [`JsonLdDataTypes`](JsonLdDataTypes.md)
+> **new JsonLdDataTypes**(): `JsonLdDataTypes`
 
 #### Returns
 
-[`JsonLdDataTypes`](JsonLdDataTypes.md)
+`JsonLdDataTypes`
 
 ## Methods
 

package/docs/reference/classes/JsonLdHelper.md

@@ -4,40 +4,58 @@ Class to help with JSON LD.
 
 ## Constructors
 
-### new JsonLdHelper()
+### Constructor
 
-> **new JsonLdHelper**(): [`JsonLdHelper`](JsonLdHelper.md)
+> **new JsonLdHelper**(): `JsonLdHelper`
 
 #### Returns
 
-[`JsonLdHelper`](JsonLdHelper.md)
+`JsonLdHelper`
 
 ## Methods
 
 ### validate()
 
-> `static` **validate**\<`T`\>(`document`, `validationFailures`, `validationMode`?): `Promise`\<`boolean`\>
+> `static` **validate**\<`T`\>(`document`, `validationFailures`, `options?`): `Promise`\<`boolean`\>
 
 Validate a JSON-LD document.
 
 #### Type Parameters
 
-• **T** *extends* [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md) = [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
+##### T
+
+`T` *extends* [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md) = [`IJsonLdDocument`](../type-aliases/IJsonLdDocument.md)
 
 #### Parameters
 
-• **document**: `T`
+##### document
+
+`T`
 
 The JSON-LD document to validate.
 
-• **validationFailures**: `IValidationFailure`[]
+##### validationFailures
+
+`IValidationFailure`[]
 
 The list of validation failures to add to.
 
-• **validationMode?**: `ValidationMode`
+##### options?
+
+Optional options for validation.
+
+###### validationMode?
+
+`ValidationMode`
 
 The validation mode to use, defaults to either.
 
+###### failOnMissingType?
+
+`boolean`
+
+If true, will fail validation if the data type is missing, defaults to false.
+
 #### Returns
 
 `Promise`\<`boolean`\>