@twin.org/data-json-ld 0.0.1-next.23 → 0.0.1-next.24

package/dist/cjs/index.cjs

@@ -1564,14 +1564,7 @@ class JsonLdProcessor {
             return document;
         }
         catch (err) {
-            if (core.Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
-            }
-            else if (core.Is.object(err) &&
-                err.name.startsWith("jsonld.")) {
-                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "jsonldError", err.details, err);
-            }
+            JsonLdProcessor.handleCommonErrors(err);
             throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "compact", undefined, err);
         }
     }
@@ -1591,17 +1584,31 @@ class JsonLdProcessor {
             return [];
         }
         catch (err) {
-            if (core.Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
-            }
-            else if (core.Is.object(err) &&
-                err.name.startsWith("jsonld.")) {
-                throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "jsonldError", err.details, err);
-            }
+            JsonLdProcessor.handleCommonErrors(err);
             throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "expand", undefined, err);
         }
     }
+    /**
+     * 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 async canonize(document, options) {
+        try {
+            const normalized = await jsonLd.canonize(core.ObjectHelper.removeEmptyProperties(document), {
+                algorithm: options?.algorithm ?? "URDNA2015",
+                format: "application/n-quads",
+                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+            });
+            return normalized;
+        }
+        catch (err) {
+            JsonLdProcessor.handleCommonErrors(err);
+            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "canonize", undefined, err);
+        }
+    }
     /**
      * Add a redirect to use during document resolution.
      * @param from The URL to redirect from.
@@ -1758,6 +1765,21 @@ class JsonLdProcessor {
             document: response
         };
     }
+    /**
+     * Handle common errors.
+     * @param err The error to handle.
+     * @internal
+     */
+    static handleCommonErrors(err) {
+        if (core.Is.object(err) &&
+            err.name === "jsonld.InvalidUrl") {
+            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+        }
+        else if (core.Is.object(err) &&
+            err.name.startsWith("jsonld.")) {
+            throw new core.GeneralError(JsonLdProcessor._CLASS_NAME, "jsonldError", err.details, err);
+        }
+    }
 }
 
 exports.JsonLdDataTypes = JsonLdDataTypes;

package/dist/esm/index.mjs

@@ -1562,14 +1562,7 @@ class JsonLdProcessor {
             return document;
         }
         catch (err) {
-            if (Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
-            }
-            else if (Is.object(err) &&
-                err.name.startsWith("jsonld.")) {
-                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "jsonldError", err.details, err);
-            }
+            JsonLdProcessor.handleCommonErrors(err);
             throw new GeneralError(JsonLdProcessor._CLASS_NAME, "compact", undefined, err);
         }
     }
@@ -1589,17 +1582,31 @@ class JsonLdProcessor {
             return [];
         }
         catch (err) {
-            if (Is.object(err) &&
-                err.name === "jsonld.InvalidUrl") {
-                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
-            }
-            else if (Is.object(err) &&
-                err.name.startsWith("jsonld.")) {
-                throw new GeneralError(JsonLdProcessor._CLASS_NAME, "jsonldError", err.details, err);
-            }
+            JsonLdProcessor.handleCommonErrors(err);
             throw new GeneralError(JsonLdProcessor._CLASS_NAME, "expand", undefined, err);
         }
     }
+    /**
+     * 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 async canonize(document, options) {
+        try {
+            const normalized = await jsonLd.canonize(ObjectHelper.removeEmptyProperties(document), {
+                algorithm: options?.algorithm ?? "URDNA2015",
+                format: "application/n-quads",
+                documentLoader: JsonLdProcessor.DOCUMENT_LOADER
+            });
+            return normalized;
+        }
+        catch (err) {
+            JsonLdProcessor.handleCommonErrors(err);
+            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "canonize", undefined, err);
+        }
+    }
     /**
      * Add a redirect to use during document resolution.
      * @param from The URL to redirect from.
@@ -1756,6 +1763,21 @@ class JsonLdProcessor {
             document: response
         };
     }
+    /**
+     * Handle common errors.
+     * @param err The error to handle.
+     * @internal
+     */
+    static handleCommonErrors(err) {
+        if (Is.object(err) &&
+            err.name === "jsonld.InvalidUrl") {
+            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "invalidUrl", { url: err.details?.url }, err);
+        }
+        else if (Is.object(err) &&
+            err.name.startsWith("jsonld.")) {
+            throw new GeneralError(JsonLdProcessor._CLASS_NAME, "jsonldError", err.details, err);
+        }
+    }
 }
 
 export { JsonLdDataTypes, JsonLdHelper, JsonLdProcessor, JsonLdTypes };

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

@@ -27,6 +27,16 @@ export declare class JsonLdProcessor {
      * @returns The expanded JSON-LD document.
      */
     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.

package/docs/changelog.md

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

package/docs/reference/classes/JsonLdProcessor.md

@@ -90,6 +90,42 @@ The expanded JSON-LD document.
 
 ***
 
+### canonize()
+
+> `static` **canonize**\<`T`\>(`document`, `options`?): `Promise`\<`string`\>
+
+Canonize a document.
+
+#### Type Parameters
+
+• **T** *extends* [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)
+
+#### Parameters
+
+##### document
+
+`T`
+
+The document to canonize.
+
+##### options?
+
+The options for canonization.
+
+###### algorithm
+
+`"URDNA2015"` \| `"URGNA2012"`
+
+The algorithm to use for canonization, defaults to URDNA2015.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The canonized document.
+
+***
+
 ### addRedirect()
 
 > `static` **addRedirect**(`from`, `to`): `void`

package/locales/en.json

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