@twin.org/web 0.0.1-next.1

package/dist/types/errors/fetchError.d.ts

@@ -0,0 +1,22 @@
+import { BaseError } from "@twin.org/core";
+import type { HttpStatusCode } from "../models/httpStatusCode";
+/**
+ * Class to represent errors from fetch.
+ */
+export declare class FetchError extends BaseError {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of FetchError.
+     * @param source The source of the error.
+     * @param message The message as a code.
+     * @param httpStatus The http status code.
+     * @param properties Any additional information for the error.
+     * @param inner The inner error if we have wrapped another error.
+     */
+    constructor(source: string, message: string, httpStatus: HttpStatusCode, properties?: {
+        [id: string]: unknown;
+    }, inner?: unknown);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./errors/fetchError";
+export * from "./models/headerTypes";
+export * from "./models/httpMethod";
+export * from "./models/httpStatusCode";
+export * from "./models/IFetchOptions";
+export * from "./models/IHttpHeaders";
+export * from "./models/IJwk";
+export * from "./models/IJwtHeader";
+export * from "./models/IJwtPayload";
+export * from "./models/jwtAlgorithms";
+export * from "./models/mimeTypes";
+export * from "./utils/fetchHelper";
+export * from "./utils/jwt";
+export * from "./utils/mimeTypeHelper";

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

@@ -0,0 +1,30 @@
+import type { IHttpHeaders } from "./IHttpHeaders";
+/**
+ * Options for call to the fetch helper.
+ */
+export interface IFetchOptions {
+    /**
+     * @param headers The headers for the request.
+     */
+    headers?: IHttpHeaders;
+    /**
+     * Timeout for requests in milliseconds.
+     */
+    timeoutMs?: number;
+    /**
+     * Include credentials in the requests.
+     */
+    includeCredentials?: boolean;
+    /**
+     * The number of times to retry fetching defaults to no retries.
+     */
+    retryCount?: number;
+    /**
+     * The number of milliseconds we should delay before any retry.
+     */
+    retryDelayMs?: number;
+    /**
+     * The number of milliseconds to cache the response for, leave undefined for no cache, 0 means infinite.
+     */
+    cacheTtlMs?: number;
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Model used for Http headers parameter.
+ */
+export interface IHttpHeaders {
+    [key: string]: string | string[];
+}

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

@@ -0,0 +1,62 @@
+import type { JwtAlgorithms } from "./jwtAlgorithms";
+/**
+ * The fields in a JSON Web Key.
+ */
+export interface IJwk {
+    /**
+     * Additional fields in the key.
+     */
+    [key: string]: unknown;
+    /**
+     * The cryptographic algorithm for the key.
+     */
+    alg?: JwtAlgorithms;
+    /**
+     * The intended use for the key.
+     */
+    use?: string;
+    /**
+     * The operation(s) that the key is intended to be used for.
+     */
+    key_ops?: string[];
+    /**
+     * The key type parameter.
+     */
+    kty: string;
+    /**
+     * The public key parameters.
+     */
+    n?: string;
+    /**
+     * Exponent parameter.
+     */
+    e?: string;
+    /**
+     * The private key parameters.
+     */
+    d?: string;
+    /**
+     * The private key parameters.
+     */
+    p?: string;
+    /**
+     * The private key parameters.
+     */
+    q?: string;
+    /**
+     * The private key parameters.
+     */
+    dp?: string;
+    /**
+     * The private key parameters.
+     */
+    dq?: string;
+    /**
+     * The private key parameters.
+     */
+    qi?: string;
+    /**
+     * The key ID.
+     */
+    kid?: string;
+}

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

@@ -0,0 +1,22 @@
+import type { JwtAlgorithms } from "./jwtAlgorithms";
+/**
+ * The fields in a JSON Web Token header.
+ */
+export interface IJwtHeader {
+    /**
+     * Additional fields in the header.
+     */
+    [key: string]: unknown;
+    /**
+     * The type of the token.
+     */
+    typ?: string;
+    /**
+     * The algorithm used to sign the token.
+     */
+    alg: JwtAlgorithms;
+    /**
+     * The key ID.
+     */
+    kid?: string;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * The fields in a JSON Web Token payload.
+ */
+export interface IJwtPayload {
+    /**
+     * Additional fields in the payload.
+     */
+    [key: string]: unknown;
+    /**
+     * The issuer of the token.
+     */
+    iss?: string;
+    /**
+     * The subject of the token.
+     */
+    sub?: string;
+    /**
+     * The audience of the token.
+     */
+    aud?: string;
+    /**
+     * The expiration time of the token.
+     */
+    exp?: number;
+    /**
+     * The not before time of the token.
+     */
+    nbf?: number;
+    /**
+     * The issued at time of the token.
+     */
+    iat?: number;
+    /**
+     * The JWT ID.
+     */
+    jti?: string;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * Common http header types.
+ */
+export declare const HeaderTypes: {
+    /**
+     * Content Type.
+     */
+    readonly ContentType: "Content-Type";
+    /**
+     * Content Length.
+     */
+    readonly ContentLength: "Content-Length";
+    /**
+     * Content Disposition.
+     */
+    readonly ContentDisposition: "Content-Disposition";
+    /**
+     * Accept.
+     */
+    readonly Accept: "Accept";
+    /**
+     * Authorization.
+     */
+    readonly Authorization: "Authorization";
+    /**
+     * Cookie.
+     */
+    readonly Cookie: "Cookie";
+    /**
+     * Set Cookie.
+     */
+    readonly SetCookie: "Set-Cookie";
+    /**
+     * Location
+     */
+    readonly Location: "Location";
+};
+/**
+ * Common http header types.
+ */
+export type HeaderTypes = (typeof HeaderTypes)[keyof typeof HeaderTypes];

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

@@ -0,0 +1,18 @@
+/**
+ * The names of the HTTP Methods.
+ */
+export declare const HttpMethod: {
+    readonly GET: "GET";
+    readonly POST: "POST";
+    readonly PUT: "PUT";
+    readonly PATCH: "PATCH";
+    readonly DELETE: "DELETE";
+    readonly OPTIONS: "OPTIONS";
+    readonly HEAD: "HEAD";
+    readonly CONNECT: "CONNECT";
+    readonly TRACE: "TRACE";
+};
+/**
+ * The HTTP Methods.
+ */
+export type HttpMethod = (typeof HttpMethod)[keyof typeof HttpMethod];

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

@@ -0,0 +1,257 @@
+/**
+ * Standard HTTP status codes.
+ */
+export declare const HttpStatusCode: {
+    /**
+     * Continue status code.
+     */
+    readonly continue: 100;
+    /**
+     * Switching Protocols status code.
+     */
+    readonly switchingProtocols: 101;
+    /**
+     * Processing status code.
+     */
+    readonly processing: 102;
+    /**
+     * Early Hints status code.
+     */
+    readonly earlyHints: 103;
+    /**
+     * OK status code.
+     */
+    readonly ok: 200;
+    /**
+     * Created status code.
+     */
+    readonly created: 201;
+    /**
+     * Accepted status code.
+     */
+    readonly accepted: 202;
+    /**
+     * Non-Authoritative Information status code.
+     */
+    readonly nonAuthoritativeInformation: 203;
+    /**
+     * No Content status code.
+     */
+    readonly noContent: 204;
+    /**
+     * Reset Content status code.
+     */
+    readonly resetContent: 205;
+    /**
+     * Partial Content status code.
+     */
+    readonly partialContent: 206;
+    /**
+     * Multi-Status status code.
+     */
+    readonly multiStatus: 207;
+    /**
+     * Already Reported status code.
+     */
+    readonly alreadyReported: 208;
+    /**
+     * IM Used status code.
+     */
+    readonly imUsed: 226;
+    /**
+     * Multiple Choices status code.
+     */
+    readonly multipleChoices: 300;
+    /**
+     * Moved Permanently status code.
+     */
+    readonly movedPermanently: 301;
+    /**
+     * Found status code.
+     */
+    readonly found: 302;
+    /**
+     * See Other status code.
+     */
+    readonly seeOther: 303;
+    /**
+     * Not Modified status code.
+     */
+    readonly notModified: 304;
+    /**
+     * Use Proxy status code.
+     */
+    readonly useProxy: 305;
+    /**
+     * Temporary Redirect status code.
+     */
+    readonly temporaryRedirect: 307;
+    /**
+     * Permanent Redirect status code.
+     */
+    readonly permanentRedirect: 308;
+    /**
+     * Bad Request status code.
+     */
+    readonly badRequest: 400;
+    /**
+     * Unauthorized status code.
+     */
+    readonly unauthorized: 401;
+    /**
+     * Payment Required status code.
+     */
+    readonly paymentRequired: 402;
+    /**
+     * Forbidden status code.
+     */
+    readonly forbidden: 403;
+    /**
+     * Not Found status code.
+     */
+    readonly notFound: 404;
+    /**
+     * Method Not Allowed status code.
+     */
+    readonly methodNotAllowed: 405;
+    /**
+     * Not Acceptable status code.
+     */
+    readonly notAcceptable: 406;
+    /**
+     * Proxy Authentication Required status code.
+     */
+    readonly proxyAuthenticationRequired: 407;
+    /**
+     * Request Timeout status code.
+     */
+    readonly requestTimeout: 408;
+    /**
+     * Conflict status code.
+     */
+    readonly conflict: 409;
+    /**
+     * Gone status code.
+     */
+    readonly gone: 410;
+    /**
+     * Length Required status code.
+     */
+    readonly lengthRequired: 411;
+    /**
+     * Precondition Failed status code.
+     */
+    readonly preconditionFailed: 412;
+    /**
+     * Payload Too Large status code.
+     */
+    readonly payloadTooLarge: 413;
+    /**
+     * URI Too Long status code.
+     */
+    readonly uriTooLong: 414;
+    /**
+     * Unsupported Media Type status code.
+     */
+    readonly unsupportedMediaType: 415;
+    /**
+     * Range Not Satisfiable status code.
+     */
+    readonly rangeNotSatisfiable: 416;
+    /**
+     * Expectation Failed status code.
+     */
+    readonly expectationFailed: 417;
+    /**
+     * I'm a Teapot status code.
+     */
+    readonly imATeapot: 418;
+    /**
+     * Misdirected Request status code.
+     */
+    readonly misdirectedRequest: 421;
+    /**
+     * Unprocessable Entity status code.
+     */
+    readonly unprocessableEntity: 422;
+    /**
+     * Locked status code.
+     */
+    readonly locked: 423;
+    /**
+     * Failed Dependency status code.
+     */
+    readonly failedDependency: 424;
+    /**
+     * Too Early status code.
+     */
+    readonly tooEarly: 425;
+    /**
+     * Upgrade Required status code.
+     */
+    readonly upgradeRequired: 426;
+    /**
+     * Precondition Required status code.
+     */
+    readonly preconditionRequired: 428;
+    /**
+     * Too Many Requests status code.
+     */
+    readonly tooManyRequests: 429;
+    /**
+     * Request Header Fields Too Large status code.
+     */
+    readonly requestHeaderFieldsTooLarge: 431;
+    /**
+     * Unavailable For Legal Reasons status code.
+     */
+    readonly unavailableForLegalReasons: 451;
+    /**
+     * Internal Server Error status code.
+     */
+    readonly internalServerError: 500;
+    /**
+     * Not Implemented status code.
+     */
+    readonly notImplemented: 501;
+    /**
+     * Bad Gateway status code.
+     */
+    readonly badGateway: 502;
+    /**
+     * Service Unavailable status code.
+     */
+    readonly serviceUnavailable: 503;
+    /**
+     * Gateway Timeout status code.
+     */
+    readonly gatewayTimeout: 504;
+    /**
+     * HTTP Version Not Supported status code.
+     */
+    readonly httpVersionNotSupported: 505;
+    /**
+     * Variant Also Negotiates status code.
+     */
+    readonly variantAlsoNegotiates: 506;
+    /**
+     * Insufficient Storage status code.
+     */
+    readonly insufficientStorage: 507;
+    /**
+     * Loop Detected status code.
+     */
+    readonly loopDetected: 508;
+    /**
+     * Not Extended status code.
+     */
+    readonly notExtended: 510;
+    /**
+     * Network Authentication Required status code.
+     */
+    readonly networkAuthenticationRequired: 511;
+};
+/**
+ * Standard HTTP status codes.
+ */
+export type HttpStatusCode = (typeof HttpStatusCode)[keyof typeof HttpStatusCode];

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

@@ -0,0 +1,17 @@
+/**
+ * The cryptographic algorithms supported for JSON Web Tokens and JSON Web Keys.
+ */
+export declare const JwtAlgorithms: {
+    /**
+     * HMAC using SHA-256.
+     */
+    readonly HS256: "HS256";
+    /**
+     * EdDSA using Ed25519.
+     */
+    readonly EdDSA: "EdDSA";
+};
+/**
+ * The cryptographic algorithms supported for JSON Web Tokens and JSON Web Keys.
+ */
+export type JwtAlgorithms = (typeof JwtAlgorithms)[keyof typeof JwtAlgorithms];

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

@@ -0,0 +1,93 @@
+/**
+ * Common mime types.
+ */
+export declare const MimeTypes: {
+    /**
+     * Plaint Text - text/plain
+     */
+    readonly PlainText: "text/plain";
+    /**
+     * HTML - text/html
+     */
+    readonly Html: "text/html";
+    /**
+     * Javascript - text/javascript
+     */
+    readonly Javascript: "text/javascript";
+    /**
+     * JSON - application/json
+     */
+    readonly Json: "application/json";
+    /**
+     * JSON-LD - application/ld+json
+     */
+    readonly JsonLd: "application/ld+json";
+    /**
+     * XML - application/xml
+     */
+    readonly Xml: "application/xml";
+    /**
+     * Application Octet Stream, arbitrary binary - application/octet-stream
+     */
+    readonly OctetStream: "application/octet-stream";
+    /**
+     * Application GZIP - application/gzip
+     */
+    readonly Gzip: "application/gzip";
+    /**
+     * Application BZIP2 - application/x-bzip2
+     */
+    readonly Bzip2: "application/x-bzip2";
+    /**
+     * Application ZIP - application/zip
+     */
+    readonly Zip: "application/zip";
+    /**
+     * Application PDF - application/pdf
+     */
+    readonly Pdf: "application/pdf";
+    /**
+     * Image GIF - image/gif
+     */
+    readonly Gif: "image/gif";
+    /**
+     * Image BMP - image/bmp
+     */
+    readonly Bmp: "image/bmp";
+    /**
+     * Image JPEG - image/jpeg
+     */
+    readonly Jpeg: "image/jpeg";
+    /**
+     * Image PNG - image/png
+     */
+    readonly Png: "image/png";
+    /**
+     * Image Tiff - image/tiff
+     */
+    readonly Tiff: "image/tiff";
+    /**
+     * Image SVG - image/svg+xml
+     */
+    readonly Svg: "image/svg+xml";
+    /**
+     * Image WEBP - image/webp
+     */
+    readonly WebP: "image/webp";
+    /**
+     * Video MP4 - video/mp4
+     */
+    readonly Mp4: "video/mp4";
+    /**
+     * Audio/Video MPEG - video/mpeg
+     */
+    readonly Mpeg: "video/mpeg";
+    /**
+     * Video WEBM - video/webm
+     */
+    readonly Webm: "video/webm";
+};
+/**
+ * Common mime types.
+ */
+export type MimeTypes = (typeof MimeTypes)[keyof typeof MimeTypes];

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

@@ -0,0 +1,52 @@
+import { HttpMethod } from "../models/httpMethod";
+import type { IFetchOptions } from "../models/IFetchOptions";
+/**
+ * Class to helper with fetch operations.
+ */
+export declare class FetchHelper {
+    /**
+     * Perform a fetch request.
+     * @param source The source for the request.
+     * @param url The url for the request.
+     * @param method The http method.
+     * @param body Request to send to the endpoint.
+     * @param options Options for sending the requests.
+     * @returns The response.
+     */
+    static fetch(source: string, url: string, method: HttpMethod, body?: string | Uint8Array, options?: Omit<IFetchOptions, "cacheTtlSeconds">): Promise<Response>;
+    /**
+     * Perform a request in json format.
+     * @param source The source for the request.
+     * @param url The url for the request.
+     * @param method The http method.
+     * @param requestData Request to send to the endpoint.
+     * @param options Options for sending the requests.
+     * @returns The response.
+     */
+    static fetchJson<T, U>(source: string, url: string, method: HttpMethod, requestData?: T, options?: IFetchOptions): Promise<U>;
+    /**
+     * Perform a request for binary data.
+     * @param source The source for the request.
+     * @param url The url for the request.
+     * @param method The http method.
+     * @param requestData Request to send to the endpoint.
+     * @param options Options for sending the requests.
+     * @returns The response.
+     */
+    static fetchBinary<T>(source: string, url: string, method: Extract<HttpMethod, "GET" | "POST">, requestData?: Uint8Array, options?: IFetchOptions): Promise<Uint8Array | T>;
+    /**
+     * Clears the cache.
+     */
+    static clearCache(): void;
+    /**
+     * Get a cache entry.
+     * @param url The url for the request.
+     * @returns The cache entry if it exists.
+     */
+    static getCacheEntry<T>(url: string): Promise<T | undefined>;
+    /**
+     * Remove a cache entry.
+     * @param url The url for the request.
+     */
+    static removeCacheEntry(url: string): void;
+}