@ez4/gateway 0.15.0 → 0.17.0

package/dist/services/http.d.ts

@@ -1,106 +0,0 @@
-import type { Service } from '@ez4/common';
-import type { LinkedVariables } from '@ez4/project/library';
-import type { HttpPath } from '../types/path.js';
-import type { HttpAuthResponse, HttpResponse } from './response.js';
-import type { HttpRequest, HttpAuthRequest } from './request.js';
-import type { RouteTypes } from './helpers.js';
-import type { HttpCors } from './cors.js';
-import type { HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody } from './common.js';
-/**
- * Provide all contracts for a self-managed HTTP service.
- */
-export declare namespace Http {
-    type Headers = HttpHeaders;
-    type Identity = HttpIdentity;
-    type PathParameters = HttpPathParameters;
-    type QueryStrings = HttpQueryStrings;
-    type JsonBody = HttpJsonBody;
-    type AuthRequest = HttpAuthRequest;
-    type Request = HttpRequest;
-    type AuthResponse = HttpAuthResponse;
-    type Response = HttpResponse;
-    type Cors = HttpCors;
-    /**
-     * Incoming request.
-     */
-    type Incoming<T extends Request> = T & {
-        /**
-         * Request Id.
-         */
-        requestId: string;
-        /**
-         * Request method.
-         */
-        method: string;
-        /**
-         * Request path.
-         */
-        path: string;
-    };
-    /**
-     * Incoming request authorizer.
-     */
-    type Authorizer<T extends AuthRequest> = (request: T, context: Service.Context<Service<any>>) => Promise<AuthResponse> | AuthResponse;
-    /**
-     * Incoming request handler.
-     */
-    type Handler<T extends Request> = (request: T, context: Service.Context<Service<any>>) => Promise<Response> | Response;
-    /**
-     * HTTP route.
-     */
-    interface Route<T extends Request = Request> {
-        /**
-         * Route path.
-         */
-        path: HttpPath;
-        /**
-         * Route authorizer.
-         */
-        authorizer?: Authorizer<any>;
-        /**
-         * Route handler.
-         */
-        handler: Handler<T> | Handler<Incoming<T>>;
-        /**
-         * Variables associated to the route.
-         */
-        variables?: LinkedVariables;
-        /**
-         * Max route execution time (in seconds) for the route.
-         */
-        timeout?: number;
-        /**
-         * Amount of memory available for the handler.
-         */
-        memory?: number;
-        /**
-         * Determines whether or not CORS is enabled for the route.
-         */
-        cors?: boolean;
-    }
-    /**
-     * HTTP service.
-     */
-    abstract class Service<T extends Request[] = Request[]> implements Service.Provider {
-        /**
-         * All expected routes.
-         */
-        abstract routes: RouteTypes<T>[];
-        /**
-         * Display name for the service.
-         */
-        name?: string;
-        /**
-         * CORS configuration.
-         */
-        cors?: Cors;
-        /**
-         * Variables associated to all the routes.
-         */
-        variables?: LinkedVariables;
-        /**
-         * Service client.
-         */
-        client: never;
-    }
-}

package/dist/services/request.d.ts

@@ -1,43 +0,0 @@
-import type { HttpHeaders, HttpIdentity, HttpPathParameters, HttpQueryStrings, HttpJsonBody } from './common.js';
-/**
- * HTTP authorizer request.
- */
-export interface HttpAuthRequest {
-    /**
-     * Expected headers.
-     */
-    headers?: HttpHeaders;
-    /**
-     * Expected path parameters.
-     */
-    parameters?: HttpPathParameters;
-    /**
-     * Expected query strings.
-     */
-    query?: HttpQueryStrings;
-}
-/**
- * HTTP request.
- */
-export interface HttpRequest {
-    /**
-     * Expected headers.
-     */
-    headers?: HttpHeaders;
-    /**
-     * Expected identity.
-     */
-    identity?: HttpIdentity;
-    /**
-     * Expected path parameters.
-     */
-    parameters?: HttpPathParameters;
-    /**
-     * Expected query strings.
-     */
-    query?: HttpQueryStrings;
-    /**
-     * Expected JSON body payload.
-     */
-    body?: HttpJsonBody;
-}

package/dist/services/response.d.ts

@@ -1,27 +0,0 @@
-import type { HttpHeaders, HttpIdentity, HttpJsonBody } from './common.js';
-/**
- * HTTP authorizer response.
- */
-export interface HttpAuthResponse {
-    /**
-     * Authorization identity.
-     */
-    identity?: HttpIdentity;
-}
-/**
- * HTTP response.
- */
-export interface HttpResponse {
-    /**
-     * Response status code.
-     */
-    status: number;
-    /**
-     * Response headers.
-     */
-    headers?: HttpHeaders;
-    /**
-     * Response body.
-     */
-    body?: HttpJsonBody;
-}

package/dist/types/authorizer.d.ts

@@ -1,9 +0,0 @@
-import type { HttpAuthResponse } from './response.js';
-import type { HttpAuthRequest } from './request.js';
-export type HttpAuthorizer = {
-    name: string;
-    file: string;
-    description?: string;
-    response?: HttpAuthResponse;
-    request?: HttpAuthRequest;
-};

package/dist/types/cors.d.ts

@@ -1,8 +0,0 @@
-export type HttpCors = {
-    allowOrigins: string[];
-    allowMethods?: string[];
-    allowCredentials?: boolean;
-    exposeHeaders?: string[];
-    allowHeaders?: string[];
-    maxAge?: number;
-};

package/dist/types/handler.d.ts

@@ -1,9 +0,0 @@
-import type { HttpRequest } from './request.js';
-import type { HttpResponse } from './response.js';
-export type HttpHandler = {
-    name: string;
-    file: string;
-    description?: string;
-    response: HttpResponse;
-    request?: HttpRequest;
-};

package/dist/types/path.d.ts

@@ -1,9 +0,0 @@
-/**
- * All supported HTTP verbs.
- */
-export type HttpVerb = 'ANY' | 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
-/**
- * Valid HTTP path.
- */
-export type HttpPath = `${HttpVerb} /${string}`;
-export declare const isHttpPath: (path: string) => path is HttpPath;

package/dist/types/request.d.ts

@@ -1,13 +0,0 @@
-import type { ObjectSchema, UnionSchema } from '@ez4/schema';
-export type HttpAuthRequest = {
-    headers?: ObjectSchema | null;
-    parameters?: ObjectSchema | null;
-    query?: ObjectSchema | null;
-};
-export type HttpRequest = {
-    headers?: ObjectSchema | null;
-    identity?: ObjectSchema | UnionSchema | null;
-    parameters?: ObjectSchema | null;
-    query?: ObjectSchema | null;
-    body?: ObjectSchema | UnionSchema | null;
-};

package/dist/types/response.d.ts

@@ -1,9 +0,0 @@
-import type { BooleanSchema, NumberSchema, ObjectSchema, StringSchema, UnionSchema } from '@ez4/schema';
-export type HttpAuthResponse = {
-    identity?: ObjectSchema | UnionSchema | null;
-};
-export type HttpResponse = {
-    status: number;
-    headers?: ObjectSchema | null;
-    body?: ObjectSchema | UnionSchema | NumberSchema | StringSchema | BooleanSchema | null;
-};

package/dist/types/route.d.ts

@@ -1,13 +0,0 @@
-import type { LinkedVariables } from '@ez4/project/library';
-import type { HttpAuthorizer } from './authorizer.js';
-import type { HttpHandler } from './handler.js';
-import type { HttpPath } from './path.js';
-export type HttpRoute = {
-    path: HttpPath;
-    handler: HttpHandler;
-    authorizer?: HttpAuthorizer;
-    variables?: LinkedVariables | null;
-    timeout?: number;
-    memory?: number;
-    cors?: boolean;
-};