@twin.org/web 0.0.2-next.8 → 0.0.3-next.1

package/dist/es/utils/jwt.js

@@ -0,0 +1,243 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Converter, GeneralError, Guards, Is, ObjectHelper } from "@twin.org/core";
+import { Ed25519 } from "@twin.org/crypto";
+import { jwtVerify, SignJWT } from "jose";
+/**
+ * Class to handle JSON Web Tokens.
+ */
+export class Jwt {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Jwt";
+    /**
+     * Encode a token.
+     * @param header The header to encode.
+     * @param payload The payload to encode.
+     * @param key The key for signing the token, can be omitted if a signer is provided.
+     * @returns The encoded token.
+     */
+    static async encode(header, payload, key) {
+        Guards.object(Jwt.CLASS_NAME, "header", header);
+        Guards.object(Jwt.CLASS_NAME, "payload", payload);
+        Guards.defined(Jwt.CLASS_NAME, "key", key);
+        return Jwt.internalEncode(header, payload, key);
+    }
+    /**
+     * Encode a token.
+     * @param header The header to encode.
+     * @param payload The payload to encode.
+     * @param signer Custom signer method.
+     * @returns The encoded token.
+     */
+    static async encodeWithSigner(header, payload, signer) {
+        Guards.object(Jwt.CLASS_NAME, "header", header);
+        Guards.stringValue(Jwt.CLASS_NAME, "header.alg", header.alg);
+        Guards.object(Jwt.CLASS_NAME, "payload", payload);
+        Guards.function(Jwt.CLASS_NAME, "signer", signer);
+        return Jwt.internalEncode(header, payload, undefined, signer);
+    }
+    /**
+     * Decode a token.
+     * @param token The token to decode.
+     * @returns The decoded payload.
+     */
+    static async decode(token) {
+        Guards.stringValue(Jwt.CLASS_NAME, "token", token);
+        let header;
+        let payload;
+        let signature;
+        const segments = token.split(".");
+        if (segments.length > 0) {
+            try {
+                const bytesHeader = Converter.base64UrlToBytes(segments[0]);
+                header = JSON.parse(Converter.bytesToUtf8(bytesHeader));
+            }
+            catch { }
+        }
+        if (segments.length > 1) {
+            try {
+                const bytesPayload = Converter.base64UrlToBytes(segments[1]);
+                payload = JSON.parse(Converter.bytesToUtf8(bytesPayload));
+            }
+            catch { }
+        }
+        if (segments.length > 2) {
+            signature = Converter.base64UrlToBytes(segments[2]);
+        }
+        return {
+            header,
+            payload,
+            signature
+        };
+    }
+    /**
+     * Verify a token.
+     * @param token The token to verify.
+     * @param key The key for verifying the token
+     * @returns The decoded payload.
+     */
+    static async verify(token, key) {
+        Guards.stringValue(Jwt.CLASS_NAME, "token", token);
+        Guards.defined(Jwt.CLASS_NAME, "key", key);
+        return Jwt.verifySignature(token, key);
+    }
+    /**
+     * Verify a token.
+     * @param token The token to verify.
+     * @param verifier Custom verification method.
+     * @returns The decoded payload.
+     */
+    static async verifyWithVerifier(token, verifier) {
+        Guards.stringValue(Jwt.CLASS_NAME, "token", token);
+        Guards.function(Jwt.CLASS_NAME, "verifier", verifier);
+        return Jwt.verifySignature(token, undefined, verifier);
+    }
+    /**
+     * Verify a token by parts.
+     * @param token The token to verify.
+     * @param key The key for verifying the token, if not provided no verification occurs.
+     * @param verifier Custom verification method.
+     * @returns True if the parts are verified.
+     */
+    static async verifySignature(token, key, verifier) {
+        Guards.stringValue(Jwt.CLASS_NAME, "token", token);
+        const hasKey = Is.notEmpty(key);
+        const hasVerifier = Is.notEmpty(verifier);
+        if (!hasKey && !hasVerifier) {
+            throw new GeneralError(Jwt.CLASS_NAME, "noKeyOrVerifier");
+        }
+        verifier ??= async (t, k) => Jwt.defaultVerifier(t, k);
+        return verifier(token, key);
+    }
+    /**
+     * The default signer for the JWT.
+     * @param header The header to sign.
+     * @param payload The payload to sign.
+     * @param key The optional key to sign with.
+     * @returns The signature.
+     */
+    static async defaultSigner(header, payload, key) {
+        Guards.object(Jwt.CLASS_NAME, "header", header);
+        Guards.object(Jwt.CLASS_NAME, "payload", payload);
+        Guards.defined(Jwt.CLASS_NAME, "key", key);
+        const signer = new SignJWT(payload);
+        signer.setProtectedHeader(header);
+        let finalKey = key;
+        if (header.alg === "EdDSA" && Is.uint8Array(key)) {
+            // Jose does not support Ed25519 keys in raw format, so we need to convert it to PKCS8.
+            finalKey = await Ed25519.privateKeyToPkcs8(key);
+        }
+        return signer.sign(finalKey);
+    }
+    /**
+     * The default verifier for the JWT.
+     * @param token The token to verify.
+     * @param key The key to verify with.
+     * @returns The header and payload if verification successful.
+     */
+    static async defaultVerifier(token, key) {
+        Guards.stringValue(Jwt.CLASS_NAME, "token", token);
+        Guards.defined(Jwt.CLASS_NAME, "key", key);
+        try {
+            const result = await jwtVerify(token, key);
+            return {
+                header: result.protectedHeader,
+                payload: result.payload
+            };
+        }
+        catch (err) {
+            throw new GeneralError(Jwt.CLASS_NAME, "verifyFailed", undefined, err);
+        }
+    }
+    /**
+     * Create bytes for signing from header and payload.
+     * @param header The header.
+     * @param payload The payload.
+     * @returns The bytes to sign.
+     */
+    static toSigningBytes(header, payload) {
+        Guards.object(Jwt.CLASS_NAME, "header", header);
+        Guards.object(Jwt.CLASS_NAME, "payload", payload);
+        const segments = [];
+        const headerBytes = Converter.utf8ToBytes(JSON.stringify(header));
+        segments.push(Converter.bytesToBase64Url(headerBytes));
+        const payloadBytes = Converter.utf8ToBytes(JSON.stringify(payload));
+        segments.push(Converter.bytesToBase64Url(payloadBytes));
+        return Converter.utf8ToBytes(segments.join("."));
+    }
+    /**
+     * Create header and payload from signing bytes.
+     * @param signingBytes The signing bytes from a token.
+     * @returns The header and payload.
+     * @throws If the signing bytes are invalid
+     */
+    static fromSigningBytes(signingBytes) {
+        Guards.uint8Array(Jwt.CLASS_NAME, "signingBytes", signingBytes);
+        const segments = Converter.bytesToUtf8(signingBytes).split(".");
+        if (segments.length !== 2) {
+            throw new GeneralError(Jwt.CLASS_NAME, "invalidSigningBytes");
+        }
+        const headerBytes = Converter.base64UrlToBytes(segments[0]);
+        const payloadBytes = Converter.base64UrlToBytes(segments[1]);
+        return {
+            header: ObjectHelper.fromBytes(headerBytes),
+            payload: ObjectHelper.fromBytes(payloadBytes)
+        };
+    }
+    /**
+     * Convert signed bytes and signature bytes to token.
+     * @param signingBytes The signed bytes.
+     * @param signature The signature.
+     * @returns The token.
+     */
+    static tokenFromBytes(signingBytes, signature) {
+        Guards.uint8Array(Jwt.CLASS_NAME, "signingBytes", signingBytes);
+        Guards.uint8Array(Jwt.CLASS_NAME, "signature", signature);
+        const signedBytesUtf8 = Converter.bytesToUtf8(signingBytes);
+        const signatureBase64 = Converter.bytesToBase64Url(signature);
+        return `${signedBytesUtf8}.${signatureBase64}`;
+    }
+    /**
+     * Convert the token to signing bytes and signature bytes.
+     * @param token The token to convert to bytes.
+     * @returns The decoded bytes.
+     * @throws If the token is invalid.
+     */
+    static tokenToBytes(token) {
+        Guards.stringValue(Jwt.CLASS_NAME, "token", token);
+        const segments = token.split(".");
+        if (segments.length !== 3) {
+            throw new GeneralError(Jwt.CLASS_NAME, "invalidTokenParts");
+        }
+        const signingBytes = Converter.utf8ToBytes(`${segments[0]}.${segments[1]}`);
+        const signature = Converter.base64UrlToBytes(segments[2]);
+        return {
+            signingBytes,
+            signature
+        };
+    }
+    /**
+     * Encode a token.
+     * @param header The header to encode.
+     * @param payload The payload to encode.
+     * @param key The key for signing the token, can be omitted if a signer is provided.
+     * @param signer Custom signer method.
+     * @returns The encoded token.
+     * @internal
+     */
+    static async internalEncode(header, payload, key, signer) {
+        const hasKey = Is.notEmpty(key);
+        const hasSigner = Is.notEmpty(signer);
+        if (!hasKey && !hasSigner) {
+            throw new GeneralError(Jwt.CLASS_NAME, "noKeyOrSigner");
+        }
+        signer ??= async (h, p, k) => Jwt.defaultSigner(h, p, k);
+        if (Is.undefined(header.typ)) {
+            header.typ = "JWT";
+        }
+        return signer(header, payload, key);
+    }
+}
+//# sourceMappingURL=jwt.js.map

package/dist/es/utils/jwt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jwt.js","sourceRoot":"","sources":["../../../src/utils/jwt.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAK1C;;GAEG;AACH,MAAM,OAAO,GAAG;IACf;;OAEG;IACI,MAAM,CAAU,UAAU,SAAyB;IAE1D;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,MAAS,EACT,OAAU,EACV,GAAiB;QAEjB,MAAM,CAAC,MAAM,CAAa,GAAG,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAc,GAAG,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACrE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEjD,OAAO,GAAG,CAAC,cAAc,CAAO,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CACnC,MAAS,EACT,OAAU,EACV,MAIoB;QAEpB,MAAM,CAAC,MAAM,CAAa,GAAG,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAClE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,gBAAsB,MAAM,CAAC,GAAG,CAAC,CAAC;QAEnE,MAAM,CAAC,MAAM,CAAc,GAAG,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACrE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAExD,OAAO,GAAG,CAAC,cAAc,CAAO,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,KAAa;QAMb,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAEzD,IAAI,MAAqB,CAAC;QAC1B,IAAI,OAAsB,CAAC;QAC3B,IAAI,SAAiC,CAAC;QAEtC,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC;gBACJ,MAAM,WAAW,GAAG,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5D,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC;YACzD,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;QACX,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC;gBACJ,MAAM,YAAY,GAAG,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC7D,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;YAC3D,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;QACX,CAAC;QAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,SAAS,GAAG,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;QAED,OAAO;YACN,MAAM;YACN,OAAO;YACP,SAAS;SACT,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,KAAa,EACb,GAAiB;QAKjB,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEjD,OAAO,GAAG,CAAC,eAAe,CAAO,KAAK,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CACrC,KAAa,EACb,QAME;QAKF,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAE5D,OAAO,GAAG,CAAC,eAAe,CAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAClC,KAAa,EACb,GAAkB,EAClB,QAME;QAKF,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,WAAW,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1C,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAC7B,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAC3D,CAAC;QAED,QAAQ,KAAK,KAAK,EACjB,CAAC,EACD,CAAC,EAIC,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAEhC,OAAO,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAChC,MAAkB,EAClB,OAAoB,EACpB,GAA6B;QAE7B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEjD,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAElC,IAAI,QAAQ,GAAG,GAAG,CAAC;QACnB,IAAI,MAAM,CAAC,GAAG,KAAK,OAAO,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAClD,uFAAuF;YACvF,QAAQ,GAAG,MAAM,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAClC,KAAa,EACb,GAA6B;QAK7B,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QACzD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEjD,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAC3C,OAAO;gBACN,MAAM,EAAE,MAAM,CAAC,eAAoB;gBACnC,OAAO,EAAE,MAAM,CAAC,OAAY;aAC5B,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;QACxE,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAC3B,MAAS,EACT,OAAU;QAEV,MAAM,CAAC,MAAM,CAAI,GAAG,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,MAAM,CAAI,GAAG,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE3D,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,MAAM,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QAClE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC,CAAC;QAEvD,MAAM,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACpE,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;QAExD,OAAO,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAC7B,YAAwB;QAKxB,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QAEtE,MAAM,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChE,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,WAAW,GAAG,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,YAAY,GAAG,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7D,OAAO;YACN,MAAM,EAAE,YAAY,CAAC,SAAS,CAAI,WAAW,CAAC;YAC9C,OAAO,EAAE,YAAY,CAAC,SAAS,CAAI,YAAY,CAAC;SAChD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,YAAwB,EAAE,SAAqB;QAC3E,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,kBAAwB,YAAY,CAAC,CAAC;QACtE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAChE,MAAM,eAAe,GAAG,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAC5D,MAAM,eAAe,GAAG,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;QAC9D,OAAO,GAAG,eAAe,IAAI,eAAe,EAAE,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,KAAa;QAIvC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAEzD,MAAM,QAAQ,GAAa,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5E,MAAM,SAAS,GAAG,SAAS,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1D,OAAO;YACN,YAAY;YACZ,SAAS;SACT,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,KAAK,CAAC,cAAc,CAClC,MAAS,EACT,OAAU,EACV,GAAkB,EAClB,MAIoB;QAEpB,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QACzD,CAAC;QAED,MAAM,KAAK,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAmB,EAAE,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAE1E,IAAI,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,CAAC,GAAG,GAAG,KAAK,CAAC;QACpB,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACrC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, GeneralError, Guards, Is, ObjectHelper } from \"@twin.org/core\";\nimport { Ed25519 } from \"@twin.org/crypto\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { jwtVerify, SignJWT } from \"jose\";\nimport type { IJwtHeader } from \"../models/IJwtHeader.js\";\nimport type { IJwtPayload } from \"../models/IJwtPayload.js\";\nimport type { JwkCryptoKey } from \"../models/jwkCryptoKey.js\";\n\n/**\n * Class to handle JSON Web Tokens.\n */\nexport class Jwt {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Jwt>();\n\n\t/**\n\t * Encode a token.\n\t * @param header The header to encode.\n\t * @param payload The payload to encode.\n\t * @param key The key for signing the token, can be omitted if a signer is provided.\n\t * @returns The encoded token.\n\t */\n\tpublic static async encode<T extends IJwtHeader, U extends IJwtPayload>(\n\t\theader: T,\n\t\tpayload: U,\n\t\tkey: JwkCryptoKey\n\t): Promise<string> {\n\t\tGuards.object<IJwtHeader>(Jwt.CLASS_NAME, nameof(header), header);\n\t\tGuards.object<IJwtPayload>(Jwt.CLASS_NAME, nameof(payload), payload);\n\t\tGuards.defined(Jwt.CLASS_NAME, nameof(key), key);\n\n\t\treturn Jwt.internalEncode<T, U>(header, payload, key);\n\t}\n\n\t/**\n\t * Encode a token.\n\t * @param header The header to encode.\n\t * @param payload The payload to encode.\n\t * @param signer Custom signer method.\n\t * @returns The encoded token.\n\t */\n\tpublic static async encodeWithSigner<T extends IJwtHeader, U extends IJwtPayload>(\n\t\theader: T,\n\t\tpayload: U,\n\t\tsigner: (\n\t\t\theader: IJwtHeader,\n\t\t\tpayload: IJwtPayload,\n\t\t\tkey: JwkCryptoKey | undefined\n\t\t) => Promise<string>\n\t): Promise<string> {\n\t\tGuards.object<IJwtHeader>(Jwt.CLASS_NAME, nameof(header), header);\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(header.alg), header.alg);\n\n\t\tGuards.object<IJwtPayload>(Jwt.CLASS_NAME, nameof(payload), payload);\n\t\tGuards.function(Jwt.CLASS_NAME, nameof(signer), signer);\n\n\t\treturn Jwt.internalEncode<T, U>(header, payload, undefined, signer);\n\t}\n\n\t/**\n\t * Decode a token.\n\t * @param token The token to decode.\n\t * @returns The decoded payload.\n\t */\n\tpublic static async decode<T extends IJwtHeader, U extends IJwtPayload>(\n\t\ttoken: string\n\t): Promise<{\n\t\theader?: T;\n\t\tpayload?: U;\n\t\tsignature?: Uint8Array;\n\t}> {\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(token), token);\n\n\t\tlet header: T | undefined;\n\t\tlet payload: U | undefined;\n\t\tlet signature: Uint8Array | undefined;\n\n\t\tconst segments = token.split(\".\");\n\t\tif (segments.length > 0) {\n\t\t\ttry {\n\t\t\t\tconst bytesHeader = Converter.base64UrlToBytes(segments[0]);\n\t\t\t\theader = JSON.parse(Converter.bytesToUtf8(bytesHeader));\n\t\t\t} catch {}\n\t\t}\n\n\t\tif (segments.length > 1) {\n\t\t\ttry {\n\t\t\t\tconst bytesPayload = Converter.base64UrlToBytes(segments[1]);\n\t\t\t\tpayload = JSON.parse(Converter.bytesToUtf8(bytesPayload));\n\t\t\t} catch {}\n\t\t}\n\n\t\tif (segments.length > 2) {\n\t\t\tsignature = Converter.base64UrlToBytes(segments[2]);\n\t\t}\n\n\t\treturn {\n\t\t\theader,\n\t\t\tpayload,\n\t\t\tsignature\n\t\t};\n\t}\n\n\t/**\n\t * Verify a token.\n\t * @param token The token to verify.\n\t * @param key The key for verifying the token\n\t * @returns The decoded payload.\n\t */\n\tpublic static async verify<T extends IJwtHeader, U extends IJwtPayload>(\n\t\ttoken: string,\n\t\tkey: JwkCryptoKey\n\t): Promise<{\n\t\theader: T;\n\t\tpayload: U;\n\t}> {\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(token), token);\n\t\tGuards.defined(Jwt.CLASS_NAME, nameof(key), key);\n\n\t\treturn Jwt.verifySignature<T, U>(token, key);\n\t}\n\n\t/**\n\t * Verify a token.\n\t * @param token The token to verify.\n\t * @param verifier Custom verification method.\n\t * @returns The decoded payload.\n\t */\n\tpublic static async verifyWithVerifier<T extends IJwtHeader, U extends IJwtPayload>(\n\t\ttoken: string,\n\t\tverifier: (\n\t\t\ttoken: string,\n\t\t\tkey: JwkCryptoKey | undefined\n\t\t) => Promise<{\n\t\t\theader: T;\n\t\t\tpayload: U;\n\t\t}>\n\t): Promise<{\n\t\theader: T;\n\t\tpayload: U;\n\t}> {\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(token), token);\n\t\tGuards.function(Jwt.CLASS_NAME, nameof(verifier), verifier);\n\n\t\treturn Jwt.verifySignature<T, U>(token, undefined, verifier);\n\t}\n\n\t/**\n\t * Verify a token by parts.\n\t * @param token The token to verify.\n\t * @param key The key for verifying the token, if not provided no verification occurs.\n\t * @param verifier Custom verification method.\n\t * @returns True if the parts are verified.\n\t */\n\tpublic static async verifySignature<T extends IJwtHeader, U extends IJwtPayload>(\n\t\ttoken: string,\n\t\tkey?: JwkCryptoKey,\n\t\tverifier?: (\n\t\t\ttoken: string,\n\t\t\tkey: JwkCryptoKey | undefined\n\t\t) => Promise<{\n\t\t\theader: T;\n\t\t\tpayload: U;\n\t\t}>\n\t): Promise<{\n\t\theader: T;\n\t\tpayload: U;\n\t}> {\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(token), token);\n\t\tconst hasKey = Is.notEmpty(key);\n\t\tconst hasVerifier = Is.notEmpty(verifier);\n\t\tif (!hasKey && !hasVerifier) {\n\t\t\tthrow new GeneralError(Jwt.CLASS_NAME, \"noKeyOrVerifier\");\n\t\t}\n\n\t\tverifier ??= async (\n\t\t\tt,\n\t\t\tk\n\t\t): Promise<{\n\t\t\theader: T;\n\t\t\tpayload: U;\n\t\t}> => Jwt.defaultVerifier(t, k);\n\n\t\treturn verifier(token, key);\n\t}\n\n\t/**\n\t * The default signer for the JWT.\n\t * @param header The header to sign.\n\t * @param payload The payload to sign.\n\t * @param key The optional key to sign with.\n\t * @returns The signature.\n\t */\n\tpublic static async defaultSigner(\n\t\theader: IJwtHeader,\n\t\tpayload: IJwtPayload,\n\t\tkey: JwkCryptoKey | undefined\n\t): Promise<string> {\n\t\tGuards.object(Jwt.CLASS_NAME, nameof(header), header);\n\t\tGuards.object(Jwt.CLASS_NAME, nameof(payload), payload);\n\t\tGuards.defined(Jwt.CLASS_NAME, nameof(key), key);\n\n\t\tconst signer = new SignJWT(payload);\n\t\tsigner.setProtectedHeader(header);\n\n\t\tlet finalKey = key;\n\t\tif (header.alg === \"EdDSA\" && Is.uint8Array(key)) {\n\t\t\t// Jose does not support Ed25519 keys in raw format, so we need to convert it to PKCS8.\n\t\t\tfinalKey = await Ed25519.privateKeyToPkcs8(key);\n\t\t}\n\t\treturn signer.sign(finalKey);\n\t}\n\n\t/**\n\t * The default verifier for the JWT.\n\t * @param token The token to verify.\n\t * @param key The key to verify with.\n\t * @returns The header and payload if verification successful.\n\t */\n\tpublic static async defaultVerifier<T extends IJwtHeader, U extends IJwtPayload>(\n\t\ttoken: string,\n\t\tkey: JwkCryptoKey | undefined\n\t): Promise<{\n\t\theader: T;\n\t\tpayload: U;\n\t}> {\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(token), token);\n\t\tGuards.defined(Jwt.CLASS_NAME, nameof(key), key);\n\n\t\ttry {\n\t\t\tconst result = await jwtVerify(token, key);\n\t\t\treturn {\n\t\t\t\theader: result.protectedHeader as T,\n\t\t\t\tpayload: result.payload as U\n\t\t\t};\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(Jwt.CLASS_NAME, \"verifyFailed\", undefined, err);\n\t\t}\n\t}\n\n\t/**\n\t * Create bytes for signing from header and payload.\n\t * @param header The header.\n\t * @param payload The payload.\n\t * @returns The bytes to sign.\n\t */\n\tpublic static toSigningBytes<T extends IJwtHeader, U extends IJwtPayload>(\n\t\theader: T,\n\t\tpayload: U\n\t): Uint8Array {\n\t\tGuards.object<T>(Jwt.CLASS_NAME, nameof(header), header);\n\t\tGuards.object<U>(Jwt.CLASS_NAME, nameof(payload), payload);\n\n\t\tconst segments: string[] = [];\n\n\t\tconst headerBytes = Converter.utf8ToBytes(JSON.stringify(header));\n\t\tsegments.push(Converter.bytesToBase64Url(headerBytes));\n\n\t\tconst payloadBytes = Converter.utf8ToBytes(JSON.stringify(payload));\n\t\tsegments.push(Converter.bytesToBase64Url(payloadBytes));\n\n\t\treturn Converter.utf8ToBytes(segments.join(\".\"));\n\t}\n\n\t/**\n\t * Create header and payload from signing bytes.\n\t * @param signingBytes The signing bytes from a token.\n\t * @returns The header and payload.\n\t * @throws If the signing bytes are invalid\n\t */\n\tpublic static fromSigningBytes<T extends IJwtHeader, U extends IJwtPayload>(\n\t\tsigningBytes: Uint8Array\n\t): {\n\t\theader: T;\n\t\tpayload: U;\n\t} {\n\t\tGuards.uint8Array(Jwt.CLASS_NAME, nameof(signingBytes), signingBytes);\n\n\t\tconst segments = Converter.bytesToUtf8(signingBytes).split(\".\");\n\t\tif (segments.length !== 2) {\n\t\t\tthrow new GeneralError(Jwt.CLASS_NAME, \"invalidSigningBytes\");\n\t\t}\n\n\t\tconst headerBytes = Converter.base64UrlToBytes(segments[0]);\n\t\tconst payloadBytes = Converter.base64UrlToBytes(segments[1]);\n\n\t\treturn {\n\t\t\theader: ObjectHelper.fromBytes<T>(headerBytes),\n\t\t\tpayload: ObjectHelper.fromBytes<U>(payloadBytes)\n\t\t};\n\t}\n\n\t/**\n\t * Convert signed bytes and signature bytes to token.\n\t * @param signingBytes The signed bytes.\n\t * @param signature The signature.\n\t * @returns The token.\n\t */\n\tpublic static tokenFromBytes(signingBytes: Uint8Array, signature: Uint8Array): string {\n\t\tGuards.uint8Array(Jwt.CLASS_NAME, nameof(signingBytes), signingBytes);\n\t\tGuards.uint8Array(Jwt.CLASS_NAME, nameof(signature), signature);\n\t\tconst signedBytesUtf8 = Converter.bytesToUtf8(signingBytes);\n\t\tconst signatureBase64 = Converter.bytesToBase64Url(signature);\n\t\treturn `${signedBytesUtf8}.${signatureBase64}`;\n\t}\n\n\t/**\n\t * Convert the token to signing bytes and signature bytes.\n\t * @param token The token to convert to bytes.\n\t * @returns The decoded bytes.\n\t * @throws If the token is invalid.\n\t */\n\tpublic static tokenToBytes(token: string): {\n\t\tsigningBytes: Uint8Array;\n\t\tsignature: Uint8Array;\n\t} {\n\t\tGuards.stringValue(Jwt.CLASS_NAME, nameof(token), token);\n\n\t\tconst segments: string[] = token.split(\".\");\n\n\t\tif (segments.length !== 3) {\n\t\t\tthrow new GeneralError(Jwt.CLASS_NAME, \"invalidTokenParts\");\n\t\t}\n\n\t\tconst signingBytes = Converter.utf8ToBytes(`${segments[0]}.${segments[1]}`);\n\t\tconst signature = Converter.base64UrlToBytes(segments[2]);\n\n\t\treturn {\n\t\t\tsigningBytes,\n\t\t\tsignature\n\t\t};\n\t}\n\n\t/**\n\t * Encode a token.\n\t * @param header The header to encode.\n\t * @param payload The payload to encode.\n\t * @param key The key for signing the token, can be omitted if a signer is provided.\n\t * @param signer Custom signer method.\n\t * @returns The encoded token.\n\t * @internal\n\t */\n\tprivate static async internalEncode<T extends IJwtHeader, U extends IJwtPayload>(\n\t\theader: T,\n\t\tpayload: U,\n\t\tkey?: JwkCryptoKey,\n\t\tsigner?: (\n\t\t\theader: IJwtHeader,\n\t\t\tpayload: IJwtPayload,\n\t\t\tkey: JwkCryptoKey | undefined\n\t\t) => Promise<string>\n\t): Promise<string> {\n\t\tconst hasKey = Is.notEmpty(key);\n\t\tconst hasSigner = Is.notEmpty(signer);\n\t\tif (!hasKey && !hasSigner) {\n\t\t\tthrow new GeneralError(Jwt.CLASS_NAME, \"noKeyOrSigner\");\n\t\t}\n\n\t\tsigner ??= async (h, p, k): Promise<string> => Jwt.defaultSigner(h, p, k);\n\n\t\tif (Is.undefined(header.typ)) {\n\t\t\theader.typ = \"JWT\";\n\t\t}\n\n\t\treturn signer(header, payload, key);\n\t}\n}\n"]}

package/dist/es/utils/mimeTypeHelper.js

@@ -0,0 +1,144 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Converter, Is, StringHelper } from "@twin.org/core";
+import { MimeTypes } from "../models/mimeTypes.js";
+/**
+ * Class to help with mime types.
+ */
+export class MimeTypeHelper {
+    /**
+     * Detect the mime type from a byte array.
+     * @param data The data to test.
+     * @returns The mime type if detected.
+     */
+    static async detect(data) {
+        if (!Is.uint8Array(data) || data.length === 0) {
+            return undefined;
+        }
+        // Image
+        if (MimeTypeHelper.checkBytes(data, [0x47, 0x49, 0x46])) {
+            return MimeTypes.Gif;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0x42, 0x4d])) {
+            return MimeTypes.Bmp;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0xff, 0xd8, 0xff])) {
+            return MimeTypes.Jpeg;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a])) {
+            return MimeTypes.Png;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0x49, 0x49, 0x2a, 0x00]) ||
+            MimeTypeHelper.checkBytes(data, [0x4d, 0x4d, 0x00, 0x2a])) {
+            return MimeTypes.Tiff;
+        }
+        // Compression
+        if (MimeTypeHelper.checkBytes(data, [0x1f, 0x8b, 0x8])) {
+            return MimeTypes.Gzip;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0x78, 0x01]) ||
+            MimeTypeHelper.checkBytes(data, [0x78, 0x9c]) ||
+            MimeTypeHelper.checkBytes(data, [0x78, 0xda])) {
+            return MimeTypes.Zlib;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0x42, 0x5a, 0x68])) {
+            return MimeTypes.Bzip2;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0x50, 0x4b, 0x3, 0x4])) {
+            return MimeTypes.Zip;
+        }
+        // Documents
+        if (MimeTypeHelper.checkText(data, ["%PDF"])) {
+            return MimeTypes.Pdf;
+        }
+        // Lookup svg before xml, as svg are xml files as well
+        const asText = Converter.bytesToUtf8(data);
+        if (asText.includes("<svg")) {
+            return MimeTypes.Svg;
+        }
+        if (MimeTypeHelper.checkText(data, ["<?xml ", "<message"])) {
+            return MimeTypes.Xml;
+        }
+        if (MimeTypeHelper.checkBytes(data, [0xef, 0xbb, 0xbf]) &&
+            MimeTypeHelper.checkText(data, ["<?xml "], 3)) {
+            // UTF-8-BOM
+            return MimeTypes.Xml;
+        }
+        if (StringHelper.isUtf8(data)) {
+            try {
+                JSON.parse(new TextDecoder().decode(data));
+                return MimeTypes.Json;
+            }
+            catch {
+                return MimeTypes.PlainText;
+            }
+        }
+    }
+    /**
+     * Return the default extension for a mime type.
+     * @param mimeType The mimetype to get the extension for.
+     * @returns The extension for the mime type.
+     */
+    static defaultExtension(mimeType) {
+        if (!Is.stringValue(mimeType)) {
+            return undefined;
+        }
+        const lookup = {
+            [MimeTypes.PlainText]: "txt",
+            [MimeTypes.Html]: "html",
+            [MimeTypes.Javascript]: "js",
+            [MimeTypes.Json]: "json",
+            [MimeTypes.JsonLd]: "jsonld",
+            [MimeTypes.Jwt]: "jwt",
+            [MimeTypes.Xml]: "xml",
+            [MimeTypes.OctetStream]: "bin",
+            [MimeTypes.Gzip]: "gzip",
+            [MimeTypes.Zlib]: "zlib",
+            [MimeTypes.Bzip2]: "bz2",
+            [MimeTypes.Zip]: "zip",
+            [MimeTypes.Pdf]: "pdf",
+            [MimeTypes.Gif]: "gif",
+            [MimeTypes.Bmp]: "bmp",
+            [MimeTypes.Jpeg]: "jpeg",
+            [MimeTypes.Png]: "png",
+            [MimeTypes.Tiff]: "tif",
+            [MimeTypes.Svg]: "svg",
+            [MimeTypes.WebP]: "webp",
+            [MimeTypes.Mp4]: "mp4",
+            [MimeTypes.Mpeg]: "mpg",
+            [MimeTypes.Webm]: "webm"
+        };
+        return lookup[mimeType];
+    }
+    /**
+     * Check if the bytes match.
+     * @param data The data to look at.
+     * @param bytes The bytes to try and match.
+     * @param startOffset Start offset in the data.
+     * @returns True if the bytes match.
+     * @internal
+     */
+    static checkBytes(data, bytes, startOffset = 0) {
+        if (data.length - startOffset < bytes.length) {
+            return false;
+        }
+        for (let i = 0; i < bytes.length; i++) {
+            if (data[i + startOffset] !== bytes[i]) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Check if the text matches.
+     * @param data The data to look at.
+     * @param texts The text to try and match.
+     * @param startOffset Start offset in the data.
+     * @returns True if the bytes match.
+     * @internal
+     */
+    static checkText(data, texts, startOffset = 0) {
+        return texts.some(text => MimeTypeHelper.checkBytes(data, Array.from(Converter.utf8ToBytes(text)), startOffset));
+    }
+}
+//# sourceMappingURL=mimeTypeHelper.js.map

package/dist/es/utils/mimeTypeHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mimeTypeHelper.js","sourceRoot":"","sources":["../../../src/utils/mimeTypeHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAgB;QAC1C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,QAAQ;QACR,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACzD,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACnD,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QACD,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACzD,OAAO,SAAS,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACvF,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,IACC,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACzD,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EACxD,CAAC;YACF,OAAO,SAAS,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,cAAc;QACd,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACxD,OAAO,SAAS,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,IACC,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC7C,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC7C,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAC5C,CAAC;YACF,OAAO,SAAS,CAAC,IAAI,CAAC;QACvB,CAAC;QAED,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;YACzD,OAAO,SAAS,CAAC,KAAK,CAAC;QACxB,CAAC;QAED,IAAI,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YAC7D,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,YAAY;QACZ,IAAI,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YAC9C,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,sDAAsD;QACtD,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,IAAI,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;YAC5D,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,IACC,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;YACnD,cAAc,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAC5C,CAAC;YACF,YAAY;YACZ,OAAO,SAAS,CAAC,GAAG,CAAC;QACtB,CAAC;QAED,IAAI,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC;gBACJ,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3C,OAAO,SAAS,CAAC,IAAI,CAAC;YACvB,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,SAAS,CAAC,SAAS,CAAC;YAC5B,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,QAA4B;QAC1D,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,MAAM,MAAM,GAAmC;YAC9C,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,KAAK;YAC5B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;YACxB,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,IAAI;YAC5B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;YACxB,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,QAAQ;YAC5B,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,KAAK;YAC9B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;YACxB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;YACxB,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,KAAK;YACxB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;YACxB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK;YACvB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;YACxB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK;YACtB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,KAAK;YACvB,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM;SACxB,CAAC;QAEF,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,UAAU,CAAC,IAAgB,EAAE,KAAe,EAAE,WAAW,GAAG,CAAC;QAC3E,IAAI,IAAI,CAAC,MAAM,GAAG,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;YAC9C,OAAO,KAAK,CAAC;QACd,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxC,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,SAAS,CAAC,IAAgB,EAAE,KAAe,EAAE,WAAW,GAAG,CAAC;QAC1E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACxB,cAAc,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,CACrF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, Is, StringHelper } from \"@twin.org/core\";\nimport { MimeTypes } from \"../models/mimeTypes.js\";\n\n/**\n * Class to help with mime types.\n */\nexport class MimeTypeHelper {\n\t/**\n\t * Detect the mime type from a byte array.\n\t * @param data The data to test.\n\t * @returns The mime type if detected.\n\t */\n\tpublic static async detect(data: Uint8Array): Promise<string | undefined> {\n\t\tif (!Is.uint8Array(data) || data.length === 0) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\t// Image\n\t\tif (MimeTypeHelper.checkBytes(data, [0x47, 0x49, 0x46])) {\n\t\t\treturn MimeTypes.Gif;\n\t\t}\n\n\t\tif (MimeTypeHelper.checkBytes(data, [0x42, 0x4d])) {\n\t\t\treturn MimeTypes.Bmp;\n\t\t}\n\t\tif (MimeTypeHelper.checkBytes(data, [0xff, 0xd8, 0xff])) {\n\t\t\treturn MimeTypes.Jpeg;\n\t\t}\n\n\t\tif (MimeTypeHelper.checkBytes(data, [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a])) {\n\t\t\treturn MimeTypes.Png;\n\t\t}\n\n\t\tif (\n\t\t\tMimeTypeHelper.checkBytes(data, [0x49, 0x49, 0x2a, 0x00]) ||\n\t\t\tMimeTypeHelper.checkBytes(data, [0x4d, 0x4d, 0x00, 0x2a])\n\t\t) {\n\t\t\treturn MimeTypes.Tiff;\n\t\t}\n\n\t\t// Compression\n\t\tif (MimeTypeHelper.checkBytes(data, [0x1f, 0x8b, 0x8])) {\n\t\t\treturn MimeTypes.Gzip;\n\t\t}\n\n\t\tif (\n\t\t\tMimeTypeHelper.checkBytes(data, [0x78, 0x01]) ||\n\t\t\tMimeTypeHelper.checkBytes(data, [0x78, 0x9c]) ||\n\t\t\tMimeTypeHelper.checkBytes(data, [0x78, 0xda])\n\t\t) {\n\t\t\treturn MimeTypes.Zlib;\n\t\t}\n\n\t\tif (MimeTypeHelper.checkBytes(data, [0x42, 0x5a, 0x68])) {\n\t\t\treturn MimeTypes.Bzip2;\n\t\t}\n\n\t\tif (MimeTypeHelper.checkBytes(data, [0x50, 0x4b, 0x3, 0x4])) {\n\t\t\treturn MimeTypes.Zip;\n\t\t}\n\n\t\t// Documents\n\t\tif (MimeTypeHelper.checkText(data, [\"%PDF\"])) {\n\t\t\treturn MimeTypes.Pdf;\n\t\t}\n\n\t\t// Lookup svg before xml, as svg are xml files as well\n\t\tconst asText = Converter.bytesToUtf8(data);\n\t\tif (asText.includes(\"<svg\")) {\n\t\t\treturn MimeTypes.Svg;\n\t\t}\n\n\t\tif (MimeTypeHelper.checkText(data, [\"<?xml \", \"<message\"])) {\n\t\t\treturn MimeTypes.Xml;\n\t\t}\n\n\t\tif (\n\t\t\tMimeTypeHelper.checkBytes(data, [0xef, 0xbb, 0xbf]) &&\n\t\t\tMimeTypeHelper.checkText(data, [\"<?xml \"], 3)\n\t\t) {\n\t\t\t// UTF-8-BOM\n\t\t\treturn MimeTypes.Xml;\n\t\t}\n\n\t\tif (StringHelper.isUtf8(data)) {\n\t\t\ttry {\n\t\t\t\tJSON.parse(new TextDecoder().decode(data));\n\t\t\t\treturn MimeTypes.Json;\n\t\t\t} catch {\n\t\t\t\treturn MimeTypes.PlainText;\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Return the default extension for a mime type.\n\t * @param mimeType The mimetype to get the extension for.\n\t * @returns The extension for the mime type.\n\t */\n\tpublic static defaultExtension(mimeType: string | undefined): string | undefined {\n\t\tif (!Is.stringValue(mimeType)) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst lookup: { [mimeType: string]: string } = {\n\t\t\t[MimeTypes.PlainText]: \"txt\",\n\t\t\t[MimeTypes.Html]: \"html\",\n\t\t\t[MimeTypes.Javascript]: \"js\",\n\t\t\t[MimeTypes.Json]: \"json\",\n\t\t\t[MimeTypes.JsonLd]: \"jsonld\",\n\t\t\t[MimeTypes.Jwt]: \"jwt\",\n\t\t\t[MimeTypes.Xml]: \"xml\",\n\t\t\t[MimeTypes.OctetStream]: \"bin\",\n\t\t\t[MimeTypes.Gzip]: \"gzip\",\n\t\t\t[MimeTypes.Zlib]: \"zlib\",\n\t\t\t[MimeTypes.Bzip2]: \"bz2\",\n\t\t\t[MimeTypes.Zip]: \"zip\",\n\t\t\t[MimeTypes.Pdf]: \"pdf\",\n\t\t\t[MimeTypes.Gif]: \"gif\",\n\t\t\t[MimeTypes.Bmp]: \"bmp\",\n\t\t\t[MimeTypes.Jpeg]: \"jpeg\",\n\t\t\t[MimeTypes.Png]: \"png\",\n\t\t\t[MimeTypes.Tiff]: \"tif\",\n\t\t\t[MimeTypes.Svg]: \"svg\",\n\t\t\t[MimeTypes.WebP]: \"webp\",\n\t\t\t[MimeTypes.Mp4]: \"mp4\",\n\t\t\t[MimeTypes.Mpeg]: \"mpg\",\n\t\t\t[MimeTypes.Webm]: \"webm\"\n\t\t};\n\n\t\treturn lookup[mimeType];\n\t}\n\n\t/**\n\t * Check if the bytes match.\n\t * @param data The data to look at.\n\t * @param bytes The bytes to try and match.\n\t * @param startOffset Start offset in the data.\n\t * @returns True if the bytes match.\n\t * @internal\n\t */\n\tprivate static checkBytes(data: Uint8Array, bytes: number[], startOffset = 0): boolean {\n\t\tif (data.length - startOffset < bytes.length) {\n\t\t\treturn false;\n\t\t}\n\n\t\tfor (let i = 0; i < bytes.length; i++) {\n\t\t\tif (data[i + startOffset] !== bytes[i]) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\n\t\treturn true;\n\t}\n\n\t/**\n\t * Check if the text matches.\n\t * @param data The data to look at.\n\t * @param texts The text to try and match.\n\t * @param startOffset Start offset in the data.\n\t * @returns True if the bytes match.\n\t * @internal\n\t */\n\tprivate static checkText(data: Uint8Array, texts: string[], startOffset = 0): boolean {\n\t\treturn texts.some(text =>\n\t\t\tMimeTypeHelper.checkBytes(data, Array.from(Converter.utf8ToBytes(text)), startOffset)\n\t\t);\n\t}\n}\n"]}

package/dist/types/errors/fetchError.d.ts

@@ -1,5 +1,5 @@
 import { BaseError } from "@twin.org/core";
-import type { HttpStatusCode } from "../models/httpStatusCode";
+import type { HttpStatusCode } from "../models/httpStatusCode.js";
 /**
  * Class to represent errors from fetch.
  */

package/dist/types/index.d.ts

@@ -1,16 +1,17 @@
-export * from "./errors/fetchError";
-export * from "./models/headerTypes";
-export * from "./models/httpMethod";
-export * from "./models/httpStatusCode";
-export * from "./models/IFetchOptions";
-export * from "./models/IHttpHeaders";
-export * from "./models/IJwk";
-export * from "./models/IJwtHeader";
-export * from "./models/IJwtPayload";
-export * from "./models/jwkCryptoKey";
-export * from "./models/mimeTypes";
-export * from "./utils/fetchHelper";
-export * from "./utils/jwk";
-export * from "./utils/jws";
-export * from "./utils/jwt";
-export * from "./utils/mimeTypeHelper";
+export * from "./errors/fetchError.js";
+export * from "./models/headerTypes.js";
+export * from "./models/httpMethod.js";
+export * from "./models/httpStatusCode.js";
+export * from "./models/IFetchOptions.js";
+export * from "./models/IHttpHeaders.js";
+export * from "./models/IJwk.js";
+export * from "./models/IJwtHeader.js";
+export * from "./models/IJwtPayload.js";
+export * from "./models/jwkCryptoKey.js";
+export * from "./models/mimeTypes.js";
+export * from "./utils/fetchHelper.js";
+export * from "./utils/headerHelper.js";
+export * from "./utils/jwk.js";
+export * from "./utils/jws.js";
+export * from "./utils/jwt.js";
+export * from "./utils/mimeTypeHelper.js";

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

@@ -1,4 +1,4 @@
-import type { IHttpHeaders } from "./IHttpHeaders";
+import type { IHttpHeaders } from "./IHttpHeaders.js";
 /**
  * Options for call to the fetch helper.
  */

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

@@ -2,5 +2,4 @@ import type { JWK } from "jose";
 /**
  * The fields in a JSON Web Key.
  */
-export interface IJwk extends JWK {
-}
+export type IJwk = JWK;

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

@@ -2,5 +2,4 @@ import type { JWTHeaderParameters } from "jose";
 /**
  * The fields in a JSON Web Token header.
  */
-export interface IJwtHeader extends JWTHeaderParameters {
-}
+export type IJwtHeader = JWTHeaderParameters;

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

@@ -2,5 +2,4 @@ import type { JWTPayload } from "jose";
 /**
  * The fields in a JSON Web Token payload.
  */
-export interface IJwtPayload extends JWTPayload {
-}
+export type IJwtPayload = JWTPayload;

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

@@ -1,9 +1,13 @@
-import { HttpMethod } from "../models/httpMethod";
-import type { IFetchOptions } from "../models/IFetchOptions";
+import { HttpMethod } from "../models/httpMethod.js";
+import type { IFetchOptions } from "../models/IFetchOptions.js";
 /**
  * Class to helper with fetch operations.
  */
 export declare class FetchHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Perform a fetch request.
      * @param source The source for the request.

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

@@ -0,0 +1,17 @@
+/**
+ * Class to helper with header operations.
+ */
+export declare class HeaderHelper {
+    /**
+     * Create a bearer token header.
+     * @param token The token to create the header for.
+     * @returns The bearer token header.
+     */
+    static createBearer(token: unknown): string;
+    /**
+     * Extract the bearer token from a header.
+     * @param header The header value to extract the token from.
+     * @returns The extracted token if it exists.
+     */
+    static extractBearer(header: unknown): string;
+}

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

@@ -1,9 +1,13 @@
-import type { IJwk } from "../models/IJwk";
-import type { JwkCryptoKey } from "../models/jwkCryptoKey";
+import type { IJwk } from "../models/IJwk.js";
+import type { JwkCryptoKey } from "../models/jwkCryptoKey.js";
 /**
  * Class to handle JSON Web Keys.
  */
 export declare class Jwk {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Convert the JWK to a crypto key.
      * @param jwk The JWK to convert.
@@ -14,15 +18,17 @@ export declare class Jwk {
     /**
      * Convert the Ed25519 private key to a crypto key.
      * @param privateKey The private key to use.
+     * @param overrideUse Optional override for the use property, defaults to "sig".
      * @returns The crypto key.
      */
-    static fromEd25519Private(privateKey: Uint8Array): Promise<IJwk>;
+    static fromEd25519Private(privateKey: Uint8Array, overrideUse?: "enc" | "sig" | string): Promise<IJwk>;
     /**
      * Convert the Ed25519 public key to a crypto key.
      * @param publicKey The private key to use.
+     * @param overrideUse Optional override for the use property, defaults to "sig".
      * @returns The crypto key.
      */
-    static fromEd25519Public(publicKey: Uint8Array): Promise<IJwk>;
+    static fromEd25519Public(publicKey: Uint8Array, overrideUse?: "enc" | "sig" | string): Promise<IJwk>;
     /**
      * Convert the JWK to raw keys.
      * @param jwk The JWK to convert to raw.

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

@@ -1,8 +1,12 @@
-import type { JwkCryptoKey } from "../models/jwkCryptoKey";
+import type { JwkCryptoKey } from "../models/jwkCryptoKey.js";
 /**
  * Class to handle JSON Web Signatures.
  */
 export declare class Jws {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Create a signature.
      * @param privateKey The private key to use.

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

@@ -1,10 +1,14 @@
-import type { IJwtHeader } from "../models/IJwtHeader";
-import type { IJwtPayload } from "../models/IJwtPayload";
-import type { JwkCryptoKey } from "../models/jwkCryptoKey";
+import type { IJwtHeader } from "../models/IJwtHeader.js";
+import type { IJwtPayload } from "../models/IJwtPayload.js";
+import type { JwkCryptoKey } from "../models/jwkCryptoKey.js";
 /**
  * Class to handle JSON Web Tokens.
  */
 export declare class Jwt {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Encode a token.
      * @param header The header to encode.