@twin.org/web 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/classes/HeaderHelper.md

@@ -12,6 +12,14 @@ Class to helper with header operations.
 
 `HeaderHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### createBearer()
@@ -55,3 +63,131 @@ The header value to extract the token from.
 `string`
 
 The extracted token if it exists.
+
+***
+
+### extractLinkHeaderRelation()
+
+> `static` **extractLinkHeaderRelation**(`linkHeader`, `relation`): \{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
+
+Extract the 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`
+
+The relation type to extract.
+
+#### Returns
+
+\{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `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()
+
+> `static` **extractLinkHeaders**(`linkHeader`): `object`[] \| `undefined`
+
+Extract the link headers.
+
+#### Parameters
+
+##### linkHeader
+
+`unknown`
+
+The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+
+#### Returns
+
+`object`[] \| `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
+
+***
+
+### extractLinkHeader()
+
+> `static` **extractLinkHeader**(`linkHeader`): \{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `undefined`
+
+Extract the properties from a Link header.
+
+#### Parameters
+
+##### linkHeader
+
+`string`
+
+The Link header value in format `<url>; rel="..."; param1=""; param2=""`.
+
+#### Returns
+
+\{ `url`: `string`; `urlQueryParams?`: \{\[`id`: `string`\]: `string`; \}; `rel`: `string`; `params?`: \{\[`id`: `string`\]: `string`; \}; \} \| `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()
+
+> `static` **createLinkHeader**(`url`, `urlQueryParams`, `rel`, `params?`): `string`
+
+Create a compliant Link header.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to include in the Link header.
+
+##### urlQueryParams
+
+Optional query parameters to include in the URL.
+
+\{\[`id`: `string`\]: `string`; \} | `undefined`
+
+##### rel
+
+`string`
+
+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/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [FetchError](classes/FetchError.md)
+- [CookieHelper](classes/CookieHelper.md)
 - [FetchHelper](classes/FetchHelper.md)
 - [HeaderHelper](classes/HeaderHelper.md)
 - [Jwk](classes/Jwk.md)

package/docs/reference/variables/HeaderTypes.md

@@ -12,44 +12,316 @@ Common http header types.
 
 Content Type.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
+
+### ContentLanguage
+
+> `readonly` **ContentLanguage**: `"content-language"` = `"content-language"`
+
+Content Language.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language
+
 ### ContentLength
 
 > `readonly` **ContentLength**: `"content-length"` = `"content-length"`
 
 Content Length.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length
+
 ### ContentDisposition
 
 > `readonly` **ContentDisposition**: `"content-disposition"` = `"content-disposition"`
 
 Content Disposition.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+
+### ContentEncoding
+
+> `readonly` **ContentEncoding**: `"content-encoding"` = `"content-encoding"`
+
+Content Encoding.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding
+
+### CacheControl
+
+> `readonly` **CacheControl**: `"cache-control"` = `"cache-control"`
+
+Cache Control.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
+
+### ETag
+
+> `readonly` **ETag**: `"etag"` = `"etag"`
+
+ETag.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
+
+### IfNoneMatch
+
+> `readonly` **IfNoneMatch**: `"if-none-match"` = `"if-none-match"`
+
+If-None-Match.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match
+
+### LastModified
+
+> `readonly` **LastModified**: `"last-modified"` = `"last-modified"`
+
+Last-Modified.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified
+
+### IfModifiedSince
+
+> `readonly` **IfModifiedSince**: `"if-modified-since"` = `"if-modified-since"`
+
+If-Modified-Since.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since
+
 ### Accept
 
 > `readonly` **Accept**: `"accept"` = `"accept"`
 
 Accept.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept
+
+### AcceptLanguage
+
+> `readonly` **AcceptLanguage**: `"accept-language"` = `"accept-language"`
+
+Accept-Language.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language
+
+### AcceptEncoding
+
+> `readonly` **AcceptEncoding**: `"accept-encoding"` = `"accept-encoding"`
+
+Accept-Encoding.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Encoding
+
 ### Authorization
 
 > `readonly` **Authorization**: `"authorization"` = `"authorization"`
 
 Authorization.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Authorization
+
+### WwwAuthenticate
+
+> `readonly` **WwwAuthenticate**: `"www-authenticate"` = `"www-authenticate"`
+
+WWW-Authenticate.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/WWW-Authenticate
+
 ### Cookie
 
 > `readonly` **Cookie**: `"cookie"` = `"cookie"`
 
 Cookie.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cookie
+
 ### SetCookie
 
 > `readonly` **SetCookie**: `"set-cookie"` = `"set-cookie"`
 
 Set Cookie.
 
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie
+
 ### Location
 
 > `readonly` **Location**: `"location"` = `"location"`
 
 Location
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Location
+
+### Origin
+
+> `readonly` **Origin**: `"origin"` = `"origin"`
+
+Origin.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
+
+### Referer
+
+> `readonly` **Referer**: `"referer"` = `"referer"`
+
+Referer.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer
+
+### Link
+
+> `readonly` **Link**: `"link"` = `"link"`
+
+Link
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+
+### Vary
+
+> `readonly` **Vary**: `"vary"` = `"vary"`
+
+Vary.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary
+
+### AccessControlAllowOrigin
+
+> `readonly` **AccessControlAllowOrigin**: `"access-control-allow-origin"` = `"access-control-allow-origin"`
+
+Access-Control-Allow-Origin.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
+
+### AccessControlAllowMethods
+
+> `readonly` **AccessControlAllowMethods**: `"access-control-allow-methods"` = `"access-control-allow-methods"`
+
+Access-Control-Allow-Methods.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
+
+### AccessControlAllowHeaders
+
+> `readonly` **AccessControlAllowHeaders**: `"access-control-allow-headers"` = `"access-control-allow-headers"`
+
+Access-Control-Allow-Headers.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
+
+### AccessControlExposeHeaders
+
+> `readonly` **AccessControlExposeHeaders**: `"access-control-expose-headers"` = `"access-control-expose-headers"`
+
+Access-Control-Expose-Headers.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers
+
+### AccessControlMaxAge
+
+> `readonly` **AccessControlMaxAge**: `"access-control-max-age"` = `"access-control-max-age"`
+
+Access-Control-Max-Age.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age
+
+### AccessControlAllowCredentials
+
+> `readonly` **AccessControlAllowCredentials**: `"access-control-allow-credentials"` = `"access-control-allow-credentials"`
+
+Access-Control-Allow-Credentials.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials
+
+### Range
+
+> `readonly` **Range**: `"range"` = `"range"`
+
+Range.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range
+
+### AcceptRanges
+
+> `readonly` **AcceptRanges**: `"accept-ranges"` = `"accept-ranges"`
+
+Accept-Ranges.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Ranges
+
+### ContentRange
+
+> `readonly` **ContentRange**: `"content-range"` = `"content-range"`
+
+Content-Range.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range
+
+### UserAgent
+
+> `readonly` **UserAgent**: `"user-agent"` = `"user-agent"`
+
+User-Agent
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent

package/docs/reference/variables/HttpMethod.md

@@ -10,34 +10,88 @@ The names of the HTTP Methods.
 
 > `readonly` **GET**: `"GET"` = `"GET"`
 
+Retrieve a representation of the resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET
+
 ### POST
 
 > `readonly` **POST**: `"POST"` = `"POST"`
 
+Submit an entity to the specified resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST
+
 ### PUT
 
 > `readonly` **PUT**: `"PUT"` = `"PUT"`
 
+Replace all current representations of the target resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT
+
 ### PATCH
 
 > `readonly` **PATCH**: `"PATCH"` = `"PATCH"`
 
+Apply partial modifications to a resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH
+
 ### DELETE
 
 > `readonly` **DELETE**: `"DELETE"` = `"DELETE"`
 
+Delete the specified resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE
+
 ### OPTIONS
 
 > `readonly` **OPTIONS**: `"OPTIONS"` = `"OPTIONS"`
 
+Describe the communication options for the target resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS
+
 ### HEAD
 
 > `readonly` **HEAD**: `"HEAD"` = `"HEAD"`
 
+Ask for a response identical to GET, but without the response body.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD
+
 ### CONNECT
 
 > `readonly` **CONNECT**: `"CONNECT"` = `"CONNECT"`
 
+Establish a tunnel to the server identified by the target resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT
+
 ### TRACE
 
 > `readonly` **TRACE**: `"TRACE"` = `"TRACE"`
+
+Perform a message loop-back test along the path to the target resource.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/TRACE