prostgles-server 4.2.154 → 4.2.156

package/dist/AuthHandler.d.ts

@@ -1,204 +0,0 @@
-import { Express, NextFunction, Request, Response } from "express";
-import { AnyObject, FieldFilter } from "prostgles-types";
-import { LocalParams, PRGLIOSocket } from "./DboBuilder/DboBuilder";
-import { DBOFullyTyped } from "./DBSchemaBuilder";
-import { DB, DBHandlerServer, Prostgles } from "./Prostgles";
-type Awaitable<T> = T | Promise<T>;
-type AuthSocketSchema = {
-    user?: AnyObject;
-    register?: boolean;
-    login?: boolean;
-    logout?: boolean;
-    pathGuard?: boolean;
-};
-export type ExpressReq = Request;
-export type ExpressRes = Response;
-export type LoginClientInfo = {
-    ip_address: string;
-    ip_address_remote: string | undefined;
-    x_real_ip: string | undefined;
-    user_agent: string | undefined;
-};
-export type BasicSession = {
-    /** Must be hard to bruteforce */
-    sid: string;
-    /** UNIX millisecond timestamp */
-    expires: number;
-    /** On expired */
-    onExpiration: "redirect" | "show_error";
-};
-export type AuthClientRequest = {
-    socket: PRGLIOSocket;
-} | {
-    httpReq: ExpressReq;
-};
-export type UserLike = {
-    id: string;
-    type: string;
-    [key: string]: any;
-};
-export type SessionUser<ServerUser extends UserLike = UserLike, ClientUser extends AnyObject = AnyObject> = {
-    /**
-     * This user will be available in all serverside prostgles options
-     * id and type values will be available in the prostgles.user session variable in postgres
-     * */
-    user: ServerUser;
-    /**
-     * Controls which fields from user are available in postgres session variable
-     */
-    sessionFields?: FieldFilter<ServerUser>;
-    /**
-     * User data sent to the authenticated client
-     */
-    clientUser: ClientUser;
-};
-export type AuthResult<SU = SessionUser> = SU & {
-    sid: string;
-} | {
-    user?: undefined;
-    clientUser?: undefined;
-    sid?: string;
-} | undefined;
-export declare const HTTPCODES: {
-    AUTH_ERROR: number;
-    NOT_FOUND: number;
-    BAD_REQUEST: number;
-    INTERNAL_SERVER_ERROR: number;
-};
-export declare const getLoginClientInfo: (req: AuthClientRequest) => AuthClientRequest & LoginClientInfo;
-export type AuthRequestParams<S, SUser extends SessionUser> = {
-    db: DB;
-    dbo: DBOFullyTyped<S>;
-    getUser: () => Promise<AuthResult<SUser>>;
-};
-export type Auth<S = void, SUser extends SessionUser = SessionUser> = {
-    /**
-     * Name of the cookie or socket hadnshake query param that represents the session id.
-     * Defaults to "session_id"
-     */
-    sidKeyName?: string;
-    /**
-     * Response time rounding in milliseconds to prevent timing attacks on login. Login response time should always be a multiple of this value. Defaults to 500 milliseconds
-     */
-    responseThrottle?: number;
-    expressConfig?: {
-        /**
-         * Express app instance. If provided Prostgles will attempt to set sidKeyName to user cookie
-         */
-        app: Express;
-        /**
-         * Used in allowing logging in through express. Defaults to /login
-         */
-        loginRoute?: string;
-        /**
-         * Used in allowing logging out through express. Defaults to /logout
-         */
-        logoutGetPath?: string;
-        /**
-         * Options used in setting the cookie after a successful login
-         */
-        cookieOptions?: AnyObject;
-        /**
-         * False by default. If false and userRoutes are provided then the socket will request window.location.reload if the current url is on a user route.
-         */
-        disableSocketAuthGuard?: boolean;
-        /**
-         * If provided, any client requests to NOT these routes (or their subroutes) will be redirected to loginRoute (if logged in) and then redirected back to the initial route after logging in
-         * If logged in the user is allowed to access these routes
-         */
-        publicRoutes?: string[];
-        /**
-         * Will attach a app.use listener and will expose getUser
-         * Used for blocking access
-         */
-        use?: (args: {
-            req: ExpressReq;
-            res: ExpressRes;
-            next: NextFunction;
-        } & AuthRequestParams<S, SUser>) => void | Promise<void>;
-        /**
-         * Will be called after a GET request is authorised
-         * This means that
-         */
-        onGetRequestOK?: (req: ExpressReq, res: ExpressRes, params: AuthRequestParams<S, SUser>) => any;
-        /**
-         * Name of get url parameter used in redirecting user after successful login.
-         * Defaults to "returnURL"
-         */
-        returnUrlParamName?: string;
-        magicLinks?: {
-            /**
-             * Will default to /magic-link
-             */
-            route?: string;
-            /**
-             * Used in creating a session/logging in using a magic link
-             */
-            check: (magicId: string, dbo: DBOFullyTyped<S>, db: DB, client: LoginClientInfo) => Awaitable<BasicSession | undefined>;
-        };
-    };
-    /**
-     * undefined sid is allowed to enable public users
-     */
-    getUser: (sid: string | undefined, dbo: DBOFullyTyped<S>, db: DB, client: AuthClientRequest & LoginClientInfo) => Awaitable<AuthResult<SUser>>;
-    register?: (params: AnyObject, dbo: DBOFullyTyped<S>, db: DB) => Awaitable<BasicSession> | BasicSession;
-    login?: (params: AnyObject, dbo: DBOFullyTyped<S>, db: DB, client: LoginClientInfo) => Awaitable<BasicSession> | BasicSession;
-    logout?: (sid: string | undefined, dbo: DBOFullyTyped<S>, db: DB) => Awaitable<any>;
-    /**
-     * If provided then session info will be saved on socket.__prglCache and reused from there
-     */
-    cacheSession?: {
-        getSession: (sid: string | undefined, dbo: DBOFullyTyped<S>, db: DB) => Awaitable<BasicSession>;
-    };
-};
-export declare class AuthHandler {
-    protected prostgles: Prostgles;
-    protected opts?: Auth;
-    dbo: DBHandlerServer;
-    db: DB;
-    sidKeyName?: string;
-    routes: {
-        login?: string;
-        returnUrlParamName?: string;
-        logoutGetPath?: string;
-        magicLinks?: {
-            route: string;
-            expressRoute: string;
-        };
-        readonly catchAll: '*';
-    };
-    constructor(prostgles: Prostgles);
-    validateSid: (sid: string | undefined) => string | undefined;
-    matchesRoute: (route: string | undefined, clientFullRoute: string) => boolean | "" | undefined;
-    isUserRoute: (pathname: string) => boolean;
-    private setCookieAndGoToReturnURLIFSet;
-    getUser: (clientReq: {
-        httpReq: ExpressReq;
-    }) => Promise<AuthResult>;
-    init(): Promise<void>;
-    getReturnUrl: (req: ExpressReq) => string | null | undefined;
-    destroy: () => void;
-    throttledFunc: <T>(func: () => Promise<T>, throttle?: number) => Promise<T>;
-    loginThrottled: (params: AnyObject, client: LoginClientInfo) => Promise<BasicSession>;
-    /**
-     * Will return first sid value found in:
-     *  Bearer header
-     *  http cookie
-     *  query params
-     * Based on sid names in auth
-     */
-    getSID(localParams: LocalParams): string | undefined;
-    /**
-     * Used for logging
-     */
-    getSIDNoError: (localParams: LocalParams | undefined) => string | undefined;
-    getClientInfo(localParams: Pick<LocalParams, "socket" | "httpReq">): Promise<AuthResult>;
-    isValidSocketSession: (socket: PRGLIOSocket, session: BasicSession) => boolean;
-    makeSocketAuth: (socket: PRGLIOSocket) => Promise<Record<string, never> | {
-        auth: AuthSocketSchema;
-        userData: AuthResult;
-    }>;
-}
-export declare const getSafeReturnURL: (returnURL: string, returnUrlParamName: string, quiet?: boolean) => string | undefined;
-export {};
-//# sourceMappingURL=AuthHandler.d.ts.map

package/dist/AuthHandler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AuthHandler.d.ts","sourceRoot":"","sources":["../lib/AuthHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,SAAS,EAA0D,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACjH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7D,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AACnC,KAAK,gBAAgB,GAAG;IACtB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC;AACjC,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;AAElC,MAAM,MAAM,eAAe,GAAG;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAEzB,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IAEZ,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAEhB,iBAAiB;IACjB,YAAY,EAAE,UAAU,GAAG,YAAY,CAAC;CACzC,CAAC;AACF,MAAM,MAAM,iBAAiB,GAAG;IAAE,MAAM,EAAE,YAAY,CAAA;CAAE,GAAG;IAAE,OAAO,EAAE,UAAU,CAAA;CAAE,CAAC;AACnF,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAA;AACD,MAAM,MAAM,WAAW,CAAC,UAAU,SAAS,QAAQ,GAAG,QAAQ,EAAE,UAAU,SAAS,SAAS,GAAG,SAAS,IAAI;IAC1G;;;SAGK;IACL,IAAI,EAAE,UAAU,CAAC;IACjB;;OAEG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IACxC;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB,CAAA;AAED,MAAM,MAAM,UAAU,CAAC,EAAE,GAAG,WAAW,IAAI,EAAE,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;CAAE,GAAG;IACjE,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,GAAG,SAAS,CAAC;AAEd,eAAO,MAAM,SAAS;;;;;CAKrB,CAAC;AAEF,eAAO,MAAM,kBAAkB,QAAS,iBAAiB,KAAG,iBAAiB,GAAG,eAqB/E,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,KAAK,SAAS,WAAW,IAAI;IAAE,EAAE,EAAE,EAAE,CAAC;IAAC,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IAAC,OAAO,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;CAAE,CAAA;AAE1I,MAAM,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,KAAK,SAAS,WAAW,GAAG,WAAW,IAAI;IACpE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,aAAa,CAAC,EAAE;QACd;;WAEG;QACH,GAAG,EAAE,OAAO,CAAC;QAEb;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,aAAa,CAAC,EAAE,SAAS,CAAC;QAE1B;;WAEG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;QAEjC;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;QAExB;;;WAGG;QACH,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE;YAAE,GAAG,EAAE,UAAU,CAAC;YAAC,GAAG,EAAE,UAAU,CAAC;YAAC,IAAI,EAAE,YAAY,CAAA;SAAE,GAAG,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAE7H;;;WAGG;QACH,cAAc,CAAC,EAAE,CACf,GAAG,EAAE,UAAU,EACf,GAAG,EAAE,UAAU,EACf,MAAM,EAAE,iBAAiB,CAAC,CAAC,EAAE,KAAK,CAAC,KAChC,GAAG,CAAC;QAET;;;WAGG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,UAAU,CAAC,EAAE;YAEX;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,eAAe,KAAK,SAAS,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;SACzH,CAAA;KAEF,CAAA;IAED;;OAEG;IACH,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,iBAAiB,GAAG,eAAe,KAAK,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAE/I,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,SAAS,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;IACxG,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,eAAe,KAAK,SAAS,CAAC,YAAY,CAAC,GAAG,YAAY,CAAC;IAC9H,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC;IAEpF;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,KAAK,SAAS,CAAC,YAAY,CAAC,CAAA;KAChG,CAAA;CACF,CAAA;AAED,qBAAa,WAAW;IACtB,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;IAC/B,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACtB,GAAG,EAAE,eAAe,CAAC;IACrB,EAAE,EAAE,EAAE,CAAC;IACP,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,EAAE;QACN,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE;YACX,KAAK,EAAE,MAAM,CAAC;YACd,YAAY,EAAE,MAAM,CAAC;SACtB,CAAA;QACD,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;KACxB,CAEA;gBAEW,SAAS,EAAE,SAAS;IAsBhC,WAAW,QAAS,MAAM,GAAG,SAAS,wBAIrC;IAED,YAAY,UAAW,MAAM,GAAG,SAAS,mBAAmB,MAAM,8BAKjE;IAED,WAAW,aAAc,MAAM,aAW9B;IAED,OAAO,CAAC,8BAA8B,CAmCrC;IAED,OAAO,cAAqB;QAAE,OAAO,EAAE,UAAU,CAAC;KAAE,KAAG,QAAQ,UAAU,CAAC,CAezE;IAEK,IAAI;IAkKV,YAAY,QAAS,UAAU,+BAQ9B;IAED,OAAO,aAIN;IAED,aAAa,+DAgCZ;IAED,cAAc,WAAkB,SAAS,UAAU,eAAe,KAAG,QAAQ,YAAY,CAAC,CAqBzF;IAGD;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS;IA8CpD;;OAEG;IACH,aAAa,gBAAiB,WAAW,GAAG,SAAS,KAAG,MAAM,GAAG,SAAS,CAOzE;IAEK,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IAgE9F,oBAAoB,WAAY,YAAY,WAAW,YAAY,KAAG,OAAO,CAc5E;IAED,cAAc,WAAkB,YAAY;cAAmB,gBAAgB;kBAAY,UAAU;OAiFpG;CACF;AAED,eAAO,MAAM,gBAAgB,cAAe,MAAM,sBAAsB,MAAM,wCAkB7E,CAAA"}