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

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

@@ -1,35 +1,144 @@
 /**
  * Common mime types.
+ * @see https://www.iana.org/assignments/media-types/media-types.xhtml
  */
 export declare const MimeTypes: {
     /**
      * Plaint Text - text/plain
      */
     readonly PlainText: "text/plain";
+    /**
+     * Event Stream - text/event-stream
+     */
+    readonly EventStream: "text/event-stream";
     /**
      * HTML - text/html
      */
     readonly Html: "text/html";
+    /**
+     * CSS - text/css
+     */
+    readonly Css: "text/css";
     /**
      * Javascript - text/javascript
      */
     readonly Javascript: "text/javascript";
+    /**
+     * Markdown - text/markdown
+     */
+    readonly Markdown: "text/markdown";
     /**
      * JSON - application/json
      */
     readonly Json: "application/json";
+    /**
+     * Problem JSON - application/problem+json
+     */
+    readonly ProblemJson: "application/problem+json";
     /**
      * JSON-LD - application/ld+json
      */
     readonly JsonLd: "application/ld+json";
+    /**
+     * Activity Streams - application/activity+json
+     */
+    readonly ActivityStreams: "application/activity+json";
+    /**
+     * WebFinger JRD - application/jrd+json
+     */
+    readonly JrdJson: "application/jrd+json";
     /**
      * JWT - application/jwt
      */
     readonly Jwt: "application/jwt";
+    /**
+     * Access Token JWT - application/at+jwt
+     */
+    readonly AccessTokenJwt: "application/at+jwt";
+    /**
+     * JOSE (Compact Serialization) - application/jose
+     */
+    readonly Jose: "application/jose";
+    /**
+     * JOSE (JSON Serialization) - application/jose+json
+     */
+    readonly JoseJson: "application/jose+json";
+    /**
+     * JSON Web Key (JWK) - application/jwk+json
+     */
+    readonly JwkJson: "application/jwk+json";
+    /**
+     * JSON Web Key Set (JWKS) - application/jwk-set+json
+     */
+    readonly JwkSetJson: "application/jwk-set+json";
+    /**
+     * Decentralized Identifier (DID) - application/did+json
+     */
+    readonly DidJson: "application/did+json";
+    /**
+     * Decentralized Identifier (DID) (JSON-LD) - application/did+ld+json
+     */
+    readonly DidLdJson: "application/did+ld+json";
+    /**
+     * Verifiable Credential (JSON-LD) - application/vc+ld+json
+     */
+    readonly VerifiableCredentialLdJson: "application/vc+ld+json";
+    /**
+     * Verifiable Presentation (JSON-LD) - application/vp+ld+json
+     */
+    readonly VerifiablePresentationLdJson: "application/vp+ld+json";
+    /**
+     * Verifiable Credential (JWT) - application/vc+jwt
+     */
+    readonly VerifiableCredentialJwt: "application/vc+jwt";
+    /**
+     * Verifiable Presentation (JWT) - application/vp+jwt
+     */
+    readonly VerifiablePresentationJwt: "application/vp+jwt";
+    /**
+     * JSON Patch - application/json-patch+json
+     */
+    readonly JsonPatch: "application/json-patch+json";
+    /**
+     * JSON Merge Patch - application/merge-patch+json
+     */
+    readonly MergePatch: "application/merge-patch+json";
+    /**
+     * CBOR Web Token (CWT) - application/cwt
+     */
+    readonly Cwt: "application/cwt";
+    /**
+     * COSE - application/cose
+     */
+    readonly Cose: "application/cose";
+    /**
+     * COSE Key - application/cose-key
+     */
+    readonly CoseKey: "application/cose-key";
+    /**
+     * COSE Key Set - application/cose-key-set
+     */
+    readonly CoseKeySet: "application/cose-key-set";
+    /**
+     * Form URL Encoded - application/x-www-form-urlencoded
+     */
+    readonly FormUrlEncoded: "application/x-www-form-urlencoded";
+    /**
+     * Multipart Form Data - multipart/form-data
+     */
+    readonly MultipartFormData: "multipart/form-data";
     /**
      * XML - application/xml
      */
     readonly Xml: "application/xml";
+    /**
+     * WASM - application/wasm
+     */
+    readonly Wasm: "application/wasm";
+    /**
+     * Web App Manifest - application/manifest+json
+     */
+    readonly WebManifest: "application/manifest+json";
     /**
      * Application Octet Stream, arbitrary binary - application/octet-stream
      */
@@ -78,10 +187,62 @@ export declare const MimeTypes: {
      * Image SVG - image/svg+xml
      */
     readonly Svg: "image/svg+xml";
+    /**
+     * Image ICO - image/x-icon
+     */
+    readonly Ico: "image/x-icon";
     /**
      * Image WEBP - image/webp
      */
     readonly WebP: "image/webp";
+    /**
+     * Image AVIF - image/avif
+     */
+    readonly Avif: "image/avif";
+    /**
+     * Image APNG - image/apng
+     */
+    readonly Apng: "image/apng";
+    /**
+     * Font WOFF - font/woff
+     */
+    readonly Woff: "font/woff";
+    /**
+     * Font WOFF2 - font/woff2
+     */
+    readonly Woff2: "font/woff2";
+    /**
+     * Font TTF - font/ttf
+     */
+    readonly Ttf: "font/ttf";
+    /**
+     * Font OTF - font/otf
+     */
+    readonly Otf: "font/otf";
+    /**
+     * Audio MP3 - audio/mpeg
+     */
+    readonly Mp3: "audio/mpeg";
+    /**
+     * Audio OGG - audio/ogg
+     */
+    readonly OggAudio: "audio/ogg";
+    /**
+     * Audio WAV - audio/wav
+     */
+    readonly Wav: "audio/wav";
+    /**
+     * Audio WEBM - audio/webm
+     */
+    readonly WebmAudio: "audio/webm";
+    /**
+     * Audio AAC - audio/aac
+     */
+    readonly Aac: "audio/aac";
+    /**
+     * Audio MP4 - audio/mp4
+     */
+    readonly Mp4Audio: "audio/mp4";
     /**
      * Video MP4 - video/mp4
      */
@@ -94,6 +255,14 @@ export declare const MimeTypes: {
      * Video WEBM - video/webm
      */
     readonly Webm: "video/webm";
+    /**
+     * Video OGG - video/ogg
+     */
+    readonly OggVideo: "video/ogg";
+    /**
+     * Video QuickTime - video/quicktime
+     */
+    readonly Quicktime: "video/quicktime";
 };
 /**
  * Common mime types.

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

@@ -0,0 +1,49 @@
+/**
+ * Class to help with cookie operations.
+ */
+export declare class CookieHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a cookie string.
+     * @param cookieName The name of the cookie.
+     * @param cookieValue The value of the cookie.
+     * @param options Additional cookie options.
+     * @param options.secure Should this be a secure cookie.
+     * @param options.httpOnly Should this be an http only cookie.
+     * @param options.sameSite The same site option for the cookie.
+     * @param options.path The path for the cookie.
+     * @returns The created cookie string.
+     */
+    static createCookie(cookieName: string, cookieValue: string, options?: {
+        secure?: boolean;
+        httpOnly?: boolean;
+        sameSite?: "Strict" | "Lax" | "None";
+        path?: string;
+    }): string;
+    /**
+     * Create a cookie string which will delete a cookie.
+     * @param cookieName The name of the cookie.
+     * @param options Additional cookie options.
+     * @param options.secure Should this be a secure cookie.
+     * @param options.httpOnly Should this be an http only cookie.
+     * @param options.sameSite The same site option for the cookie.
+     * @param options.path The path for the cookie.
+     * @returns The created cookie string.
+     */
+    static deleteCookie(cookieName: string, options?: {
+        secure?: boolean;
+        httpOnly?: boolean;
+        sameSite?: "Strict" | "Lax" | "None";
+        path?: string;
+    }): string;
+    /**
+     * Get cookies from headers.
+     * @param headers The headers to get cookies from.
+     * @param cookieName The name of the cookie to get.
+     * @returns The cookies found in the headers.
+     */
+    static getCookieFromHeaders(headers: string | string[] | undefined, cookieName: string): string | undefined;
+}

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

@@ -2,6 +2,10 @@
  * Class to helper with header operations.
  */
 export declare class HeaderHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
     /**
      * Create a bearer token header.
      * @param token The token to create the header for.
@@ -14,4 +18,67 @@ export declare class HeaderHelper {
      * @returns The extracted token if it exists.
      */
     static extractBearer(header: unknown): string;
+    /**
+     * Extract the 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Create a compliant Link header.
+     * @param url The URL to include in the Link header.
+     * @param urlQueryParams Optional query parameters to include in the URL.
+     * @param rel The relation type (e.g., "next", "prev", "self").
+     * @returns 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
+     */
+    static createLinkHeader(url: string, urlQueryParams: {
+        [id: string]: string;
+    } | undefined, rel: string, params?: {
+        [id: string]: string;
+    }): string;
 }