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

package/dist/es/utils/fetchHelper.js

@@ -0,0 +1,271 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { AsyncCache, BaseError, Guards, Is, ObjectHelper } from "@twin.org/core";
+import { FetchError } from "../errors/fetchError.js";
+import { HeaderTypes } from "../models/headerTypes.js";
+import { HttpMethod } from "../models/httpMethod.js";
+import { HttpStatusCode } from "../models/httpStatusCode.js";
+import { MimeTypes } from "../models/mimeTypes.js";
+/**
+ * Class to helper with fetch operations.
+ */
+export class FetchHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "FetchHelper";
+    /**
+     * Prefix to use for cache entries.
+     * @internal
+     */
+    static _CACHE_PREFIX = "fetch_";
+    /**
+     * Perform a fetch request.
+     * @param source The source for the request.
+     * @param url The url for the request.
+     * @param method The http method.
+     * @param body Request to send to the endpoint.
+     * @param options Options for sending the requests.
+     * @returns The response.
+     */
+    static async fetch(source, url, method, body, options) {
+        Guards.string(FetchHelper.CLASS_NAME, "source", source);
+        Guards.string(FetchHelper.CLASS_NAME, "url", url);
+        Guards.arrayOneOf(FetchHelper.CLASS_NAME, "method", method, Object.values(HttpMethod));
+        if (!Is.undefined(body) && !Is.uint8Array(body)) {
+            Guards.string(FetchHelper.CLASS_NAME, "body", body);
+        }
+        if (!Is.undefined(options)) {
+            Guards.object(FetchHelper.CLASS_NAME, "options", options);
+            if (!Is.undefined(options.headers)) {
+                Guards.object(FetchHelper.CLASS_NAME, "options.headers", options.headers);
+            }
+            if (!Is.undefined(options.timeoutMs)) {
+                Guards.integer(FetchHelper.CLASS_NAME, "options.timeoutMs", options.timeoutMs);
+            }
+            if (!Is.undefined(options.includeCredentials)) {
+                Guards.boolean(FetchHelper.CLASS_NAME, "options.includeCredentials", options.includeCredentials);
+            }
+            if (!Is.undefined(options.retryCount)) {
+                Guards.integer(FetchHelper.CLASS_NAME, "options.retryCount", options.retryCount);
+            }
+            if (!Is.undefined(options.retryDelayMs)) {
+                Guards.integer(FetchHelper.CLASS_NAME, "options.retryDelayMs", options.retryDelayMs);
+            }
+        }
+        let controller;
+        let timerId;
+        const retryCount = options?.retryCount ?? 1;
+        const baseDelayMilliseconds = options?.retryDelayMs ?? 3000;
+        let lastError;
+        let attempt;
+        for (attempt = 0; attempt < retryCount; attempt++) {
+            if (attempt > 0) {
+                const exponentialBackoffDelay = baseDelayMilliseconds * Math.pow(2, attempt - 1);
+                await new Promise(resolve => globalThis.setTimeout(resolve, exponentialBackoffDelay));
+            }
+            if (options?.timeoutMs !== undefined) {
+                controller = new AbortController();
+                timerId = globalThis.setTimeout(() => {
+                    if (controller) {
+                        controller.abort();
+                    }
+                }, options?.timeoutMs);
+            }
+            let finalBody;
+            if (method === HttpMethod.POST || method === HttpMethod.PUT) {
+                if (Is.string(body)) {
+                    finalBody = body;
+                }
+                else if (Is.uint8Array(body)) {
+                    finalBody = new Uint8Array(body);
+                }
+            }
+            try {
+                const requestOptions = {
+                    method,
+                    headers: options?.headers,
+                    body: finalBody,
+                    signal: controller ? controller.signal : undefined
+                };
+                if (Is.boolean(options?.includeCredentials)) {
+                    requestOptions.credentials = "include";
+                }
+                const response = await fetch(url, requestOptions);
+                if (!response.ok && retryCount > 1) {
+                    lastError = new FetchError(source, `${"fetchHelper"}.general`, response.status ?? HttpStatusCode.internalServerError, {
+                        url,
+                        statusText: response.statusText
+                    });
+                }
+                else {
+                    return response;
+                }
+            }
+            catch (err) {
+                const isErr = Is.object(err);
+                if (isErr && Is.stringValue(err.message) && err.message.includes("Failed to fetch")) {
+                    lastError = new FetchError(source, `${"fetchHelper"}.connectivity`, HttpStatusCode.serviceUnavailable, {
+                        url
+                    }, err);
+                }
+                else {
+                    const isAbort = isErr && err.name === "AbortError";
+                    const props = { url };
+                    let httpStatus = HttpStatusCode.internalServerError;
+                    if (isAbort) {
+                        httpStatus = HttpStatusCode.requestTimeout;
+                    }
+                    else if (isErr && "httpStatus" in err) {
+                        httpStatus = err.httpStatus;
+                    }
+                    if (isErr && "statusText" in err) {
+                        props.statusText = err.statusText;
+                    }
+                    if (isAbort) {
+                        lastError = new FetchError(source, `${"fetchHelper"}.timeout`, httpStatus, props, err);
+                    }
+                    else {
+                        lastError = new FetchError(source, `${"fetchHelper"}.general`, httpStatus, props, err);
+                    }
+                }
+            }
+            finally {
+                if (timerId) {
+                    globalThis.clearTimeout(timerId);
+                }
+            }
+        }
+        if (retryCount > 1 && attempt === retryCount) {
+            throw new FetchError(source, `${"fetchHelper"}.retryLimitExceeded`, HttpStatusCode.internalServerError, { url }, lastError);
+        }
+        throw lastError;
+    }
+    /**
+     * Perform a request in json format.
+     * @param source The source for the request.
+     * @param url The url for the request.
+     * @param method The http method.
+     * @param requestData Request to send to the endpoint.
+     * @param options Options for sending the requests.
+     * @returns The response.
+     */
+    static async fetchJson(source, url, method, requestData, options) {
+        if (Is.integer(options?.cacheTtlMs) && options.cacheTtlMs >= 0) {
+            // The cache option is set, so call the same method again but without
+            // the cache option to get the result and cache it.
+            const cacheResponse = AsyncCache.exec(`${FetchHelper._CACHE_PREFIX}${url}`, options.cacheTtlMs, async () => FetchHelper.fetchJson(source, url, method, requestData, ObjectHelper.omit(options, ["cacheTtlMs"])));
+            // If the return value is a promise return it, otherwise continue
+            // with the regular processing.
+            if (Is.promise(cacheResponse)) {
+                return cacheResponse;
+            }
+        }
+        options ??= {};
+        options.headers ??= {};
+        if (Is.undefined(options.headers[HeaderTypes.ContentType]) &&
+            (method === HttpMethod.POST || method === HttpMethod.PUT || method === HttpMethod.PATCH)) {
+            options.headers[HeaderTypes.ContentType] = MimeTypes.Json;
+        }
+        const response = await FetchHelper.fetch(source, url, method, requestData ? JSON.stringify(requestData) : undefined, options);
+        if (response.ok) {
+            if (response.status === HttpStatusCode.noContent) {
+                return {};
+            }
+            try {
+                return (await response.json());
+            }
+            catch (err) {
+                throw new FetchError(source, `${"fetchHelper"}.decodingJSON`, HttpStatusCode.badRequest, { url }, err);
+            }
+        }
+        const errorResponseData = await response.json();
+        const errorResponse = BaseError.fromError(errorResponseData);
+        const isErrorEmpty = BaseError.isEmpty(errorResponse);
+        throw new FetchError(source, `${"fetchHelper"}.failureStatusText`, response.status, {
+            statusText: response.statusText,
+            url,
+            data: isErrorEmpty ? errorResponseData : undefined
+        }, isErrorEmpty ? undefined : errorResponse);
+    }
+    /**
+     * Perform a request for binary data.
+     * @param source The source for the request.
+     * @param url The url for the request.
+     * @param method The http method.
+     * @param requestData Request to send to the endpoint.
+     * @param options Options for sending the requests.
+     * @returns The response.
+     */
+    static async fetchBinary(source, url, method, requestData, options) {
+        if (Is.integer(options?.cacheTtlMs) && options.cacheTtlMs >= 0) {
+            // The cache option is set, so call the same method again but without
+            // the cache option to get the result and cache it.
+            const cacheResponse = AsyncCache.exec(`${FetchHelper._CACHE_PREFIX}${url}`, options.cacheTtlMs * 1000, async () => FetchHelper.fetchBinary(source, url, method, requestData, ObjectHelper.omit(options, ["cacheTtlMs"])));
+            // If the return value is a promise return it, otherwise continue
+            // with the regular processing.
+            if (Is.promise(cacheResponse)) {
+                return cacheResponse;
+            }
+        }
+        options ??= {};
+        options.headers ??= {};
+        if (Is.undefined(options.headers[HeaderTypes.ContentType])) {
+            options.headers[HeaderTypes.ContentType] = MimeTypes.OctetStream;
+        }
+        const response = await FetchHelper.fetch(source, url, method, requestData, options);
+        if (response.ok) {
+            if (method === HttpMethod.GET) {
+                if (response.status === HttpStatusCode.noContent) {
+                    return new Uint8Array();
+                }
+                return new Uint8Array(await response.arrayBuffer());
+            }
+            try {
+                return (await response.json());
+            }
+            catch (err) {
+                throw new FetchError(source, `${"fetchHelper"}.decodingJSON`, HttpStatusCode.badRequest, { url }, err);
+            }
+        }
+        const errorResponseData = await response.json();
+        const errorResponse = BaseError.fromError(errorResponseData);
+        const isErrorEmpty = BaseError.isEmpty(errorResponse);
+        throw new FetchError(source, `${"fetchHelper"}.failureStatusText`, response.status, {
+            statusText: response.statusText,
+            url,
+            data: isErrorEmpty ? errorResponseData : undefined
+        }, isErrorEmpty ? undefined : errorResponse);
+    }
+    /**
+     * Clears the cache.
+     */
+    static clearCache() {
+        AsyncCache.clearCache(FetchHelper._CACHE_PREFIX);
+    }
+    /**
+     * Get a cache entry.
+     * @param url The url for the request.
+     * @returns The cache entry if it exists.
+     */
+    static async getCacheEntry(url) {
+        return AsyncCache.get(`${FetchHelper._CACHE_PREFIX}${url}`);
+    }
+    /**
+     * Set a cache entry.
+     * @param url The url for the request.
+     * @param value The value to cache.
+     * @returns The cache entry if it exists.
+     */
+    static async setCacheEntry(url, value) {
+        await AsyncCache.set(`${FetchHelper._CACHE_PREFIX}${url}`, value);
+    }
+    /**
+     * Remove a cache entry.
+     * @param url The url for the request.
+     */
+    static removeCacheEntry(url) {
+        AsyncCache.remove(`${FetchHelper._CACHE_PREFIX}${url}`);
+    }
+}
+//# sourceMappingURL=fetchHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetchHelper.js","sourceRoot":"","sources":["../../../src/utils/fetchHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAe,MAAM,gBAAgB,CAAC;AAE9F,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG7D,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,WAAW;IACvB;;OAEG;IACI,MAAM,CAAU,UAAU,iBAAiC;IAElE;;;OAGG;IACK,MAAM,CAAU,aAAa,GAAW,QAAQ,CAAC;IAEzD;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CACxB,MAAc,EACd,GAAW,EACX,MAAkB,EAClB,IAA0B,EAC1B,OAAgD;QAEhD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACxD,MAAM,CAAC,UAAU,CAChB,WAAW,CAAC,UAAU,YAEtB,MAAM,EACN,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,MAAM,CAAgB,WAAW,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;YAC/E,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpC,MAAM,CAAC,MAAM,CACZ,WAAW,CAAC,UAAU,qBAEtB,OAAO,CAAC,OAAO,CACf,CAAC;YACH,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACtC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,uBAA6B,OAAO,CAAC,SAAS,CAAC,CAAC;YACtF,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBAC/C,MAAM,CAAC,OAAO,CACb,WAAW,CAAC,UAAU,gCAEtB,OAAO,CAAC,kBAAkB,CAC1B,CAAC;YACH,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,wBAA8B,OAAO,CAAC,UAAU,CAAC,CAAC;YACxF,CAAC;YACD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBACzC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,0BAAgC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC5F,CAAC;QACF,CAAC;QAED,IAAI,UAAuC,CAAC;QAC5C,IAAI,OAA4C,CAAC;QACjD,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,CAAC,CAAC;QAC5C,MAAM,qBAAqB,GAAG,OAAO,EAAE,YAAY,IAAI,IAAI,CAAC;QAE5D,IAAI,SAA6B,CAAC;QAClC,IAAI,OAAO,CAAC;QACZ,KAAK,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;YACnD,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;gBACjB,MAAM,uBAAuB,GAAG,qBAAqB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;gBACjF,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC;YACvF,CAAC;YAED,IAAI,OAAO,EAAE,SAAS,KAAK,SAAS,EAAE,CAAC;gBACtC,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;gBACnC,OAAO,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,EAAE;oBACpC,IAAI,UAAU,EAAE,CAAC;wBAChB,UAAU,CAAC,KAAK,EAAE,CAAC;oBACpB,CAAC;gBACF,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,SAAS,CAAC;YACd,IAAI,MAAM,KAAK,UAAU,CAAC,IAAI,IAAI,MAAM,KAAK,UAAU,CAAC,GAAG,EAAE,CAAC;gBAC7D,IAAI,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrB,SAAS,GAAG,IAAI,CAAC;gBAClB,CAAC;qBAAM,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChC,SAAS,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;gBAClC,CAAC;YACF,CAAC;YAED,IAAI,CAAC;gBACJ,MAAM,cAAc,GAAgB;oBACnC,MAAM;oBACN,OAAO,EAAE,OAAO,EAAE,OAAsB;oBACxC,IAAI,EAAE,SAAS;oBACf,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;iBAClD,CAAC;gBACF,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,kBAAkB,CAAC,EAAE,CAAC;oBAC7C,cAAc,CAAC,WAAW,GAAG,SAAS,CAAC;gBACxC,CAAC;gBAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;gBAElD,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;oBACpC,SAAS,GAAG,IAAI,UAAU,CACzB,MAAM,EACN,GAAG,aAA8B,UAAU,EAC1C,QAAQ,CAAC,MAAyB,IAAI,cAAc,CAAC,mBAAmB,EACzE;wBACC,GAAG;wBACH,UAAU,EAAE,QAAQ,CAAC,UAAU;qBAC/B,CACD,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACP,OAAO,QAAQ,CAAC;gBACjB,CAAC;YACF,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAS,GAAG,CAAC,CAAC;gBACrC,IAAI,KAAK,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACrF,SAAS,GAAG,IAAI,UAAU,CACzB,MAAM,EACN,GAAG,aAA8B,eAAe,EAChD,cAAc,CAAC,kBAAkB,EACjC;wBACC,GAAG;qBACH,EACD,GAAG,CACH,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACP,MAAM,OAAO,GAAG,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC;oBACnD,MAAM,KAAK,GAA8B,EAAE,GAAG,EAAE,CAAC;oBACjD,IAAI,UAAU,GAAmB,cAAc,CAAC,mBAAmB,CAAC;oBACpE,IAAI,OAAO,EAAE,CAAC;wBACb,UAAU,GAAG,cAAc,CAAC,cAAc,CAAC;oBAC5C,CAAC;yBAAM,IAAI,KAAK,IAAI,YAAY,IAAI,GAAG,EAAE,CAAC;wBACzC,UAAU,GAAG,GAAG,CAAC,UAA4B,CAAC;oBAC/C,CAAC;oBACD,IAAI,KAAK,IAAI,YAAY,IAAI,GAAG,EAAE,CAAC;wBAClC,KAAK,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC;oBACnC,CAAC;oBAED,IAAI,OAAO,EAAE,CAAC;wBACb,SAAS,GAAG,IAAI,UAAU,CACzB,MAAM,EACN,GAAG,aAA8B,UAAU,EAC3C,UAAU,EACV,KAAK,EACL,GAAG,CACH,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACP,SAAS,GAAG,IAAI,UAAU,CACzB,MAAM,EACN,GAAG,aAA8B,UAAU,EAC3C,UAAU,EACV,KAAK,EACL,GAAG,CACH,CAAC;oBACH,CAAC;gBACF,CAAC;YACF,CAAC;oBAAS,CAAC;gBACV,IAAI,OAAO,EAAE,CAAC;oBACb,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;gBAClC,CAAC;YACF,CAAC;QACF,CAAC;QAED,IAAI,UAAU,GAAG,CAAC,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;YAC9C,MAAM,IAAI,UAAU,CACnB,MAAM,EACN,GAAG,aAA8B,qBAAqB,EACtD,cAAc,CAAC,mBAAmB,EAClC,EAAE,GAAG,EAAE,EACP,SAAS,CACT,CAAC;QACH,CAAC;QAED,MAAM,SAAkB,CAAC;IAC1B,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC5B,MAAc,EACd,GAAW,EACX,MAAkB,EAClB,WAAe,EACf,OAAuB;QAEvB,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;YAChE,qEAAqE;YACrE,mDAAmD;YACnD,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CACpC,GAAG,WAAW,CAAC,aAAa,GAAG,GAAG,EAAE,EACpC,OAAO,CAAC,UAAU,EAClB,KAAK,IAAI,EAAE,CACV,WAAW,CAAC,SAAS,CACpB,MAAM,EACN,GAAG,EACH,MAAM,EACN,WAAW,EACX,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAC1C,CACF,CAAC;YAEF,iEAAiE;YACjE,+BAA+B;YAC/B,IAAI,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC/B,OAAO,aAAa,CAAC;YACtB,CAAC;QACF,CAAC;QAED,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,KAAK,EAAE,CAAC;QAEvB,IACC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;YACtD,CAAC,MAAM,KAAK,UAAU,CAAC,IAAI,IAAI,MAAM,KAAK,UAAU,CAAC,GAAG,IAAI,MAAM,KAAK,UAAU,CAAC,KAAK,CAAC,EACvF,CAAC;YACF,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC;QAC3D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CACvC,MAAM,EACN,GAAG,EACH,MAAM,EACN,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,EACrD,OAAO,CACP,CAAC;QAEF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,QAAQ,CAAC,MAAM,KAAK,cAAc,CAAC,SAAS,EAAE,CAAC;gBAClD,OAAO,EAAO,CAAC;YAChB,CAAC;YACD,IAAI,CAAC;gBACJ,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;YACrC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,MAAM,IAAI,UAAU,CACnB,MAAM,EACN,GAAG,aAA8B,eAAe,EAChD,cAAc,CAAC,UAAU,EACzB,EAAE,GAAG,EAAE,EACP,GAAG,CACH,CAAC;YACH,CAAC;QACF,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChD,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAEtD,MAAM,IAAI,UAAU,CACnB,MAAM,EACN,GAAG,aAA8B,oBAAoB,EACrD,QAAQ,CAAC,MAAwB,EACjC;YACC,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,GAAG;YACH,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;SAClD,EACD,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CACxC,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,MAAc,EACd,GAAW,EACX,MAA2C,EAC3C,WAAwB,EACxB,OAAuB;QAEvB,IAAI,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;YAChE,qEAAqE;YACrE,mDAAmD;YACnD,MAAM,aAAa,GAAG,UAAU,CAAC,IAAI,CACpC,GAAG,WAAW,CAAC,aAAa,GAAG,GAAG,EAAE,EACpC,OAAO,CAAC,UAAU,GAAG,IAAI,EACzB,KAAK,IAAI,EAAE,CACV,WAAW,CAAC,WAAW,CACtB,MAAM,EACN,GAAG,EACH,MAAM,EACN,WAAW,EACX,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAC1C,CACF,CAAC;YAEF,iEAAiE;YACjE,+BAA+B;YAC/B,IAAI,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;gBAC/B,OAAO,aAAa,CAAC;YACtB,CAAC;QACF,CAAC;QAED,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,KAAK,EAAE,CAAC;QAEvB,IAAI,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;YAC5D,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,WAAW,CAAC;QAClE,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAEpF,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,MAAM,KAAK,UAAU,CAAC,GAAG,EAAE,CAAC;gBAC/B,IAAI,QAAQ,CAAC,MAAM,KAAK,cAAc,CAAC,SAAS,EAAE,CAAC;oBAClD,OAAO,IAAI,UAAU,EAAE,CAAC;gBACzB,CAAC;gBACD,OAAO,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,IAAI,CAAC;gBACJ,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;YACrC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,MAAM,IAAI,UAAU,CACnB,MAAM,EACN,GAAG,aAA8B,eAAe,EAChD,cAAc,CAAC,UAAU,EACzB,EAAE,GAAG,EAAE,EACP,GAAG,CACH,CAAC;YACH,CAAC;QACF,CAAC;QAED,MAAM,iBAAiB,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAChD,MAAM,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,SAAS,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAEtD,MAAM,IAAI,UAAU,CACnB,MAAM,EACN,GAAG,aAA8B,oBAAoB,EACrD,QAAQ,CAAC,MAAwB,EACjC;YACC,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,GAAG;YACH,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,SAAS;SAClD,EACD,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CACxC,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU;QACvB,UAAU,CAAC,UAAU,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAI,GAAW;QAC/C,OAAO,UAAU,CAAC,GAAG,CAAI,GAAG,WAAW,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,CAAC;IAChE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAI,GAAW,EAAE,KAAQ;QACzD,MAAM,UAAU,CAAC,GAAG,CAAI,GAAG,WAAW,CAAC,aAAa,GAAG,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,gBAAgB,CAAC,GAAW;QACzC,UAAU,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,aAAa,GAAG,GAAG,EAAE,CAAC,CAAC;IACzD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { AsyncCache, BaseError, Guards, Is, ObjectHelper, type IError } from \"@twin.org/core\";\nimport { nameof, nameofCamelCase } from \"@twin.org/nameof\";\nimport { FetchError } from \"../errors/fetchError.js\";\nimport { HeaderTypes } from \"../models/headerTypes.js\";\nimport { HttpMethod } from \"../models/httpMethod.js\";\nimport { HttpStatusCode } from \"../models/httpStatusCode.js\";\nimport type { IFetchOptions } from \"../models/IFetchOptions.js\";\nimport type { IHttpHeaders } from \"../models/IHttpHeaders.js\";\nimport { MimeTypes } from \"../models/mimeTypes.js\";\n\n/**\n * Class to helper with fetch operations.\n */\nexport class FetchHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<FetchHelper>();\n\n\t/**\n\t * Prefix to use for cache entries.\n\t * @internal\n\t */\n\tprivate static readonly _CACHE_PREFIX: string = \"fetch_\";\n\n\t/**\n\t * Perform a fetch request.\n\t * @param source The source for the request.\n\t * @param url The url for the request.\n\t * @param method The http method.\n\t * @param body Request to send to the endpoint.\n\t * @param options Options for sending the requests.\n\t * @returns The response.\n\t */\n\tpublic static async fetch(\n\t\tsource: string,\n\t\turl: string,\n\t\tmethod: HttpMethod,\n\t\tbody?: string | Uint8Array,\n\t\toptions?: Omit<IFetchOptions, \"cacheTtlSeconds\">\n\t): Promise<Response> {\n\t\tGuards.string(FetchHelper.CLASS_NAME, nameof(source), source);\n\t\tGuards.string(FetchHelper.CLASS_NAME, nameof(url), url);\n\t\tGuards.arrayOneOf<HttpMethod>(\n\t\t\tFetchHelper.CLASS_NAME,\n\t\t\tnameof(method),\n\t\t\tmethod,\n\t\t\tObject.values(HttpMethod)\n\t\t);\n\t\tif (!Is.undefined(body) && !Is.uint8Array(body)) {\n\t\t\tGuards.string(FetchHelper.CLASS_NAME, nameof(body), body);\n\t\t}\n\t\tif (!Is.undefined(options)) {\n\t\t\tGuards.object<IFetchOptions>(FetchHelper.CLASS_NAME, nameof(options), options);\n\t\t\tif (!Is.undefined(options.headers)) {\n\t\t\t\tGuards.object<IHttpHeaders>(\n\t\t\t\t\tFetchHelper.CLASS_NAME,\n\t\t\t\t\tnameof(options.headers),\n\t\t\t\t\toptions.headers\n\t\t\t\t);\n\t\t\t}\n\t\t\tif (!Is.undefined(options.timeoutMs)) {\n\t\t\t\tGuards.integer(FetchHelper.CLASS_NAME, nameof(options.timeoutMs), options.timeoutMs);\n\t\t\t}\n\t\t\tif (!Is.undefined(options.includeCredentials)) {\n\t\t\t\tGuards.boolean(\n\t\t\t\t\tFetchHelper.CLASS_NAME,\n\t\t\t\t\tnameof(options.includeCredentials),\n\t\t\t\t\toptions.includeCredentials\n\t\t\t\t);\n\t\t\t}\n\t\t\tif (!Is.undefined(options.retryCount)) {\n\t\t\t\tGuards.integer(FetchHelper.CLASS_NAME, nameof(options.retryCount), options.retryCount);\n\t\t\t}\n\t\t\tif (!Is.undefined(options.retryDelayMs)) {\n\t\t\t\tGuards.integer(FetchHelper.CLASS_NAME, nameof(options.retryDelayMs), options.retryDelayMs);\n\t\t\t}\n\t\t}\n\n\t\tlet controller: AbortController | undefined;\n\t\tlet timerId: number | NodeJS.Timeout | undefined;\n\t\tconst retryCount = options?.retryCount ?? 1;\n\t\tconst baseDelayMilliseconds = options?.retryDelayMs ?? 3000;\n\n\t\tlet lastError: IError | undefined;\n\t\tlet attempt;\n\t\tfor (attempt = 0; attempt < retryCount; attempt++) {\n\t\t\tif (attempt > 0) {\n\t\t\t\tconst exponentialBackoffDelay = baseDelayMilliseconds * Math.pow(2, attempt - 1);\n\t\t\t\tawait new Promise(resolve => globalThis.setTimeout(resolve, exponentialBackoffDelay));\n\t\t\t}\n\n\t\t\tif (options?.timeoutMs !== undefined) {\n\t\t\t\tcontroller = new AbortController();\n\t\t\t\ttimerId = globalThis.setTimeout(() => {\n\t\t\t\t\tif (controller) {\n\t\t\t\t\t\tcontroller.abort();\n\t\t\t\t\t}\n\t\t\t\t}, options?.timeoutMs);\n\t\t\t}\n\n\t\t\tlet finalBody;\n\t\t\tif (method === HttpMethod.POST || method === HttpMethod.PUT) {\n\t\t\t\tif (Is.string(body)) {\n\t\t\t\t\tfinalBody = body;\n\t\t\t\t} else if (Is.uint8Array(body)) {\n\t\t\t\t\tfinalBody = new Uint8Array(body);\n\t\t\t\t}\n\t\t\t}\n\n\t\t\ttry {\n\t\t\t\tconst requestOptions: RequestInit = {\n\t\t\t\t\tmethod,\n\t\t\t\t\theaders: options?.headers as HeadersInit,\n\t\t\t\t\tbody: finalBody,\n\t\t\t\t\tsignal: controller ? controller.signal : undefined\n\t\t\t\t};\n\t\t\t\tif (Is.boolean(options?.includeCredentials)) {\n\t\t\t\t\trequestOptions.credentials = \"include\";\n\t\t\t\t}\n\n\t\t\t\tconst response = await fetch(url, requestOptions);\n\n\t\t\t\tif (!response.ok && retryCount > 1) {\n\t\t\t\t\tlastError = new FetchError(\n\t\t\t\t\t\tsource,\n\t\t\t\t\t\t`${nameofCamelCase<FetchHelper>()}.general`,\n\t\t\t\t\t\t(response.status as HttpStatusCode) ?? HttpStatusCode.internalServerError,\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\turl,\n\t\t\t\t\t\t\tstatusText: response.statusText\n\t\t\t\t\t\t}\n\t\t\t\t\t);\n\t\t\t\t} else {\n\t\t\t\t\treturn response;\n\t\t\t\t}\n\t\t\t} catch (err) {\n\t\t\t\tconst isErr = Is.object<IError>(err);\n\t\t\t\tif (isErr && Is.stringValue(err.message) && err.message.includes(\"Failed to fetch\")) {\n\t\t\t\t\tlastError = new FetchError(\n\t\t\t\t\t\tsource,\n\t\t\t\t\t\t`${nameofCamelCase<FetchHelper>()}.connectivity`,\n\t\t\t\t\t\tHttpStatusCode.serviceUnavailable,\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\turl\n\t\t\t\t\t\t},\n\t\t\t\t\t\terr\n\t\t\t\t\t);\n\t\t\t\t} else {\n\t\t\t\t\tconst isAbort = isErr && err.name === \"AbortError\";\n\t\t\t\t\tconst props: { [id: string]: unknown } = { url };\n\t\t\t\t\tlet httpStatus: HttpStatusCode = HttpStatusCode.internalServerError;\n\t\t\t\t\tif (isAbort) {\n\t\t\t\t\t\thttpStatus = HttpStatusCode.requestTimeout;\n\t\t\t\t\t} else if (isErr && \"httpStatus\" in err) {\n\t\t\t\t\t\thttpStatus = err.httpStatus as HttpStatusCode;\n\t\t\t\t\t}\n\t\t\t\t\tif (isErr && \"statusText\" in err) {\n\t\t\t\t\t\tprops.statusText = err.statusText;\n\t\t\t\t\t}\n\n\t\t\t\t\tif (isAbort) {\n\t\t\t\t\t\tlastError = new FetchError(\n\t\t\t\t\t\t\tsource,\n\t\t\t\t\t\t\t`${nameofCamelCase<FetchHelper>()}.timeout`,\n\t\t\t\t\t\t\thttpStatus,\n\t\t\t\t\t\t\tprops,\n\t\t\t\t\t\t\terr\n\t\t\t\t\t\t);\n\t\t\t\t\t} else {\n\t\t\t\t\t\tlastError = new FetchError(\n\t\t\t\t\t\t\tsource,\n\t\t\t\t\t\t\t`${nameofCamelCase<FetchHelper>()}.general`,\n\t\t\t\t\t\t\thttpStatus,\n\t\t\t\t\t\t\tprops,\n\t\t\t\t\t\t\terr\n\t\t\t\t\t\t);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} finally {\n\t\t\t\tif (timerId) {\n\t\t\t\t\tglobalThis.clearTimeout(timerId);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tif (retryCount > 1 && attempt === retryCount) {\n\t\t\tthrow new FetchError(\n\t\t\t\tsource,\n\t\t\t\t`${nameofCamelCase<FetchHelper>()}.retryLimitExceeded`,\n\t\t\t\tHttpStatusCode.internalServerError,\n\t\t\t\t{ url },\n\t\t\t\tlastError\n\t\t\t);\n\t\t}\n\n\t\tthrow lastError as Error;\n\t}\n\n\t/**\n\t * Perform a request in json format.\n\t * @param source The source for the request.\n\t * @param url The url for the request.\n\t * @param method The http method.\n\t * @param requestData Request to send to the endpoint.\n\t * @param options Options for sending the requests.\n\t * @returns The response.\n\t */\n\tpublic static async fetchJson<T, U>(\n\t\tsource: string,\n\t\turl: string,\n\t\tmethod: HttpMethod,\n\t\trequestData?: T,\n\t\toptions?: IFetchOptions\n\t): Promise<U> {\n\t\tif (Is.integer(options?.cacheTtlMs) && options.cacheTtlMs >= 0) {\n\t\t\t// The cache option is set, so call the same method again but without\n\t\t\t// the cache option to get the result and cache it.\n\t\t\tconst cacheResponse = AsyncCache.exec(\n\t\t\t\t`${FetchHelper._CACHE_PREFIX}${url}`,\n\t\t\t\toptions.cacheTtlMs,\n\t\t\t\tasync () =>\n\t\t\t\t\tFetchHelper.fetchJson<T, U>(\n\t\t\t\t\t\tsource,\n\t\t\t\t\t\turl,\n\t\t\t\t\t\tmethod,\n\t\t\t\t\t\trequestData,\n\t\t\t\t\t\tObjectHelper.omit(options, [\"cacheTtlMs\"])\n\t\t\t\t\t)\n\t\t\t);\n\n\t\t\t// If the return value is a promise return it, otherwise continue\n\t\t\t// with the regular processing.\n\t\t\tif (Is.promise(cacheResponse)) {\n\t\t\t\treturn cacheResponse;\n\t\t\t}\n\t\t}\n\n\t\toptions ??= {};\n\t\toptions.headers ??= {};\n\n\t\tif (\n\t\t\tIs.undefined(options.headers[HeaderTypes.ContentType]) &&\n\t\t\t(method === HttpMethod.POST || method === HttpMethod.PUT || method === HttpMethod.PATCH)\n\t\t) {\n\t\t\toptions.headers[HeaderTypes.ContentType] = MimeTypes.Json;\n\t\t}\n\n\t\tconst response = await FetchHelper.fetch(\n\t\t\tsource,\n\t\t\turl,\n\t\t\tmethod,\n\t\t\trequestData ? JSON.stringify(requestData) : undefined,\n\t\t\toptions\n\t\t);\n\n\t\tif (response.ok) {\n\t\t\tif (response.status === HttpStatusCode.noContent) {\n\t\t\t\treturn {} as U;\n\t\t\t}\n\t\t\ttry {\n\t\t\t\treturn (await response.json()) as U;\n\t\t\t} catch (err) {\n\t\t\t\tthrow new FetchError(\n\t\t\t\t\tsource,\n\t\t\t\t\t`${nameofCamelCase<FetchHelper>()}.decodingJSON`,\n\t\t\t\t\tHttpStatusCode.badRequest,\n\t\t\t\t\t{ url },\n\t\t\t\t\terr\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tconst errorResponseData = await response.json();\n\t\tconst errorResponse = BaseError.fromError(errorResponseData);\n\t\tconst isErrorEmpty = BaseError.isEmpty(errorResponse);\n\n\t\tthrow new FetchError(\n\t\t\tsource,\n\t\t\t`${nameofCamelCase<FetchHelper>()}.failureStatusText`,\n\t\t\tresponse.status as HttpStatusCode,\n\t\t\t{\n\t\t\t\tstatusText: response.statusText,\n\t\t\t\turl,\n\t\t\t\tdata: isErrorEmpty ? errorResponseData : undefined\n\t\t\t},\n\t\t\tisErrorEmpty ? undefined : errorResponse\n\t\t);\n\t}\n\n\t/**\n\t * Perform a request for binary data.\n\t * @param source The source for the request.\n\t * @param url The url for the request.\n\t * @param method The http method.\n\t * @param requestData Request to send to the endpoint.\n\t * @param options Options for sending the requests.\n\t * @returns The response.\n\t */\n\tpublic static async fetchBinary<T>(\n\t\tsource: string,\n\t\turl: string,\n\t\tmethod: Extract<HttpMethod, \"GET\" | \"POST\">,\n\t\trequestData?: Uint8Array,\n\t\toptions?: IFetchOptions\n\t): Promise<Uint8Array | T> {\n\t\tif (Is.integer(options?.cacheTtlMs) && options.cacheTtlMs >= 0) {\n\t\t\t// The cache option is set, so call the same method again but without\n\t\t\t// the cache option to get the result and cache it.\n\t\t\tconst cacheResponse = AsyncCache.exec(\n\t\t\t\t`${FetchHelper._CACHE_PREFIX}${url}`,\n\t\t\t\toptions.cacheTtlMs * 1000,\n\t\t\t\tasync () =>\n\t\t\t\t\tFetchHelper.fetchBinary<T>(\n\t\t\t\t\t\tsource,\n\t\t\t\t\t\turl,\n\t\t\t\t\t\tmethod,\n\t\t\t\t\t\trequestData,\n\t\t\t\t\t\tObjectHelper.omit(options, [\"cacheTtlMs\"])\n\t\t\t\t\t)\n\t\t\t);\n\n\t\t\t// If the return value is a promise return it, otherwise continue\n\t\t\t// with the regular processing.\n\t\t\tif (Is.promise(cacheResponse)) {\n\t\t\t\treturn cacheResponse;\n\t\t\t}\n\t\t}\n\n\t\toptions ??= {};\n\t\toptions.headers ??= {};\n\n\t\tif (Is.undefined(options.headers[HeaderTypes.ContentType])) {\n\t\t\toptions.headers[HeaderTypes.ContentType] = MimeTypes.OctetStream;\n\t\t}\n\n\t\tconst response = await FetchHelper.fetch(source, url, method, requestData, options);\n\n\t\tif (response.ok) {\n\t\t\tif (method === HttpMethod.GET) {\n\t\t\t\tif (response.status === HttpStatusCode.noContent) {\n\t\t\t\t\treturn new Uint8Array();\n\t\t\t\t}\n\t\t\t\treturn new Uint8Array(await response.arrayBuffer());\n\t\t\t}\n\t\t\ttry {\n\t\t\t\treturn (await response.json()) as T;\n\t\t\t} catch (err) {\n\t\t\t\tthrow new FetchError(\n\t\t\t\t\tsource,\n\t\t\t\t\t`${nameofCamelCase<FetchHelper>()}.decodingJSON`,\n\t\t\t\t\tHttpStatusCode.badRequest,\n\t\t\t\t\t{ url },\n\t\t\t\t\terr\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\n\t\tconst errorResponseData = await response.json();\n\t\tconst errorResponse = BaseError.fromError(errorResponseData);\n\t\tconst isErrorEmpty = BaseError.isEmpty(errorResponse);\n\n\t\tthrow new FetchError(\n\t\t\tsource,\n\t\t\t`${nameofCamelCase<FetchHelper>()}.failureStatusText`,\n\t\t\tresponse.status as HttpStatusCode,\n\t\t\t{\n\t\t\t\tstatusText: response.statusText,\n\t\t\t\turl,\n\t\t\t\tdata: isErrorEmpty ? errorResponseData : undefined\n\t\t\t},\n\t\t\tisErrorEmpty ? undefined : errorResponse\n\t\t);\n\t}\n\n\t/**\n\t * Clears the cache.\n\t */\n\tpublic static clearCache(): void {\n\t\tAsyncCache.clearCache(FetchHelper._CACHE_PREFIX);\n\t}\n\n\t/**\n\t * Get a cache entry.\n\t * @param url The url for the request.\n\t * @returns The cache entry if it exists.\n\t */\n\tpublic static async getCacheEntry<T>(url: string): Promise<T | undefined> {\n\t\treturn AsyncCache.get<T>(`${FetchHelper._CACHE_PREFIX}${url}`);\n\t}\n\n\t/**\n\t * Set a cache entry.\n\t * @param url The url for the request.\n\t * @param value The value to cache.\n\t * @returns The cache entry if it exists.\n\t */\n\tpublic static async setCacheEntry<T>(url: string, value: T): Promise<void> {\n\t\tawait AsyncCache.set<T>(`${FetchHelper._CACHE_PREFIX}${url}`, value);\n\t}\n\n\t/**\n\t * Remove a cache entry.\n\t * @param url The url for the request.\n\t */\n\tpublic static removeCacheEntry(url: string): void {\n\t\tAsyncCache.remove(`${FetchHelper._CACHE_PREFIX}${url}`);\n\t}\n}\n"]}

package/dist/es/utils/headerHelper.js

@@ -0,0 +1,34 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is } from "@twin.org/core";
+/**
+ * Class to helper with header operations.
+ */
+export class HeaderHelper {
+    /**
+     * Create a bearer token header.
+     * @param token The token to create the header for.
+     * @returns The bearer token header.
+     */
+    static createBearer(token) {
+        if (Is.stringValue(token)) {
+            if (token.startsWith("Bearer ")) {
+                return token;
+            }
+            return `Bearer ${token.trim()}`;
+        }
+        return "";
+    }
+    /**
+     * 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) {
+        if (Is.stringValue(header) && header.startsWith("Bearer ")) {
+            return header.slice(7, header.length).trim();
+        }
+        return "";
+    }
+}
+//# sourceMappingURL=headerHelper.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"headerHelper.js","sourceRoot":"","sources":["../../../src/utils/headerHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,YAAY;IACxB;;;;OAIG;IACI,MAAM,CAAC,YAAY,CAAC,KAAc;QACxC,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjC,OAAO,KAAK,CAAC;YACd,CAAC;YACD,OAAO,UAAU,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QACjC,CAAC;QACD,OAAO,EAAE,CAAC;IACX,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,aAAa,CAAC,MAAe;QAC1C,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9C,CAAC;QACD,OAAO,EAAE,CAAC;IACX,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is } from \"@twin.org/core\";\n\n/**\n * Class to helper with header operations.\n */\nexport class HeaderHelper {\n\t/**\n\t * Create a bearer token header.\n\t * @param token The token to create the header for.\n\t * @returns The bearer token header.\n\t */\n\tpublic static createBearer(token: unknown): string {\n\t\tif (Is.stringValue(token)) {\n\t\t\tif (token.startsWith(\"Bearer \")) {\n\t\t\t\treturn token;\n\t\t\t}\n\t\t\treturn `Bearer ${token.trim()}`;\n\t\t}\n\t\treturn \"\";\n\t}\n\n\t/**\n\t * Extract the bearer token from a header.\n\t * @param header The header value to extract the token from.\n\t * @returns The extracted token if it exists.\n\t */\n\tpublic static extractBearer(header: unknown): string {\n\t\tif (Is.stringValue(header) && header.startsWith(\"Bearer \")) {\n\t\t\treturn header.slice(7, header.length).trim();\n\t\t}\n\t\treturn \"\";\n\t}\n}\n"]}

package/dist/es/utils/jwk.js

@@ -0,0 +1,99 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Converter, GeneralError, Guards, Is, JsonHelper, ObjectHelper } from "@twin.org/core";
+import { Ed25519, Sha256 } from "@twin.org/crypto";
+import { importJWK } from "jose";
+/**
+ * Class to handle JSON Web Keys.
+ */
+export class Jwk {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Jwk";
+    /**
+     * Convert the JWK to a crypto key.
+     * @param jwk The JWK to convert.
+     * @param alg The alg to be used, defaults to jwk.alg.
+     * @returns The crypto key.
+     */
+    static async toCryptoKey(jwk, alg) {
+        Guards.object(Jwk.CLASS_NAME, "jwk", jwk);
+        try {
+            const imported = await importJWK(jwk, alg);
+            return imported;
+        }
+        catch (err) {
+            throw new GeneralError(Jwk.CLASS_NAME, "jwkImportFailed", undefined, err);
+        }
+    }
+    /**
+     * 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 async fromEd25519Private(privateKey, overrideUse) {
+        Guards.uint8Array(Jwk.CLASS_NAME, "privateKey", privateKey);
+        const publicKey = Ed25519.publicKeyFromPrivateKey(privateKey);
+        const jwk = {
+            kty: "OKP",
+            use: overrideUse ?? "sig",
+            alg: "EdDSA",
+            crv: "Ed25519",
+            x: Converter.bytesToBase64Url(publicKey),
+            d: Converter.bytesToBase64Url(privateKey)
+        };
+        return jwk;
+    }
+    /**
+     * 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 async fromEd25519Public(publicKey, overrideUse) {
+        Guards.uint8Array(Jwk.CLASS_NAME, "publicKey", publicKey);
+        const jwk = {
+            kty: "OKP",
+            use: overrideUse ?? "sig",
+            alg: "EdDSA",
+            crv: "Ed25519",
+            x: Converter.bytesToBase64Url(publicKey)
+        };
+        return jwk;
+    }
+    /**
+     * Convert the JWK to raw keys.
+     * @param jwk The JWK to convert to raw.
+     * @returns The crypto key.
+     */
+    static async toRaw(jwk) {
+        Guards.object(Jwk.CLASS_NAME, "jwk", jwk);
+        let publicKey;
+        let privateKey;
+        if (Is.stringBase64Url(jwk.x)) {
+            publicKey = Converter.base64UrlToBytes(jwk.x);
+        }
+        if (Is.stringBase64Url(jwk.d)) {
+            privateKey = Converter.base64UrlToBytes(jwk.d);
+        }
+        return {
+            publicKey,
+            privateKey
+        };
+    }
+    /**
+     * Generate a KID for the JWK.
+     * @param jwk The JWK to generate a KID for.
+     * @returns The KID.
+     */
+    static async generateKid(jwk) {
+        Guards.object(Jwk.CLASS_NAME, "jwk", jwk);
+        const kidProps = ObjectHelper.pick(jwk, ["crv", "kty", "x"]);
+        const canonicalJson = JsonHelper.canonicalize(kidProps);
+        const hash = Sha256.sum256(Converter.utf8ToBytes(canonicalJson));
+        return Converter.bytesToBase64Url(hash);
+    }
+}
+//# sourceMappingURL=jwk.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jwk.js","sourceRoot":"","sources":["../../../src/utils/jwk.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAIjC;;GAEG;AACH,MAAM,OAAO,GAAG;IACf;;OAEG;IACI,MAAM,CAAU,UAAU,SAAyB;IAE1D;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAS,EAAE,GAAY;QACtD,MAAM,CAAC,MAAM,CAAO,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC3C,OAAO,QAAQ,CAAC;QACjB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;QAC3E,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CACrC,UAAsB,EACtB,WAAoC;QAEpC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAElE,MAAM,SAAS,GAAG,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QAE9D,MAAM,GAAG,GAAS;YACjB,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,WAAW,IAAI,KAAK;YACzB,GAAG,EAAE,OAAO;YACZ,GAAG,EAAE,SAAS;YACd,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC;YACxC,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC;SACzC,CAAC;QAEF,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,iBAAiB,CACpC,SAAqB,EACrB,WAAoC;QAEpC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAEhE,MAAM,GAAG,GAAS;YACjB,GAAG,EAAE,KAAK;YACV,GAAG,EAAE,WAAW,IAAI,KAAK;YACzB,GAAG,EAAE,OAAO;YACZ,GAAG,EAAE,SAAS;YACd,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC;SACxC,CAAC;QAEF,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAS;QAIlC,MAAM,CAAC,MAAM,CAAO,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEtD,IAAI,SAAiC,CAAC;QACtC,IAAI,UAAkC,CAAC;QAEvC,IAAI,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,SAAS,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,EAAE,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/B,UAAU,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,OAAO;YACN,SAAS;YACT,UAAU;SACV,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,GAAS;QACxC,MAAM,CAAC,MAAM,CAAO,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QAE7D,MAAM,aAAa,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAExD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;QAEjE,OAAO,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Converter, GeneralError, Guards, Is, JsonHelper, ObjectHelper } from \"@twin.org/core\";\nimport { Ed25519, Sha256 } from \"@twin.org/crypto\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { importJWK } from \"jose\";\nimport type { IJwk } from \"../models/IJwk.js\";\nimport type { JwkCryptoKey } from \"../models/jwkCryptoKey.js\";\n\n/**\n * Class to handle JSON Web Keys.\n */\nexport class Jwk {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Jwk>();\n\n\t/**\n\t * Convert the JWK to a crypto key.\n\t * @param jwk The JWK to convert.\n\t * @param alg The alg to be used, defaults to jwk.alg.\n\t * @returns The crypto key.\n\t */\n\tpublic static async toCryptoKey(jwk: IJwk, alg?: string): Promise<JwkCryptoKey> {\n\t\tGuards.object<IJwk>(Jwk.CLASS_NAME, nameof(jwk), jwk);\n\t\ttry {\n\t\t\tconst imported = await importJWK(jwk, alg);\n\t\t\treturn imported;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(Jwk.CLASS_NAME, \"jwkImportFailed\", undefined, err);\n\t\t}\n\t}\n\n\t/**\n\t * Convert the Ed25519 private key to a crypto key.\n\t * @param privateKey The private key to use.\n\t * @param overrideUse Optional override for the use property, defaults to \"sig\".\n\t * @returns The crypto key.\n\t */\n\tpublic static async fromEd25519Private(\n\t\tprivateKey: Uint8Array,\n\t\toverrideUse?: \"enc\" | \"sig\" | string\n\t): Promise<IJwk> {\n\t\tGuards.uint8Array(Jwk.CLASS_NAME, nameof(privateKey), privateKey);\n\n\t\tconst publicKey = Ed25519.publicKeyFromPrivateKey(privateKey);\n\n\t\tconst jwk: IJwk = {\n\t\t\tkty: \"OKP\",\n\t\t\tuse: overrideUse ?? \"sig\",\n\t\t\talg: \"EdDSA\",\n\t\t\tcrv: \"Ed25519\",\n\t\t\tx: Converter.bytesToBase64Url(publicKey),\n\t\t\td: Converter.bytesToBase64Url(privateKey)\n\t\t};\n\n\t\treturn jwk;\n\t}\n\n\t/**\n\t * Convert the Ed25519 public key to a crypto key.\n\t * @param publicKey The private key to use.\n\t * @param overrideUse Optional override for the use property, defaults to \"sig\".\n\t * @returns The crypto key.\n\t */\n\tpublic static async fromEd25519Public(\n\t\tpublicKey: Uint8Array,\n\t\toverrideUse?: \"enc\" | \"sig\" | string\n\t): Promise<IJwk> {\n\t\tGuards.uint8Array(Jwk.CLASS_NAME, nameof(publicKey), publicKey);\n\n\t\tconst jwk: IJwk = {\n\t\t\tkty: \"OKP\",\n\t\t\tuse: overrideUse ?? \"sig\",\n\t\t\talg: \"EdDSA\",\n\t\t\tcrv: \"Ed25519\",\n\t\t\tx: Converter.bytesToBase64Url(publicKey)\n\t\t};\n\n\t\treturn jwk;\n\t}\n\n\t/**\n\t * Convert the JWK to raw keys.\n\t * @param jwk The JWK to convert to raw.\n\t * @returns The crypto key.\n\t */\n\tpublic static async toRaw(jwk: IJwk): Promise<{\n\t\tpublicKey?: Uint8Array;\n\t\tprivateKey?: Uint8Array;\n\t}> {\n\t\tGuards.object<IJwk>(Jwk.CLASS_NAME, nameof(jwk), jwk);\n\n\t\tlet publicKey: Uint8Array | undefined;\n\t\tlet privateKey: Uint8Array | undefined;\n\n\t\tif (Is.stringBase64Url(jwk.x)) {\n\t\t\tpublicKey = Converter.base64UrlToBytes(jwk.x);\n\t\t}\n\t\tif (Is.stringBase64Url(jwk.d)) {\n\t\t\tprivateKey = Converter.base64UrlToBytes(jwk.d);\n\t\t}\n\n\t\treturn {\n\t\t\tpublicKey,\n\t\t\tprivateKey\n\t\t};\n\t}\n\n\t/**\n\t * Generate a KID for the JWK.\n\t * @param jwk The JWK to generate a KID for.\n\t * @returns The KID.\n\t */\n\tpublic static async generateKid(jwk: IJwk): Promise<string> {\n\t\tGuards.object<IJwk>(Jwk.CLASS_NAME, nameof(jwk), jwk);\n\n\t\tconst kidProps = ObjectHelper.pick(jwk, [\"crv\", \"kty\", \"x\"]);\n\n\t\tconst canonicalJson = JsonHelper.canonicalize(kidProps);\n\n\t\tconst hash = Sha256.sum256(Converter.utf8ToBytes(canonicalJson));\n\n\t\treturn Converter.bytesToBase64Url(hash);\n\t}\n}\n"]}

package/dist/es/utils/jws.js

@@ -0,0 +1,58 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Guards, Is } from "@twin.org/core";
+import { CompactSign, flattenedVerify } from "jose";
+/**
+ * Class to handle JSON Web Signatures.
+ */
+export class Jws {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Jws";
+    /**
+     * Create a signature.
+     * @param privateKey The private key to use.
+     * @param hash The hash to sign.
+     * @param algOverride An optional algorithm override.
+     * @returns The signature.
+     */
+    static async create(privateKey, hash, algOverride) {
+        Guards.defined(Jws.CLASS_NAME, "privateKey", privateKey);
+        Guards.uint8Array(Jws.CLASS_NAME, "hash", hash);
+        try {
+            const jws = await new CompactSign(hash)
+                .setProtectedHeader({
+                alg: algOverride ?? (Is.uint8Array(privateKey) ? "EdDSA" : privateKey.algorithm.name),
+                b64: false,
+                crit: ["b64"]
+            })
+                .sign(privateKey);
+            return jws;
+        }
+        catch (err) {
+            throw new GeneralError(Jws.CLASS_NAME, "createFailed", undefined, err);
+        }
+    }
+    /**
+     * Verify a signature.
+     * @param jws The signature to verify.
+     * @param publicKey The public key to verify the signature with.
+     * @param hash The hash to verify.
+     * @returns True if the signature was verified.
+     */
+    static async verify(jws, publicKey, hash) {
+        Guards.stringValue(Jws.CLASS_NAME, "jws", jws);
+        Guards.defined(Jws.CLASS_NAME, "publicKey", publicKey);
+        Guards.uint8Array(Jws.CLASS_NAME, "hash", hash);
+        try {
+            const jwsParts = jws.split(".");
+            await flattenedVerify({ protected: jwsParts[0], payload: hash, signature: jwsParts[2] }, publicKey);
+            return true;
+        }
+        catch (err) {
+            throw new GeneralError(Jws.CLASS_NAME, "verifyFailed", undefined, err);
+        }
+    }
+}
+//# sourceMappingURL=jws.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jws.js","sourceRoot":"","sources":["../../../src/utils/jws.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAGpD;;GAEG;AACH,MAAM,OAAO,GAAG;IACf;;OAEG;IACI,MAAM,CAAU,UAAU,SAAyB;IAE1D;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,UAAwB,EACxB,IAAgB,EAChB,WAAoB;QAEpB,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAC/D,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAEtD,IAAI,CAAC;YACJ,MAAM,GAAG,GAAG,MAAM,IAAI,WAAW,CAAC,IAAI,CAAC;iBACrC,kBAAkB,CAAC;gBACnB,GAAG,EAAE,WAAW,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;gBACrF,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,CAAC,KAAK,CAAC;aACb,CAAC;iBACD,IAAI,CAAC,UAAU,CAAC,CAAC;YAEnB,OAAO,GAAG,CAAC;QACZ,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;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACzB,GAAW,EACX,SAAuB,EACvB,IAAgB;QAEhB,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACrD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAC7D,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAEtD,IAAI,CAAC;YACJ,MAAM,QAAQ,GAAa,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE1C,MAAM,eAAe,CACpB,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,EACjE,SAAS,CACT,CAAC;YAEF,OAAO,IAAI,CAAC;QACb,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","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { CompactSign, flattenedVerify } from \"jose\";\nimport type { JwkCryptoKey } from \"../models/jwkCryptoKey.js\";\n\n/**\n * Class to handle JSON Web Signatures.\n */\nexport class Jws {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Jws>();\n\n\t/**\n\t * Create a signature.\n\t * @param privateKey The private key to use.\n\t * @param hash The hash to sign.\n\t * @param algOverride An optional algorithm override.\n\t * @returns The signature.\n\t */\n\tpublic static async create(\n\t\tprivateKey: JwkCryptoKey,\n\t\thash: Uint8Array,\n\t\talgOverride?: string\n\t): Promise<string> {\n\t\tGuards.defined(Jws.CLASS_NAME, nameof(privateKey), privateKey);\n\t\tGuards.uint8Array(Jws.CLASS_NAME, nameof(hash), hash);\n\n\t\ttry {\n\t\t\tconst jws = await new CompactSign(hash)\n\t\t\t\t.setProtectedHeader({\n\t\t\t\t\talg: algOverride ?? (Is.uint8Array(privateKey) ? \"EdDSA\" : privateKey.algorithm.name),\n\t\t\t\t\tb64: false,\n\t\t\t\t\tcrit: [\"b64\"]\n\t\t\t\t})\n\t\t\t\t.sign(privateKey);\n\n\t\t\treturn jws;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(Jws.CLASS_NAME, \"createFailed\", undefined, err);\n\t\t}\n\t}\n\n\t/**\n\t * Verify a signature.\n\t * @param jws The signature to verify.\n\t * @param publicKey The public key to verify the signature with.\n\t * @param hash The hash to verify.\n\t * @returns True if the signature was verified.\n\t */\n\tpublic static async verify(\n\t\tjws: string,\n\t\tpublicKey: JwkCryptoKey,\n\t\thash: Uint8Array\n\t): Promise<boolean> {\n\t\tGuards.stringValue(Jws.CLASS_NAME, nameof(jws), jws);\n\t\tGuards.defined(Jws.CLASS_NAME, nameof(publicKey), publicKey);\n\t\tGuards.uint8Array(Jws.CLASS_NAME, nameof(hash), hash);\n\n\t\ttry {\n\t\t\tconst jwsParts: string[] = jws.split(\".\");\n\n\t\t\tawait flattenedVerify(\n\t\t\t\t{ protected: jwsParts[0], payload: hash, signature: jwsParts[2] },\n\t\t\t\tpublicKey\n\t\t\t);\n\n\t\t\treturn true;\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(Jws.CLASS_NAME, \"verifyFailed\", undefined, err);\n\t\t}\n\t}\n}\n"]}