typedrest 0.4.1 → 0.6.0

package/endpoints/rpc/ProducerEndpoint.test.ts

@@ -1,32 +0,0 @@
-import fetchMock from 'jest-fetch-mock';
-import { ProducerEndpoint } from '.';
-import { EntryEndpoint } from '..';
-import { HttpMethod, HttpHeader } from '../../http';
-
-class MockEntity {
-    constructor(public id: number, public name: string) { }
-}
-
-fetchMock.enableMocks();
-let endpoint: ProducerEndpoint<MockEntity>;
-
-beforeEach(() => {
-    fetchMock.resetMocks();
-    endpoint = new ProducerEndpoint(new EntryEndpoint('http://localhost/'), 'endpoint');
-});
-
-test('invoke', async () => {
-    fetchMock.mockOnceIf(
-        req => req.method === HttpMethod.Post && req.url === 'http://localhost/endpoint',
-        async req => {
-            expect(req.headers.get(HttpHeader.Accept)).toBe('application/json');
-            return {
-                headers: { [HttpHeader.ContentType]: 'application/json' },
-                body: '{"id":1,"name":"input"}'
-            };
-        }
-    );
-
-    const result = await endpoint.invoke();
-    expect(result).toEqual(new MockEntity(1, 'input'));
-});

package/errors/DefaultErrorHandler.ts

@@ -1,62 +0,0 @@
-import { ErrorHandler } from "./ErrorHandler";
-import { HttpError, BadRequestError, AuthenticationError, AuthorizationError, NotFoundError, TimeoutError, ConflictError, ConcurrencyError } from "./Errors";
-import { HttpStatusCode, HttpHeader } from "../http";
-
-/**
- * Handles errors in HTTP responses by mapping status codes to common error types.
- */
-export class DefaultErrorHandler implements ErrorHandler {
-    /**
-     * Throws appropriate `Error`s based on HTTP status codes and response bodies.
-     *
-     * @throws {@link errors!BadRequestError}: {@link http!HttpStatusCode.BadRequest}
-     * @throws {@link errors!AuthenticationError}: {@link http!HttpStatusCode.Unauthorized}
-     * @throws {@link errors!AuthorizationError}: {@link http!HttpStatusCode.Forbidden}
-     * @throws {@link errors!NotFoundError}: {@link http!HttpStatusCode.NotFound} or {@link http!HttpStatusCode.Gone}
-     * @throws {@link errors!TimeoutError}: {@link http!HttpStatusCode.RequestTimeout}
-     * @throws {@link errors!ConflictError}: {@link http!HttpStatusCode.Conflict}
-     * @throws {@link errors!ConcurrencyError}: {@link http!HttpStatusCode.PreconditionFailed}
-     * @throws {@link errors!HttpError}: Other non-success status code
-     */
-    async handle(response: Response) {
-        if (response.ok) return;
-
-        const contentType = response.headers.get(HttpHeader.ContentType);
-        let jsonBody: any;
-        if (contentType?.startsWith("application/json") || contentType?.includes("+json")) {
-            try {
-                jsonBody = await response.json();
-            } catch {
-                jsonBody = undefined;
-            }
-        }
-
-        const errorType = DefaultErrorHandler.errorType(response.status);
-        throw new errorType(
-            jsonBody?.message ?? jsonBody?.details ?? `HTTP ${response.status} ${response.statusText}`,
-            response.status,
-            jsonBody);
-    }
-
-    private static errorType(status: HttpStatusCode): new (message: string, status: HttpStatusCode, data?: any) => Error {
-        switch (status) {
-            case HttpStatusCode.BadRequest:
-                return BadRequestError;
-            case HttpStatusCode.Unauthorized:
-                return AuthenticationError;
-            case HttpStatusCode.Forbidden:
-                return AuthorizationError;
-            case HttpStatusCode.NotFound:
-            case HttpStatusCode.Gone:
-                return NotFoundError;
-            case HttpStatusCode.RequestTimeout:
-                return TimeoutError;
-            case HttpStatusCode.Conflict:
-                return ConflictError;
-            case HttpStatusCode.PreconditionFailed:
-                return ConcurrencyError;
-            default:
-                return HttpError;
-        }
-    }
-}

package/http/FetchHttpClient.ts

@@ -1,26 +0,0 @@
-import { HttpMethod } from "./HttpMethod";
-import { HttpClient } from "./HttpClient";
-
-/**
- * Communicates with remote resources using JavaScript's standard Fetch API.
- */
-export class FetchHttpClient implements HttpClient {
-    /**
-     * @inheritDoc
-     */
-    defaultHeaders = new Headers();
-
-    /**
-     * @inheritDoc
-     */
-    send(uri: URL, method: HttpMethod, signal?: AbortSignal, headers?: HeadersInit, body?: BodyInit) {
-        const mergedHeaders = new Headers(headers);
-        this.defaultHeaders.forEach((value, key) => {
-            if (!mergedHeaders.has(key)) {
-                mergedHeaders.set(key, value);
-            }
-        });
-
-        return fetch(uri.href, { method, signal, headers: mergedHeaders, body });
-    }
-}

package/http/HttpHeader.ts

@@ -1,11 +0,0 @@
-export enum HttpHeader {
-    Authorization = "Authorization",
-    ContentType = "Content-Type",
-    Accept = "Accept",
-    Allow = "Allow",
-    Location = "Location",
-    Link = "Link",
-    ETag = "ETag",
-    IfMatch = "If-Match",
-    IfNoneMatch = "If-None-Match"
-}

package/http/ResponseCache.ts

@@ -1,25 +0,0 @@
-import { HttpHeader } from "./HttpHeader";
-
-/**
- * Caches the contents of a `Response`.
- */
-export class ResponseCache {
-    /**
-     * Creates a new cache.
-     * @param content The content of the `Response`.
-     * @param contentType The MIME type of the `content`.
-     * @param eTag The E-Tag associated with the `content`.
-     */
-    constructor(public readonly content: string, public readonly contentType?: string, public readonly eTag?: string) {
-    }
-
-    /**
-     * Creates a new cache from a `Response`.
-     */
-    static async from(response: Response) {
-        return new ResponseCache(
-            await response.text(),
-            response.headers.get(HttpHeader.ContentType) ?? undefined,
-            response.headers.get(HttpHeader.ETag) ?? undefined);
-    }
-}

package/jest.config.js

@@ -1,12 +0,0 @@
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  // jsdom is required for Blob() constructor and fetch()!
-  testEnvironment: 'jsdom',
-  testMatch: [
-    "**/?(*.)+(spec|test).ts"
-  ],
-  transform: {
-    "\\.ts$": ["ts-jest", { tsconfig: "tsconfig.test.json" }]
-  },
-};

package/links/AggregateLinkExtractor.ts

@@ -1,28 +0,0 @@
-import { Link } from "./Link";
-import { LinkExtractor } from "./LinkExtractor";
-
-/**
- * Combines the results of multiple {@link LinkExtractor}s.
- */
-export class AggregateLinkExtractor implements LinkExtractor {
-    private extractors: LinkExtractor[];
-
-    /**
-     * Creates a new aggregate link extractor.
-     * @param extractors The link extractors to aggregate.
-     */
-    constructor(...extractors: LinkExtractor[]) {
-        this.extractors = extractors;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    async getLinks(response: Response) {
-        let result: Link[] = [];
-        for (const extractor of this.extractors) {
-            result = result.concat(await extractor.getLinks(response));
-        }
-        return result;
-    }
-}

package/links/HalLinkExtractor.ts

@@ -1,45 +0,0 @@
-import { Link } from "./Link";
-import { LinkExtractor } from "./LinkExtractor";
-import { HttpHeader } from "../http";
-
-/**
- * Extracts links from JSON bodies according to the Hypertext Application Language (HAL) specification.
- */
-export class HalLinkExtractor implements LinkExtractor {
-    /**
-     * @inheritDoc
-     */
-    async getLinks(response: Response): Promise<Link[]> {
-        const contentType = response.headers.get(HttpHeader.ContentType);
-        if (contentType?.startsWith("application/hal+json")) {
-            return this.parseJsonBody(await response.clone().json());
-        } else {
-            return [];
-        }
-    }
-
-    private parseJsonBody(body: any) {
-        const links: Link[] = [];
-
-        const linkContainer: { [key: string]: any; } = body._links;
-        if (linkContainer) {
-            for (const rel in linkContainer) {
-                if (Array.isArray(linkContainer[rel])) {
-                    for (const link of linkContainer[rel]) {
-                        links.push(this.parseLink(rel, link));
-                    }
-                } else {
-                    links.push(this.parseLink(rel, linkContainer[rel]));
-                }
-            }
-        }
-
-        return links;
-    }
-
-    private parseLink(rel: string, obj: any) {
-        if (!obj.href)
-            throw new Error("The link header is lacking the mandatory 'href' field.");
-        return new Link(rel, obj.href, obj.title, obj.templated ? true : false);
-    }
-}

package/links/HeaderLinkExtractor.ts

@@ -1,56 +0,0 @@
-import { Link } from "./Link";
-import { LinkExtractor } from "./LinkExtractor";
-import { HttpHeader } from "../http";
-
-/**
- * Extracts links from HTTP headers.
- */
-export class HeaderLinkExtractor implements LinkExtractor {
-    /**
-     * @inheritDoc
-     */
-    async getLinks(response: Response) {
-        return response.headers.get(HttpHeader.Link)
-            ?.match(/<[^>]*>\s*(\s*;\s*[^\(\)<>@,;:"\/\[\]\?={} \t]+=(([^\(\)<>@,;:"\/\[\]\?={} \t]+)|("[^"]*")))*(,|$)/g)
-            ?.map(value => this.parseLink(value))
-            ?? [];
-    }
-
-    private parseLink(value: string) {
-        const split = this.split(value, ">");
-        const href = split.left.substring(1);
-        let rel: string | undefined;
-        let title: string | undefined;
-        let templated = false;
-
-        split.right.match(/[^\(\)<>@,;:"\/\[\]\?={} \t]+=(([^\(\)<>@,;:"\/\[\]\?={} \t]+)|("[^"]*"))/g)?.forEach(param => {
-            const paramSplit = this.split(param, "=");
-            if (paramSplit.left === "rel") {
-                rel = paramSplit.right;
-            } else if (paramSplit.left === "title") {
-                title = paramSplit.right;
-                if (title.startsWith('"') && title.endsWith('"')) {
-                    title = title.substring(1, title.length - 1);
-                }
-            } else if (paramSplit.left === "templated" && paramSplit.right === "true") {
-                templated = true;
-            }
-        });
-
-        if (!rel) throw new Error("The link header is lacking the mandatory 'rel' field.");
-        return new Link(rel, href, title, templated);
-    }
-
-    private split(str: string, separator: string): { left: string, right: string } {
-        const result = str.split(separator, 2);
-        return (result.length === 2)
-            ? {
-                left: result[0],
-                right: result[1] + str.slice(result.join(separator).length)
-            }
-            : {
-                left: result[0],
-                right: ''
-            };
-    }
-}

package/serializers/JsonSerializer.ts

@@ -1,25 +0,0 @@
-import { Serializer } from "./Serializer";
-
-/**
- * Serializes and deserializes entities as JSON.
- */
-export class JsonSerializer implements Serializer {
-    /**
-     * @inheritDoc
-     */
-    readonly supportedMediaTypes = ["application/json"];
-
-    /**
-     * @inheritDoc
-     */
-    serialize<T>(entity: T) {
-        return JSON.stringify(entity);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    deserialize<T>(text: string) {
-        return JSON.parse(text) as T;
-    }
-}