@twin.org/core 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/types/bitString.js

@@ -0,0 +1,98 @@
+import { GeneralError } from "../errors/generalError.js";
+import { Guards } from "../utils/guards.js";
+/**
+ * A class to represent a bit string.
+ */
+export class BitString {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "BitString";
+    /**
+     * The storage for the bits.
+     * @internal
+     */
+    _bits;
+    /**
+     * The number of bits stored in the buffer.
+     * @internal
+     */
+    _numberBits;
+    /**
+     * Create a new instance of BitString.
+     * @param numberBits The length of the bit string.
+     */
+    constructor(numberBits) {
+        Guards.integer(BitString.CLASS_NAME, "numberBits", numberBits);
+        this._numberBits = numberBits;
+        this._bits = new Uint8Array(Math.ceil(numberBits / 8));
+    }
+    /**
+     * Create a new instance of BitString from a bit array.
+     * @param bits The bits to create the bit string from.
+     * @param numberBits The number of bits in the bit string.
+     * @returns The new instance of BitString.
+     */
+    static fromBits(bits, numberBits) {
+        Guards.uint8Array(BitString.CLASS_NAME, "bits", bits);
+        Guards.integer(BitString.CLASS_NAME, "numberBits", numberBits);
+        const bs = new BitString(numberBits);
+        bs._bits.set(bits);
+        return bs;
+    }
+    /**
+     * Get the bit at the given index.
+     * @param index The index to get the bit for.
+     * @returns True if the bit at the index is set.
+     * @throws GeneralError if the index is out of range.
+     */
+    getBit(index) {
+        Guards.integer(BitString.CLASS_NAME, "index", index);
+        if (index < 0 || index >= this._numberBits) {
+            throw new GeneralError(BitString.CLASS_NAME, "outOfRange", {
+                index,
+                numberBits: this._numberBits
+            });
+        }
+        const byteIndex = Math.floor(index / 8);
+        const bitIndex = index % 8;
+        return (this._bits[byteIndex] & (1 << bitIndex)) !== 0;
+    }
+    /**
+     * Set the bit at the given index.
+     * @param index The index to set the bit for.
+     * @param value The value to set the bit to.
+     * @throws GeneralError if the index is out of range.
+     */
+    setBit(index, value) {
+        if (index < 0 || index >= this._numberBits) {
+            throw new GeneralError(BitString.CLASS_NAME, "outOfRange", {
+                index,
+                numberBits: this._numberBits
+            });
+        }
+        const byteIndex = Math.floor(index / 8);
+        const bitIndex = index % 8;
+        if (value) {
+            this._bits[byteIndex] |= 1 << bitIndex;
+        }
+        else {
+            this._bits[byteIndex] &= ~(1 << bitIndex);
+        }
+    }
+    /**
+     * Get the bits of the bit string.
+     * @returns The bits stored in a Uint8Array.
+     */
+    getBits() {
+        return this._bits;
+    }
+    /**
+     * Get the length of the bit string.
+     * @returns The length of the bit string.
+     */
+    getLength() {
+        return this._numberBits;
+    }
+}
+//# sourceMappingURL=bitString.js.map

package/dist/es/types/bitString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bitString.js","sourceRoot":"","sources":["../../../src/types/bitString.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C;;GAEG;AACH,MAAM,OAAO,SAAS;IACrB;;OAEG;IACI,MAAM,CAAU,UAAU,eAA+B;IAEhE;;;OAGG;IACc,KAAK,CAAa;IAEnC;;;OAGG;IACc,WAAW,CAAS;IAErC;;;OAGG;IACH,YAAY,UAAkB;QAC7B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAgB,EAAE,UAAkB;QAC1D,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC5D,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QACrE,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QACrC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnB,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAa;QAC1B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAC3D,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,IAAI,YAAY,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,EAAE;gBAC1D,KAAK;gBACL,UAAU,EAAE,IAAI,CAAC,WAAW;aAC5B,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC;QAC3B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAa,EAAE,KAAc;QAC1C,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,IAAI,YAAY,CAAC,SAAS,CAAC,UAAU,EAAE,YAAY,EAAE;gBAC1D,KAAK;gBACL,UAAU,EAAE,IAAI,CAAC,WAAW;aAC5B,CAAC,CAAC;QACJ,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC;QAC3B,IAAI,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC;QACxC,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC;QAC3C,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,OAAO;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/* eslint-disable no-bitwise */\nimport { nameof } from \"@twin.org/nameof\";\nimport { GeneralError } from \"../errors/generalError.js\";\nimport { Guards } from \"../utils/guards.js\";\n\n/**\n * A class to represent a bit string.\n */\nexport class BitString {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<BitString>();\n\n\t/**\n\t * The storage for the bits.\n\t * @internal\n\t */\n\tprivate readonly _bits: Uint8Array;\n\n\t/**\n\t * The number of bits stored in the buffer.\n\t * @internal\n\t */\n\tprivate readonly _numberBits: number;\n\n\t/**\n\t * Create a new instance of BitString.\n\t * @param numberBits The length of the bit string.\n\t */\n\tconstructor(numberBits: number) {\n\t\tGuards.integer(BitString.CLASS_NAME, nameof(numberBits), numberBits);\n\t\tthis._numberBits = numberBits;\n\t\tthis._bits = new Uint8Array(Math.ceil(numberBits / 8));\n\t}\n\n\t/**\n\t * Create a new instance of BitString from a bit array.\n\t * @param bits The bits to create the bit string from.\n\t * @param numberBits The number of bits in the bit string.\n\t * @returns The new instance of BitString.\n\t */\n\tpublic static fromBits(bits: Uint8Array, numberBits: number): BitString {\n\t\tGuards.uint8Array(BitString.CLASS_NAME, nameof(bits), bits);\n\t\tGuards.integer(BitString.CLASS_NAME, nameof(numberBits), numberBits);\n\t\tconst bs = new BitString(numberBits);\n\t\tbs._bits.set(bits);\n\t\treturn bs;\n\t}\n\n\t/**\n\t * Get the bit at the given index.\n\t * @param index The index to get the bit for.\n\t * @returns True if the bit at the index is set.\n\t * @throws GeneralError if the index is out of range.\n\t */\n\tpublic getBit(index: number): boolean {\n\t\tGuards.integer(BitString.CLASS_NAME, nameof(index), index);\n\t\tif (index < 0 || index >= this._numberBits) {\n\t\t\tthrow new GeneralError(BitString.CLASS_NAME, \"outOfRange\", {\n\t\t\t\tindex,\n\t\t\t\tnumberBits: this._numberBits\n\t\t\t});\n\t\t}\n\n\t\tconst byteIndex = Math.floor(index / 8);\n\t\tconst bitIndex = index % 8;\n\t\treturn (this._bits[byteIndex] & (1 << bitIndex)) !== 0;\n\t}\n\n\t/**\n\t * Set the bit at the given index.\n\t * @param index The index to set the bit for.\n\t * @param value The value to set the bit to.\n\t * @throws GeneralError if the index is out of range.\n\t */\n\tpublic setBit(index: number, value: boolean): void {\n\t\tif (index < 0 || index >= this._numberBits) {\n\t\t\tthrow new GeneralError(BitString.CLASS_NAME, \"outOfRange\", {\n\t\t\t\tindex,\n\t\t\t\tnumberBits: this._numberBits\n\t\t\t});\n\t\t}\n\t\tconst byteIndex = Math.floor(index / 8);\n\t\tconst bitIndex = index % 8;\n\t\tif (value) {\n\t\t\tthis._bits[byteIndex] |= 1 << bitIndex;\n\t\t} else {\n\t\t\tthis._bits[byteIndex] &= ~(1 << bitIndex);\n\t\t}\n\t}\n\n\t/**\n\t * Get the bits of the bit string.\n\t * @returns The bits stored in a Uint8Array.\n\t */\n\tpublic getBits(): Uint8Array {\n\t\treturn this._bits;\n\t}\n\n\t/**\n\t * Get the length of the bit string.\n\t * @returns The length of the bit string.\n\t */\n\tpublic getLength(): number {\n\t\treturn this._numberBits;\n\t}\n}\n"]}

package/dist/es/types/url.js

@@ -0,0 +1,144 @@
+import { GuardError } from "../errors/guardError.js";
+import { Coerce } from "../utils/coerce.js";
+import { Guards } from "../utils/guards.js";
+import { Is } from "../utils/is.js";
+/**
+ * Class to help with urls.
+ */
+export class Url {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Url";
+    /**
+     * The internal representation of the url.
+     * @internal
+     */
+    _urlParts;
+    /**
+     * Create a new instance of Url.
+     * @param url The url string.
+     */
+    constructor(url) {
+        Guards.stringValue(Url.CLASS_NAME, "url", url);
+        try {
+            const u = new URL(url);
+            this._urlParts = Url.fromURLToParts(u);
+        }
+        catch {
+            throw new GuardError(Url.CLASS_NAME, "guard.url", "url", url);
+        }
+    }
+    /**
+     * Try and parse a string into the url parts.
+     * @param url The url to parse.
+     * @returns The formatted url or undefined if the value is not a url.
+     */
+    static tryParseExact(url) {
+        if (!Is.stringValue(url)) {
+            return;
+        }
+        try {
+            // By constructing a new standard URL class this will
+            // validate the format
+            const u = new URL(url);
+            return Url.fromParts(Url.fromURLToParts(u));
+        }
+        catch { }
+    }
+    /**
+     * Parse a string into the url parts.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The url to parse.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static guard(source, property, value) {
+        Guards.stringValue(source, property, value);
+        const result = Url.tryParseExact(value);
+        if (!result) {
+            throw new GuardError(source, "guard.url", property, value);
+        }
+    }
+    /**
+     * Validate a string as a Url.
+     * @param property Throw an exception if the url property is invalid.
+     * @param value The url to parse.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource The optional human readable name for the field as an i18 resource.
+     * @returns The formatted url.
+     */
+    static validate(property, value, failures, fieldNameResource) {
+        if (!Is.stringValue(value)) {
+            failures.push({
+                property,
+                reason: "validation.beNotEmpty",
+                properties: { fieldName: fieldNameResource ?? "validation.defaultFieldName", value }
+            });
+            return false;
+        }
+        const result = Url.tryParseExact(value);
+        if (Is.undefined(result)) {
+            failures.push({
+                property,
+                reason: "validation.beUrl",
+                properties: { fieldName: fieldNameResource ?? "validation.defaultFieldName", value }
+            });
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Construct a url from a URL.
+     * @param url The url to construct from.
+     * @returns The formatted url.
+     */
+    static fromURLToParts(url) {
+        return {
+            schema: url.protocol.replace(/:$/, ""),
+            host: url.hostname,
+            port: Coerce.number(url.port),
+            path: url.pathname,
+            params: Is.stringValue(url.search) ? url.search.replace(/^\?/, "") : undefined,
+            hash: Is.stringValue(url.hash) ? url.hash.replace(/^#/, "") : undefined
+        };
+    }
+    /**
+     * Construct a url from valid parts.
+     * @param urlParts The url to create the parts from.
+     * @returns The formatted url.
+     */
+    static fromParts(urlParts) {
+        const u = new Url("http://dummy");
+        u._urlParts = urlParts;
+        return u;
+    }
+    /**
+     * Get the parts of the url.
+     * @returns The parts of the url.
+     */
+    parts() {
+        return this._urlParts;
+    }
+    /**
+     * Convert the parts in to a full string.
+     * @returns The formatted url.
+     */
+    toString() {
+        const parts = [this._urlParts.schema, "://", this._urlParts.host];
+        if (Is.number(this._urlParts.port)) {
+            parts.push(`:${this._urlParts.port}`);
+        }
+        if (Is.stringValue(this._urlParts.path)) {
+            parts.push(this._urlParts.path);
+        }
+        if (Is.stringValue(this._urlParts.params)) {
+            parts.push(`?${this._urlParts.params}`);
+        }
+        if (Is.stringValue(this._urlParts.hash)) {
+            parts.push(`#${this._urlParts.hash}`);
+        }
+        return parts.join("");
+    }
+}
+//# sourceMappingURL=url.js.map

package/dist/es/types/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/types/url.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,GAAG;IACf;;OAEG;IACI,MAAM,CAAU,UAAU,SAAyB;IAE1D;;;OAGG;IACK,SAAS,CAAY;IAE7B;;;OAGG;IACH,YAAY,GAAW;QACtB,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAErD,IAAI,CAAC;YACJ,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC;QAAC,MAAM,CAAC;YACR,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QAC/D,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,GAAY;QACvC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO;QACR,CAAC;QAED,IAAI,CAAC;YACJ,qDAAqD;YACrD,sBAAsB;YACtB,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,OAAO,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACX,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAc,EAAE,QAAgB,EAAE,KAAc;QACnE,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAE5C,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC5D,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CACrB,QAAgB,EAChB,KAAc,EACd,QAA8B,EAC9B,iBAA0B;QAE1B,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,MAAM,EAAE,uBAAuB;gBAC/B,UAAU,EAAE,EAAE,SAAS,EAAE,iBAAiB,IAAI,6BAA6B,EAAE,KAAK,EAAE;aACpF,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAExC,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,MAAM,EAAE,kBAAkB;gBAC1B,UAAU,EAAE,EAAE,SAAS,EAAE,iBAAiB,IAAI,6BAA6B,EAAE,KAAK,EAAE;aACpF,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,GAAQ;QACpC,OAAO;YACN,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YACtC,IAAI,EAAE,GAAG,CAAC,QAAQ;YAClB,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;YAC7B,IAAI,EAAE,GAAG,CAAC,QAAQ;YAClB,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;YAC9E,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS;SACvE,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,QAAmB;QAC1C,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC,CAAC,SAAS,GAAG,QAAQ,CAAC;QACvB,OAAO,CAAC,CAAC;IACV,CAAC;IAED;;;OAGG;IACI,KAAK;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACd,MAAM,KAAK,GAAa,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5E,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3C,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { GuardError } from \"../errors/guardError.js\";\nimport type { IUrlParts } from \"../models/IUrlParts.js\";\nimport type { IValidationFailure } from \"../models/IValidationFailure.js\";\nimport { Coerce } from \"../utils/coerce.js\";\nimport { Guards } from \"../utils/guards.js\";\nimport { Is } from \"../utils/is.js\";\n\n/**\n * Class to help with urls.\n */\nexport class Url {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Url>();\n\n\t/**\n\t * The internal representation of the url.\n\t * @internal\n\t */\n\tprivate _urlParts: IUrlParts;\n\n\t/**\n\t * Create a new instance of Url.\n\t * @param url The url string.\n\t */\n\tconstructor(url: string) {\n\t\tGuards.stringValue(Url.CLASS_NAME, nameof(url), url);\n\n\t\ttry {\n\t\t\tconst u = new URL(url);\n\t\t\tthis._urlParts = Url.fromURLToParts(u);\n\t\t} catch {\n\t\t\tthrow new GuardError(Url.CLASS_NAME, \"guard.url\", \"url\", url);\n\t\t}\n\t}\n\n\t/**\n\t * Try and parse a string into the url parts.\n\t * @param url The url to parse.\n\t * @returns The formatted url or undefined if the value is not a url.\n\t */\n\tpublic static tryParseExact(url: unknown): Url | undefined {\n\t\tif (!Is.stringValue(url)) {\n\t\t\treturn;\n\t\t}\n\n\t\ttry {\n\t\t\t// By constructing a new standard URL class this will\n\t\t\t// validate the format\n\t\t\tconst u = new URL(url);\n\t\t\treturn Url.fromParts(Url.fromURLToParts(u));\n\t\t} catch {}\n\t}\n\n\t/**\n\t * Parse a string into the url parts.\n\t * @param source The source of the error.\n\t * @param property The name of the property.\n\t * @param value The url to parse.\n\t * @throws GuardError If the value does not match the assertion.\n\t */\n\tpublic static guard(source: string, property: string, value: unknown): asserts value is string {\n\t\tGuards.stringValue(source, property, value);\n\n\t\tconst result = Url.tryParseExact(value);\n\n\t\tif (!result) {\n\t\t\tthrow new GuardError(source, \"guard.url\", property, value);\n\t\t}\n\t}\n\n\t/**\n\t * Validate a string as a Url.\n\t * @param property Throw an exception if the url property is invalid.\n\t * @param value The url to parse.\n\t * @param failures The list of failures to add to.\n\t * @param fieldNameResource The optional human readable name for the field as an i18 resource.\n\t * @returns The formatted url.\n\t */\n\tpublic static validate(\n\t\tproperty: string,\n\t\tvalue: unknown,\n\t\tfailures: IValidationFailure[],\n\t\tfieldNameResource?: string\n\t): value is Url {\n\t\tif (!Is.stringValue(value)) {\n\t\t\tfailures.push({\n\t\t\t\tproperty,\n\t\t\t\treason: \"validation.beNotEmpty\",\n\t\t\t\tproperties: { fieldName: fieldNameResource ?? \"validation.defaultFieldName\", value }\n\t\t\t});\n\n\t\t\treturn false;\n\t\t}\n\n\t\tconst result = Url.tryParseExact(value);\n\n\t\tif (Is.undefined(result)) {\n\t\t\tfailures.push({\n\t\t\t\tproperty,\n\t\t\t\treason: \"validation.beUrl\",\n\t\t\t\tproperties: { fieldName: fieldNameResource ?? \"validation.defaultFieldName\", value }\n\t\t\t});\n\n\t\t\treturn false;\n\t\t}\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * Construct a url from a URL.\n\t * @param url The url to construct from.\n\t * @returns The formatted url.\n\t */\n\tpublic static fromURLToParts(url: URL): IUrlParts {\n\t\treturn {\n\t\t\tschema: url.protocol.replace(/:$/, \"\"),\n\t\t\thost: url.hostname,\n\t\t\tport: Coerce.number(url.port),\n\t\t\tpath: url.pathname,\n\t\t\tparams: Is.stringValue(url.search) ? url.search.replace(/^\\?/, \"\") : undefined,\n\t\t\thash: Is.stringValue(url.hash) ? url.hash.replace(/^#/, \"\") : undefined\n\t\t};\n\t}\n\n\t/**\n\t * Construct a url from valid parts.\n\t * @param urlParts The url to create the parts from.\n\t * @returns The formatted url.\n\t */\n\tpublic static fromParts(urlParts: IUrlParts): Url {\n\t\tconst u = new Url(\"http://dummy\");\n\t\tu._urlParts = urlParts;\n\t\treturn u;\n\t}\n\n\t/**\n\t * Get the parts of the url.\n\t * @returns The parts of the url.\n\t */\n\tpublic parts(): IUrlParts {\n\t\treturn this._urlParts;\n\t}\n\n\t/**\n\t * Convert the parts in to a full string.\n\t * @returns The formatted url.\n\t */\n\tpublic toString(): string {\n\t\tconst parts: string[] = [this._urlParts.schema, \"://\", this._urlParts.host];\n\t\tif (Is.number(this._urlParts.port)) {\n\t\t\tparts.push(`:${this._urlParts.port}`);\n\t\t}\n\t\tif (Is.stringValue(this._urlParts.path)) {\n\t\t\tparts.push(this._urlParts.path);\n\t\t}\n\t\tif (Is.stringValue(this._urlParts.params)) {\n\t\t\tparts.push(`?${this._urlParts.params}`);\n\t\t}\n\t\tif (Is.stringValue(this._urlParts.hash)) {\n\t\t\tparts.push(`#${this._urlParts.hash}`);\n\t\t}\n\t\treturn parts.join(\"\");\n\t}\n}\n"]}

package/dist/es/types/urn.js

@@ -0,0 +1,212 @@
+import { GuardError } from "../errors/guardError.js";
+import { RandomHelper } from "../helpers/randomHelper.js";
+import { Converter } from "../utils/converter.js";
+import { Guards } from "../utils/guards.js";
+import { Is } from "../utils/is.js";
+/**
+ * Class to help with urns.
+ */
+export class Urn {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Urn";
+    /**
+     * The specific part of the namespace.
+     * @internal
+     */
+    _urnParts;
+    /**
+     * Create a new instance of Urn.
+     * @param namespaceIdentifier The identifier for the namespace.
+     * @param namespaceSpecific The specific part of the namespace.
+     */
+    constructor(namespaceIdentifier, namespaceSpecific) {
+        Guards.stringValue(Urn.CLASS_NAME, "namespaceIdentifier", namespaceIdentifier);
+        // Strip leading and trailing colons
+        this._urnParts = [this.stripColons(namespaceIdentifier)];
+        if (Is.array(namespaceSpecific)) {
+            Guards.arrayValue(Urn.CLASS_NAME, "namespaceSpecific", namespaceSpecific);
+            this._urnParts.push(...namespaceSpecific);
+        }
+        else {
+            Guards.stringValue(Urn.CLASS_NAME, "namespaceSpecific", namespaceSpecific);
+            this._urnParts.push(...this.stripColons(namespaceSpecific).split(":"));
+        }
+    }
+    /**
+     * Generate a random identifier with 32 byte id.
+     * @param namespace The prefix for the urn.
+     * @returns A new Id in URN format.
+     */
+    static generateRandom(namespace) {
+        return new Urn(namespace, Converter.bytesToHex(RandomHelper.generate(32)));
+    }
+    /**
+     * Does the provided urn match the namespace.
+     * @param urn The urn to check.
+     * @param namespace The namespace to match.
+     * @returns True if the namespace matches.
+     */
+    static hasNamespace(urn, namespace) {
+        if (!Is.stringValue(urn)) {
+            return false;
+        }
+        if (urn.startsWith("urn:")) {
+            urn = urn.slice(4);
+        }
+        if (urn.length === namespace.length) {
+            return urn === namespace;
+        }
+        return urn.startsWith(`${namespace}:`);
+    }
+    /**
+     * Try and parse a string into the urn parts.
+     * @param urn The urn to parse.
+     * @returns The formatted urn or undefined if the value is not a urn.
+     */
+    static tryParseExact(urn) {
+        if (!Is.stringValue(urn)) {
+            return;
+        }
+        const parts = urn.split(":");
+        if (parts[0] === "urn") {
+            parts.shift();
+        }
+        if (parts.length < 2) {
+            return;
+        }
+        if (!/[\da-z][\da-z-]{0,31}/.test(parts[0])) {
+            return;
+        }
+        for (let i = 1; i < parts.length; i++) {
+            if (!/[\d!#$%'()*+,./:;=?@_a-z-]+/.test(parts[i])) {
+                return;
+            }
+        }
+        return new Urn(parts[0], parts.slice(1));
+    }
+    /**
+     * Construct a urn from a string that has already been validated.
+     * @param urn The urn to parse.
+     * @returns The formatted urn.
+     */
+    static fromValidString(urn) {
+        const parts = urn.split(":");
+        if (parts[0] === "urn") {
+            parts.shift();
+        }
+        return new Urn(parts[0], parts.slice(1));
+    }
+    /**
+     * Add a urn: prefix if there isn't one already.
+     * @param urn The urn string to add a prefix to.
+     * @returns The urn with a prefix.
+     */
+    static addPrefix(urn) {
+        if (Is.stringValue(urn)) {
+            if (urn.startsWith("urn:")) {
+                return urn;
+            }
+            return `urn:${urn}`;
+        }
+    }
+    /**
+     * Parse a string into the urn parts.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The urn to parse.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static guard(source, property, value) {
+        Guards.stringValue(source, property, value);
+        const result = Urn.tryParseExact(value);
+        if (!result) {
+            throw new GuardError(source, "guard.urn", property, value);
+        }
+    }
+    /**
+     * Validate a string as a Urn.
+     * @param property Throw an exception if the urn property is invalid.
+     * @param value The urn to parse.
+     * @param failures The list of failures to add to.
+     * @param fieldNameResource The optional human readable name for the field as an i18 resource.
+     * @returns The formatted urn.
+     */
+    static validate(property, value, failures, fieldNameResource) {
+        if (!Is.stringValue(value)) {
+            failures.push({
+                property,
+                reason: "validation.beNotEmpty",
+                properties: { fieldName: fieldNameResource ?? "validation.defaultFieldName", value }
+            });
+            return false;
+        }
+        const result = Urn.tryParseExact(value);
+        if (Is.undefined(result)) {
+            failures.push({
+                property,
+                reason: "validation.beUrn",
+                properties: { fieldName: fieldNameResource ?? "validation.defaultFieldName", value }
+            });
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Get the parts.
+     * @param startIndex The index to start from, defaults to 0.
+     * @returns The parts.
+     */
+    parts(startIndex = 0) {
+        return this._urnParts.slice(startIndex);
+    }
+    /**
+     * Get the namespace identifier.
+     * @returns The namespace identifier.
+     */
+    namespaceIdentifier() {
+        return this._urnParts[0];
+    }
+    /**
+     * Get the namespace method, the first component after the identifier.
+     * @returns The namespace method.
+     */
+    namespaceMethod() {
+        return this._urnParts.length > 1 ? this._urnParts[1] : "";
+    }
+    /**
+     * Get the namespace specific parts.
+     * @param startIndex The index to start from, defaults to 0.
+     * @returns The namespace specific parts.
+     */
+    namespaceSpecificParts(startIndex = 0) {
+        return this._urnParts.length > 1 ? this._urnParts.slice(startIndex + 1) : [];
+    }
+    /**
+     * Get the namespace specific.
+     * @param startIndex The index to start from, defaults to 0.
+     * @returns The namespace specific.
+     */
+    namespaceSpecific(startIndex = 0) {
+        return this._urnParts.length > 1 ? this._urnParts.slice(startIndex + 1).join(":") : "";
+    }
+    /**
+     * Convert the parts in to a full string.
+     * @param omitPrefix Omit the urn: prefix from the string.
+     * @returns The formatted urn.
+     */
+    toString(omitPrefix = true) {
+        return omitPrefix ? this._urnParts.join(":") : `urn:${this._urnParts.join(":")}`;
+    }
+    /**
+     * Strip the leading and trailing colons from a string.
+     * @param val The value to strip.
+     * @returns The stripped string.
+     * @internal
+     */
+    stripColons(val) {
+        return val.replace(/^:?(.*?):?$/, "$1");
+    }
+}
+//# sourceMappingURL=urn.js.map

package/dist/es/types/urn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urn.js","sourceRoot":"","sources":["../../../src/types/urn.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,GAAG;IACf;;OAEG;IACI,MAAM,CAAU,UAAU,SAAyB;IAE1D;;;OAGG;IACc,SAAS,CAAW;IAErC;;;;OAIG;IACH,YAAY,mBAA2B,EAAE,iBAAoC;QAC5E,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,yBAA+B,mBAAmB,CAAC,CAAC;QAErF,oCAAoC;QACpC,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAEzD,IAAI,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,uBAA6B,iBAAiB,CAAC,CAAC;YAChF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAC;QAC3C,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,uBAA6B,iBAAiB,CAAC,CAAC;YACjF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACxE,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,SAAiB;QAC7C,OAAO,IAAI,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,GAAW,EAAE,SAAiB;QACxD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;QACD,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC;QAED,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,GAAG,KAAK,SAAS,CAAC;QAC1B,CAAC;QAED,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,GAAY;QACvC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO;QACR,CAAC;QAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE7B,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO;QACR,CAAC;QAED,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,OAAO;QACR,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC,6BAA6B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnD,OAAO;YACR,CAAC;QACF,CAAC;QAED,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,GAAW;QACxC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE7B,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACxB,KAAK,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QAED,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,GAAY;QACnC,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC5B,OAAO,GAAG,CAAC;YACZ,CAAC;YACD,OAAO,OAAO,GAAG,EAAE,CAAC;QACrB,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAc,EAAE,QAAgB,EAAE,KAAc;QACnE,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAE5C,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAExC,IAAI,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,IAAI,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;QAC5D,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CACrB,QAAgB,EAChB,KAAc,EACd,QAA8B,EAC9B,iBAA0B;QAE1B,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,MAAM,EAAE,uBAAuB;gBAC/B,UAAU,EAAE,EAAE,SAAS,EAAE,iBAAiB,IAAI,6BAA6B,EAAE,KAAK,EAAE;aACpF,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAExC,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,IAAI,CAAC;gBACb,QAAQ;gBACR,MAAM,EAAE,kBAAkB;gBAC1B,UAAU,EAAE,EAAE,SAAS,EAAE,iBAAiB,IAAI,6BAA6B,EAAE,KAAK,EAAE;aACpF,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAqB,CAAC;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,mBAAmB;QACzB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACI,eAAe;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACI,sBAAsB,CAAC,aAAqB,CAAC;QACnD,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACI,iBAAiB,CAAC,aAAqB,CAAC;QAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACI,QAAQ,CAAC,aAAsB,IAAI;QACzC,OAAO,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IAClF,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,GAAW;QAC9B,OAAO,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { nameof } from \"@twin.org/nameof\";\nimport { GuardError } from \"../errors/guardError.js\";\nimport { RandomHelper } from \"../helpers/randomHelper.js\";\nimport type { IValidationFailure } from \"../models/IValidationFailure.js\";\nimport { Converter } from \"../utils/converter.js\";\nimport { Guards } from \"../utils/guards.js\";\nimport { Is } from \"../utils/is.js\";\n\n/**\n * Class to help with urns.\n */\nexport class Urn {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Urn>();\n\n\t/**\n\t * The specific part of the namespace.\n\t * @internal\n\t */\n\tprivate readonly _urnParts: string[];\n\n\t/**\n\t * Create a new instance of Urn.\n\t * @param namespaceIdentifier The identifier for the namespace.\n\t * @param namespaceSpecific The specific part of the namespace.\n\t */\n\tconstructor(namespaceIdentifier: string, namespaceSpecific: string | string[]) {\n\t\tGuards.stringValue(Urn.CLASS_NAME, nameof(namespaceIdentifier), namespaceIdentifier);\n\n\t\t// Strip leading and trailing colons\n\t\tthis._urnParts = [this.stripColons(namespaceIdentifier)];\n\n\t\tif (Is.array(namespaceSpecific)) {\n\t\t\tGuards.arrayValue(Urn.CLASS_NAME, nameof(namespaceSpecific), namespaceSpecific);\n\t\t\tthis._urnParts.push(...namespaceSpecific);\n\t\t} else {\n\t\t\tGuards.stringValue(Urn.CLASS_NAME, nameof(namespaceSpecific), namespaceSpecific);\n\t\t\tthis._urnParts.push(...this.stripColons(namespaceSpecific).split(\":\"));\n\t\t}\n\t}\n\n\t/**\n\t * Generate a random identifier with 32 byte id.\n\t * @param namespace The prefix for the urn.\n\t * @returns A new Id in URN format.\n\t */\n\tpublic static generateRandom(namespace: string): Urn {\n\t\treturn new Urn(namespace, Converter.bytesToHex(RandomHelper.generate(32)));\n\t}\n\n\t/**\n\t * Does the provided urn match the namespace.\n\t * @param urn The urn to check.\n\t * @param namespace The namespace to match.\n\t * @returns True if the namespace matches.\n\t */\n\tpublic static hasNamespace(urn: string, namespace: string): boolean {\n\t\tif (!Is.stringValue(urn)) {\n\t\t\treturn false;\n\t\t}\n\t\tif (urn.startsWith(\"urn:\")) {\n\t\t\turn = urn.slice(4);\n\t\t}\n\n\t\tif (urn.length === namespace.length) {\n\t\t\treturn urn === namespace;\n\t\t}\n\n\t\treturn urn.startsWith(`${namespace}:`);\n\t}\n\n\t/**\n\t * Try and parse a string into the urn parts.\n\t * @param urn The urn to parse.\n\t * @returns The formatted urn or undefined if the value is not a urn.\n\t */\n\tpublic static tryParseExact(urn: unknown): Urn | undefined {\n\t\tif (!Is.stringValue(urn)) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst parts = urn.split(\":\");\n\n\t\tif (parts[0] === \"urn\") {\n\t\t\tparts.shift();\n\t\t}\n\n\t\tif (parts.length < 2) {\n\t\t\treturn;\n\t\t}\n\n\t\tif (!/[\\da-z][\\da-z-]{0,31}/.test(parts[0])) {\n\t\t\treturn;\n\t\t}\n\n\t\tfor (let i = 1; i < parts.length; i++) {\n\t\t\tif (!/[\\d!#$%'()*+,./:;=?@_a-z-]+/.test(parts[i])) {\n\t\t\t\treturn;\n\t\t\t}\n\t\t}\n\n\t\treturn new Urn(parts[0], parts.slice(1));\n\t}\n\n\t/**\n\t * Construct a urn from a string that has already been validated.\n\t * @param urn The urn to parse.\n\t * @returns The formatted urn.\n\t */\n\tpublic static fromValidString(urn: string): Urn {\n\t\tconst parts = urn.split(\":\");\n\n\t\tif (parts[0] === \"urn\") {\n\t\t\tparts.shift();\n\t\t}\n\n\t\treturn new Urn(parts[0], parts.slice(1));\n\t}\n\n\t/**\n\t * Add a urn: prefix if there isn't one already.\n\t * @param urn The urn string to add a prefix to.\n\t * @returns The urn with a prefix.\n\t */\n\tpublic static addPrefix(urn: unknown): string | undefined {\n\t\tif (Is.stringValue(urn)) {\n\t\t\tif (urn.startsWith(\"urn:\")) {\n\t\t\t\treturn urn;\n\t\t\t}\n\t\t\treturn `urn:${urn}`;\n\t\t}\n\t}\n\n\t/**\n\t * Parse a string into the urn parts.\n\t * @param source The source of the error.\n\t * @param property The name of the property.\n\t * @param value The urn to parse.\n\t * @throws GuardError If the value does not match the assertion.\n\t */\n\tpublic static guard(source: string, property: string, value: unknown): asserts value is string {\n\t\tGuards.stringValue(source, property, value);\n\n\t\tconst result = Urn.tryParseExact(value);\n\n\t\tif (!result) {\n\t\t\tthrow new GuardError(source, \"guard.urn\", property, value);\n\t\t}\n\t}\n\n\t/**\n\t * Validate a string as a Urn.\n\t * @param property Throw an exception if the urn property is invalid.\n\t * @param value The urn to parse.\n\t * @param failures The list of failures to add to.\n\t * @param fieldNameResource The optional human readable name for the field as an i18 resource.\n\t * @returns The formatted urn.\n\t */\n\tpublic static validate(\n\t\tproperty: string,\n\t\tvalue: unknown,\n\t\tfailures: IValidationFailure[],\n\t\tfieldNameResource?: string\n\t): value is string {\n\t\tif (!Is.stringValue(value)) {\n\t\t\tfailures.push({\n\t\t\t\tproperty,\n\t\t\t\treason: \"validation.beNotEmpty\",\n\t\t\t\tproperties: { fieldName: fieldNameResource ?? \"validation.defaultFieldName\", value }\n\t\t\t});\n\n\t\t\treturn false;\n\t\t}\n\n\t\tconst result = Urn.tryParseExact(value);\n\n\t\tif (Is.undefined(result)) {\n\t\t\tfailures.push({\n\t\t\t\tproperty,\n\t\t\t\treason: \"validation.beUrn\",\n\t\t\t\tproperties: { fieldName: fieldNameResource ?? \"validation.defaultFieldName\", value }\n\t\t\t});\n\n\t\t\treturn false;\n\t\t}\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * Get the parts.\n\t * @param startIndex The index to start from, defaults to 0.\n\t * @returns The parts.\n\t */\n\tpublic parts(startIndex: number = 0): string[] {\n\t\treturn this._urnParts.slice(startIndex);\n\t}\n\n\t/**\n\t * Get the namespace identifier.\n\t * @returns The namespace identifier.\n\t */\n\tpublic namespaceIdentifier(): string {\n\t\treturn this._urnParts[0];\n\t}\n\n\t/**\n\t * Get the namespace method, the first component after the identifier.\n\t * @returns The namespace method.\n\t */\n\tpublic namespaceMethod(): string {\n\t\treturn this._urnParts.length > 1 ? this._urnParts[1] : \"\";\n\t}\n\n\t/**\n\t * Get the namespace specific parts.\n\t * @param startIndex The index to start from, defaults to 0.\n\t * @returns The namespace specific parts.\n\t */\n\tpublic namespaceSpecificParts(startIndex: number = 0): string[] {\n\t\treturn this._urnParts.length > 1 ? this._urnParts.slice(startIndex + 1) : [];\n\t}\n\n\t/**\n\t * Get the namespace specific.\n\t * @param startIndex The index to start from, defaults to 0.\n\t * @returns The namespace specific.\n\t */\n\tpublic namespaceSpecific(startIndex: number = 0): string {\n\t\treturn this._urnParts.length > 1 ? this._urnParts.slice(startIndex + 1).join(\":\") : \"\";\n\t}\n\n\t/**\n\t * Convert the parts in to a full string.\n\t * @param omitPrefix Omit the urn: prefix from the string.\n\t * @returns The formatted urn.\n\t */\n\tpublic toString(omitPrefix: boolean = true): string {\n\t\treturn omitPrefix ? this._urnParts.join(\":\") : `urn:${this._urnParts.join(\":\")}`;\n\t}\n\n\t/**\n\t * Strip the leading and trailing colons from a string.\n\t * @param val The value to strip.\n\t * @returns The stripped string.\n\t * @internal\n\t */\n\tprivate stripColons(val: string): string {\n\t\treturn val.replace(/^:?(.*?):?$/, \"$1\");\n\t}\n}\n"]}