@twin.org/web 0.0.3-next.4 → 0.0.3-next.40

package/docs/reference/classes/MimeTypeHelper.md

@@ -14,7 +14,7 @@ Class to help with mime types.
 
 ## Methods
 
-### detect()
+### detect() {#detect}
 
 > `static` **detect**(`data`): `Promise`\<`string` \| `undefined`\>
 
@@ -36,7 +36,7 @@ The mime type if detected.
 
 ***
 
-### defaultExtension()
+### defaultExtension() {#defaultextension}
 
 > `static` **defaultExtension**(`mimeType`): `string` \| `undefined`
 
@@ -46,9 +46,9 @@ Return the default extension for a mime type.
 
 ##### mimeType
 
-The mimetype to get the extension for.
+`string` \| `undefined`
 
-`string` | `undefined`
+The mimetype to get the extension for.
 
 #### Returns
 

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)
@@ -14,6 +15,7 @@
 
 - [IFetchOptions](interfaces/IFetchOptions.md)
 - [IHttpHeaders](interfaces/IHttpHeaders.md)
+- [IHttpLinkHeader](interfaces/IHttpLinkHeader.md)
 
 ## Type Aliases
 
@@ -21,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)
@@ -29,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/IFetchOptions.md

@@ -4,50 +4,48 @@ Options for call to the fetch helper.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: [`IHttpHeaders`](IHttpHeaders.md)
-
-#### Param
+> `optional` **headers?**: [`IHttpHeaders`](IHttpHeaders.md)
 
 The headers for the request.
 
 ***
 
-### timeoutMs?
+### timeoutMs? {#timeoutms}
 
-> `optional` **timeoutMs**: `number`
+> `optional` **timeoutMs?**: `number`
 
 Timeout for requests in milliseconds.
 
 ***
 
-### includeCredentials?
+### includeCredentials? {#includecredentials}
 
-> `optional` **includeCredentials**: `boolean`
+> `optional` **includeCredentials?**: `boolean`
 
 Include credentials in the requests.
 
 ***
 
-### retryCount?
+### retryCount? {#retrycount}
 
-> `optional` **retryCount**: `number`
+> `optional` **retryCount?**: `number`
 
 The number of times to retry fetching defaults to no retries.
 
 ***
 
-### retryDelayMs?
+### retryDelayMs? {#retrydelayms}
 
-> `optional` **retryDelayMs**: `number`
+> `optional` **retryDelayMs?**: `number`
 
 The number of milliseconds we should delay before any retry.
 
 ***
 
-### cacheTtlMs?
+### cacheTtlMs? {#cachettlms}
 
-> `optional` **cacheTtlMs**: `number`
+> `optional` **cacheTtlMs?**: `number`
 
 The number of milliseconds to cache the response for, leave undefined for no cache, 0 means infinite.

package/docs/reference/interfaces/IHttpHeaders.md

@@ -4,4 +4,4 @@ Model used for Http headers parameter.
 
 ## Indexable
 
-\[`key`: `string`\]: `string` \| `string`[]
+> \[`key`: `string`\]: `string` \| `string`[]

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/HeaderTypes.md

@@ -6,50 +6,322 @@ Common http header types.
 
 ## Type Declaration
 
-### ContentType
+### ContentType {#contenttype}
 
 > `readonly` **ContentType**: `"content-type"` = `"content-type"`
 
 Content Type.
 
-### ContentLength
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
+
+### ContentLanguage {#contentlanguage}
+
+> `readonly` **ContentLanguage**: `"content-language"` = `"content-language"`
+
+Content Language.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language
+
+### ContentLength {#contentlength}
 
 > `readonly` **ContentLength**: `"content-length"` = `"content-length"`
 
 Content Length.
 
-### ContentDisposition
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length
+
+### ContentDisposition {#contentdisposition}
 
 > `readonly` **ContentDisposition**: `"content-disposition"` = `"content-disposition"`
 
 Content Disposition.
 
-### Accept
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+
+### ContentEncoding {#contentencoding}
+
+> `readonly` **ContentEncoding**: `"content-encoding"` = `"content-encoding"`
+
+Content Encoding.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Encoding
+
+### CacheControl {#cachecontrol}
+
+> `readonly` **CacheControl**: `"cache-control"` = `"cache-control"`
+
+Cache Control.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
+
+### ETag {#etag}
+
+> `readonly` **ETag**: `"etag"` = `"etag"`
+
+ETag.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag
+
+### IfNoneMatch {#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 {#lastmodified}
+
+> `readonly` **LastModified**: `"last-modified"` = `"last-modified"`
+
+Last-Modified.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Last-Modified
+
+### IfModifiedSince {#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 {#accept}
 
 > `readonly` **Accept**: `"accept"` = `"accept"`
 
 Accept.
 
-### Authorization
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept
+
+### AcceptLanguage {#acceptlanguage}
+
+> `readonly` **AcceptLanguage**: `"accept-language"` = `"accept-language"`
+
+Accept-Language.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Language
+
+### AcceptEncoding {#acceptencoding}
+
+> `readonly` **AcceptEncoding**: `"accept-encoding"` = `"accept-encoding"`
+
+Accept-Encoding.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Accept-Encoding
+
+### Authorization {#authorization}
 
 > `readonly` **Authorization**: `"authorization"` = `"authorization"`
 
 Authorization.
 
-### Cookie
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Authorization
+
+### WwwAuthenticate {#wwwauthenticate}
+
+> `readonly` **WwwAuthenticate**: `"www-authenticate"` = `"www-authenticate"`
+
+WWW-Authenticate.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/WWW-Authenticate
+
+### Cookie {#cookie}
 
 > `readonly` **Cookie**: `"cookie"` = `"cookie"`
 
 Cookie.
 
-### SetCookie
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Cookie
+
+### SetCookie {#setcookie}
 
 > `readonly` **SetCookie**: `"set-cookie"` = `"set-cookie"`
 
 Set Cookie.
 
-### Location
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Set-Cookie
+
+### Location {#location}
 
 > `readonly` **Location**: `"location"` = `"location"`
 
 Location
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Location
+
+### Origin {#origin}
+
+> `readonly` **Origin**: `"origin"` = `"origin"`
+
+Origin.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
+
+### Referer {#referer}
+
+> `readonly` **Referer**: `"referer"` = `"referer"`
+
+Referer.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer
+
+### Link {#link}
+
+> `readonly` **Link**: `"link"` = `"link"`
+
+Link
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Link
+
+### Vary {#vary}
+
+> `readonly` **Vary**: `"vary"` = `"vary"`
+
+Vary.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary
+
+### AccessControlAllowOrigin {#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 {#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 {#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 {#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 {#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 {#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 {#range}
+
+> `readonly` **Range**: `"range"` = `"range"`
+
+Range.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range
+
+### AcceptRanges {#acceptranges}
+
+> `readonly` **AcceptRanges**: `"accept-ranges"` = `"accept-ranges"`
+
+Accept-Ranges.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Ranges
+
+### ContentRange {#contentrange}
+
+> `readonly` **ContentRange**: `"content-range"` = `"content-range"`
+
+Content-Range.
+
+#### See
+
+https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range
+
+### UserAgent {#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/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"`
+
+Pre-emptively 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