@twin.org/data-json-ld 0.0.1-next.5 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -12,6 +12,10 @@ var jsonLd = require('jsonld');
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const JsonLdTypes = {
+    /**
+     * Context Root.
+     */
+    ContextRoot: "https://schema.twindev.org/json-ld/",
     /**
      * Represents JSON-LD Document.
      */
@@ -1590,6 +1594,45 @@ class JsonLdProcessor {
         }
         return combinedContexts;
     }
+    /**
+     * 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, match) {
+        if (!core.Is.arrayValue(match)) {
+            return context;
+        }
+        let finalContext;
+        if (core.Is.string(context)) {
+            for (const m of match) {
+                if (context === m) {
+                    break;
+                }
+            }
+        }
+        else if (core.Is.array(context)) {
+            for (const item of context) {
+                const hasMatch = match.some(m => core.ObjectHelper.equal(m, item));
+                if (!hasMatch) {
+                    finalContext ??= [];
+                    if (core.Is.array(finalContext)) {
+                        finalContext.push(item);
+                    }
+                }
+            }
+        }
+        else if (core.Is.object(context)) {
+            const hasMatch = match.some(m => core.ObjectHelper.equal(m, context));
+            if (!hasMatch) {
+                finalContext = context;
+            }
+        }
+        return core.Is.arrayValue(finalContext) && finalContext.length === 1
+            ? finalContext[0]
+            : finalContext;
+    }
     /**
      * Document loader which uses a caching mechanism.
      * @param url The document url to load.

package/dist/esm/index.mjs

@@ -10,6 +10,10 @@ import jsonLd from 'jsonld';
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const JsonLdTypes = {
+    /**
+     * Context Root.
+     */
+    ContextRoot: "https://schema.twindev.org/json-ld/",
     /**
      * Represents JSON-LD Document.
      */
@@ -1588,6 +1592,45 @@ class JsonLdProcessor {
         }
         return combinedContexts;
     }
+    /**
+     * 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, match) {
+        if (!Is.arrayValue(match)) {
+            return context;
+        }
+        let finalContext;
+        if (Is.string(context)) {
+            for (const m of match) {
+                if (context === m) {
+                    break;
+                }
+            }
+        }
+        else if (Is.array(context)) {
+            for (const item of context) {
+                const hasMatch = match.some(m => ObjectHelper.equal(m, item));
+                if (!hasMatch) {
+                    finalContext ??= [];
+                    if (Is.array(finalContext)) {
+                        finalContext.push(item);
+                    }
+                }
+            }
+        }
+        else if (Is.object(context)) {
+            const hasMatch = match.some(m => ObjectHelper.equal(m, context));
+            if (!hasMatch) {
+                finalContext = context;
+            }
+        }
+        return Is.arrayValue(finalContext) && finalContext.length === 1
+            ? finalContext[0]
+            : finalContext;
+    }
     /**
      * Document loader which uses a caching mechanism.
      * @param url The document url to load.

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

@@ -2,6 +2,10 @@
  * The types of JSON-LD data.
  */
 export declare const JsonLdTypes: {
+    /**
+     * Context Root.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/json-ld/";
     /**
      * Represents JSON-LD Document.
      */

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

@@ -1,5 +1,5 @@
 import type { RemoteDocument, Url } from "jsonld/jsonld-spec";
-import type { IJsonLdContextDefinitionRoot, IJsonLdDocument, IJsonLdNodeObject } from "../models/IJsonLdDocument";
+import type { IJsonLdContextDefinitionElement, IJsonLdContextDefinitionRoot, IJsonLdDocument, IJsonLdNodeObject } from "../models/IJsonLdDocument";
 /**
  * JSON-LD Processor.
  */
@@ -55,4 +55,11 @@ export declare class JsonLdProcessor {
     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

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

package/docs/reference/classes/JsonLdProcessor.md

@@ -173,3 +173,27 @@ The initial context.
 `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
 
 The combined contexts.
+
+***
+
+### removeContexts()
+
+> `static` **removeContexts**(`context`, `match`?): `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+Remove all the contexts that match the pattern.
+
+#### Parameters
+
+• **context**: `undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The context to remove the entries from.
+
+• **match?**: [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[]
+
+The element to try and match.
+
+#### Returns
+
+`undefined` \| [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
+
+The updated contexts.

package/docs/reference/variables/JsonLdTypes.md

@@ -6,6 +6,12 @@ The types of JSON-LD data.
 
 ## Type declaration
 
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/json-ld/"` = `"https://schema.twindev.org/json-ld/"`
+
+Context Root.
+
 ### Document
 
 > `readonly` **Document**: `"https://schema.twindev.org/json-ld/JsonLdDocument"` = `"https://schema.twindev.org/json-ld/JsonLdDocument"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-json-ld",
-	"version": "0.0.1-next.5",
+	"version": "0.0.1-next.7",
 	"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.1-next.5",
+		"@twin.org/data-core": "0.0.1-next.7",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next",