@breautek/storm 8.6.0 → 9.0.0

package/src/Handler.ts

@@ -1,5 +1,5 @@
 /*
-   Copyright 2017-2021 Norman Breau
+   Copyright 2017-2025 Norman Breau
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -15,9 +15,8 @@
 */
 
 import {Application} from './Application';
-import {getInstance} from './instance';
 import {Request} from './Request';
-import {Response} from './Response';
+import {Response, SendableData} from './Response';
 import {Middleware} from './Middleware';
 import {StormError} from './StormError';
 import {IConfig} from './IConfig';
@@ -25,47 +24,28 @@ import { InternalError } from './InternalError';
 import { IRequestResponse } from './IRequestResponse';
 import { BaseLogger } from '@arashi/logger';
 import { ResponseData } from './ResponseData';
-import { ReadStream } from 'fs';
 import { NotImplementedError } from './NotImplementedError';
 import { HTTPMethod } from './HTTPMethod';
 
 const TAG: string = 'Handler';
 
-/**
- * IHandlerResponse can actually accept any arbitrary object, however it may do
- * certain things depending on the type of object it receives.
- * 
- * - If the response object is a stream, it will pipe the stream to stream the HTTP response.
- * - If the response is ResponseData, the status code and response data will be passed as the HTTP response.
- * - Passing nothing/undefined will return a status code of 204 with no body content
- * - Primitive data types will be passed as is
- * - Buffers will be passed through
- * - Any other object will be passed through JSON.stringify
- */
-export type IHandlerResponse = ResponseData | ReadableStream | ReadStream | any | void;
-
-/**
- * Like IHandlerResponse, an IHandlerError can be any arbitrary type of object,
- * however it's recommended that the type be of a StormError.
- * 
- * If the type is not a StormError, the error will be wrapped in an InternalError object.
- * This is to avoid accidental leakage of privilege data (e.g. snippets of database queries with sensitive information)
- */
-export type IHandlerError = StormError | Error | any;
-
 export class Handler<
         TApplication extends Application = Application,
-        TGetRequest     = any,
-        TGetResponse    = IHandlerResponse,
-        TPostRequest    = any,
-        TPostResponse   = IHandlerResponse,
-        TPutRequest     = any,
-        TPutResponse    = IHandlerResponse,
-        TDeleteRequest  = any,
-        TDeleteResponse = IHandlerResponse,
+        TGetRequest     extends SendableData    = void | SendableData,
+        TGetResponse    extends SendableData    = void | SendableData,
+        TPostRequest    extends SendableData    = void | SendableData,
+        TPostResponse   extends SendableData    = void | SendableData,
+        TPutRequest     extends SendableData    = void | SendableData,
+        TPutResponse    extends SendableData    = void | SendableData,
+        TDeleteRequest  extends SendableData    = void | SendableData,
+        TDeleteResponse extends SendableData    = void | SendableData
     >  {
         
     private $app: TApplication;
+
+    /**
+     * @deprecated
+     */
     private $middlewares: Middleware[];
 
     constructor(app: TApplication) {
@@ -77,23 +57,32 @@ export class Handler<
         return this.$app;
     }
 
+    /**
+     * @deprecated
+     */
     protected _initMiddlewares(): Middleware[] {
         return [];
     }
 
-    public getAccessToken(request: Request): string {
-        let config: IConfig = getInstance().getConfig();
+    public getAccessToken(request: Request<unknown>): string {
+        let config: IConfig = this.$app.getConfig();
         let authHeader: string = config.authentication_header;
         return request.getHeader(authHeader);
     }
 
+    /**
+     * @deprecated
+     * @param request 
+     * @param response 
+     * @returns 
+     */
     private async $executeMiddlewares(request: Request, response: Response): Promise<IRequestResponse> {
         let result: IRequestResponse = {
             request,
             response
         };
 
-        let logger: BaseLogger = getInstance().getLogger();
+        let logger: BaseLogger = this.$app.getLogger();
 
         try {
             for (let i: number = 0; i < this.$middlewares.length; i++) {
@@ -133,13 +122,19 @@ export class Handler<
         return Promise.resolve(result);
     }
 
+    /**
+     * @deprecated
+     * @param request 
+     * @param response 
+     * @param error 
+     */
     protected _onMiddlewareReject(request: Request, response: Response, error: StormError): void {}
 
-    private $handleResponse<TResponse>(response: Response<TResponse>, data: any): void {
+    private $handleResponse<TResponse extends SendableData>(response: Response<TResponse>, data: TResponse | ResponseData<TResponse>): void {
         response.send(data);
     }
 
-    private $handleResponseError<TResponse>(response: Response<TResponse>, error: any): void {
+    private $handleResponseError<TResponse extends SendableData>(response: Response<TResponse>, error: any): void {
         response.error(error);
     }
 
@@ -148,7 +143,7 @@ export class Handler<
 
         try {
             let result: IRequestResponse<TGetRequest, TGetResponse> = await this.$executeMiddlewares(request, response);
-            let req: any = await this._get(result.request);
+            let req: TGetResponse | ResponseData<TGetResponse> = await this._get(result.request);
             this.$handleResponse(response, req);
         }
         catch (ex) {
@@ -161,7 +156,7 @@ export class Handler<
 
         try {
             let result: IRequestResponse<TPutRequest, TPutResponse> = await this.$executeMiddlewares(request, response);
-            let req: any = await this._put(result.request);
+            let req: TPutResponse | ResponseData<TPutResponse> = await this._put(result.request);
             this.$handleResponse(response, req);
         }
         catch (ex) {
@@ -187,7 +182,7 @@ export class Handler<
 
         try {
             let result: IRequestResponse<TDeleteRequest, TDeleteResponse> = await this.$executeMiddlewares(request, response);
-            let req: any = await this._delete(result.request);
+            let req: ResponseData<TDeleteResponse> | TDeleteResponse = await this._delete(result.request);
             this.$handleResponse(response, req);
         }
         catch (ex) {
@@ -195,19 +190,19 @@ export class Handler<
         }
     }
 
-    protected async _get(request: Request<TGetRequest>): Promise<TGetResponse> {
+    protected async _get(request: Request<TGetRequest>): Promise<TGetResponse | ResponseData<TGetResponse>> {
         throw new NotImplementedError(HTTPMethod.GET);
     }
 
-    protected async _post(request: Request<TPostRequest>): Promise<TPostResponse> {
+    protected async _post(request: Request<TPostRequest>): Promise<TPostResponse | ResponseData<TPostResponse>> {
         throw new NotImplementedError(HTTPMethod.POST);
     }
 
-    protected async _put(request: Request<TPutRequest>): Promise<TPutResponse> {
+    protected async _put(request: Request<TPutRequest>): Promise<TPutResponse | ResponseData<TPutResponse>> {
         throw new NotImplementedError(HTTPMethod.PUT);
     }
 
-    protected async _delete(request: Request<TDeleteRequest>): Promise<TDeleteResponse> {
+    protected async _delete(request: Request<TDeleteRequest>): Promise<TDeleteResponse | ResponseData<TDeleteResponse>> {
         throw new NotImplementedError(HTTPMethod.DELETE);
     }
 }

package/src/IDatabaseConnection.ts

@@ -25,6 +25,9 @@ export interface IDatabaseConnection {
     getInstantiationStack(): string;
     getAPI(): any;
     isReadOnly(): boolean;
+    isMaster(): boolean;
+    isReplication(): boolean;
+    hasReplicationEnabled(): boolean;
     setTimeout(timeout: number): void;
     getTimeout(): number;
     query(query: IQueryable<any>, params?: any): Promise<any>;

package/src/IRequestResponse.ts

@@ -1,5 +1,5 @@
 /*
-   Copyright 2017-2021 Norman Breau
+   Copyright 2017-2025 Norman Breau
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -15,9 +15,9 @@
 */
 
 import {Request} from './Request';
-import {Response} from './Response';
+import {Response, SendableData} from './Response';
 
-export interface IRequestResponse<TRequest = any, TResponse = any> {
+export interface IRequestResponse<TRequest = any, TResponse extends SendableData = SendableData> {
     request: Request<TRequest>;
     response: Response<TResponse>;
 }

package/src/ManagedDatabaseConnection.ts

@@ -44,6 +44,18 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
         this.$instantionStack = new Error().stack;
     }
 
+    public isMaster(): boolean {
+        throw new Error('Method not implemented.');
+    }
+    
+    public isReplication(): boolean {
+        throw new Error('Method not implemented.');
+    }
+    
+    public hasReplicationEnabled(): boolean {
+        throw new Error('Method not implemented.');
+    }
+
     public formatQuery(query: IQueryable<any>): string {
         throw new Error('Unsupported API call');
     }

package/src/Middleware.ts

@@ -17,9 +17,21 @@
 import {Request} from './Request';
 import {Response} from './Response';
 import {IRequestResponse} from './IRequestResponse';
+import { Application } from './Application';
 
-export abstract class Middleware {
-    public constructor() {}
+/**
+ * @deprecated
+ */
+export abstract class Middleware<TApplication extends Application = Application> {
+    private $app: TApplication;
+
+    public constructor(app: TApplication) {
+        this.$app = app;
+    }
+
+    public getApplication(): TApplication {
+        return this.$app;
+    }
 
     protected abstract _execute(request: Request, response: Response): Promise<IRequestResponse>;
 

package/src/MySQLConnection.ts

@@ -37,6 +37,7 @@ import { GetMasterPositionQuery } from './private/GetMasterPositionQuery';
 import { IQueryable } from './IQueryable';
 import { queryFormatter } from './mysql/queryFormatter';
 import { TransactionAccessLevel } from './TransactionAccessLevel';
+import { GetProcessList, IGetProcessListOutput } from './private/GetProcessList';
 
 const DEFAULT_HIGH_WATERMARK: number = 512; // in number of result objects
 const TAG: string = 'MySQLConnection';
@@ -62,11 +63,13 @@ let rollbackQuery: RollbackQuery = new RollbackQuery();
 export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
     private $transaction: boolean;
     private $opened: boolean;
+    private $hasReplicationEnabled: boolean;
     private $isMasterConnection: boolean;
 
     public constructor(connection: MySQL.PoolConnection, instantiationStack: string, isReadOnly: boolean = true) {
         super(connection, isReadOnly, instantiationStack);
 
+        this.$hasReplicationEnabled = false;
         this.$opened = true;
         this.$transaction = false;
         this.$isMasterConnection = null;
@@ -91,17 +94,47 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
      */
     public async __internal_init(): Promise<void> {
         let result = await new GetSlavePositionQuery().execute(this);
-        this.$isMasterConnection = result === null;
+        if (result !== null) {
+            this.$hasReplicationEnabled = true;
+            this.$isMasterConnection = false;
+        }
+        else {
+            this.$isMasterConnection = true;
+            let processList: IGetProcessListOutput[] = await new GetProcessList().execute(this);
+
+            for (let i: number = 0; i < processList.length; i++) {
+                let p: IGetProcessListOutput = processList[i];
+
+                if (p.Command === 'Binlog Dump') {
+                    this.$hasReplicationEnabled = true;
+                    break;
+                }
+            }
+        }
     }
 
     public override formatQuery(query: IQueryable<any>): string {
         return this.getAPI().config.queryFormat(query.getQuery(this), query.getParametersForQuery());
     }
 
+    /**
+     * Returns true if this server is the source.
+     * Will also return true if there is no replication detected.
+     */
     public isMaster(): boolean {
         return this.$isMasterConnection;
     }
 
+    /**
+     * Returns true if this server is part of a replication cluster.
+     */
+    public hasReplicationEnabled(): boolean {
+        return this.$hasReplicationEnabled;
+    }
+
+    /**
+     * Returns true if this server is a replication server.
+     */
     public isReplication(): boolean {
         return !this.isMaster();
     }

package/src/MySQLDatabase.ts

@@ -89,21 +89,19 @@ export class MySQLDatabase extends Database<MySQL.PoolConfig, MySQL.PoolConnecti
         let conn: MySQLConnection = await this.$getConnectionFromPool(query, requireWriteAccess, instantationStack);
         await conn.__internal_init();
 
-        if (conn.isReplication()) {
+        if (conn.hasReplicationEnabled() && conn.isReplication() && position && position.page && position.position) {
             // master connections will not wait on database positions
             // they are guarenteed to be at the tip.
             // readonly, or otherwise known as replication connections
             // may have replication lag. If we have a desired position target,
             // then await for the connection to catch up to that target.
-            if (position && position.page && position.position) {
-                let waiter: ConnectionReplicationWaiter = new ConnectionReplicationWaiter(conn);
-                try {
-                    await waiter.wait(position);
-                }
-                catch (ex) {
-                    conn.close(true);
-                    throw ex;
-                }
+            let waiter: ConnectionReplicationWaiter = new ConnectionReplicationWaiter(conn);
+            try {
+                await waiter.wait(position);
+            }
+            catch (ex) {
+                conn.close(true);
+                throw ex;
             }
         }
 

package/src/Response.ts

@@ -19,23 +19,35 @@ import {ResponseData} from './ResponseData';
 import {StormError, IErrorResponse} from './StormError';
 import * as express from 'express';
 import { InternalError } from './InternalError';
-import { getInstance } from './instance';
 import { Stream } from 'stream';
+import { Application } from './Application';
 
 const TAG: string = 'Response';
 
-export type SendableData = ResponseData | Error | IErrorResponse | Buffer | any;
+export type SendableData =
+    ResponseData<SendableData> |
+    Error |
+    IErrorResponse |
+    Buffer |
+    string |
+    number |
+    void |
+    ReadableStream |
+    Stream.Readable
+;
 
 export interface IHeaderKeyValuePair {
     [key: string]: string;
 }
 
-export class Response<TResponse = SendableData, TErrorResponse = Error | IErrorResponse | string> {
+export class Response<TResponse extends SendableData = SendableData, TErrorResponse extends SendableData = SendableData> {
+    private $app: Application;
     private $response: express.Response;
     private $created: Date;
     private $requestURL: string;
 
-    public constructor(response: express.Response, requestURL: string) {
+    public constructor(app: Application, response: express.Response, requestURL: string) {
+        this.$app = app;
         this.$response = response;
         this.$created = new Date();
         this.$requestURL = requestURL;
@@ -54,7 +66,7 @@ export class Response<TResponse = SendableData, TErrorResponse = Error | IErrorR
         this.$response.redirect(url);
     }
 
-    private $send(data?: TResponse | TErrorResponse | StormError | IErrorResponse | Buffer, statusOverride?: StatusCode): void {
+    private $send(data?: SendableData, statusOverride?: StatusCode): void {
         if (data === null || data === undefined) {
             this.setStatus(statusOverride || StatusCode.OK_NO_CONTENT);
             this.$response.send()
@@ -92,9 +104,10 @@ export class Response<TResponse = SendableData, TErrorResponse = Error | IErrorR
         }
     }
 
-    public send(data?: TResponse | TErrorResponse | StormError | IErrorResponse | Buffer): void {
+    // public send(data?: TResponse | TErrorResponse | StormError | IErrorResponse | Buffer): void {
+    public send(data?: SendableData): void {
         this.$send(data);
-        getInstance().getLogger().info(TAG, `API ${this.$requestURL} (${this.getStatus()}) responded in ${new Date().getTime() - this.$created.getTime()}ms`);
+        this.$app.getLogger().info(TAG, `API ${this.$requestURL} (${this.getStatus()}) responded in ${new Date().getTime() - this.$created.getTime()}ms`);
     }
 
     public pipe(stream: NodeJS.ReadableStream): void {

package/src/ServiceProvider.ts

@@ -15,10 +15,10 @@
 */
 
 import {Application} from './Application';
-import {IServiceHeaders} from './IServiceHeaders';
 import {HTTPMethod} from './HTTPMethod';
 import {ServiceResponse} from './ServiceResponse';
 import * as http from 'http';
+import { OutgoingHttpHeaders } from 'http2';
 
 const TAG: string = 'ServiceProvider';
 const NO_DATA: string = `|${0x0}|`;
@@ -78,8 +78,19 @@ export abstract class ServiceProvider {
         return `/api/${this._getBase()}/${this.getVersion()}/${url}${this.urlSuffix()}${queryString}`;
     }
 
-    public request(method: HTTPMethod, url: string, accessToken: string, data: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
+    public request(method: HTTPMethod, url: string, accessToken: string, data: any, headers?: OutgoingHttpHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return new Promise<ServiceResponse>((resolve, reject) => {
+            if (!headers) {
+                headers = {};
+            }
+
+            headers[this.$app.getConfig().authentication_header] = accessToken;
+            headers[this.$app.getConfig().backend_authentication_header] = this.$getSecret();
+            
+            if (!headers['content-type']) {
+                headers['content-type'] = 'application/json';
+            }
+
             let httpOpts: http.RequestOptions = {
                 port: this._getPort(),
                 hostname: `${this._getDomain()}`,
@@ -88,13 +99,6 @@ export abstract class ServiceProvider {
                 headers: headers || {}
             };
 
-            httpOpts.headers[this.$app.getConfig().authentication_header] = accessToken;
-            httpOpts.headers[this.$app.getConfig().backend_authentication_header] = this.$getSecret();
-            
-            if (!httpOpts.headers['Content-Type']) {
-                httpOpts.headers['Content-Type'] = 'application/json';
-            }
-
             this.$app.getLogger().trace(TAG, `ServiceProvider Request`);
             this.$app.getLogger().trace(TAG, `METHOD: ${httpOpts.method}`);
             this.$app.getLogger().trace(TAG, `HOSTNAME: ${httpOpts.hostname}`);
@@ -137,19 +141,19 @@ export abstract class ServiceProvider {
         request.end();
     }
 
-    public get(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
+    public get(url: string, accessToken: string, data?: any, headers?: OutgoingHttpHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.GET, this._createURL(url, data), accessToken, NO_DATA, headers, additionalOptions);
     }
 
-    public post(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
+    public post(url: string, accessToken: string, data?: any, headers?: OutgoingHttpHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.POST, this._createURL(url), accessToken, data, headers, additionalOptions);
     }
 
-    public put(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
+    public put(url: string, accessToken: string, data?: any, headers?: OutgoingHttpHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.PUT, this._createURL(url), accessToken, data, headers, additionalOptions);
     }
 
-    public delete(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
+    public delete(url: string, accessToken: string, data?: any, headers?: OutgoingHttpHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.DELETE, this._createURL(url), accessToken, data, headers, additionalOptions);
     }
 }

package/src/TokenManager.ts

@@ -20,6 +20,7 @@ import {IJWTVerifyOptions} from './IJWTVerifyOptions';
 import {JWTVerifyOptionsParser} from './JWTVerifyOptionsParser';
 import {randomBytes} from 'crypto';
 import { IAuthTokenData } from './IAuthTokenData';
+import { StringValue } from 'ms';
 
 // const TAG: string = 'TokenManager';
 
@@ -30,7 +31,7 @@ export class TokenManager<TAuthToken extends IAuthTokenData = IAuthTokenData> {
         this.$secret = secret;
     }
 
-    public sign(payload: {[key: string]: any}, expiresIn: string | number): Promise<Token> {
+    public sign(payload: {[key: string]: any}, expiresIn: StringValue | number): Promise<Token> {
         return new Promise<Token>((resolve, reject) => {
             randomBytes(64, (err: Error, buffer: Buffer) => {
                 if (err) {

package/src/api.ts

@@ -75,17 +75,14 @@ export {Middleware} from './Middleware';
 export {Request, IParameterMap} from './Request';
 export {Response} from './Response';
 export {ResponseData} from './ResponseData';
-export {Handler, IHandlerError, IHandlerResponse} from './Handler';
-export {CORSMiddleware} from './CORSMiddleware';
+export {Handler} from './Handler';
 export {ServiceProvider} from './ServiceProvider';
 export {HTTPMethod} from './HTTPMethod';
 export {ServiceResponse} from './ServiceResponse';
-export {BackendAuthenticationMiddleware} from './BackendAuthenticationMiddleware';
 
 // Interfaces
 export {IDatabaseConfig} from './IDatabaseConfig';
 export {IJWTVerifyOptions} from './IJWTVerifyOptions';
-export {IHandler} from './IHandler';
 export {IRequestResponse} from './IRequestResponse';
 export {
     IConfig,
@@ -95,7 +92,6 @@ export {
 } from './IConfig';
 export {IFormData} from './IFormData';
 export {IDatabaseConnection} from './IDatabaseConnection';
-export {IServiceHeaders} from './IServiceHeaders';
 export {IAuthTokenData} from './IAuthTokenData';
 export {IQueryable} from './IQueryable';
 export {IDatabasePosition} from './IDatabasePosition';

package/src/private/ConnectionReplicationWaiter.ts

@@ -55,7 +55,7 @@ export class ConnectionReplicationWaiter {
     }
 
     public async wait(target: IDatabasePosition, timeout: number = ConnectionReplicationWaiter.DEFAULT_TIMEOUT): Promise<void> {
-        if (!this.$conn.isReadOnly()) {
+        if (this.$conn.isMaster()) {
             return;
         }
 

package/src/private/GetProcessList.ts

@@ -0,0 +1,20 @@
+
+import { IDatabaseConnection } from '../IDatabaseConnection';
+import {Query} from '../Query';
+
+export interface IGetProcessListOutput {
+    Id: number;
+    User: string;
+    Host: string;
+    db: string;
+    Command: string;
+    Time: number;
+    State: string;
+    Info: string;
+}
+
+export class GetProcessList extends Query<void, IGetProcessListOutput[]> {
+    protected override _getQuery(connection: IDatabaseConnection): string {
+        return 'SHOW PROCESSLIST';
+    }
+}

package/docs/classes/BackendAuthenticationMiddleware.html

@@ -1,8 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BackendAuthenticationMiddleware | @breautek/storm</title><meta name="description" content="Documentation for @breautek/storm"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@breautek/storm</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">BackendAuthenticationMiddleware</a></li></ul><h1>Class BackendAuthenticationMiddleware</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A base authentication strategy that handles 90% of the authentication process.
-This will verify that the token hasn't been manipulated or tainted.
-The authenticate API must be implemented by subclasses to further validate the token data
-for their specific use cases.</p>
-</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/aee41fe79c42b214a44357bedb97b86fde2c357f/src/BackendAuthenticationMiddleware.ts#L32">src/BackendAuthenticationMiddleware.ts:32</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
-</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#execute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>execute</span></a>
-</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorbackendauthenticationmiddleware"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">BackendAuthenticationMiddleware</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">BackendAuthenticationMiddleware</a><a href="#constructorbackendauthenticationmiddleware" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">BackendAuthenticationMiddleware</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/aee41fe79c42b214a44357bedb97b86fde2c357f/src/BackendAuthenticationMiddleware.ts#L35">src/BackendAuthenticationMiddleware.ts:35</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="execute"><span>execute</span><a href="#execute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="execute-1"><span class="tsd-kind-call-signature">execute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">request</span><span class="tsd-signature-symbol">:</span> <a href="Request.html" class="tsd-signature-type tsd-kind-class">Request</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><a href="#execute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">request</span>: <a href="Request.html" class="tsd-signature-type tsd-kind-class">Request</a></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Arbituary object containing any relevant information used for authentication.</p>
-</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/breautek/storm/blob/aee41fe79c42b214a44357bedb97b86fde2c357f/src/BackendAuthenticationMiddleware.ts#L45">src/BackendAuthenticationMiddleware.ts:45</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#execute"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>execute</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">@breautek/storm</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>