@twin.org/web 0.0.3-next.3 → 0.0.3-next.30

package/docs/reference/classes/FetchHelper.md

@@ -14,7 +14,7 @@ Class to helper with fetch operations.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fetch()
+### fetch() {#fetch}
 
 > `static` **fetch**(`source`, `url`, `method`, `body?`, `options?`): `Promise`\<`Response`\>
 
@@ -50,9 +50,9 @@ The http method.
 
 ##### body?
 
-Request to send to the endpoint.
+`string` \| `Uint8Array`\<`ArrayBufferLike`\>
 
-`string` | `Uint8Array`\<`ArrayBufferLike`\>
+Request to send to the endpoint.
 
 ##### options?
 
@@ -68,7 +68,7 @@ The response.
 
 ***
 
-### fetchJson()
+### fetchJson() {#fetchjson}
 
 > `static` **fetchJson**\<`T`, `U`\>(`source`, `url`, `method`, `requestData?`, `options?`): `Promise`\<`U`\>
 
@@ -124,7 +124,7 @@ The response.
 
 ***
 
-### fetchBinary()
+### fetchBinary() {#fetchbinary}
 
 > `static` **fetchBinary**\<`T`\>(`source`, `url`, `method`, `requestData?`, `options?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `T`\>
 
@@ -152,9 +152,9 @@ The url for the request.
 
 ##### method
 
-The http method.
+`"GET"` \| `"POST"`
 
-`"GET"` | `"POST"`
+The http method.
 
 ##### requestData?
 
@@ -176,7 +176,7 @@ The response.
 
 ***
 
-### clearCache()
+### clearCache() {#clearcache}
 
 > `static` **clearCache**(): `void`
 
@@ -188,7 +188,7 @@ Clears the cache.
 
 ***
 
-### getCacheEntry()
+### getCacheEntry() {#getcacheentry}
 
 > `static` **getCacheEntry**\<`T`\>(`url`): `Promise`\<`T` \| `undefined`\>
 
@@ -216,7 +216,7 @@ The cache entry if it exists.
 
 ***
 
-### setCacheEntry()
+### setCacheEntry() {#setcacheentry}
 
 > `static` **setCacheEntry**\<`T`\>(`url`, `value`): `Promise`\<`void`\>
 
@@ -250,7 +250,7 @@ The cache entry if it exists.
 
 ***
 
-### removeCacheEntry()
+### removeCacheEntry() {#removecacheentry}
 
 > `static` **removeCacheEntry**(`url`): `void`
 

package/docs/reference/classes/HeaderHelper.md

@@ -12,9 +12,17 @@ Class to helper with header operations.
 
 `HeaderHelper`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### createBearer()
+### createBearer() {#createbearer}
 
 > `static` **createBearer**(`token`): `string`
 
@@ -36,7 +44,7 @@ The bearer token header.
 
 ***
 
-### extractBearer()
+### extractBearer() {#extractbearer}
 
 > `static` **extractBearer**(`header`): `string`
 
@@ -55,3 +63,378 @@ The header value to extract the token from.
 `string`
 
 The extracted token if it exists.
+
+***
+
+### extractAcceptLanguage() {#extractacceptlanguage}
+
+> `static` **extractAcceptLanguage**(`headers?`): `object`[] \| `undefined`
+
+Extract parsed language preferences from the Accept-Language header.
+
+#### Parameters
+
+##### headers?
+
+[`IHttpHeaders`](../interfaces/IHttpHeaders.md)
+
+The HTTP request headers.
+
+#### Returns
+
+`object`[] \| `undefined`
+
+The parsed language preferences ordered by highest quality first, or undefined if missing or invalid.
+
+***
+
+### parseAcceptLanguage() {#parseacceptlanguage}
+
+> `static` **parseAcceptLanguage**(`acceptLanguage`): `object`[] \| `undefined`
+
+Parse one or more Accept-Language header values into language preferences.
+
+#### Parameters
+
+##### acceptLanguage
+
+`string` \| `string`[] \| `undefined`
+
+The Accept-Language header value or values.
+
+#### Returns
+
+`object`[] \| `undefined`
+
+The parsed language preferences ordered by highest quality first, or undefined if missing or if any entry is invalid.
+
+***
+
+### extractClientIps() {#extractclientips}
+
+> `static` **extractClientIps**(`headers?`): `string`[]
+
+Extract client IP addresses from HTTP request headers.
+Checks all `X-Forwarded-For` and `X-Real-IP` header values for proxied requests.
+
+#### Parameters
+
+##### headers?
+
+[`IHttpHeaders`](../interfaces/IHttpHeaders.md)
+
+The HTTP request headers.
+
+#### Returns
+
+`string`[]
+
+The extracted client IP addresses in header order.
+
+***
+
+### extractUserAgent() {#extractuseragent}
+
+> `static` **extractUserAgent**(`headers?`, `maxLength?`): `string` \| `undefined`
+
+Extract the User-Agent header from the HTTP request context.
+
+#### Parameters
+
+##### headers?
+
+[`IHttpHeaders`](../interfaces/IHttpHeaders.md)
+
+The HTTP request headers.
+
+##### maxLength?
+
+`number`
+
+Optional maximum length for the User-Agent string to prevent excessively long values.
+
+#### Returns
+
+`string` \| `undefined`
+
+The user agent string or undefined if not available.
+
+***
+
+### extractCorrelationId() {#extractcorrelationid}
+
+> `static` **extractCorrelationId**(`headers?`, `maxLength?`): `string` \| `undefined`
+
+Extract a correlation ID for request tracing from the X-Correlation-ID header.
+
+#### Parameters
+
+##### headers?
+
+[`IHttpHeaders`](../interfaces/IHttpHeaders.md)
+
+The HTTP request headers.
+
+##### maxLength?
+
+`number`
+
+Optional maximum length for the extracted correlation ID.
+
+#### Returns
+
+`string` \| `undefined`
+
+The correlation ID, or undefined if the header is missing or invalid.
+
+***
+
+### isIpAddress() {#isipaddress}
+
+> `static` **isIpAddress**(`ip`): `boolean`
+
+Validate if a string is a valid IP address (IPv4 or IPv6).
+
+#### Parameters
+
+##### ip
+
+`string`
+
+The IP address to validate.
+
+#### Returns
+
+`boolean`
+
+True if valid, false otherwise.
+
+***
+
+### isIpAddressV4() {#isipaddressv4}
+
+> `static` **isIpAddressV4**(`ip`): `boolean`
+
+Validate if a string is a valid IP address IPv4.
+
+#### Parameters
+
+##### ip
+
+`string`
+
+The IP address to validate.
+
+#### Returns
+
+`boolean`
+
+True if valid, false otherwise.
+
+***
+
+### isIpAddressV6() {#isipaddressv6}
+
+> `static` **isIpAddressV6**(`ip`): `boolean`
+
+Validate if a string is a valid IP address IPv6.
+
+#### Parameters
+
+##### ip
+
+`string`
+
+The IP address to validate.
+
+#### Returns
+
+`boolean`
+
+True if valid, false otherwise.
+
+***
+
+### extractLinkHeaderRelation() {#extractlinkheaderrelation}
+
+> `static` **extractLinkHeaderRelation**(`linkHeader`, `relation`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md) \| `undefined`
+
+Extract the first occurrence of 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.
+
+#### 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.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+
+***
+
+### extractLinkHeaders() {#extractlinkheaders}
+
+> `static` **extractLinkHeaders**(`linkHeader`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md)[] \| `undefined`
+
+Extract the link headers.
+
+#### Parameters
+
+##### linkHeader
+
+`unknown`
+
+The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+
+#### Returns
+
+[`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md)[] \| `undefined`
+
+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
+
+***
+
+### 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`): [`IHttpLinkHeader`](../interfaces/IHttpLinkHeader.md) \| `undefined`
+
+Extract the properties from a Link header.
+
+#### Parameters
+
+##### linkHeader
+
+`string`
+
+The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+
+#### Returns
+
+[`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
+
+***
+
+### createLinkHeader() {#createlinkheader}
+
+> `static` **createLinkHeader**(`url`, `urlQueryParams`, `rel`, `params?`): `string`
+
+Create a compliant Link header.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to include in the Link header.
+
+##### urlQueryParams
+
+\{\[`id`: `string`\]: `string`; \} \| `undefined`
+
+Optional query parameters to include in the URL.
+
+##### rel
+
+`string` \| `string`[] \| [`HttpLinkRelType`](../type-aliases/HttpLinkRelType.md)[]
+
+The relation type (e.g., "next", "prev", "self").
+
+##### params?
+
+#### Returns
+
+`string`
+
+The formatted Link header string.
+
+#### Throws
+
+GeneralError if the URL or rel are invalid.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link

package/docs/reference/classes/Jwk.md

@@ -14,7 +14,7 @@ Class to handle JSON Web Keys.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### toCryptoKey()
+### toCryptoKey() {#tocryptokey}
 
 > `static` **toCryptoKey**(`jwk`, `alg?`): `Promise`\<[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md)\>
 
@@ -50,7 +50,7 @@ The crypto key.
 
 ***
 
-### fromEd25519Private()
+### fromEd25519Private() {#fromed25519private}
 
 > `static` **fromEd25519Private**(`privateKey`, `overrideUse?`): `Promise`\<`JWK`\>
 
@@ -78,7 +78,7 @@ The crypto key.
 
 ***
 
-### fromEd25519Public()
+### fromEd25519Public() {#fromed25519public}
 
 > `static` **fromEd25519Public**(`publicKey`, `overrideUse?`): `Promise`\<`JWK`\>
 
@@ -106,7 +106,7 @@ The crypto key.
 
 ***
 
-### toRaw()
+### toRaw() {#toraw}
 
 > `static` **toRaw**(`jwk`): `Promise`\<\{ `publicKey?`: `Uint8Array`\<`ArrayBufferLike`\>; `privateKey?`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
@@ -128,7 +128,7 @@ The crypto key.
 
 ***
 
-### generateKid()
+### generateKid() {#generatekid}
 
 > `static` **generateKid**(`jwk`): `Promise`\<`string`\>
 

package/docs/reference/classes/Jws.md

@@ -14,7 +14,7 @@ Class to handle JSON Web Signatures.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > `static` **create**(`privateKey`, `hash`, `algOverride?`): `Promise`\<`string`\>
 
@@ -56,7 +56,7 @@ The signature.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > `static` **verify**(`jws`, `publicKey`, `hash`): `Promise`\<`boolean`\>
 

package/docs/reference/classes/Jwt.md

@@ -14,7 +14,7 @@ Class to handle JSON Web Tokens.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### encode()
+### encode() {#encode}
 
 > `static` **encode**\<`T`, `U`\>(`header`, `payload`, `key`): `Promise`\<`string`\>
 
@@ -66,7 +66,7 @@ The encoded token.
 
 ***
 
-### encodeWithSigner()
+### encodeWithSigner() {#encodewithsigner}
 
 > `static` **encodeWithSigner**\<`T`, `U`\>(`header`, `payload`, `signer`): `Promise`\<`string`\>
 
@@ -110,7 +110,7 @@ The encoded token.
 
 ***
 
-### decode()
+### decode() {#decode}
 
 > `static` **decode**\<`T`, `U`\>(`token`): `Promise`\<\{ `header?`: `T`; `payload?`: `U`; `signature?`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
@@ -142,7 +142,7 @@ The decoded payload.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > `static` **verify**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -180,7 +180,7 @@ The decoded payload.
 
 ***
 
-### verifyWithVerifier()
+### verifyWithVerifier() {#verifywithverifier}
 
 > `static` **verifyWithVerifier**\<`T`, `U`\>(`token`, `verifier`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -218,7 +218,7 @@ The decoded payload.
 
 ***
 
-### verifySignature()
+### verifySignature() {#verifysignature}
 
 > `static` **verifySignature**\<`T`, `U`\>(`token`, `key?`, `verifier?`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -262,7 +262,7 @@ True if the parts are verified.
 
 ***
 
-### defaultSigner()
+### defaultSigner() {#defaultsigner}
 
 > `static` **defaultSigner**(`header`, `payload`, `key`): `Promise`\<`string`\>
 
@@ -284,9 +284,9 @@ The payload to sign.
 
 ##### key
 
-The optional key to sign with.
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md) \| `undefined`
 
-[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md) | `undefined`
+The optional key to sign with.
 
 #### Returns
 
@@ -296,7 +296,7 @@ The signature.
 
 ***
 
-### defaultVerifier()
+### defaultVerifier() {#defaultverifier}
 
 > `static` **defaultVerifier**\<`T`, `U`\>(`token`, `key`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
@@ -322,9 +322,9 @@ The token to verify.
 
 ##### key
 
-The key to verify with.
+[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md) \| `undefined`
 
-[`JwkCryptoKey`](../type-aliases/JwkCryptoKey.md) | `undefined`
+The key to verify with.
 
 #### Returns
 
@@ -334,7 +334,7 @@ The header and payload if verification successful.
 
 ***
 
-### toSigningBytes()
+### toSigningBytes() {#tosigningbytes}
 
 > `static` **toSigningBytes**\<`T`, `U`\>(`header`, `payload`): `Uint8Array`
 
@@ -372,7 +372,7 @@ The bytes to sign.
 
 ***
 
-### fromSigningBytes()
+### fromSigningBytes() {#fromsigningbytes}
 
 > `static` **fromSigningBytes**\<`T`, `U`\>(`signingBytes`): `object`
 
@@ -416,7 +416,7 @@ If the signing bytes are invalid
 
 ***
 
-### tokenFromBytes()
+### tokenFromBytes() {#tokenfrombytes}
 
 > `static` **tokenFromBytes**(`signingBytes`, `signature`): `string`
 
@@ -444,7 +444,7 @@ The token.
 
 ***
 
-### tokenToBytes()
+### tokenToBytes() {#tokentobytes}
 
 > `static` **tokenToBytes**(`token`): `object`