@h4ad/serverless-adapter 2.17.0 → 3.0.0

package/lib/core/logger.d.ts

@@ -1,67 +0,0 @@
-/**
- * The type representing the possible log levels to choose from.
- *
- * @breadcrumb Core / Logger
- * @public
- */
-export declare type LogLevels = 'debug' | 'verbose' | 'info' | 'warn' | 'error' | 'none';
-/**
- * The options to customize {@link ILogger}
- *
- * @breadcrumb Core / Logger
- * @public
- */
-export declare type LoggerOptions = {
-    /**
-     * Select the log level, {@link LogLevels | see more}.
-     *
-     * @defaultValue error
-     */
-    level: LogLevels;
-};
-/**
- * The log function used in any level.
- *
- * @breadcrumb Core / Logger
- * @public
- */
-export declare type LoggerFN = (message: any, ...additional: any[]) => void;
-/**
- * The interface representing the logger, you can provide a custom logger by implementing this interface.
- *
- * @breadcrumb Core / Logger
- * @public
- */
-export declare type ILogger = Record<Exclude<LogLevels, 'none'>, LoggerFN>;
-/**
- * The method used to create a simple logger instance to use in this library.
- *
- * @remarks Behind the scenes, this simple logger sends the message to the `console` methods.
- *
- * @example
- * ```typescript
- * const logger = createDefaultLogger();
- *
- * logger.error('An error happens.');
- * // An error happens.
- * ```
- *
- * @param level - Select the level of the log
- *
- * @breadcrumb Core / Logger
- * @public
- */
-export declare function createDefaultLogger({ level }?: LoggerOptions): ILogger;
-/**
- * The method used to chck if logger was created by this library, or it was defined by the user.
- *
- * @param logger - The instance of the logger to check
- *
- * @breadcrumb Core / Logger
- * @public
- */
-export declare function isInternalLogger(logger: ILogger): boolean;
-export declare type __ΩLogLevels = any[];
-export declare type __ΩLoggerOptions = any[];
-export declare type __ΩLoggerFN = any[];
-export declare type __ΩILogger = any[];

package/lib/core/no-op.d.ts

@@ -1,7 +0,0 @@
-/**
- * No operation function is used when we need to pass a function, but we don't want to specify any behavior.
- *
- * @breadcrumb Core
- * @public
- */
-export declare const NO_OP: (...args: any[]) => any;

package/lib/core/optional.d.ts

@@ -1,21 +0,0 @@
-/**
- * Return the defaultValue whether the value is undefined, otherwise, return the value.
- *
- * @example
- * ```typescript
- * const value1 = getDefaultIfUndefined(undefined, true);
- * const value2 = getDefaultIfUndefined(false, true);
- *
- * console.log(value1);
- * // true
- * console.log(value2);
- * // false
- * ```
- *
- * @param value - The value to be checked
- * @param defaultValue - The default value when value is undefined
- *
- * @breadcrumb Core
- * @public
- */
-export declare function getDefaultIfUndefined<T>(value: T | undefined, defaultValue: T): T;

package/lib/core/path.d.ts

@@ -1,36 +0,0 @@
-/**
- * Transform the path and a map of query params to a string with formatted query params
- *
- * @example
- * ```typescript
- * const path = '/pets/search';
- * const queryParams = { batata: undefined, petType: [ 'dog', 'fish' ] };
- * const result = getPathWithQueryStringParams(path, queryParams);
- * console.log(result);
- * // /pets/search?batata=&petType=dog&petType=fish
- * ```
- *
- * @param path - The path
- * @param queryParams - The query params
- *
- * @breadcrumb Core / Path
- * @public
- */
-export declare function getPathWithQueryStringParams(path: string, queryParams: string | Record<string, string | string[] | undefined> | undefined | null): string;
-/**
- * Map query params to a string with formatted query params
- *
- * @example
- * ```typescript
- * const queryParams = { batata: undefined, petType: [ 'dog', 'fish' ] };
- * const result = getQueryParamsStringFromRecord(queryParams);
- * console.log(result);
- * // batata=&petType=dog&petType=fish
- * ```
- *
- * @param queryParamsRecord - The query params record
- *
- * @breadcrumb Core / Path
- * @public
- */
-export declare function getQueryParamsStringFromRecord(queryParamsRecord: Record<string, string | string[] | undefined> | undefined | null): string;

package/lib/core/stream.d.ts

@@ -1,20 +0,0 @@
-/// <reference types="node" />
-import { Readable, Writable } from 'stream';
-/**
- * Check if stream already ended
- *
- * @param stream - The stream
- *
- * @breadcrumb Core / Stream
- * @public
- */
-export declare function isStreamEnded(stream: Readable | Writable): boolean;
-/**
- * Wait asynchronous the stream to complete
- *
- * @param stream - The stream
- *
- * @breadcrumb Core / Stream
- * @public
- */
-export declare function waitForStreamComplete<TStream extends Readable | Writable>(stream: TStream): Promise<TStream>;

package/lib/frameworks/apollo-server/apollo-server.framework.d.ts

@@ -1,71 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import { ApolloServer, BaseContext } from '@apollo/server';
-import { FrameworkContract } from '../../contracts';
-import { ServerlessRequest } from '../../network';
-/**
- * The default context of Apollo Server when you integrate and don't pass any context.
- *
- * @breadcrumb Frameworks / ApolloServerFramework
- * @public
- */
-export interface DefaultServerlessApolloServerContext extends BaseContext {
-    /**
-     * The request reference
-     */
-    request: IncomingMessage;
-    /**
-     * The response reference
-     */
-    response: ServerResponse;
-}
-/**
- * The arguments used to create a Context inside {@link ApolloServerOptions}
- *
- * @breadcrumb Frameworks / ApolloServerFramework
- * @public
- */
-export declare type ApolloServerContextArguments = {
-    /**
-     * The request reference
-     */
-    request: IncomingMessage;
-    /**
-     * The response reference
-     */
-    response: ServerResponse;
-};
-/**
- * The options to customize {@link ApolloServerFramework}
- *
- * @breadcrumb Frameworks / ApolloServerFramework
- * @public
- */
-export interface ApolloServerOptions<TContext extends BaseContext> {
-    /**
-     * Define a function to create the context of Apollo Server
-     *
-     * @param options - Default options passed by library
-     */
-    context?: (options: ApolloServerContextArguments) => Promise<TContext>;
-}
-/**
- * The framework that forwards requests to Apollo Server
- *
- * @breadcrumb Frameworks / ApolloServerFramework
- * @public
- */
-export declare class ApolloServerFramework<TContext extends BaseContext> implements FrameworkContract<ApolloServer<TContext>> {
-    protected readonly options?: ApolloServerOptions<TContext> | undefined;
-    /**
-     * Construtor padrão
-     */
-    constructor(options?: ApolloServerOptions<TContext> | undefined);
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: ApolloServer<TContext>, request: ServerlessRequest, response: ServerResponse): void;
-}
-export declare type __ΩDefaultServerlessApolloServerContext = any[];
-export declare type __ΩApolloServerContextArguments = any[];
-export declare type __ΩApolloServerOptions = any[];

package/lib/frameworks/apollo-server/index.d.ts

@@ -1 +0,0 @@
-export * from './apollo-server.framework';

package/lib/frameworks/body-parser/base-body-parser.framework.d.ts

@@ -1,69 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import type { NextHandleFunction } from 'connect';
-import type { HttpError } from 'http-errors';
-import { FrameworkContract } from '../../contracts';
-/**
- * The options for {@link BaseBodyParserFramework}
- *
- * @breadcrumb Frameworks / BodyParserFramework
- * @public
- */
-export declare type BodyParserOptions = {
-    /**
-     * Implements a custom way of handling error.
-     *
-     * @defaultValue {@link BaseBodyParserFramework.defaultHandleOnError}
-     *
-     * @example
-     * ```typescript
-     * customErrorHandler: (req: IncomingMessage, response: ServerResponse, error: HttpError<any>) => {
-     *   response.setHeader('content-type', 'text/plain');
-     *   response.statusCode = error.statusCode;
-     *   // always call end to return the error
-     *   response.end(error.message);
-     * }
-     * ```
-     *
-     * @param request - The referecene for request
-     * @param response - The reference for response
-     * @param error - The error throwed by body-parser
-     */
-    customErrorHandler?: (request: IncomingMessage, response: ServerResponse, error: HttpError<any>) => void;
-};
-/**
- * The base class used by other body-parser functions to parse a specific content-type
- *
- * @breadcrumb Frameworks / BodyParserFramework
- * @public
- */
-export declare class BaseBodyParserFramework<TApp> implements FrameworkContract<TApp> {
-    protected readonly framework: FrameworkContract<TApp>;
-    protected readonly middleware: NextHandleFunction;
-    protected readonly options?: BodyParserOptions | undefined;
-    /**
-     * Default Constructor
-     */
-    protected constructor(framework: FrameworkContract<TApp>, middleware: NextHandleFunction, options?: BodyParserOptions | undefined);
-    /**
-     * The selected error handler
-     */
-    protected readonly errorHandler: NonNullable<BodyParserOptions['customErrorHandler']>;
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: TApp, request: IncomingMessage, response: ServerResponse): void;
-    /**
-     * Handle next execution called by the cors package
-     */
-    protected onBodyParserFinished(app: TApp, request: IncomingMessage, response: ServerResponse): () => void;
-    /**
-     * The default function to handle errors
-     *
-     * @param request - The referecene for request
-     * @param response - The reference for response
-     * @param error - The error throwed by body-parser
-     */
-    protected defaultHandleOnError(request: IncomingMessage, response: ServerResponse, error: HttpError<any>): void;
-}
-export declare type __ΩBodyParserOptions = any[];

package/lib/frameworks/body-parser/index.d.ts

@@ -1,5 +0,0 @@
-export * from './base-body-parser.framework';
-export * from './json-body-parser.framework';
-export * from './raw-body-parser.framework';
-export * from './text-body-parser.framework';
-export * from './urlencoded-body-parser.framework';

package/lib/frameworks/body-parser/json-body-parser.framework.d.ts

@@ -1,26 +0,0 @@
-import { OptionsJson } from 'body-parser';
-import { FrameworkContract } from '../../contracts';
-import { BaseBodyParserFramework, BodyParserOptions } from './base-body-parser.framework';
-/**
- * The body-parser options for application/json
- *
- * @remarks {@link https://github.com/expressjs/body-parser#bodyparserjsonoptions}
- *
- * @breadcrumb Frameworks / BodyParserFramework / JsonBodyParserFramework
- * @public
- */
-export declare type JsonBodyParserFrameworkOptions = OptionsJson & BodyParserOptions;
-/**
- * The body-parser class used to parse application/json.
- *
- * @breadcrumb Frameworks / BodyParserFramework / JsonBodyParserFramework
- * @public
- */
-export declare class JsonBodyParserFramework<TApp> extends BaseBodyParserFramework<TApp> implements FrameworkContract<TApp> {
-    protected readonly framework: FrameworkContract<TApp>;
-    /**
-     * Default Constructor
-     */
-    constructor(framework: FrameworkContract<TApp>, options?: JsonBodyParserFrameworkOptions);
-}
-export declare type __ΩJsonBodyParserFrameworkOptions = any[];

package/lib/frameworks/body-parser/raw-body-parser.framework.d.ts

@@ -1,26 +0,0 @@
-import { Options } from 'body-parser';
-import { FrameworkContract } from '../../contracts';
-import { BaseBodyParserFramework, BodyParserOptions } from './base-body-parser.framework';
-/**
- * The body-parser options for application/octet-stream
- *
- * @remarks {@link https://github.com/expressjs/body-parser#bodyparserrawoptions}
- *
- * @breadcrumb Frameworks / BodyParserFramework / RawBodyParserFramework
- * @public
- */
-export declare type RawBodyParserFrameworkOptions = Options & BodyParserOptions;
-/**
- * The body-parser class used to parse application/octet-stream.
- *
- * @breadcrumb Frameworks / BodyParserFramework / RawBodyParserFramework
- * @public
- */
-export declare class RawBodyParserFramework<TApp> extends BaseBodyParserFramework<TApp> implements FrameworkContract<TApp> {
-    protected readonly framework: FrameworkContract<TApp>;
-    /**
-     * Default Constructor
-     */
-    constructor(framework: FrameworkContract<TApp>, options?: RawBodyParserFrameworkOptions);
-}
-export declare type __ΩRawBodyParserFrameworkOptions = any[];

package/lib/frameworks/body-parser/text-body-parser.framework.d.ts

@@ -1,26 +0,0 @@
-import { OptionsText } from 'body-parser';
-import { FrameworkContract } from '../../contracts';
-import { BaseBodyParserFramework, BodyParserOptions } from './base-body-parser.framework';
-/**
- * The body-parser options for text/plain
- *
- * @remarks {@link https://github.com/expressjs/body-parser#bodyparsertextoptions}
- *
- * @breadcrumb Frameworks / BodyParserFramework / TextBodyParserFramework
- * @public
- */
-export declare type TextBodyParserFrameworkOptions = OptionsText & BodyParserOptions;
-/**
- * The body-parser class used to parse text/plain.
- *
- * @breadcrumb Frameworks / BodyParserFramework / TextBodyParserFramework
- * @public
- */
-export declare class TextBodyParserFramework<TApp> extends BaseBodyParserFramework<TApp> implements FrameworkContract<TApp> {
-    protected readonly framework: FrameworkContract<TApp>;
-    /**
-     * Default Constructor
-     */
-    constructor(framework: FrameworkContract<TApp>, options?: TextBodyParserFrameworkOptions);
-}
-export declare type __ΩTextBodyParserFrameworkOptions = any[];

package/lib/frameworks/body-parser/urlencoded-body-parser.framework.d.ts

@@ -1,26 +0,0 @@
-import { OptionsUrlencoded } from 'body-parser';
-import { FrameworkContract } from '../../contracts';
-import { BaseBodyParserFramework, BodyParserOptions } from './base-body-parser.framework';
-/**
- * The body parser options for application/x-www-form-urlencoded
- *
- * @remarks {@link https://github.com/expressjs/body-parser#bodyparserurlencodedoptions}
- *
- * @breadcrumb Frameworks / BodyParserFramework / UrlencodedBodyParserFramework
- * @public
- */
-export declare type UrlencodedBodyParserFrameworkOptions = OptionsUrlencoded & BodyParserOptions;
-/**
- * The body-parser class used to parse application/x-www-form-urlencoded.
- *
- * @breadcrumb Frameworks / BodyParserFramework / UrlencodedBodyParserFramework
- * @public
- */
-export declare class UrlencodedBodyParserFramework<TApp> extends BaseBodyParserFramework<TApp> implements FrameworkContract<TApp> {
-    protected readonly framework: FrameworkContract<TApp>;
-    /**
-     * Default Constructor
-     */
-    constructor(framework: FrameworkContract<TApp>, options?: UrlencodedBodyParserFrameworkOptions);
-}
-export declare type __ΩUrlencodedBodyParserFrameworkOptions = any[];

package/lib/frameworks/cors/cors.framework.d.ts

@@ -1,78 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import cors, { CorsOptions } from 'cors';
-import { FrameworkContract } from '../../contracts';
-/**
- * The options to customize {@link CorsFramework}
- *
- * @breadcrumb Frameworks / CorsFramework
- * @public
- */
-export declare type CorsFrameworkOptions = CorsOptions & {
-    /**
-     * Send error 403 when cors is invalid. From what I read in `cors`, `fastify/cors` and [this problem](https://stackoverflow.com/questions/57212248/why-is-http-request-been-processed-in-action-even-when-cors-is-not-enabled)
-     * it is normal to process the request even if the origin is invalid.
-     * So this option will respond with error if this method was called from an invalid origin (or not allowed method) like [access control lib](https://github.com/primus/access-control/blob/master/index.js#L95-L115) .
-     *
-     * @defaultValue true
-     */
-    forbiddenOnInvalidOriginOrMethod?: boolean;
-};
-/**
- * The framework that handles cors for your api without relying on internals of the framework
- *
- * @example
- * ```typescript
- * import express from 'express';
- * import { ServerlessAdapter } from '@h4ad/serverless-adapter';
- * import { ExpressFramework } from '@h4ad/serverless-adapter/lib/frameworks/express';
- * import { CorsFramework } from '@h4ad/serverless-adapter/lib/frameworks/cors';
- *
- * const expressFramework = new ExpressFramework();
- * const options: CorsOptions = {}; // customize the options
- * const framework = new CorsFramework(expressFramework, options);
- *
- * export const handler = ServerlessAdapter.new(null)
- *   .setFramework(framework)
- *   // set other configurations and then build
- *   .build();
- * ```
- *
- * @breadcrumb Frameworks / CorsFramework
- * @public
- */
-export declare class CorsFramework<TApp> implements FrameworkContract<TApp> {
-    protected readonly framework: FrameworkContract<TApp>;
-    protected readonly options?: CorsFrameworkOptions | undefined;
-    /**
-     * Default Constructor
-     */
-    constructor(framework: FrameworkContract<TApp>, options?: CorsFrameworkOptions | undefined);
-    /**
-     * All cors headers that can be added by cors package
-     */
-    protected readonly corsHeaders: string[];
-    /**
-     * The cached instance of cors
-     */
-    protected readonly cachedCorsInstance: ReturnType<typeof cors>;
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: TApp, request: IncomingMessage, response: ServerResponse): void;
-    /**
-     * Handle next execution called by the cors package
-     */
-    protected onCorsNext(app: TApp, request: IncomingMessage, response: ServerResponse): () => void;
-    /**
-     * Format the headers to be standardized with the rest of the library, such as ApiGatewayV2.
-     * Also, some frameworks don't support headers as an array, so we need to format the values.
-     */
-    protected formatHeaderValuesAddedByCorsPackage(response: ServerResponse): void;
-    /**
-     * Check if the origin is invalid or if the method is not allowed.
-     * Highly inspired by [access-control](https://github.com/primus/access-control/blob/master/index.js#L95-L115)
-     */
-    protected isInvalidOriginOrMethodIsNotAllowed(request: IncomingMessage, allowedOrigin: number | string | string[] | undefined): boolean;
-}
-export declare type __ΩCorsFrameworkOptions = any[];

package/lib/frameworks/cors/index.d.ts

@@ -1 +0,0 @@
-export * from './cors.framework';

package/lib/frameworks/deepkit/http-deepkit.framework.d.ts

@@ -1,17 +0,0 @@
-/// <reference types="node" />
-import { ServerResponse } from 'http';
-import { HttpKernel } from '@deepkit/http';
-import { FrameworkContract } from '../../contracts';
-import { ServerlessRequest } from '../../network';
-/**
- * The framework that forwards requests to express handler
- *
- * @breadcrumb Frameworks / HttpDeepkitFramework
- * @public
- */
-export declare class HttpDeepkitFramework implements FrameworkContract<HttpKernel> {
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: HttpKernel, request: ServerlessRequest, response: ServerResponse): void;
-}

package/lib/frameworks/deepkit/index.d.ts

@@ -1 +0,0 @@
-export * from './http-deepkit.framework';

package/lib/frameworks/express/express.framework.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import type { Express } from 'express';
-import { FrameworkContract } from '../../contracts';
-/**
- * The framework that forwards requests to express handler
- *
- * @breadcrumb Frameworks / ExpressFramework
- * @public
- */
-export declare class ExpressFramework implements FrameworkContract<Express> {
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: Express, request: IncomingMessage, response: ServerResponse): void;
-}

package/lib/frameworks/express/index.d.ts

@@ -1 +0,0 @@
-export * from './express.framework';

package/lib/frameworks/fastify/fastify.framework.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import type { FastifyInstance } from 'fastify';
-import { FrameworkContract } from '../../contracts';
-/**
- * The framework that forwards requests to fastify handler
- *
- * @breadcrumb Frameworks / FastifyFramework
- * @public
- */
-export declare class FastifyFramework implements FrameworkContract<FastifyInstance> {
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: FastifyInstance, request: IncomingMessage, response: ServerResponse): void;
-}

package/lib/frameworks/fastify/helpers/no-op-content-parser.d.ts

@@ -1,13 +0,0 @@
-import { FastifyInstance } from 'fastify';
-/**
- * Just return the current body as it was parsed.
- *
- * @remarks This function is intended to be used with BodyParserFrameworks.
- *
- * @param app - The instance of fastify
- * @param contentType - The content type to be anuled
- *
- * @breadcrumb Frameworks / FastifyFramework / Helpers
- * @public
- */
-export declare function setNoOpForContentType(app: FastifyInstance, contentType: string): void;

package/lib/frameworks/fastify/index.d.ts

@@ -1 +0,0 @@
-export * from './fastify.framework';

package/lib/frameworks/hapi/hapi.framework.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import type { Server } from 'hapi';
-import { FrameworkContract } from '../../contracts';
-/**
- * The framework that forwards requests to hapi handler
- *
- * @breadcrumb Frameworks / HapiFramework
- * @public
- */
-export declare class HapiFramework implements FrameworkContract<Server> {
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: Server, request: IncomingMessage, response: ServerResponse): void;
-}

package/lib/frameworks/hapi/index.d.ts

@@ -1 +0,0 @@
-export * from './hapi.framework';

package/lib/frameworks/koa/index.d.ts

@@ -1 +0,0 @@
-export * from './koa.framework';

package/lib/frameworks/koa/koa.framework.d.ts

@@ -1,16 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage, ServerResponse } from 'http';
-import type Application from 'koa';
-import { FrameworkContract } from '../../contracts';
-/**
- * The framework that forwards requests to koa handler
- *
- * @breadcrumb Frameworks / KoaFramework
- * @public
- */
-export declare class KoaFramework implements FrameworkContract<Application> {
-    /**
-     * {@inheritDoc}
-     */
-    sendRequest(app: Application, request: IncomingMessage, response: ServerResponse): void;
-}

package/lib/frameworks/lazy/index.d.ts

@@ -1 +0,0 @@
-export * from './lazy.framework';