@3sixty/api-models 0.0.0-stage → 0.20.0-next.0

package/dist/es/helpers/httpUrlHelper.js

@@ -0,0 +1,156 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is, StringHelper } from "@3sixty/core";
+/**
+ * Class to help with handling http URLs.
+ */
+export class HttpUrlHelper {
+    /**
+     * Extract the origin from the url which includes protocol,host,port.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/origin
+     * @param url The url to extract the origin from.
+     * @returns The extracted origin.
+     */
+    static extractOrigin(url) {
+        try {
+            const convertedUrl = new URL(url);
+            return convertedUrl.origin;
+        }
+        catch { }
+    }
+    /**
+     * Extract the path from the url.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname
+     * @param url The url to extract the path from.
+     * @returns The extracted path.
+     */
+    static extractPath(url) {
+        try {
+            const convertedUrl = new URL(url);
+            return convertedUrl.pathname;
+        }
+        catch { }
+    }
+    /**
+     * Extract the search from the url.
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/search
+     * @param url The url to extract the search from.
+     * @returns The extracted search.
+     */
+    static extractSearch(url) {
+        try {
+            const convertedUrl = new URL(url);
+            return convertedUrl.search;
+        }
+        catch { }
+    }
+    /**
+     * Extract the path and search from the url.
+     * @param url The url to extract the path and search from.
+     * @returns The extracted path and search.
+     */
+    static extractPathAndSearch(url) {
+        try {
+            const convertedUrl = new URL(url);
+            return `${convertedUrl.pathname}${convertedUrl.search}`;
+        }
+        catch { }
+    }
+    /**
+     * Combine an optional origin and an optional path into a single URL string.
+     * Relative paths (no protocol, no leading slash) have a leading slash prepended.
+     * Trailing slashes are trimmed from the origin before joining.
+     * Returns undefined when both arguments are absent or empty.
+     * @param origin The optional origin (e.g. "https://example.com").
+     * @param path The optional path or URL template (e.g. "/api/items" or "api/items").
+     * @returns The combined string, or undefined when both are absent.
+     */
+    static combineOriginPath(origin, path) {
+        const normalizedPath = Is.stringValue(path) && !path.includes("://")
+            ? `/${StringHelper.trimLeadingSlashes(path)}`
+            : path;
+        if (Is.stringValue(origin) && Is.stringValue(normalizedPath)) {
+            return `${StringHelper.trimTrailingSlashes(origin)}${normalizedPath}`;
+        }
+        else if (Is.stringValue(origin)) {
+            return origin;
+        }
+        else if (Is.stringValue(normalizedPath)) {
+            return normalizedPath;
+        }
+    }
+    /**
+     * Encode a single URL path segment per RFC 3986 §3.3.
+     * Unlike encodeURIComponent, sub-delimiters ($ & + , ; =) and the colon and
+     * at-sign characters that are valid unencoded in path segments are preserved.
+     * @see https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+     * @param segment The raw path segment value to encode.
+     * @returns The percent-encoded path segment.
+     */
+    static encodeUriPathSegment(segment) {
+        // RFC 3986 §3.3: only encode characters outside the allowed path segment set.
+        // Allowed: unreserved (A-Za-z0-9 - . _ ~), sub-delimiters (! $ & ' ( ) * + , ; =), and : @
+        return segment.replace(/[^\w!$&'()*+,.:;=@~-]/g, ch => encodeURIComponent(ch));
+    }
+    /**
+     * Replace the origin in the url.
+     * @param url The url to replace the origin in.
+     * @param newOrigin The new origin to use.
+     * @returns The url with the replaced origin.
+     */
+    static replaceOrigin(url, newOrigin) {
+        if (!Is.stringValue(url) || !Is.stringValue(newOrigin) || !newOrigin.startsWith("http")) {
+            return url;
+        }
+        try {
+            const parsedUrl = new URL(url.startsWith("/") ? `http://placeholder${url}` : url);
+            const newParsedUrl = new URL(newOrigin);
+            parsedUrl.protocol = newParsedUrl.protocol;
+            parsedUrl.host = newParsedUrl.host;
+            parsedUrl.port = newParsedUrl.port;
+            return parsedUrl.toString();
+        }
+        catch { }
+        return url;
+    }
+    /**
+     * Add a query string parameter to the url.
+     * @param url The url to add the query string parameter to.
+     * @param key The key of the query string parameter.
+     * @param value The value of the query string parameter.
+     * @returns The url with the added query string parameter.
+     */
+    static addQueryStringParam(url, key, value) {
+        if (!Is.stringValue(url) || !Is.stringValue(key) || !Is.stringValue(value)) {
+            return url;
+        }
+        try {
+            const isRelative = url.startsWith("/");
+            const parsedUrl = new URL(isRelative ? `http://placeholder${url}` : url);
+            parsedUrl.searchParams.set(key, value);
+            return isRelative
+                ? `${parsedUrl.pathname}${parsedUrl.search}${parsedUrl.hash}`
+                : parsedUrl.toString();
+        }
+        catch { }
+        return url;
+    }
+    /**
+     * Get a query string parameter from the url.
+     * @param url The url to get the query string parameter from.
+     * @param key The key of the query string parameter.
+     * @returns The value of the query string parameter.
+     */
+    static getQueryStringParam(url, key) {
+        if (!Is.stringValue(url) || !Is.stringValue(key)) {
+            return undefined;
+        }
+        try {
+            const parsedUrl = new URL(url);
+            return parsedUrl.searchParams.get(key) ?? undefined;
+        }
+        catch { }
+        return undefined;
+    }
+}
+//# sourceMappingURL=httpUrlHelper.js.map

package/dist/es/helpers/httpUrlHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpUrlHelper.js","sourceRoot":"","sources":["../../../src/helpers/httpUrlHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAEhD;;GAEG;AACH,MAAM,OAAO,aAAa;IACzB;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,GAAW;QACtC,IAAI,CAAC;YACJ,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,YAAY,CAAC,MAAM,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,GAAW;QACpC,IAAI,CAAC;YACJ,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,YAAY,CAAC,QAAQ,CAAC;QAC9B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACX,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,GAAW;QACtC,IAAI,CAAC;YACJ,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,YAAY,CAAC,MAAM,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACX,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,oBAAoB,CAAC,GAAW;QAC7C,IAAI,CAAC;YACJ,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAClC,OAAO,GAAG,YAAY,CAAC,QAAQ,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC;QACzD,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACX,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,iBAAiB,CAAC,MAAe,EAAE,IAAa;QAC7D,MAAM,cAAc,GACnB,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC5C,CAAC,CAAC,IAAI,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE;YAC7C,CAAC,CAAC,IAAI,CAAC;QAET,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YAC9D,OAAO,GAAG,YAAY,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,cAAc,EAAE,CAAC;QACvE,CAAC;aAAM,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC;QACf,CAAC;aAAM,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YAC3C,OAAO,cAAc,CAAC;QACvB,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACjD,8EAA8E;QAC9E,2FAA2F;QAC3F,OAAO,OAAO,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC,EAAE,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC;IAChF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,GAAW,EAAE,SAAkB;QAC1D,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YACzF,OAAO,GAAG,CAAC;QACZ,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAClF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;YACxC,SAAS,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAC;YAC3C,SAAS,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;YACnC,SAAS,CAAC,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;YACnC,OAAO,SAAS,CAAC,QAAQ,EAAE,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,mBAAmB,CAAC,GAAW,EAAE,GAAW,EAAE,KAAa;QACxE,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5E,OAAO,GAAG,CAAC;QACZ,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACvC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,qBAAqB,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACzE,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvC,OAAO,UAAU;gBAChB,CAAC,CAAC,GAAG,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,IAAI,EAAE;gBAC7D,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,mBAAmB,CAAC,GAAW,EAAE,GAAW;QACzD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAClD,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YAC/B,OAAO,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,OAAO,SAAS,CAAC;IAClB,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is, StringHelper } from \"@3sixty/core\";\n\n/**\n * Class to help with handling http URLs.\n */\nexport class HttpUrlHelper {\n\t/**\n\t * Extract the origin from the url which includes protocol,host,port.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/origin\n\t * @param url The url to extract the origin from.\n\t * @returns The extracted origin.\n\t */\n\tpublic static extractOrigin(url: string): string | undefined {\n\t\ttry {\n\t\t\tconst convertedUrl = new URL(url);\n\t\t\treturn convertedUrl.origin;\n\t\t} catch {}\n\t}\n\n\t/**\n\t * Extract the path from the url.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/pathname\n\t * @param url The url to extract the path from.\n\t * @returns The extracted path.\n\t */\n\tpublic static extractPath(url: string): string | undefined {\n\t\ttry {\n\t\t\tconst convertedUrl = new URL(url);\n\t\t\treturn convertedUrl.pathname;\n\t\t} catch {}\n\t}\n\n\t/**\n\t * Extract the search from the url.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/API/URL/search\n\t * @param url The url to extract the search from.\n\t * @returns The extracted search.\n\t */\n\tpublic static extractSearch(url: string): string | undefined {\n\t\ttry {\n\t\t\tconst convertedUrl = new URL(url);\n\t\t\treturn convertedUrl.search;\n\t\t} catch {}\n\t}\n\n\t/**\n\t * Extract the path and search from the url.\n\t * @param url The url to extract the path and search from.\n\t * @returns The extracted path and search.\n\t */\n\tpublic static extractPathAndSearch(url: string): string | undefined {\n\t\ttry {\n\t\t\tconst convertedUrl = new URL(url);\n\t\t\treturn `${convertedUrl.pathname}${convertedUrl.search}`;\n\t\t} catch {}\n\t}\n\n\t/**\n\t * Combine an optional origin and an optional path into a single URL string.\n\t * Relative paths (no protocol, no leading slash) have a leading slash prepended.\n\t * Trailing slashes are trimmed from the origin before joining.\n\t * Returns undefined when both arguments are absent or empty.\n\t * @param origin The optional origin (e.g. \"https://example.com\").\n\t * @param path The optional path or URL template (e.g. \"/api/items\" or \"api/items\").\n\t * @returns The combined string, or undefined when both are absent.\n\t */\n\tpublic static combineOriginPath(origin?: string, path?: string): string | undefined {\n\t\tconst normalizedPath =\n\t\t\tIs.stringValue(path) && !path.includes(\"://\")\n\t\t\t\t? `/${StringHelper.trimLeadingSlashes(path)}`\n\t\t\t\t: path;\n\n\t\tif (Is.stringValue(origin) && Is.stringValue(normalizedPath)) {\n\t\t\treturn `${StringHelper.trimTrailingSlashes(origin)}${normalizedPath}`;\n\t\t} else if (Is.stringValue(origin)) {\n\t\t\treturn origin;\n\t\t} else if (Is.stringValue(normalizedPath)) {\n\t\t\treturn normalizedPath;\n\t\t}\n\t}\n\n\t/**\n\t * Encode a single URL path segment per RFC 3986 §3.3.\n\t * Unlike encodeURIComponent, sub-delimiters ($ & + , ; =) and the colon and\n\t * at-sign characters that are valid unencoded in path segments are preserved.\n\t * @see https://datatracker.ietf.org/doc/html/rfc3986#section-3.3\n\t * @param segment The raw path segment value to encode.\n\t * @returns The percent-encoded path segment.\n\t */\n\tpublic static encodeUriPathSegment(segment: string): string {\n\t\t// RFC 3986 §3.3: only encode characters outside the allowed path segment set.\n\t\t// Allowed: unreserved (A-Za-z0-9 - . _ ~), sub-delimiters (! $ & ' ( ) * + , ; =), and : @\n\t\treturn segment.replace(/[^\\w!$&'()*+,.:;=@~-]/g, ch => encodeURIComponent(ch));\n\t}\n\n\t/**\n\t * Replace the origin in the url.\n\t * @param url The url to replace the origin in.\n\t * @param newOrigin The new origin to use.\n\t * @returns The url with the replaced origin.\n\t */\n\tpublic static replaceOrigin(url: string, newOrigin?: string): string {\n\t\tif (!Is.stringValue(url) || !Is.stringValue(newOrigin) || !newOrigin.startsWith(\"http\")) {\n\t\t\treturn url;\n\t\t}\n\n\t\ttry {\n\t\t\tconst parsedUrl = new URL(url.startsWith(\"/\") ? `http://placeholder${url}` : url);\n\t\t\tconst newParsedUrl = new URL(newOrigin);\n\t\t\tparsedUrl.protocol = newParsedUrl.protocol;\n\t\t\tparsedUrl.host = newParsedUrl.host;\n\t\t\tparsedUrl.port = newParsedUrl.port;\n\t\t\treturn parsedUrl.toString();\n\t\t} catch {}\n\n\t\treturn url;\n\t}\n\n\t/**\n\t * Add a query string parameter to the url.\n\t * @param url The url to add the query string parameter to.\n\t * @param key The key of the query string parameter.\n\t * @param value The value of the query string parameter.\n\t * @returns The url with the added query string parameter.\n\t */\n\tpublic static addQueryStringParam(url: string, key: string, value: string): string {\n\t\tif (!Is.stringValue(url) || !Is.stringValue(key) || !Is.stringValue(value)) {\n\t\t\treturn url;\n\t\t}\n\n\t\ttry {\n\t\t\tconst isRelative = url.startsWith(\"/\");\n\t\t\tconst parsedUrl = new URL(isRelative ? `http://placeholder${url}` : url);\n\t\t\tparsedUrl.searchParams.set(key, value);\n\t\t\treturn isRelative\n\t\t\t\t? `${parsedUrl.pathname}${parsedUrl.search}${parsedUrl.hash}`\n\t\t\t\t: parsedUrl.toString();\n\t\t} catch {}\n\n\t\treturn url;\n\t}\n\n\t/**\n\t * Get a query string parameter from the url.\n\t * @param url The url to get the query string parameter from.\n\t * @param key The key of the query string parameter.\n\t * @returns The value of the query string parameter.\n\t */\n\tpublic static getQueryStringParam(url: string, key: string): string | undefined {\n\t\tif (!Is.stringValue(url) || !Is.stringValue(key)) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\ttry {\n\t\t\tconst parsedUrl = new URL(url);\n\t\t\treturn parsedUrl.searchParams.get(key) ?? undefined;\n\t\t} catch {}\n\n\t\treturn undefined;\n\t}\n}\n"]}

package/dist/es/helpers/scopeHelper.js

@@ -0,0 +1,46 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is } from "@3sixty/core";
+/**
+ * Helper methods for working with scope values stored as comma-separated strings.
+ */
+export class ScopeHelper {
+    /**
+     * Converts a scope value to a normalised lowercase array. Accepts either a comma-separated
+     * string or an already-split array, so callers do not need to branch on input type.
+     * Returns an empty array for an empty or undefined input.
+     * @param scope The comma-separated scope string, or an array of scope entries.
+     * @returns The scope entries as a trimmed, lowercase array.
+     */
+    static toArray(scope) {
+        if (Array.isArray(scope)) {
+            return scope.map(s => s.trim().toLocaleLowerCase()).filter(s => s.length > 0);
+        }
+        if (!Is.stringValue(scope)) {
+            return [];
+        }
+        return scope
+            .split(",")
+            .map(s => s.trim().toLocaleLowerCase())
+            .filter(s => s.length > 0);
+    }
+    /**
+     * Joins a scope array into a normalised comma-separated string, trimming and lowercasing each entry.
+     * @param scopes The scope entries to join.
+     * @returns The comma-separated scope string.
+     */
+    static toString(scopes) {
+        return scopes.map(s => s.trim().toLocaleLowerCase()).join(",");
+    }
+    /**
+     * Returns true if the scope includes the specified value. Accepts either a
+     * comma-separated string or an array, matching the input forms accepted by toArray.
+     * @param scope The comma-separated scope string or array to search.
+     * @param value The scope value to look for.
+     * @returns True when value is present in the scope.
+     */
+    static includes(scope, value) {
+        return ScopeHelper.toArray(scope).includes(value);
+    }
+}
+//# sourceMappingURL=scopeHelper.js.map

package/dist/es/helpers/scopeHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopeHelper.js","sourceRoot":"","sources":["../../../src/helpers/scopeHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAElC;;GAEG;AACH,MAAM,OAAO,WAAW;IACvB;;;;;;OAMG;IACI,MAAM,CAAC,OAAO,CAAC,KAAoC;QACzD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,EAAE,CAAC;QACX,CAAC;QACD,OAAO,KAAK;aACV,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,iBAAiB,EAAE,CAAC;aACtC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,MAAgB;QACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,QAAQ,CAAC,KAAoC,EAAE,KAAa;QACzE,OAAO,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is } from \"@3sixty/core\";\n\n/**\n * Helper methods for working with scope values stored as comma-separated strings.\n */\nexport class ScopeHelper {\n\t/**\n\t * Converts a scope value to a normalised lowercase array. Accepts either a comma-separated\n\t * string or an already-split array, so callers do not need to branch on input type.\n\t * Returns an empty array for an empty or undefined input.\n\t * @param scope The comma-separated scope string, or an array of scope entries.\n\t * @returns The scope entries as a trimmed, lowercase array.\n\t */\n\tpublic static toArray(scope: string | string[] | undefined): string[] {\n\t\tif (Array.isArray(scope)) {\n\t\t\treturn scope.map(s => s.trim().toLocaleLowerCase()).filter(s => s.length > 0);\n\t\t}\n\t\tif (!Is.stringValue(scope)) {\n\t\t\treturn [];\n\t\t}\n\t\treturn scope\n\t\t\t.split(\",\")\n\t\t\t.map(s => s.trim().toLocaleLowerCase())\n\t\t\t.filter(s => s.length > 0);\n\t}\n\n\t/**\n\t * Joins a scope array into a normalised comma-separated string, trimming and lowercasing each entry.\n\t * @param scopes The scope entries to join.\n\t * @returns The comma-separated scope string.\n\t */\n\tpublic static toString(scopes: string[]): string {\n\t\treturn scopes.map(s => s.trim().toLocaleLowerCase()).join(\",\");\n\t}\n\n\t/**\n\t * Returns true if the scope includes the specified value. Accepts either a\n\t * comma-separated string or an array, matching the input forms accepted by toArray.\n\t * @param scope The comma-separated scope string or array to search.\n\t * @param value The scope value to look for.\n\t * @returns True when value is present in the scope.\n\t */\n\tpublic static includes(scope: string | string[] | undefined, value: string): boolean {\n\t\treturn ScopeHelper.toArray(scope).includes(value);\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,78 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./errors/forbiddenError.js";
+export * from "./errors/tooManyRequestsError.js";
+export * from "./factories/mimeTypeProcessorFactory.js";
+export * from "./factories/restClientProcessorFactory.js";
+export * from "./factories/restRouteProcessorFactory.js";
+export * from "./factories/socketRouteProcessorFactory.js";
+export * from "./helpers/httpErrorHelper.js";
+export * from "./helpers/httpHeaderHelper.js";
+export * from "./helpers/httpParameterHelper.js";
+export * from "./helpers/httpUrlHelper.js";
+export * from "./helpers/scopeHelper.js";
+export * from "./models/api/IServerFavIconResponse.js";
+export * from "./models/api/IServerHealthResponse.js";
+export * from "./models/api/IServerInfoResponse.js";
+export * from "./models/api/IServerLivezResponse.js";
+export * from "./models/api/IServerReadyzResponse.js";
+export * from "./models/api/IServerRootResponse.js";
+export * from "./models/api/IServerSpecResponse.js";
+export * from "./models/client/IRestClientProcessor.js";
+export * from "./models/client/IRestClientProcessorContext.js";
+export * from "./models/config/IBaseRestClientConfig.js";
+export * from "./models/config/IBaseSocketClientConfig.js";
+export * from "./models/healthCategory.js";
+export * from "./models/healthStatus.js";
+export * from "./models/httpContextIdKeys.js";
+export * from "./models/IHealth.js";
+export * from "./models/protocol/IHttpRequest.js";
+export * from "./models/protocol/IHttpRequestContext.js";
+export * from "./models/protocol/IHttpRequestPathParams.js";
+export * from "./models/protocol/IHttpRequestQuery.js";
+export * from "./models/protocol/IHttpResponse.js";
+export * from "./models/protocol/IHttpServerRequest.js";
+export * from "./models/protocol/ISocketRequestContext.js";
+export * from "./models/protocol/ISocketServerRequest.js";
+export * from "./models/requests/INoContentRequest.js";
+export * from "./models/responses/errors/IBadRequestResponse.js";
+export * from "./models/responses/errors/IConflictResponse.js";
+export * from "./models/responses/errors/IForbiddenResponse.js";
+export * from "./models/responses/errors/IInternalServerErrorResponse.js";
+export * from "./models/responses/errors/INotFoundResponse.js";
+export * from "./models/responses/errors/INotImplementedResponse.js";
+export * from "./models/responses/errors/ITooManyRequestsResponse.js";
+export * from "./models/responses/errors/IUnauthorizedResponse.js";
+export * from "./models/responses/errors/IUnprocessableEntityResponse.js";
+export * from "./models/responses/success/IAcceptedResponse.js";
+export * from "./models/responses/success/ICreatedResponse.js";
+export * from "./models/responses/success/INoContentResponse.js";
+export * from "./models/responses/success/IOkResponse.js";
+export * from "./models/routes/httpBodyLimit.js";
+export * from "./models/routes/IBaseRoute.js";
+export * from "./models/routes/IBaseRouteEntryPoint.js";
+export * from "./models/routes/IRestRoute.js";
+export * from "./models/routes/IRestRouteEntryPoint.js";
+export * from "./models/routes/IRestRouteExample.js";
+export * from "./models/routes/IRestRouteRequestExample.js";
+export * from "./models/routes/IRestRouteResponseAttachmentOptions.js";
+export * from "./models/routes/IRestRouteResponseExample.js";
+export * from "./models/routes/IRestRouteResponseOptions.js";
+export * from "./models/routes/ISocketRoute.js";
+export * from "./models/routes/ISocketRouteEntryPoint.js";
+export * from "./models/routes/ITag.js";
+export * from "./models/server/IBaseRouteProcessor.js";
+export * from "./models/server/IMimeTypeProcessor.js";
+export * from "./models/server/IRestRouteProcessor.js";
+export * from "./models/server/ISocketRouteProcessor.js";
+export * from "./models/server/IWebServer.js";
+export * from "./models/server/IWebServerOptions.js";
+export * from "./models/services/IHealthApplicationCallback.js";
+export * from "./models/services/IHealthComponent.js";
+export * from "./models/services/IHealthProviderComponent.js";
+export * from "./models/services/IInformationComponent.js";
+export * from "./models/services/IPlatformComponent.js";
+export * from "./models/services/IServerInfo.js";
+export * from "./models/services/ITenant.js";
+export * from "./models/services/ITenantAdminComponent.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AACxD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,kCAAkC,CAAC;AACjD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qCAAqC,CAAC;AACpD,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,qCAAqC,CAAC;AACpD,cAAc,qCAAqC,CAAC;AACpD,cAAc,yCAAyC,CAAC;AACxD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AACzC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qBAAqB,CAAC;AACpC,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AACzD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,yCAAyC,CAAC;AACxD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wCAAwC,CAAC;AACvD,cAAc,kDAAkD,CAAC;AACjE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,oDAAoD,CAAC;AACnE,cAAc,2DAA2D,CAAC;AAC1E,cAAc,iDAAiD,CAAC;AAChE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,kDAAkD,CAAC;AACjE,cAAc,2CAA2C,CAAC;AAC1D,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,yCAAyC,CAAC;AACxD,cAAc,sCAAsC,CAAC;AACrD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wDAAwD,CAAC;AACvE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,iCAAiC,CAAC;AAChD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC;AACxC,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,0CAA0C,CAAC;AACzD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,iDAAiD,CAAC;AAChE,cAAc,uCAAuC,CAAC;AACtD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,kCAAkC,CAAC;AACjD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4CAA4C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./errors/forbiddenError.js\";\nexport * from \"./errors/tooManyRequestsError.js\";\nexport * from \"./factories/mimeTypeProcessorFactory.js\";\nexport * from \"./factories/restClientProcessorFactory.js\";\nexport * from \"./factories/restRouteProcessorFactory.js\";\nexport * from \"./factories/socketRouteProcessorFactory.js\";\nexport * from \"./helpers/httpErrorHelper.js\";\nexport * from \"./helpers/httpHeaderHelper.js\";\nexport * from \"./helpers/httpParameterHelper.js\";\nexport * from \"./helpers/httpUrlHelper.js\";\nexport * from \"./helpers/scopeHelper.js\";\nexport * from \"./models/api/IServerFavIconResponse.js\";\nexport * from \"./models/api/IServerHealthResponse.js\";\nexport * from \"./models/api/IServerInfoResponse.js\";\nexport * from \"./models/api/IServerLivezResponse.js\";\nexport * from \"./models/api/IServerReadyzResponse.js\";\nexport * from \"./models/api/IServerRootResponse.js\";\nexport * from \"./models/api/IServerSpecResponse.js\";\nexport * from \"./models/client/IRestClientProcessor.js\";\nexport * from \"./models/client/IRestClientProcessorContext.js\";\nexport * from \"./models/config/IBaseRestClientConfig.js\";\nexport * from \"./models/config/IBaseSocketClientConfig.js\";\nexport * from \"./models/healthCategory.js\";\nexport * from \"./models/healthStatus.js\";\nexport * from \"./models/httpContextIdKeys.js\";\nexport * from \"./models/IHealth.js\";\nexport * from \"./models/protocol/IHttpRequest.js\";\nexport * from \"./models/protocol/IHttpRequestContext.js\";\nexport * from \"./models/protocol/IHttpRequestPathParams.js\";\nexport * from \"./models/protocol/IHttpRequestQuery.js\";\nexport * from \"./models/protocol/IHttpResponse.js\";\nexport * from \"./models/protocol/IHttpServerRequest.js\";\nexport * from \"./models/protocol/ISocketRequestContext.js\";\nexport * from \"./models/protocol/ISocketServerRequest.js\";\nexport * from \"./models/requests/INoContentRequest.js\";\nexport * from \"./models/responses/errors/IBadRequestResponse.js\";\nexport * from \"./models/responses/errors/IConflictResponse.js\";\nexport * from \"./models/responses/errors/IForbiddenResponse.js\";\nexport * from \"./models/responses/errors/IInternalServerErrorResponse.js\";\nexport * from \"./models/responses/errors/INotFoundResponse.js\";\nexport * from \"./models/responses/errors/INotImplementedResponse.js\";\nexport * from \"./models/responses/errors/ITooManyRequestsResponse.js\";\nexport * from \"./models/responses/errors/IUnauthorizedResponse.js\";\nexport * from \"./models/responses/errors/IUnprocessableEntityResponse.js\";\nexport * from \"./models/responses/success/IAcceptedResponse.js\";\nexport * from \"./models/responses/success/ICreatedResponse.js\";\nexport * from \"./models/responses/success/INoContentResponse.js\";\nexport * from \"./models/responses/success/IOkResponse.js\";\nexport * from \"./models/routes/httpBodyLimit.js\";\nexport * from \"./models/routes/IBaseRoute.js\";\nexport * from \"./models/routes/IBaseRouteEntryPoint.js\";\nexport * from \"./models/routes/IRestRoute.js\";\nexport * from \"./models/routes/IRestRouteEntryPoint.js\";\nexport * from \"./models/routes/IRestRouteExample.js\";\nexport * from \"./models/routes/IRestRouteRequestExample.js\";\nexport * from \"./models/routes/IRestRouteResponseAttachmentOptions.js\";\nexport * from \"./models/routes/IRestRouteResponseExample.js\";\nexport * from \"./models/routes/IRestRouteResponseOptions.js\";\nexport * from \"./models/routes/ISocketRoute.js\";\nexport * from \"./models/routes/ISocketRouteEntryPoint.js\";\nexport * from \"./models/routes/ITag.js\";\nexport * from \"./models/server/IBaseRouteProcessor.js\";\nexport * from \"./models/server/IMimeTypeProcessor.js\";\nexport * from \"./models/server/IRestRouteProcessor.js\";\nexport * from \"./models/server/ISocketRouteProcessor.js\";\nexport * from \"./models/server/IWebServer.js\";\nexport * from \"./models/server/IWebServerOptions.js\";\nexport * from \"./models/services/IHealthApplicationCallback.js\";\nexport * from \"./models/services/IHealthComponent.js\";\nexport * from \"./models/services/IHealthProviderComponent.js\";\nexport * from \"./models/services/IInformationComponent.js\";\nexport * from \"./models/services/IPlatformComponent.js\";\nexport * from \"./models/services/IServerInfo.js\";\nexport * from \"./models/services/ITenant.js\";\nexport * from \"./models/services/ITenantAdminComponent.js\";\n"]}

package/dist/es/models/IHealth.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHealth.js.map

package/dist/es/models/IHealth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHealth.js","sourceRoot":"","sources":["../../../src/models/IHealth.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\nimport type { HealthCategory } from \"./healthCategory.js\";\nimport type { HealthStatus } from \"./healthStatus.js\";\n\n/**\n * Provides health information for a component.\n */\nexport interface IHealth {\n\t/**\n\t * The source of the health information.\n\t */\n\tsource: string;\n\n\t/**\n\t * The description of the component as an i18n key.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * The category of the health check.\n\t */\n\tcategory?: HealthCategory;\n\n\t/**\n\t * The overall status of the component, the entries can also report their own health.\n\t */\n\tstatus: HealthStatus;\n\n\t/**\n\t * The error details when the status is not Ok.\n\t */\n\terror?: IError;\n\n\t/**\n\t * The message for the status if there are further details to provide as an i18n key.\n\t */\n\tmessage?: string;\n\n\t/**\n\t * Data to substitute in the i18n key for the message.\n\t */\n\tdata?: { [id: string]: unknown };\n\n\t/**\n\t * The grouped child components, if any.\n\t */\n\tgrouped?: IHealth[];\n}\n"]}

package/dist/es/models/api/IServerFavIconResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerFavIconResponse.js.map

package/dist/es/models/api/IServerFavIconResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerFavIconResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerFavIconResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, HttpStatusCode } from \"@3sixty/web\";\n\n/**\n * The favicon for the server.\n */\nexport interface IServerFavIconResponse {\n\t/**\n\t * Additional response headers.\n\t */\n\theaders?: {\n\t\t/**\n\t\t * The content type for the response.\n\t\t */\n\t\t[HeaderTypes.ContentType]?: string;\n\t};\n\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The favicon for the server.\n\t */\n\tbody?: Uint8Array;\n}\n"]}

package/dist/es/models/api/IServerHealthResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerHealthResponse.js.map

package/dist/es/models/api/IServerHealthResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerHealthResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerHealthResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HealthStatus } from \"../healthStatus.js\";\nimport type { IHealth } from \"../IHealth.js\";\n\n/**\n * The health of the server.\n */\nexport interface IServerHealthResponse {\n\t/**\n\t * The health for the server.\n\t */\n\tbody: { status: HealthStatus; components: IHealth[] };\n}\n"]}

package/dist/es/models/api/IServerInfoResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerInfoResponse.js.map

package/dist/es/models/api/IServerInfoResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerInfoResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerInfoResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IServerInfo } from \"../services/IServerInfo.js\";\n\n/**\n * The information about the server.\n */\nexport interface IServerInfoResponse {\n\t/**\n\t * The information for the server.\n\t */\n\tbody: IServerInfo;\n}\n"]}

package/dist/es/models/api/IServerLivezResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerLivezResponse.js.map

package/dist/es/models/api/IServerLivezResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerLivezResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerLivezResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\n\n/**\n * The livez of the server.\n */\nexport interface IServerLivezResponse {\n\t/**\n\t * The headers for the response.\n\t */\n\theaders: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.PlainText;\n\t};\n\n\t/**\n\t * The livez information for the server.\n\t */\n\tbody: \"alive\" | \"dead\";\n}\n"]}

package/dist/es/models/api/IServerReadyzResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerReadyzResponse.js.map

package/dist/es/models/api/IServerReadyzResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerReadyzResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerReadyzResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\n\n/**\n * The readyz of the server.\n */\nexport interface IServerReadyzResponse {\n\t/**\n\t * The headers for the response.\n\t */\n\theaders: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.PlainText;\n\t};\n\n\t/**\n\t * The readyz information for the server.\n\t */\n\tbody: \"ready\" | \"not ready\";\n}\n"]}

package/dist/es/models/api/IServerRootResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerRootResponse.js.map

package/dist/es/models/api/IServerRootResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerRootResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerRootResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@3sixty/web\";\n\n/**\n * The root text for the server.\n */\nexport interface IServerRootResponse {\n\t/**\n\t * The headers for the response.\n\t */\n\theaders: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.PlainText;\n\t};\n\n\t/**\n\t * The root text for the server.\n\t */\n\tbody: string;\n}\n"]}

package/dist/es/models/api/IServerSpecResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IServerSpecResponse.js.map

package/dist/es/models/api/IServerSpecResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IServerSpecResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IServerSpecResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode } from \"@3sixty/web\";\n\n/**\n * The OpenAPI spec for the endpoints.\n */\nexport interface IServerSpecResponse {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * The spec for the server.\n\t */\n\tbody?: unknown;\n}\n"]}

package/dist/es/models/client/IRestClientProcessor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestClientProcessor.js.map

package/dist/es/models/client/IRestClientProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestClientProcessor.js","sourceRoot":"","sources":["../../../../src/models/client/IRestClientProcessor.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { IRestClientProcessorContext } from \"./IRestClientProcessorContext.js\";\n\n/**\n * A processor that participates in an outbound REST request.\n */\nexport interface IRestClientProcessor extends IComponent {\n\t/**\n\t * Run the processor before the fetch takes place.\n\t * @param context The details of the request being made.\n\t * @param next Performs the request, or calls the next processor in the chain.\n\t * @returns The result of next.\n\t */\n\tpre?(context: IRestClientProcessorContext, next: () => Promise<Response>): Promise<Response>;\n\n\t/**\n\t * Run the processor after the fetch completes.\n\t * @param context The details of the request that was made.\n\t * @param response The response from the request.\n\t * @param next Performs the post processing, or calls the next processor in the chain.\n\t * @returns The result of next.\n\t */\n\tpost?(\n\t\tcontext: IRestClientProcessorContext,\n\t\tresponse: Response,\n\t\tnext: () => Promise<Response>\n\t): Promise<Response>;\n}\n"]}

package/dist/es/models/client/IRestClientProcessorContext.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IRestClientProcessorContext.js.map

package/dist/es/models/client/IRestClientProcessorContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRestClientProcessorContext.js","sourceRoot":"","sources":["../../../../src/models/client/IRestClientProcessorContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod, IHttpHeaders } from \"@3sixty/web\";\n\n/**\n * The context of a rest client processor.\n */\nexport interface IRestClientProcessorContext {\n\t/**\n\t * The name of the REST client making the request.\n\t */\n\trestClientClassName: string;\n\n\t/**\n\t * The base URL of the request.\n\t */\n\tbaseUrl: string;\n\n\t/**\n\t * The route template before path parameter substitution.\n\t */\n\trouteTemplate: string;\n\n\t/**\n\t * The route being requested.\n\t */\n\troute: string;\n\n\t/**\n\t * The HTTP method of the request.\n\t */\n\tmethod: HttpMethod;\n\n\t/**\n\t * The headers being sent with the request.\n\t */\n\theaders: IHttpHeaders;\n\n\t/**\n\t * The timeout for the request in milliseconds.\n\t */\n\ttimeout?: number;\n\n\t/**\n\t * Whether to include credentials in the request.\n\t */\n\tincludeCredentials?: boolean;\n\n\t/**\n\t * The request being made.\n\t */\n\tbody?: string;\n}\n"]}

package/dist/es/models/config/IBaseRestClientConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IBaseRestClientConfig.js.map

package/dist/es/models/config/IBaseRestClientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseRestClientConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IBaseRestClientConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\nimport type { IHttpHeaders } from \"@3sixty/web\";\n\n/**\n * Definition for the configuration of a rest client.\n */\nexport interface IBaseRestClientConfig {\n\t/**\n\t * The endpoint where the api is hosted.\n\t */\n\tendpoint: string;\n\n\t/**\n\t * The prefix to the routes.\n\t */\n\tpathPrefix?: string;\n\n\t/**\n\t * The headers to include in requests.\n\t */\n\theaders?: IHttpHeaders;\n\n\t/**\n\t * Timeout for requests in ms.\n\t */\n\ttimeout?: number;\n\n\t/**\n\t * Include credentials in the request, defaults to true.\n\t */\n\tincludeCredentials?: boolean;\n\n\t/**\n\t * The types of the processors to run around each request, resolved from the `RestClientProcessorFactory`.\n\t */\n\tprocessorTypes?: string[];\n\n\t/**\n\t * Hook to provide headers asynchronously.\n\t * @returns A promise that resolves to the headers.\n\t */\n\tcustomHeaders?: () => Promise<IHttpHeaders>;\n\n\t/**\n\t * Hook to provide an authorization header value asynchronously.\n\t * @returns A promise that resolves to the authorization header value.\n\t */\n\tcustomAuthHeader?: () => Promise<string>;\n\n\t/**\n\t * Hook to handle authorization failures asynchronously.\n\t * @returns A promise that resolves when the auth failure handling is complete.\n\t */\n\tonAuthFailure?: (err: IError) => Promise<void>;\n}\n"]}

package/dist/es/models/config/IBaseSocketClientConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IBaseSocketClientConfig.js.map

package/dist/es/models/config/IBaseSocketClientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBaseSocketClientConfig.js","sourceRoot":"","sources":["../../../../src/models/config/IBaseSocketClientConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpHeaders } from \"@3sixty/web\";\n\n/**\n * Definition for the configuration of a socket service.\n */\nexport interface IBaseSocketClientConfig {\n\t/**\n\t * Base path for the socket service, defaults to /socket.\n\t */\n\tbasePath?: string;\n\n\t/**\n\t * The endpoint where the api is hosted.\n\t */\n\tendpoint: string;\n\n\t/**\n\t * The prefix to the routes.\n\t */\n\tpathPrefix?: string;\n\n\t/**\n\t * The headers to include in requests.\n\t */\n\theaders?: IHttpHeaders;\n}\n"]}

package/dist/es/models/healthCategory.js

@@ -0,0 +1,17 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The category of a health check.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HealthCategory = {
+    /**
+     * Connectivity health check for infrastructure connectors.
+     */
+    Connectivity: "connectivity",
+    /**
+     * Application health check for domain services.
+     */
+    Application: "application"
+};
+//# sourceMappingURL=healthCategory.js.map

package/dist/es/models/healthCategory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthCategory.js","sourceRoot":"","sources":["../../../src/models/healthCategory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,WAAW,EAAE,aAAa;CACjB,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The category of a health check.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HealthCategory = {\n\t/**\n\t * Connectivity health check for infrastructure connectors.\n\t */\n\tConnectivity: \"connectivity\",\n\n\t/**\n\t * Application health check for domain services.\n\t */\n\tApplication: \"application\"\n} as const;\n\n/**\n * The category of a health check.\n */\nexport type HealthCategory = (typeof HealthCategory)[keyof typeof HealthCategory];\n"]}

package/dist/es/models/healthStatus.js

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The health status of the component.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HealthStatus = {
+    /**
+     * OK.
+     */
+    Ok: "ok",
+    /**
+     * Warning.
+     */
+    Warning: "warning",
+    /**
+     * Error.
+     */
+    Error: "error"
+};
+//# sourceMappingURL=healthStatus.js.map

package/dist/es/models/healthStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"healthStatus.js","sourceRoot":"","sources":["../../../src/models/healthStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,YAAY,GAAG;IAC3B;;OAEG;IACH,EAAE,EAAE,IAAI;IAER;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,KAAK,EAAE,OAAO;CACL,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The health status of the component.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HealthStatus = {\n\t/**\n\t * OK.\n\t */\n\tOk: \"ok\",\n\n\t/**\n\t * Warning.\n\t */\n\tWarning: \"warning\",\n\n\t/**\n\t * Error.\n\t */\n\tError: \"error\"\n} as const;\n\n/**\n * The health status of the component.\n */\nexport type HealthStatus = (typeof HealthStatus)[keyof typeof HealthStatus];\n"]}

package/dist/es/models/httpContextIdKeys.js

@@ -0,0 +1,42 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * HTTP definition of some context keys.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HttpContextIdKeys = {
+    /**
+     * IP address of the client.
+     */
+    IpAddress: "ipAddress",
+    /**
+     * User agent of the client.
+     */
+    UserAgent: "userAgent",
+    /**
+     * Correlation ID of the request.
+     */
+    CorrelationId: "correlationId",
+    /**
+     * Is this a remote request, will be a random UUID if request arrived through a REST endpoint, otherwise undefined.
+     */
+    RemoteRequest: "remoteRequest",
+    /**
+     * Public Origin of the request.
+     */
+    PublicOrigin: "publicOrigin",
+    /**
+     * Local Origin of the request.
+     */
+    LocalOrigin: "localOrigin",
+    /**
+     * The comma-separated scope claim from the verified JWT for the current request.
+     */
+    Scope: "scope",
+    /**
+     * The caller's original tenant ID before an escalated privilege tenant override was applied.
+     * Only present when overrideTenant substitution is active for the current request.
+     */
+    OriginalTenant: "originalTenant"
+};
+//# sourceMappingURL=httpContextIdKeys.js.map

package/dist/es/models/httpContextIdKeys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpContextIdKeys.js","sourceRoot":"","sources":["../../../src/models/httpContextIdKeys.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAChC;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,aAAa,EAAE,eAAe;IAE9B;;OAEG;IACH,aAAa,EAAE,eAAe;IAE9B;;OAEG;IACH,YAAY,EAAE,cAAc;IAE5B;;OAEG;IACH,WAAW,EAAE,aAAa;IAE1B;;OAEG;IACH,KAAK,EAAE,OAAO;IAEd;;;OAGG;IACH,cAAc,EAAE,gBAAgB;CACvB,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * HTTP definition of some context keys.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HttpContextIdKeys = {\n\t/**\n\t * IP address of the client.\n\t */\n\tIpAddress: \"ipAddress\",\n\n\t/**\n\t * User agent of the client.\n\t */\n\tUserAgent: \"userAgent\",\n\n\t/**\n\t * Correlation ID of the request.\n\t */\n\tCorrelationId: \"correlationId\",\n\n\t/**\n\t * Is this a remote request, will be a random UUID if request arrived through a REST endpoint, otherwise undefined.\n\t */\n\tRemoteRequest: \"remoteRequest\",\n\n\t/**\n\t * Public Origin of the request.\n\t */\n\tPublicOrigin: \"publicOrigin\",\n\n\t/**\n\t * Local Origin of the request.\n\t */\n\tLocalOrigin: \"localOrigin\",\n\n\t/**\n\t * The comma-separated scope claim from the verified JWT for the current request.\n\t */\n\tScope: \"scope\",\n\n\t/**\n\t * The caller's original tenant ID before an escalated privilege tenant override was applied.\n\t * Only present when overrideTenant substitution is active for the current request.\n\t */\n\tOriginalTenant: \"originalTenant\"\n} as const;\n\n/**\n * HTTP definition of some context keys.\n */\nexport type HttpContextIdKeys = (typeof HttpContextIdKeys)[keyof typeof HttpContextIdKeys];\n"]}

package/dist/es/models/protocol/IHttpRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHttpRequest.js.map

package/dist/es/models/protocol/IHttpRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequest.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpHeaders } from \"@3sixty/web\";\nimport type { IHttpRequestPathParams } from \"./IHttpRequestPathParams.js\";\nimport type { IHttpRequestQuery } from \"./IHttpRequestQuery.js\";\n\n/**\n * Model for the standard parameters for an http request.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IHttpRequest<T = any> {\n\t/**\n\t * Incoming Http Headers.\n\t */\n\theaders?: IHttpHeaders;\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams?: IHttpRequestPathParams;\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: IHttpRequestQuery;\n\n\t/**\n\t * Data to return send as the body.\n\t */\n\tbody?: T;\n}\n"]}

package/dist/es/models/protocol/IHttpRequestContext.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHttpRequestContext.js.map

package/dist/es/models/protocol/IHttpRequestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequestContext.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequestContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpServerRequest } from \"./IHttpServerRequest.js\";\n\n/**\n * Context data from the HTTP request.\n */\nexport interface IHttpRequestContext {\n\t/**\n\t * The raw HTTP request.\n\t */\n\tserverRequest: IHttpServerRequest;\n\n\t/**\n\t * The state handed through the processors.\n\t */\n\tprocessorState: { [id: string]: unknown };\n\n\t/**\n\t * Logging component type for the request.\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/protocol/IHttpRequestPathParams.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IHttpRequestPathParams.js.map

package/dist/es/models/protocol/IHttpRequestPathParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequestPathParams.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequestPathParams.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model for the standard parameters for an http request.\n */\nexport interface IHttpRequestPathParams {\n\t[id: string]: string;\n}\n"]}

package/dist/es/models/protocol/IHttpRequestQuery.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IHttpRequestQuery.js.map

package/dist/es/models/protocol/IHttpRequestQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpRequestQuery.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpRequestQuery.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Model used for Http request query parameters.\n */\nexport interface IHttpRequestQuery {\n\t[id: string]: string;\n}\n"]}

package/dist/es/models/protocol/IHttpResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHttpResponse.js.map

package/dist/es/models/protocol/IHttpResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpResponse.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpStatusCode, IHttpHeaders } from \"@3sixty/web\";\n\n/**\n * Model for the standard parameters for an http response.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IHttpResponse<T = any> {\n\t/**\n\t * Response status code.\n\t */\n\tstatusCode?: HttpStatusCode;\n\n\t/**\n\t * Response headers.\n\t */\n\theaders?: IHttpHeaders;\n\n\t/**\n\t * Data to return as the main payload.\n\t */\n\tbody?: T;\n}\n"]}

package/dist/es/models/protocol/IHttpServerRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IHttpServerRequest.js.map

package/dist/es/models/protocol/IHttpServerRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpServerRequest.js","sourceRoot":"","sources":["../../../../src/models/protocol/IHttpServerRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpMethod } from \"@3sixty/web\";\nimport type { IHttpRequest } from \"./IHttpRequest.js\";\n\n/**\n * Model for the standard parameters for an http request.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IHttpServerRequest<T = any> extends IHttpRequest<T> {\n\t/**\n\t * The request url.\n\t */\n\turl: string;\n\n\t/**\n\t * The request method.\n\t */\n\tmethod?: HttpMethod;\n}\n"]}

package/dist/es/models/protocol/ISocketRequestContext.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISocketRequestContext.js.map

package/dist/es/models/protocol/ISocketRequestContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISocketRequestContext.js","sourceRoot":"","sources":["../../../../src/models/protocol/ISocketRequestContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IHttpRequestContext } from \"./IHttpRequestContext.js\";\n\n/**\n * Context data from the socket request.\n */\nexport interface ISocketRequestContext extends IHttpRequestContext {\n\t/**\n\t * The id of the socket.\n\t */\n\tsocketId: string;\n}\n"]}