@twin.org/web 0.0.3-next.25 → 0.0.3-next.26

package/dist/es/index.js

@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0.
 export * from "./errors/fetchError.js";
 export * from "./models/headerTypes.js";
+export * from "./models/httpLinkRelType.js";
 export * from "./models/httpMethod.js";
 export * from "./models/httpStatusCode.js";
 export * from "./models/IFetchOptions.js";
 export * from "./models/IHttpHeaders.js";
+export * from "./models/IHttpLinkHeader.js";
 export * from "./models/IJwk.js";
 export * from "./models/IJwtHeader.js";
 export * from "./models/IJwtPayload.js";

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./errors/fetchError.js\";\nexport * from \"./models/headerTypes.js\";\nexport * from \"./models/httpMethod.js\";\nexport * from \"./models/httpStatusCode.js\";\nexport * from \"./models/IFetchOptions.js\";\nexport * from \"./models/IHttpHeaders.js\";\nexport * from \"./models/IJwk.js\";\nexport * from \"./models/IJwtHeader.js\";\nexport * from \"./models/IJwtPayload.js\";\nexport * from \"./models/jwkCryptoKey.js\";\nexport * from \"./models/mimeTypes.js\";\nexport * from \"./utils/cookieHelper.js\";\nexport * from \"./utils/fetchHelper.js\";\nexport * from \"./utils/headerHelper.js\";\nexport * from \"./utils/jwk.js\";\nexport * from \"./utils/jws.js\";\nexport * from \"./utils/jwt.js\";\nexport * from \"./utils/mimeTypeHelper.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./errors/fetchError.js\";\nexport * from \"./models/headerTypes.js\";\nexport * from \"./models/httpLinkRelType.js\";\nexport * from \"./models/httpMethod.js\";\nexport * from \"./models/httpStatusCode.js\";\nexport * from \"./models/IFetchOptions.js\";\nexport * from \"./models/IHttpHeaders.js\";\nexport * from \"./models/IHttpLinkHeader.js\";\nexport * from \"./models/IJwk.js\";\nexport * from \"./models/IJwtHeader.js\";\nexport * from \"./models/IJwtPayload.js\";\nexport * from \"./models/jwkCryptoKey.js\";\nexport * from \"./models/mimeTypes.js\";\nexport * from \"./utils/cookieHelper.js\";\nexport * from \"./utils/fetchHelper.js\";\nexport * from \"./utils/headerHelper.js\";\nexport * from \"./utils/jwk.js\";\nexport * from \"./utils/jws.js\";\nexport * from \"./utils/jwt.js\";\nexport * from \"./utils/mimeTypeHelper.js\";\n"]}

package/dist/es/models/IHttpLinkHeader.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IHttpLinkHeader.js","sourceRoot":"","sources":["../../../src/models/IHttpLinkHeader.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HttpLinkRelType } from \"./httpLinkRelType.js\";\n\n/**\n * Model used for Http link headers parameter.\n */\nexport interface IHttpLinkHeader {\n\t/**\n\t * The URL of the link.\n\t */\n\turl: string;\n\n\t/**\n\t * Optional query parameters for the URL.\n\t */\n\turlQueryParams?: { [id: string]: string };\n\n\t/**\n\t * The relation types of the link.\n\t */\n\trel: (string | HttpLinkRelType)[];\n\n\t/**\n\t * Optional additional parameters for the link.\n\t */\n\tparams?: { [id: string]: string };\n}\n"]}

package/dist/es/models/httpLinkRelType.js

@@ -0,0 +1,130 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Common HTML rel attribute values.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const HttpLinkRelType = {
+    /**
+     * Alternate representation of the current document.
+     */
+    alternate: "alternate",
+    /**
+     * Author of the current document or article.
+     */
+    author: "author",
+    /**
+     * Permalink for the nearest ancestor section.
+     */
+    bookmark: "bookmark",
+    /**
+     * Preferred URL for the current document.
+     */
+    canonical: "canonical",
+    /**
+     * Compression dictionary for future downloads.
+     */
+    compressionDictionary: "compression-dictionary",
+    /**
+     * Hint to perform DNS resolution in advance.
+     */
+    dnsPrefetch: "dns-prefetch",
+    /**
+     * The referenced document is external to the current site.
+     */
+    external: "external",
+    /**
+     * Allows render-blocking until essential parts are parsed.
+     */
+    expect: "expect",
+    /**
+     * Link to context-sensitive help.
+     */
+    help: "help",
+    /**
+     * Icon representing the current document.
+     */
+    icon: "icon",
+    /**
+     * Licensing information for the current document.
+     */
+    license: "license",
+    /**
+     * Web application manifest.
+     */
+    manifest: "manifest",
+    /**
+     * Indicates the current document represents the linked identity.
+     */
+    me: "me",
+    /**
+     * Pre-emptively fetch a module and optionally its dependencies.
+     */
+    modulePreload: "modulepreload",
+    /**
+     * The next document in a series.
+     */
+    next: "next",
+    /**
+     * The current document does not endorse the referenced document.
+     */
+    nofollow: "nofollow",
+    /**
+     * Prevent access to the originating browsing context.
+     */
+    noopener: "noopener",
+    /**
+     * Suppress the Referer header and implies noopener.
+     */
+    noreferrer: "noreferrer",
+    /**
+     * Allow access to the originating browsing context.
+     */
+    opener: "opener",
+    /**
+     * Address of the pingback server for the current document.
+     */
+    pingback: "pingback",
+    /**
+     * Hint to connect to the target origin in advance.
+     */
+    preconnect: "preconnect",
+    /**
+     * Hint to fetch and cache a likely next resource.
+     */
+    prefetch: "prefetch",
+    /**
+     * Hint to fetch and cache a resource for the current navigation.
+     */
+    preload: "preload",
+    /**
+     * Deprecated hint to fetch and process a target in advance.
+     */
+    prerender: "prerender",
+    /**
+     * The previous document in a series.
+     */
+    prev: "prev",
+    /**
+     * Privacy policy for the current document.
+     */
+    privacyPolicy: "privacy-policy",
+    /**
+     * Search resource for the current document or related resources.
+     */
+    search: "search",
+    /**
+     * External stylesheet for the current document.
+     */
+    stylesheet: "stylesheet",
+    /**
+     * Tag applying to the current document.
+     */
+    tag: "tag",
+    /**
+     * Terms of service for the current document.
+     */
+    termsOfService: "terms-of-service"
+};
+//# sourceMappingURL=httpLinkRelType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"httpLinkRelType.js","sourceRoot":"","sources":["../../../src/models/httpLinkRelType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,qBAAqB,EAAE,wBAAwB;IAE/C;;OAEG;IACH,WAAW,EAAE,cAAc;IAE3B;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,EAAE,EAAE,IAAI;IAER;;OAEG;IACH,aAAa,EAAE,eAAe;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,aAAa,EAAE,gBAAgB;IAE/B;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;OAEG;IACH,GAAG,EAAE,KAAK;IAEV;;OAEG;IACH,cAAc,EAAE,kBAAkB;CACzB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Common HTML rel attribute values.\n * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const HttpLinkRelType = {\n\t/**\n\t * Alternate representation of the current document.\n\t */\n\talternate: \"alternate\",\n\n\t/**\n\t * Author of the current document or article.\n\t */\n\tauthor: \"author\",\n\n\t/**\n\t * Permalink for the nearest ancestor section.\n\t */\n\tbookmark: \"bookmark\",\n\n\t/**\n\t * Preferred URL for the current document.\n\t */\n\tcanonical: \"canonical\",\n\n\t/**\n\t * Compression dictionary for future downloads.\n\t */\n\tcompressionDictionary: \"compression-dictionary\",\n\n\t/**\n\t * Hint to perform DNS resolution in advance.\n\t */\n\tdnsPrefetch: \"dns-prefetch\",\n\n\t/**\n\t * The referenced document is external to the current site.\n\t */\n\texternal: \"external\",\n\n\t/**\n\t * Allows render-blocking until essential parts are parsed.\n\t */\n\texpect: \"expect\",\n\n\t/**\n\t * Link to context-sensitive help.\n\t */\n\thelp: \"help\",\n\n\t/**\n\t * Icon representing the current document.\n\t */\n\ticon: \"icon\",\n\n\t/**\n\t * Licensing information for the current document.\n\t */\n\tlicense: \"license\",\n\n\t/**\n\t * Web application manifest.\n\t */\n\tmanifest: \"manifest\",\n\n\t/**\n\t * Indicates the current document represents the linked identity.\n\t */\n\tme: \"me\",\n\n\t/**\n\t * Pre-emptively fetch a module and optionally its dependencies.\n\t */\n\tmodulePreload: \"modulepreload\",\n\n\t/**\n\t * The next document in a series.\n\t */\n\tnext: \"next\",\n\n\t/**\n\t * The current document does not endorse the referenced document.\n\t */\n\tnofollow: \"nofollow\",\n\n\t/**\n\t * Prevent access to the originating browsing context.\n\t */\n\tnoopener: \"noopener\",\n\n\t/**\n\t * Suppress the Referer header and implies noopener.\n\t */\n\tnoreferrer: \"noreferrer\",\n\n\t/**\n\t * Allow access to the originating browsing context.\n\t */\n\topener: \"opener\",\n\n\t/**\n\t * Address of the pingback server for the current document.\n\t */\n\tpingback: \"pingback\",\n\n\t/**\n\t * Hint to connect to the target origin in advance.\n\t */\n\tpreconnect: \"preconnect\",\n\n\t/**\n\t * Hint to fetch and cache a likely next resource.\n\t */\n\tprefetch: \"prefetch\",\n\n\t/**\n\t * Hint to fetch and cache a resource for the current navigation.\n\t */\n\tpreload: \"preload\",\n\n\t/**\n\t * Deprecated hint to fetch and process a target in advance.\n\t */\n\tprerender: \"prerender\",\n\n\t/**\n\t * The previous document in a series.\n\t */\n\tprev: \"prev\",\n\n\t/**\n\t * Privacy policy for the current document.\n\t */\n\tprivacyPolicy: \"privacy-policy\",\n\n\t/**\n\t * Search resource for the current document or related resources.\n\t */\n\tsearch: \"search\",\n\n\t/**\n\t * External stylesheet for the current document.\n\t */\n\tstylesheet: \"stylesheet\",\n\n\t/**\n\t * Tag applying to the current document.\n\t */\n\ttag: \"tag\",\n\n\t/**\n\t * Terms of service for the current document.\n\t */\n\ttermsOfService: \"terms-of-service\"\n} as const;\n\n/**\n * Common HTML rel attribute values.\n */\nexport type HttpLinkRelType = (typeof HttpLinkRelType)[keyof typeof HttpLinkRelType];\n"]}

package/dist/es/utils/headerHelper.js

@@ -1,6 +1,6 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-import { GeneralError, Guards, Is } from "@twin.org/core";
+import { ArrayHelper, GeneralError, Guards, Is } from "@twin.org/core";
 /**
  * Class to helper with header operations.
  */
@@ -35,7 +35,7 @@ export class HeaderHelper {
         return "";
     }
     /**
-     * Extract the properties from a Link header for a specific relation type.
+     * Extract the first occurrence of properties from a Link header for a specific relation type.
      * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
      * @param relation The relation type to extract.
      * @returns The extracted URL, rel and optional params or undefined if invalid/missing.
@@ -44,7 +44,20 @@ export class HeaderHelper {
     static extractLinkHeaderRelation(linkHeader, relation) {
         const headers = HeaderHelper.extractLinkHeaders(linkHeader);
         if (Is.arrayValue(headers)) {
-            return headers.find(h => h.rel === relation);
+            return headers.find(h => HeaderHelper.matchesLinkHeaderRelation(h.rel, relation));
+        }
+    }
+    /**
+     * Extract multiple properties from a Link header for a specific relation type.
+     * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+     * @param relation The relation type to extract.
+     * @returns The extracted URL, rel and optional params or undefined if invalid/missing.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+     */
+    static extractLinkHeaderRelations(linkHeader, relation) {
+        const headers = HeaderHelper.extractLinkHeaders(linkHeader);
+        if (Is.arrayValue(headers)) {
+            return headers.filter(h => HeaderHelper.matchesLinkHeaderRelation(h.rel, relation));
         }
     }
     /**
@@ -54,22 +67,36 @@ export class HeaderHelper {
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
      */
     static extractLinkHeaders(linkHeader) {
-        if (Is.stringValue(linkHeader)) {
-            const header = HeaderHelper.extractLinkHeader(linkHeader);
-            return header ? [header] : [];
-        }
-        if (Is.arrayValue(linkHeader)) {
+        const linkHeaderArray = ArrayHelper.fromObjectOrArray(linkHeader);
+        if (Is.arrayValue(linkHeaderArray)) {
             const results = [];
-            for (const singleLinkHeader of linkHeader) {
-                const header = HeaderHelper.extractLinkHeader(singleLinkHeader);
-                if (header) {
-                    results.push(header);
-                }
+            for (const singleLinkHeader of linkHeaderArray) {
+                const segments = HeaderHelper.extractLinkHeaderSegments(singleLinkHeader);
+                results.push(...segments.map(l => HeaderHelper.extractLinkHeader(l)).filter(h => !Is.empty(h)));
             }
             return results;
         }
         return undefined;
     }
+    /**
+     * Split a combined Link header value into individual link-value segments, comma separated.
+     * @param linkHeader Raw Link header string.
+     * @returns Array of individual link-value segments.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+     */
+    static extractLinkHeaderSegments(linkHeader) {
+        if (!Is.stringValue(linkHeader)) {
+            return [];
+        }
+        const trimmed = linkHeader.trim();
+        if (Is.empty(trimmed)) {
+            return [];
+        }
+        return trimmed
+            .split(/,(?=\s*<)/)
+            .map(s => s.trim())
+            .filter(s => !Is.empty(s));
+    }
     /**
      * Extract the properties from a Link header.
      * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
@@ -105,7 +132,7 @@ export class HeaderHelper {
             for (let i = 1; i < parts.length; i++) {
                 const relMatch = /rel="([^"]+)"/.exec(parts[i].trim());
                 if (relMatch?.[1]) {
-                    rel = relMatch[1];
+                    rel = HeaderHelper.normalizeLinkHeaderRelations(relMatch[1]);
                 }
                 else {
                     const paramMatch = /([^=]+)="([^"]+)"/.exec(parts[i].trim());
@@ -114,7 +141,7 @@ export class HeaderHelper {
                     }
                 }
             }
-            if (Is.stringValue(url) && Is.stringValue(rel)) {
+            if (Is.stringValue(url) && Is.arrayValue(rel)) {
                 return {
                     url,
                     urlQueryParams,
@@ -136,12 +163,18 @@ export class HeaderHelper {
      */
     static createLinkHeader(url, urlQueryParams, rel, params) {
         Guards.stringValue(HeaderHelper.CLASS_NAME, "url", url);
-        Guards.stringValue(HeaderHelper.CLASS_NAME, "rel", rel);
+        const relationValues = Is.string(rel)
+            ? HeaderHelper.normalizeLinkHeaderRelations(rel)
+            : ArrayHelper.fromObjectOrArray(rel);
+        Guards.arrayValue(HeaderHelper.CLASS_NAME, "rel", relationValues);
         if (url.includes(">")) {
             throw new GeneralError(HeaderHelper.CLASS_NAME, "invalidLinkHeaderURL");
         }
-        if (rel.includes('"')) {
-            throw new GeneralError(HeaderHelper.CLASS_NAME, "invalidLinkHeaderRel");
+        for (let i = 0; i < relationValues.length; i++) {
+            Guards.stringValue(HeaderHelper.CLASS_NAME, `${"rel"}.${i.toString()}`, relationValues[i]);
+            if (relationValues[i].includes('"') || relationValues[i].includes(" ")) {
+                throw new GeneralError(HeaderHelper.CLASS_NAME, "invalidLinkHeaderRel");
+            }
         }
         if (Is.objectValue(urlQueryParams)) {
             const queryParamsString = Object.entries(urlQueryParams)
@@ -158,11 +191,36 @@ export class HeaderHelper {
                 url += `&${queryParamsString}`;
             }
         }
-        return `<${url}>; rel="${rel}"${params
+        return `<${url}>; rel="${relationValues.join(" ")}"${params
             ? Object.entries(params)
                 .map(([key, value]) => `; ${key}="${value}"`)
                 .join("")
             : ""}`;
     }
+    /**
+     * Does the relation selector match any of the link header relations.
+     * @param relations The relations from the header.
+     * @param relation The relation selector to test.
+     * @returns True if the selector matches any relation.
+     * @internal
+     */
+    static matchesLinkHeaderRelation(relations, relation) {
+        if (Is.string(relation)) {
+            return relations.includes(relation);
+        }
+        return relations.some(relValue => relation.test(relValue));
+    }
+    /**
+     * Normalize a relation string into tokens.
+     * @param relation The relation string.
+     * @returns The relation tokens.
+     * @internal
+     */
+    static normalizeLinkHeaderRelations(relation) {
+        return relation
+            .split(/\s+/)
+            .map(relValue => relValue.trim())
+            .filter(relValue => !Is.empty(relValue));
+    }
 }
 //# sourceMappingURL=headerHelper.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"headerHelper.js","sourceRoot":"","sources":["../../../src/utils/headerHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAG1D;;GAEG;AACH,MAAM,OAAO,YAAY;IACxB;;OAEG;IACI,MAAM,CAAU,UAAU,kBAAkC;IAEnE;;;;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;IAED;;;;;;OAMG;IACI,MAAM,CAAC,yBAAyB,CACtC,UAAmB,EACnB,QAAgB;QAShB,MAAM,OAAO,GAAG,YAAY,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAmB;QAQnD,IAAI,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,MAAM,GAAG,YAAY,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;YAC1D,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,EAAE,CAAC,UAAU,CAAS,UAAU,CAAC,EAAE,CAAC;YACvC,MAAM,OAAO,GAAG,EAAE,CAAC;YACnB,KAAK,MAAM,gBAAgB,IAAI,UAAU,EAAE,CAAC;gBAC3C,MAAM,MAAM,GAAG,YAAY,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;gBAChE,IAAI,MAAM,EAAE,CAAC;oBACZ,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACtB,CAAC;YACF,CAAC;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAAC,UAAkB;QAQjD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEpC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvB,IAAI,GAAG,CAAC;YACR,IAAI,cAAoD,CAAC;YAEzD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnC,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAElB,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACpC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;oBACvB,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;oBAClD,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAE9C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACpC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAC1C,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;4BAClD,cAAc,KAAK,EAAE,CAAC;4BACtB,cAAc,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;wBACjD,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;YAED,IAAI,GAAG,CAAC;YACR,MAAM,MAAM,GAA6B,EAAE,CAAC;YAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBACvD,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACnB,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBACnB,CAAC;qBAAM,CAAC;oBACP,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;oBAC7D,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBACxC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;oBACvC,CAAC;gBACF,CAAC;YACF,CAAC;YAED,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChD,OAAO;oBACN,GAAG;oBACH,cAAc;oBACd,GAAG;oBACH,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;iBAC3D,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,gBAAgB,CAC7B,GAAW,EACX,cAAoD,EACpD,GAAW,EACX,MAAiC;QAEjC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAC9D,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAE9D,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC;QACzE,CAAC;QACD,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YACpC,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC;iBACtD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;iBAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;YACZ,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACvB,GAAG,IAAI,IAAI,iBAAiB,EAAE,CAAC;YAChC,CAAC;iBAAM,IAAI,UAAU,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1C,GAAG,IAAI,iBAAiB,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACP,GAAG,IAAI,IAAI,iBAAiB,EAAE,CAAC;YAChC,CAAC;QACF,CAAC;QAED,OAAO,IAAI,GAAG,WAAW,GAAG,IAC3B,MAAM;YACL,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;iBACrB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,KAAK,GAAG,CAAC;iBAC5C,IAAI,CAAC,EAAE,CAAC;YACX,CAAC,CAAC,EACJ,EAAE,CAAC;IACJ,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\";\n\n/**\n * Class to helper with header operations.\n */\nexport class HeaderHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<HeaderHelper>();\n\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\t/**\n\t * Extract the properties from a Link header for a specific relation type.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @param relation The relation type to extract.\n\t * @returns The extracted URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeaderRelation(\n\t\tlinkHeader: unknown,\n\t\trelation: string\n\t):\n\t\t| {\n\t\t\t\turl: string;\n\t\t\t\turlQueryParams?: { [id: string]: string };\n\t\t\t\trel: string;\n\t\t\t\tparams?: { [id: string]: string };\n\t\t  }\n\t\t| undefined {\n\t\tconst headers = HeaderHelper.extractLinkHeaders(linkHeader);\n\t\tif (Is.arrayValue(headers)) {\n\t\t\treturn headers.find(h => h.rel === relation);\n\t\t}\n\t}\n\n\t/**\n\t * Extract the link headers.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @returns The extracted possible array of URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeaders(linkHeader: unknown):\n\t\t| {\n\t\t\t\turl: string;\n\t\t\t\turlQueryParams?: { [id: string]: string };\n\t\t\t\trel: string;\n\t\t\t\tparams?: { [id: string]: string };\n\t\t  }[]\n\t\t| undefined {\n\t\tif (Is.stringValue(linkHeader)) {\n\t\t\tconst header = HeaderHelper.extractLinkHeader(linkHeader);\n\t\t\treturn header ? [header] : [];\n\t\t}\n\t\tif (Is.arrayValue<string>(linkHeader)) {\n\t\t\tconst results = [];\n\t\t\tfor (const singleLinkHeader of linkHeader) {\n\t\t\t\tconst header = HeaderHelper.extractLinkHeader(singleLinkHeader);\n\t\t\t\tif (header) {\n\t\t\t\t\tresults.push(header);\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn results;\n\t\t}\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * Extract the properties from a Link header.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @returns The extracted URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeader(linkHeader: string):\n\t\t| {\n\t\t\t\turl: string;\n\t\t\t\turlQueryParams?: { [id: string]: string };\n\t\t\t\trel: string;\n\t\t\t\tparams?: { [id: string]: string };\n\t\t  }\n\t\t| undefined {\n\t\tif (!Is.stringValue(linkHeader)) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst parts = linkHeader.split(\";\");\n\n\t\tif (parts.length >= 2) {\n\t\t\tlet url;\n\t\t\tlet urlQueryParams: { [id: string]: string } | undefined;\n\n\t\t\tconst urlMatch = /<([^>]+)>/.exec(parts[0]);\n\t\t\tif (Is.stringValue(urlMatch?.[1])) {\n\t\t\t\turl = urlMatch[1];\n\n\t\t\t\tconst queryIndex = url.indexOf(\"?\");\n\t\t\t\tif (queryIndex !== -1) {\n\t\t\t\t\tconst urlParamsString = url.slice(queryIndex + 1);\n\t\t\t\t\tconst queryParts = urlParamsString.split(\"&\");\n\n\t\t\t\t\tfor (const queryPart of queryParts) {\n\t\t\t\t\t\tconst [key, value] = queryPart.split(\"=\");\n\t\t\t\t\t\tif (Is.stringValue(key) && Is.stringValue(value)) {\n\t\t\t\t\t\t\turlQueryParams ??= {};\n\t\t\t\t\t\t\turlQueryParams[key] = decodeURIComponent(value);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tlet rel;\n\t\t\tconst params: { [id: string]: string } = {};\n\n\t\t\tfor (let i = 1; i < parts.length; i++) {\n\t\t\t\tconst relMatch = /rel=\"([^\"]+)\"/.exec(parts[i].trim());\n\t\t\t\tif (relMatch?.[1]) {\n\t\t\t\t\trel = relMatch[1];\n\t\t\t\t} else {\n\t\t\t\t\tconst paramMatch = /([^=]+)=\"([^\"]+)\"/.exec(parts[i].trim());\n\t\t\t\t\tif (paramMatch?.[1] && paramMatch?.[2]) {\n\t\t\t\t\t\tparams[paramMatch[1]] = paramMatch[2];\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (Is.stringValue(url) && Is.stringValue(rel)) {\n\t\t\t\treturn {\n\t\t\t\t\turl,\n\t\t\t\t\turlQueryParams,\n\t\t\t\t\trel,\n\t\t\t\t\tparams: Object.keys(params).length > 0 ? params : undefined\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * Create a compliant Link header.\n\t * @param url The URL to include in the Link header.\n\t * @param urlQueryParams Optional query parameters to include in the URL.\n\t * @param rel The relation type (e.g., \"next\", \"prev\", \"self\").\n\t * @returns The formatted Link header string.\n\t * @throws GeneralError if the URL or rel are invalid.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static createLinkHeader(\n\t\turl: string,\n\t\turlQueryParams: { [id: string]: string } | undefined,\n\t\trel: string,\n\t\tparams?: { [id: string]: string }\n\t): string {\n\t\tGuards.stringValue(HeaderHelper.CLASS_NAME, nameof(url), url);\n\t\tGuards.stringValue(HeaderHelper.CLASS_NAME, nameof(rel), rel);\n\n\t\tif (url.includes(\">\")) {\n\t\t\tthrow new GeneralError(HeaderHelper.CLASS_NAME, \"invalidLinkHeaderURL\");\n\t\t}\n\t\tif (rel.includes('\"')) {\n\t\t\tthrow new GeneralError(HeaderHelper.CLASS_NAME, \"invalidLinkHeaderRel\");\n\t\t}\n\n\t\tif (Is.objectValue(urlQueryParams)) {\n\t\t\tconst queryParamsString = Object.entries(urlQueryParams)\n\t\t\t\t.map(([key, value]) => `${key}=${encodeURIComponent(value)}`)\n\t\t\t\t.join(\"&\");\n\t\t\tconst queryIndex = url.indexOf(\"?\");\n\t\t\tif (queryIndex === -1) {\n\t\t\t\turl += `?${queryParamsString}`;\n\t\t\t} else if (queryIndex === url.length - 1) {\n\t\t\t\turl += queryParamsString;\n\t\t\t} else {\n\t\t\t\turl += `&${queryParamsString}`;\n\t\t\t}\n\t\t}\n\n\t\treturn `<${url}>; rel=\"${rel}\"${\n\t\t\tparams\n\t\t\t\t? Object.entries(params)\n\t\t\t\t\t\t.map(([key, value]) => `; ${key}=\"${value}\"`)\n\t\t\t\t\t\t.join(\"\")\n\t\t\t\t: \"\"\n\t\t}`;\n\t}\n}\n"]}
+{"version":3,"file":"headerHelper.js","sourceRoot":"","sources":["../../../src/utils/headerHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAKvE;;GAEG;AACH,MAAM,OAAO,YAAY;IACxB;;OAEG;IACI,MAAM,CAAU,UAAU,kBAAkC;IAEnE;;;;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;IAED;;;;;;OAMG;IACI,MAAM,CAAC,yBAAyB,CACtC,UAAmB,EACnB,QAA2C;QAE3C,MAAM,OAAO,GAAG,YAAY,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,yBAAyB,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;QACnF,CAAC;IACF,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,0BAA0B,CACvC,UAAmB,EACnB,QAA2C;QAE3C,MAAM,OAAO,GAAG,YAAY,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAC5D,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,yBAAyB,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC;QACrF,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAmB;QACnD,MAAM,eAAe,GAAG,WAAW,CAAC,iBAAiB,CAAS,UAA+B,CAAC,CAAC;QAC/F,IAAI,EAAE,CAAC,UAAU,CAAS,eAAe,CAAC,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,EAAE,CAAC;YACnB,KAAK,MAAM,gBAAgB,IAAI,eAAe,EAAE,CAAC;gBAChD,MAAM,QAAQ,GAAG,YAAY,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;gBAC1E,OAAO,CAAC,IAAI,CACX,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CACjF,CAAC;YACH,CAAC;YACD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,yBAAyB,CAAC,UAAkB;QACzD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,EAAE,CAAC;QACX,CAAC;QACD,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC;QAClC,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACX,CAAC;QACD,OAAO,OAAO;aACZ,KAAK,CAAC,WAAW,CAAC;aAClB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aAClB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAAC,UAAkB;QACjD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAEpC,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvB,IAAI,GAAG,CAAC;YACR,IAAI,cAAoD,CAAC;YAEzD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnC,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;gBAElB,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACpC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;oBACvB,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;oBAClD,MAAM,UAAU,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAE9C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;wBACpC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;wBAC1C,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;4BAClD,cAAc,KAAK,EAAE,CAAC;4BACtB,cAAc,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;wBACjD,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;YAED,IAAI,GAAyB,CAAC;YAC9B,MAAM,MAAM,GAA6B,EAAE,CAAC;YAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBACvD,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACnB,GAAG,GAAG,YAAY,CAAC,4BAA4B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC9D,CAAC;qBAAM,CAAC;oBACP,MAAM,UAAU,GAAG,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;oBAC7D,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBACxC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;oBACvC,CAAC;gBACF,CAAC;YACF,CAAC;YAED,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC/C,OAAO;oBACN,GAAG;oBACH,cAAc;oBACd,GAAG;oBACH,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;iBAC3D,CAAC;YACH,CAAC;QACF,CAAC;QAED,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,gBAAgB,CAC7B,GAAW,EACX,cAAoD,EACpD,GAA4D,EAC5D,MAAiC;QAEjC,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAE9D,MAAM,cAAc,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC;YACpC,CAAC,CAAC,YAAY,CAAC,4BAA4B,CAAC,GAAG,CAAC;YAChD,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAEtC,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,SAAe,cAAc,CAAC,CAAC;QAExE,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC;QACzE,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,MAAM,CAAC,WAAW,CACjB,YAAY,CAAC,UAAU,EACvB,GAAG,KAAW,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAChC,cAAc,CAAC,CAAC,CAAC,CACjB,CAAC;YACF,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxE,MAAM,IAAI,YAAY,CAAC,YAAY,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAC;YACzE,CAAC;QACF,CAAC;QAED,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YACpC,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC;iBACtD,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;iBAC5D,IAAI,CAAC,GAAG,CAAC,CAAC;YACZ,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE,CAAC;gBACvB,GAAG,IAAI,IAAI,iBAAiB,EAAE,CAAC;YAChC,CAAC;iBAAM,IAAI,UAAU,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC1C,GAAG,IAAI,iBAAiB,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACP,GAAG,IAAI,IAAI,iBAAiB,EAAE,CAAC;YAChC,CAAC;QACF,CAAC;QAED,OAAO,IAAI,GAAG,WAAW,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,IAChD,MAAM;YACL,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;iBACrB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,GAAG,KAAK,KAAK,GAAG,CAAC;iBAC5C,IAAI,CAAC,EAAE,CAAC;YACX,CAAC,CAAC,EACJ,EAAE,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,yBAAyB,CACvC,SAAuC,EACvC,QAA2C;QAE3C,IAAI,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,4BAA4B,CAAC,QAAgB;QAC3D,OAAO,QAAQ;aACb,KAAK,CAAC,KAAK,CAAC;aACZ,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;aAChC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAsB,CAAC;IAChE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ArrayHelper, GeneralError, Guards, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { HttpLinkRelType } from \"../models/httpLinkRelType.js\";\nimport type { IHttpLinkHeader } from \"../models/IHttpLinkHeader.js\";\n\n/**\n * Class to helper with header operations.\n */\nexport class HeaderHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<HeaderHelper>();\n\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\t/**\n\t * Extract the first occurrence of properties from a Link header for a specific relation type.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @param relation The relation type to extract.\n\t * @returns The extracted URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeaderRelation(\n\t\tlinkHeader: unknown,\n\t\trelation: HttpLinkRelType | string | RegExp\n\t): IHttpLinkHeader | undefined {\n\t\tconst headers = HeaderHelper.extractLinkHeaders(linkHeader);\n\t\tif (Is.arrayValue(headers)) {\n\t\t\treturn headers.find(h => HeaderHelper.matchesLinkHeaderRelation(h.rel, relation));\n\t\t}\n\t}\n\n\t/**\n\t * Extract multiple properties from a Link header for a specific relation type.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @param relation The relation type to extract.\n\t * @returns The extracted URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeaderRelations(\n\t\tlinkHeader: unknown,\n\t\trelation: HttpLinkRelType | string | RegExp\n\t): IHttpLinkHeader[] | undefined {\n\t\tconst headers = HeaderHelper.extractLinkHeaders(linkHeader);\n\t\tif (Is.arrayValue(headers)) {\n\t\t\treturn headers.filter(h => HeaderHelper.matchesLinkHeaderRelation(h.rel, relation));\n\t\t}\n\t}\n\n\t/**\n\t * Extract the link headers.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @returns The extracted possible array of URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeaders(linkHeader: unknown): IHttpLinkHeader[] | undefined {\n\t\tconst linkHeaderArray = ArrayHelper.fromObjectOrArray<string>(linkHeader as string | string[]);\n\t\tif (Is.arrayValue<string>(linkHeaderArray)) {\n\t\t\tconst results = [];\n\t\t\tfor (const singleLinkHeader of linkHeaderArray) {\n\t\t\t\tconst segments = HeaderHelper.extractLinkHeaderSegments(singleLinkHeader);\n\t\t\t\tresults.push(\n\t\t\t\t\t...segments.map(l => HeaderHelper.extractLinkHeader(l)).filter(h => !Is.empty(h))\n\t\t\t\t);\n\t\t\t}\n\t\t\treturn results;\n\t\t}\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * Split a combined Link header value into individual link-value segments, comma separated.\n\t * @param linkHeader Raw Link header string.\n\t * @returns Array of individual link-value segments.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeaderSegments(linkHeader: string): string[] {\n\t\tif (!Is.stringValue(linkHeader)) {\n\t\t\treturn [];\n\t\t}\n\t\tconst trimmed = linkHeader.trim();\n\t\tif (Is.empty(trimmed)) {\n\t\t\treturn [];\n\t\t}\n\t\treturn trimmed\n\t\t\t.split(/,(?=\\s*<)/)\n\t\t\t.map(s => s.trim())\n\t\t\t.filter(s => !Is.empty(s));\n\t}\n\n\t/**\n\t * Extract the properties from a Link header.\n\t * @param linkHeader The Link header value in format `<url>; rel=\"...\"; param1=\"\"; param2=\"\"`.\n\t * @returns The extracted URL, rel and optional params or undefined if invalid/missing.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static extractLinkHeader(linkHeader: string): IHttpLinkHeader | undefined {\n\t\tif (!Is.stringValue(linkHeader)) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst parts = linkHeader.split(\";\");\n\n\t\tif (parts.length >= 2) {\n\t\t\tlet url;\n\t\t\tlet urlQueryParams: { [id: string]: string } | undefined;\n\n\t\t\tconst urlMatch = /<([^>]+)>/.exec(parts[0]);\n\t\t\tif (Is.stringValue(urlMatch?.[1])) {\n\t\t\t\turl = urlMatch[1];\n\n\t\t\t\tconst queryIndex = url.indexOf(\"?\");\n\t\t\t\tif (queryIndex !== -1) {\n\t\t\t\t\tconst urlParamsString = url.slice(queryIndex + 1);\n\t\t\t\t\tconst queryParts = urlParamsString.split(\"&\");\n\n\t\t\t\t\tfor (const queryPart of queryParts) {\n\t\t\t\t\t\tconst [key, value] = queryPart.split(\"=\");\n\t\t\t\t\t\tif (Is.stringValue(key) && Is.stringValue(value)) {\n\t\t\t\t\t\t\turlQueryParams ??= {};\n\t\t\t\t\t\t\turlQueryParams[key] = decodeURIComponent(value);\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tlet rel: string[] | undefined;\n\t\t\tconst params: { [id: string]: string } = {};\n\n\t\t\tfor (let i = 1; i < parts.length; i++) {\n\t\t\t\tconst relMatch = /rel=\"([^\"]+)\"/.exec(parts[i].trim());\n\t\t\t\tif (relMatch?.[1]) {\n\t\t\t\t\trel = HeaderHelper.normalizeLinkHeaderRelations(relMatch[1]);\n\t\t\t\t} else {\n\t\t\t\t\tconst paramMatch = /([^=]+)=\"([^\"]+)\"/.exec(parts[i].trim());\n\t\t\t\t\tif (paramMatch?.[1] && paramMatch?.[2]) {\n\t\t\t\t\t\tparams[paramMatch[1]] = paramMatch[2];\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\n\t\t\tif (Is.stringValue(url) && Is.arrayValue(rel)) {\n\t\t\t\treturn {\n\t\t\t\t\turl,\n\t\t\t\t\turlQueryParams,\n\t\t\t\t\trel,\n\t\t\t\t\tparams: Object.keys(params).length > 0 ? params : undefined\n\t\t\t\t};\n\t\t\t}\n\t\t}\n\n\t\treturn undefined;\n\t}\n\n\t/**\n\t * Create a compliant Link header.\n\t * @param url The URL to include in the Link header.\n\t * @param urlQueryParams Optional query parameters to include in the URL.\n\t * @param rel The relation type (e.g., \"next\", \"prev\", \"self\").\n\t * @returns The formatted Link header string.\n\t * @throws GeneralError if the URL or rel are invalid.\n\t * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link\n\t */\n\tpublic static createLinkHeader(\n\t\turl: string,\n\t\turlQueryParams: { [id: string]: string } | undefined,\n\t\trel: HttpLinkRelType | HttpLinkRelType[] | string | string[],\n\t\tparams?: { [id: string]: string }\n\t): string {\n\t\tGuards.stringValue(HeaderHelper.CLASS_NAME, nameof(url), url);\n\n\t\tconst relationValues = Is.string(rel)\n\t\t\t? HeaderHelper.normalizeLinkHeaderRelations(rel)\n\t\t\t: ArrayHelper.fromObjectOrArray(rel);\n\n\t\tGuards.arrayValue(HeaderHelper.CLASS_NAME, nameof(rel), relationValues);\n\n\t\tif (url.includes(\">\")) {\n\t\t\tthrow new GeneralError(HeaderHelper.CLASS_NAME, \"invalidLinkHeaderURL\");\n\t\t}\n\n\t\tfor (let i = 0; i < relationValues.length; i++) {\n\t\t\tGuards.stringValue(\n\t\t\t\tHeaderHelper.CLASS_NAME,\n\t\t\t\t`${nameof(rel)}.${i.toString()}`,\n\t\t\t\trelationValues[i]\n\t\t\t);\n\t\t\tif (relationValues[i].includes('\"') || relationValues[i].includes(\" \")) {\n\t\t\t\tthrow new GeneralError(HeaderHelper.CLASS_NAME, \"invalidLinkHeaderRel\");\n\t\t\t}\n\t\t}\n\n\t\tif (Is.objectValue(urlQueryParams)) {\n\t\t\tconst queryParamsString = Object.entries(urlQueryParams)\n\t\t\t\t.map(([key, value]) => `${key}=${encodeURIComponent(value)}`)\n\t\t\t\t.join(\"&\");\n\t\t\tconst queryIndex = url.indexOf(\"?\");\n\t\t\tif (queryIndex === -1) {\n\t\t\t\turl += `?${queryParamsString}`;\n\t\t\t} else if (queryIndex === url.length - 1) {\n\t\t\t\turl += queryParamsString;\n\t\t\t} else {\n\t\t\t\turl += `&${queryParamsString}`;\n\t\t\t}\n\t\t}\n\n\t\treturn `<${url}>; rel=\"${relationValues.join(\" \")}\"${\n\t\t\tparams\n\t\t\t\t? Object.entries(params)\n\t\t\t\t\t\t.map(([key, value]) => `; ${key}=\"${value}\"`)\n\t\t\t\t\t\t.join(\"\")\n\t\t\t\t: \"\"\n\t\t}`;\n\t}\n\n\t/**\n\t * Does the relation selector match any of the link header relations.\n\t * @param relations The relations from the header.\n\t * @param relation The relation selector to test.\n\t * @returns True if the selector matches any relation.\n\t * @internal\n\t */\n\tprivate static matchesLinkHeaderRelation(\n\t\trelations: (HttpLinkRelType | string)[],\n\t\trelation: HttpLinkRelType | string | RegExp\n\t): boolean {\n\t\tif (Is.string(relation)) {\n\t\t\treturn relations.includes(relation);\n\t\t}\n\n\t\treturn relations.some(relValue => relation.test(relValue));\n\t}\n\n\t/**\n\t * Normalize a relation string into tokens.\n\t * @param relation The relation string.\n\t * @returns The relation tokens.\n\t * @internal\n\t */\n\tprivate static normalizeLinkHeaderRelations(relation: string): HttpLinkRelType[] {\n\t\treturn relation\n\t\t\t.split(/\\s+/)\n\t\t\t.map(relValue => relValue.trim())\n\t\t\t.filter(relValue => !Is.empty(relValue)) as HttpLinkRelType[];\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -1,9 +1,11 @@
 export * from "./errors/fetchError.js";
 export * from "./models/headerTypes.js";
+export * from "./models/httpLinkRelType.js";
 export * from "./models/httpMethod.js";
 export * from "./models/httpStatusCode.js";
 export * from "./models/IFetchOptions.js";
 export * from "./models/IHttpHeaders.js";
+export * from "./models/IHttpLinkHeader.js";
 export * from "./models/IJwk.js";
 export * from "./models/IJwtHeader.js";
 export * from "./models/IJwtPayload.js";

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

@@ -0,0 +1,26 @@
+import type { HttpLinkRelType } from "./httpLinkRelType.js";
+/**
+ * Model used for Http link headers parameter.
+ */
+export interface IHttpLinkHeader {
+    /**
+     * The URL of the link.
+     */
+    url: string;
+    /**
+     * Optional query parameters for the URL.
+     */
+    urlQueryParams?: {
+        [id: string]: string;
+    };
+    /**
+     * The relation types of the link.
+     */
+    rel: (string | HttpLinkRelType)[];
+    /**
+     * Optional additional parameters for the link.
+     */
+    params?: {
+        [id: string]: string;
+    };
+}

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

@@ -0,0 +1,130 @@
+/**
+ * Common HTML rel attribute values.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel
+ */
+export declare const HttpLinkRelType: {
+    /**
+     * Alternate representation of the current document.
+     */
+    readonly alternate: "alternate";
+    /**
+     * Author of the current document or article.
+     */
+    readonly author: "author";
+    /**
+     * Permalink for the nearest ancestor section.
+     */
+    readonly bookmark: "bookmark";
+    /**
+     * Preferred URL for the current document.
+     */
+    readonly canonical: "canonical";
+    /**
+     * Compression dictionary for future downloads.
+     */
+    readonly compressionDictionary: "compression-dictionary";
+    /**
+     * Hint to perform DNS resolution in advance.
+     */
+    readonly dnsPrefetch: "dns-prefetch";
+    /**
+     * The referenced document is external to the current site.
+     */
+    readonly external: "external";
+    /**
+     * Allows render-blocking until essential parts are parsed.
+     */
+    readonly expect: "expect";
+    /**
+     * Link to context-sensitive help.
+     */
+    readonly help: "help";
+    /**
+     * Icon representing the current document.
+     */
+    readonly icon: "icon";
+    /**
+     * Licensing information for the current document.
+     */
+    readonly license: "license";
+    /**
+     * Web application manifest.
+     */
+    readonly manifest: "manifest";
+    /**
+     * Indicates the current document represents the linked identity.
+     */
+    readonly me: "me";
+    /**
+     * Pre-emptively fetch a module and optionally its dependencies.
+     */
+    readonly modulePreload: "modulepreload";
+    /**
+     * The next document in a series.
+     */
+    readonly next: "next";
+    /**
+     * The current document does not endorse the referenced document.
+     */
+    readonly nofollow: "nofollow";
+    /**
+     * Prevent access to the originating browsing context.
+     */
+    readonly noopener: "noopener";
+    /**
+     * Suppress the Referer header and implies noopener.
+     */
+    readonly noreferrer: "noreferrer";
+    /**
+     * Allow access to the originating browsing context.
+     */
+    readonly opener: "opener";
+    /**
+     * Address of the pingback server for the current document.
+     */
+    readonly pingback: "pingback";
+    /**
+     * Hint to connect to the target origin in advance.
+     */
+    readonly preconnect: "preconnect";
+    /**
+     * Hint to fetch and cache a likely next resource.
+     */
+    readonly prefetch: "prefetch";
+    /**
+     * Hint to fetch and cache a resource for the current navigation.
+     */
+    readonly preload: "preload";
+    /**
+     * Deprecated hint to fetch and process a target in advance.
+     */
+    readonly prerender: "prerender";
+    /**
+     * The previous document in a series.
+     */
+    readonly prev: "prev";
+    /**
+     * Privacy policy for the current document.
+     */
+    readonly privacyPolicy: "privacy-policy";
+    /**
+     * Search resource for the current document or related resources.
+     */
+    readonly search: "search";
+    /**
+     * External stylesheet for the current document.
+     */
+    readonly stylesheet: "stylesheet";
+    /**
+     * Tag applying to the current document.
+     */
+    readonly tag: "tag";
+    /**
+     * Terms of service for the current document.
+     */
+    readonly termsOfService: "terms-of-service";
+};
+/**
+ * Common HTML rel attribute values.
+ */
+export type HttpLinkRelType = (typeof HttpLinkRelType)[keyof typeof HttpLinkRelType];

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

@@ -1,3 +1,5 @@
+import type { HttpLinkRelType } from "../models/httpLinkRelType.js";
+import type { IHttpLinkHeader } from "../models/IHttpLinkHeader.js";
 /**
  * Class to helper with header operations.
  */
@@ -19,54 +21,42 @@ export declare class HeaderHelper {
      */
     static extractBearer(header: unknown): string;
     /**
-     * Extract the properties from a Link header for a specific relation type.
+     * Extract the first occurrence of properties from a Link header for a specific relation type.
      * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
      * @param relation The relation type to extract.
      * @returns The extracted URL, rel and optional params or undefined if invalid/missing.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
      */
-    static extractLinkHeaderRelation(linkHeader: unknown, relation: string): {
-        url: string;
-        urlQueryParams?: {
-            [id: string]: string;
-        };
-        rel: string;
-        params?: {
-            [id: string]: string;
-        };
-    } | undefined;
+    static extractLinkHeaderRelation(linkHeader: unknown, relation: HttpLinkRelType | string | RegExp): IHttpLinkHeader | undefined;
+    /**
+     * Extract multiple properties from a Link header for a specific relation type.
+     * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+     * @param relation The relation type to extract.
+     * @returns The extracted URL, rel and optional params or undefined if invalid/missing.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+     */
+    static extractLinkHeaderRelations(linkHeader: unknown, relation: HttpLinkRelType | string | RegExp): IHttpLinkHeader[] | undefined;
     /**
      * Extract the link headers.
      * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
      * @returns The extracted possible array of URL, rel and optional params or undefined if invalid/missing.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
      */
-    static extractLinkHeaders(linkHeader: unknown): {
-        url: string;
-        urlQueryParams?: {
-            [id: string]: string;
-        };
-        rel: string;
-        params?: {
-            [id: string]: string;
-        };
-    }[] | undefined;
+    static extractLinkHeaders(linkHeader: unknown): IHttpLinkHeader[] | undefined;
+    /**
+     * Split a combined Link header value into individual link-value segments, comma separated.
+     * @param linkHeader Raw Link header string.
+     * @returns Array of individual link-value segments.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+     */
+    static extractLinkHeaderSegments(linkHeader: string): string[];
     /**
      * Extract the properties from a Link header.
      * @param linkHeader The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
      * @returns The extracted URL, rel and optional params or undefined if invalid/missing.
      * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
      */
-    static extractLinkHeader(linkHeader: string): {
-        url: string;
-        urlQueryParams?: {
-            [id: string]: string;
-        };
-        rel: string;
-        params?: {
-            [id: string]: string;
-        };
-    } | undefined;
+    static extractLinkHeader(linkHeader: string): IHttpLinkHeader | undefined;
     /**
      * Create a compliant Link header.
      * @param url The URL to include in the Link header.
@@ -78,7 +68,7 @@ export declare class HeaderHelper {
      */
     static createLinkHeader(url: string, urlQueryParams: {
         [id: string]: string;
-    } | undefined, rel: string, params?: {
+    } | undefined, rel: HttpLinkRelType | HttpLinkRelType[] | string | string[], params?: {
         [id: string]: string;
     }): string;
 }

package/docs/changelog.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.0.3-next.26](https://github.com/twinfoundation/framework/compare/web-v0.0.3-next.25...web-v0.0.3-next.26) (2026-03-24)
+
+
+### Features
+
+* additional http link feature support ([b68b4cc](https://github.com/twinfoundation/framework/commit/b68b4cc6a6e3cf02f91e794353714e26a49fe66c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.3-next.25 to 0.0.3-next.26
+    * @twin.org/crypto bumped from 0.0.3-next.25 to 0.0.3-next.26
+    * @twin.org/nameof bumped from 0.0.3-next.25 to 0.0.3-next.26
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.25 to 0.0.3-next.26
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.25 to 0.0.3-next.26
+    * @twin.org/validate-locales bumped from 0.0.3-next.25 to 0.0.3-next.26
+
 ## [0.0.3-next.25](https://github.com/twinfoundation/framework/compare/web-v0.0.3-next.24...web-v0.0.3-next.25) (2026-03-23)
 
 

package/docs/reference/classes/HeaderHelper.md

@@ -68,9 +68,9 @@ The extracted token if it exists.
 
 ### extractLinkHeaderRelation() {#extractlinkheaderrelation}
 
-> `static` **extractLinkHeaderRelation**(`linkHeader`, `relation`): \{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
+> `static` **extractLinkHeaderRelation**(`linkHeader`, `relation`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md) \| `undefined`
 
-Extract the properties from a Link header for a specific relation type.
+Extract the first occurrence of properties from a Link header for a specific relation type.
 
 #### Parameters
 
@@ -82,13 +82,45 @@ The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
 
 ##### relation
 
-`string`
+`string` \| `RegExp`
 
 The relation type to extract.
 
 #### Returns
 
-\{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
+[`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md) \| `undefined`
+
+The extracted URL, rel and optional params or undefined if invalid/missing.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+
+***
+
+### extractLinkHeaderRelations() {#extractlinkheaderrelations}
+
+> `static` **extractLinkHeaderRelations**(`linkHeader`, `relation`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md)[] \| `undefined`
+
+Extract multiple properties from a Link header for a specific relation type.
+
+#### Parameters
+
+##### linkHeader
+
+`unknown`
+
+The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+
+##### relation
+
+`string` \| `RegExp`
+
+The relation type to extract.
+
+#### Returns
+
+[`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md)[] \| `undefined`
 
 The extracted URL, rel and optional params or undefined if invalid/missing.
 
@@ -100,7 +132,7 @@ https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
 
 ### extractLinkHeaders() {#extractlinkheaders}
 
-> `static` **extractLinkHeaders**(`linkHeader`): `object`[] \| `undefined`
+> `static` **extractLinkHeaders**(`linkHeader`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md)[] \| `undefined`
 
 Extract the link headers.
 
@@ -114,7 +146,7 @@ The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
 
 #### Returns
 
-`object`[] \| `undefined`
+[`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md)[] \| `undefined`
 
 The extracted possible array of URL, rel and optional params or undefined if invalid/missing.
 
@@ -124,9 +156,35 @@ https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
 
 ***
 
+### extractLinkHeaderSegments() {#extractlinkheadersegments}
+
+> `static` **extractLinkHeaderSegments**(`linkHeader`): `string`[]
+
+Split a combined Link header value into individual link-value segments, comma separated.
+
+#### Parameters
+
+##### linkHeader
+
+`string`
+
+Raw Link header string.
+
+#### Returns
+
+`string`[]
+
+Array of individual link-value segments.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+
+***
+
 ### extractLinkHeader() {#extractlinkheader}
 
-> `static` **extractLinkHeader**(`linkHeader`): \{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
+> `static` **extractLinkHeader**(`linkHeader`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md) \| `undefined`
 
 Extract the properties from a Link header.
 
@@ -140,7 +198,7 @@ The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
 
 #### Returns
 
-\{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
+[`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md) \| `undefined`
 
 The extracted URL, rel and optional params or undefined if invalid/missing.
 
@@ -172,7 +230,7 @@ Optional query parameters to include in the URL.
 
 ##### rel
 
-`string`
+`string` \| `string`[] \| [`HttpLinkRelType`](../type-aliases/HttpLinkRelType.md)[]
 
 The relation type (e.g., "next", "prev", "self").
 

package/docs/reference/index.md

@@ -15,6 +15,7 @@
 
 - [IFetchOptions](interfaces/IFetchOptions.md)
 - [IHttpHeaders](interfaces/IHttpHeaders.md)
+- [IHttpLinkHeader](interfaces/IHttpLinkHeader.md)
 
 ## Type Aliases
 
@@ -22,6 +23,7 @@
 - [IJwtHeader](type-aliases/IJwtHeader.md)
 - [IJwtPayload](type-aliases/IJwtPayload.md)
 - [HeaderTypes](type-aliases/HeaderTypes.md)
+- [HttpLinkRelType](type-aliases/HttpLinkRelType.md)
 - [HttpMethod](type-aliases/HttpMethod.md)
 - [HttpStatusCode](type-aliases/HttpStatusCode.md)
 - [JwkCryptoKey](type-aliases/JwkCryptoKey.md)
@@ -30,6 +32,7 @@
 ## Variables
 
 - [HeaderTypes](variables/HeaderTypes.md)
+- [HttpLinkRelType](variables/HttpLinkRelType.md)
 - [HttpMethod](variables/HttpMethod.md)
 - [HttpStatusCode](variables/HttpStatusCode.md)
 - [MimeTypes](variables/MimeTypes.md)

package/docs/reference/interfaces/IHttpLinkHeader.md

@@ -0,0 +1,43 @@
+# Interface: IHttpLinkHeader
+
+Model used for Http link headers parameter.
+
+## Properties
+
+### url {#url}
+
+> **url**: `string`
+
+The URL of the link.
+
+***
+
+### urlQueryParams? {#urlqueryparams}
+
+> `optional` **urlQueryParams?**: `object`
+
+Optional query parameters for the URL.
+
+#### Index Signature
+
+\[`id`: `string`\]: `string`
+
+***
+
+### rel {#rel}
+
+> **rel**: `string`[]
+
+The relation types of the link.
+
+***
+
+### params? {#params}
+
+> `optional` **params?**: `object`
+
+Optional additional parameters for the link.
+
+#### Index Signature
+
+\[`id`: `string`\]: `string`

package/docs/reference/type-aliases/HttpLinkRelType.md

@@ -0,0 +1,5 @@
+# Type Alias: HttpLinkRelType
+
+> **HttpLinkRelType** = *typeof* [`HttpLinkRelType`](../variables/HttpLinkRelType.md)\[keyof *typeof* [`HttpLinkRelType`](../variables/HttpLinkRelType.md)\]
+
+Common HTML rel attribute values.

package/docs/reference/variables/HttpLinkRelType.md

@@ -0,0 +1,191 @@
+# Variable: HttpLinkRelType
+
+> `const` **HttpLinkRelType**: `object`
+
+Common HTML rel attribute values.
+
+## Type Declaration
+
+### alternate {#alternate}
+
+> `readonly` **alternate**: `"alternate"` = `"alternate"`
+
+Alternate representation of the current document.
+
+### author {#author}
+
+> `readonly` **author**: `"author"` = `"author"`
+
+Author of the current document or article.
+
+### bookmark {#bookmark}
+
+> `readonly` **bookmark**: `"bookmark"` = `"bookmark"`
+
+Permalink for the nearest ancestor section.
+
+### canonical {#canonical}
+
+> `readonly` **canonical**: `"canonical"` = `"canonical"`
+
+Preferred URL for the current document.
+
+### compressionDictionary {#compressiondictionary}
+
+> `readonly` **compressionDictionary**: `"compression-dictionary"` = `"compression-dictionary"`
+
+Compression dictionary for future downloads.
+
+### dnsPrefetch {#dnsprefetch}
+
+> `readonly` **dnsPrefetch**: `"dns-prefetch"` = `"dns-prefetch"`
+
+Hint to perform DNS resolution in advance.
+
+### external {#external}
+
+> `readonly` **external**: `"external"` = `"external"`
+
+The referenced document is external to the current site.
+
+### expect {#expect}
+
+> `readonly` **expect**: `"expect"` = `"expect"`
+
+Allows render-blocking until essential parts are parsed.
+
+### help {#help}
+
+> `readonly` **help**: `"help"` = `"help"`
+
+Link to context-sensitive help.
+
+### icon {#icon}
+
+> `readonly` **icon**: `"icon"` = `"icon"`
+
+Icon representing the current document.
+
+### license {#license}
+
+> `readonly` **license**: `"license"` = `"license"`
+
+Licensing information for the current document.
+
+### manifest {#manifest}
+
+> `readonly` **manifest**: `"manifest"` = `"manifest"`
+
+Web application manifest.
+
+### me {#me}
+
+> `readonly` **me**: `"me"` = `"me"`
+
+Indicates the current document represents the linked identity.
+
+### modulePreload {#modulepreload}
+
+> `readonly` **modulePreload**: `"modulepreload"` = `"modulepreload"`
+
+Preemptively fetch a module and optionally its dependencies.
+
+### next {#next}
+
+> `readonly` **next**: `"next"` = `"next"`
+
+The next document in a series.
+
+### nofollow {#nofollow}
+
+> `readonly` **nofollow**: `"nofollow"` = `"nofollow"`
+
+The current document does not endorse the referenced document.
+
+### noopener {#noopener}
+
+> `readonly` **noopener**: `"noopener"` = `"noopener"`
+
+Prevent access to the originating browsing context.
+
+### noreferrer {#noreferrer}
+
+> `readonly` **noreferrer**: `"noreferrer"` = `"noreferrer"`
+
+Suppress the Referer header and implies noopener.
+
+### opener {#opener}
+
+> `readonly` **opener**: `"opener"` = `"opener"`
+
+Allow access to the originating browsing context.
+
+### pingback {#pingback}
+
+> `readonly` **pingback**: `"pingback"` = `"pingback"`
+
+Address of the pingback server for the current document.
+
+### preconnect {#preconnect}
+
+> `readonly` **preconnect**: `"preconnect"` = `"preconnect"`
+
+Hint to connect to the target origin in advance.
+
+### prefetch {#prefetch}
+
+> `readonly` **prefetch**: `"prefetch"` = `"prefetch"`
+
+Hint to fetch and cache a likely next resource.
+
+### preload {#preload}
+
+> `readonly` **preload**: `"preload"` = `"preload"`
+
+Hint to fetch and cache a resource for the current navigation.
+
+### prerender {#prerender}
+
+> `readonly` **prerender**: `"prerender"` = `"prerender"`
+
+Deprecated hint to fetch and process a target in advance.
+
+### prev {#prev}
+
+> `readonly` **prev**: `"prev"` = `"prev"`
+
+The previous document in a series.
+
+### privacyPolicy {#privacypolicy}
+
+> `readonly` **privacyPolicy**: `"privacy-policy"` = `"privacy-policy"`
+
+Privacy policy for the current document.
+
+### search {#search}
+
+> `readonly` **search**: `"search"` = `"search"`
+
+Search resource for the current document or related resources.
+
+### stylesheet {#stylesheet}
+
+> `readonly` **stylesheet**: `"stylesheet"` = `"stylesheet"`
+
+External stylesheet for the current document.
+
+### tag {#tag}
+
+> `readonly` **tag**: `"tag"` = `"tag"`
+
+Tag applying to the current document.
+
+### termsOfService {#termsofservice}
+
+> `readonly` **termsOfService**: `"terms-of-service"` = `"terms-of-service"`
+
+Terms of service for the current document.
+
+## See
+
+https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/web",
-	"version": "0.0.3-next.25",
+	"version": "0.0.3-next.26",
 	"description": "Classes for use with web operations",
 	"repository": {
 		"type": "git",
@@ -14,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.3-next.25",
-		"@twin.org/crypto": "0.0.3-next.25",
-		"@twin.org/nameof": "0.0.3-next.25",
+		"@twin.org/core": "0.0.3-next.26",
+		"@twin.org/crypto": "0.0.3-next.26",
+		"@twin.org/nameof": "0.0.3-next.26",
 		"jose": "6.2.2"
 	},
 	"main": "./dist/es/index.js",