@twin.org/data-json-ld 0.0.1-next.3 → 0.0.1-next.30

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

@@ -0,0 +1,13 @@
+/**
+ * The contexts of JSON-LD data.
+ */
+export declare const JsonLdContexts: {
+    /**
+     * Context Root.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/json-ld/";
+};
+/**
+ * The contexts of JSON-LD data.
+ */
+export type JsonLdContexts = (typeof JsonLdContexts)[keyof typeof JsonLdContexts];

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

@@ -5,95 +5,99 @@ export declare const JsonLdTypes: {
     /**
      * Represents JSON-LD Document.
      */
-    readonly Document: "https://schema.twindev.org/json-ld/JsonLdDocument";
+    readonly Document: "JsonLdDocument";
+    /**
+     * Represents JSON-LD Object.
+     */
+    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 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/jsonLdProcessor.d.ts

@@ -1,34 +1,108 @@
 import type { RemoteDocument, Url } from "jsonld/jsonld-spec";
-import type { IJsonLdContextDefinition, IJsonLdDocument } 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 DOCUMENT_LOADER: (url: Url) => Promise<RemoteDocument>;
+    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 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.
+     * @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?: IJsonLdContextDefinition): Promise<IJsonLdDocument>;
+    static compact<T>(document: T, context?: IJsonLdContextDefinitionRoot): 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;
+    /**
+     * 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<T>(element: T, 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;
+    /**
+     * 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,33 @@
 # @twin.org/data-json-ld - Changelog
 
-## v0.0.1-next.3
+## [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,37 +4,45 @@ 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`, `validationMode?`): `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`
+##### validationMode?
+
+`ValidationMode`
 
 The validation mode to use, defaults to either.