@niledatabase/server 5.0.0-alpha.14 → 5.0.0-alpha.15

package/dist/index.d.mts

@@ -9,28 +9,25 @@ type Loggable = {
 };
 type LogReturn = (prefixes?: string | string[]) => Loggable;
 
+type ConfigurablePaths = {
+    get: string[];
+    post: string[];
+    delete: string[];
+    put: string[];
+};
+type ExtensionReturns = void | Response | Request | ExtensionState;
 type ExtensionCtx = {
-    handleOnRequest: (config: Config, _init: RequestInit & {
+    runExtensions: <T = ExtensionReturns>(toRun: ExtensionState, config: Config, params: any, _init?: RequestInit & {
         request: Request;
-    }, params: RequestInit) => Promise<void>;
+    }) => Promise<T>;
 };
 type ConfigConstructor = NileConfig & {
     extensionCtx?: ExtensionCtx;
 };
 declare class Config {
     routes: Routes;
-    handlers: {
-        GET: (req: Request) => Promise<void | Response>;
-        POST: (req: Request) => Promise<void | Response>;
-        DELETE: (req: Request) => Promise<void | Response>;
-        PUT: (req: Request) => Promise<void | Response>;
-    };
-    paths: {
-        get: string[];
-        post: string[];
-        delete: string[];
-        put: string[];
-    };
+    handlers: RouteFunctions;
+    paths: ConfigurablePaths;
     extensionCtx: ExtensionCtx;
     extensions?: Extension[];
     logger: LogReturn;
@@ -521,25 +518,10 @@ declare function parseCallback(headers?: Headers): string | undefined;
  * Extract the session token cookie from a set of headers.
  */
 declare function parseToken(headers?: Headers): string | undefined;
-
-type CTXHandlerType = {
-    GET: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-    POST: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-    DELETE: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-    PUT: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-};
+/**
+ * Internal helper for the password reset flow.
+ */
+declare function parseResetToken(headers: Headers | void): string | void;
 
 declare class Server {
     #private;
@@ -550,23 +532,20 @@ declare class Server {
     get db(): pg.Pool & {
         clearConnections: () => void;
     };
+    get logger(): LogReturn;
+    get extensions(): {
+        remove: (id: string) => Promise<ExtensionResult[] | undefined>;
+        add: (extension: Extension) => void;
+    };
     /**
      * A convenience function that applies a config and ensures whatever was passed is set properly
      */
     getInstance<T = Request | Headers | Record<string, string>>(config: NileConfig, req?: T): Server;
-    getPaths(): {
-        get: string[];
-        post: string[];
-        delete: string[];
-        put: string[];
-    };
-    get handlers(): {
-        GET: (req: Request) => Promise<void | Response>;
-        POST: (req: Request) => Promise<void | Response>;
-        DELETE: (req: Request) => Promise<void | Response>;
-        PUT: (req: Request) => Promise<void | Response>;
+    get handlers(): RouteFunctions & {
         withContext: CTXHandlerType;
     };
+    get paths(): ConfigurablePaths;
+    set paths(paths: ConfigurablePaths);
     /**
      * Allow the setting of headers from a req or header object.
      * Makes it possible to handle REST requests easily
@@ -574,10 +553,10 @@ declare class Server {
      * @param req
      * @returns undefined
      */
-    setContext(req: Request | Headers | Record<string, string> | unknown | {
+    setContext: (req: Request | Headers | Record<string, string> | unknown | {
         tenantId?: string;
         userId?: string;
-    }): void;
+    }, ...remaining: unknown[]) => void;
     getContext(): {
         headers: Headers | undefined;
         userId: string | null | undefined;
@@ -591,13 +570,21 @@ type Opts = {
     basePath?: string;
     fetch?: typeof fetch;
 };
-interface ExtensionResult {
-    id?: string;
-    [key: string]: unknown;
-    onRequest?: (req: Request) => void | Promise<void | RequestInit>;
-    onResponse?: (res: Response) => void | Promise<void>;
+type Any = any;
+type ExtensionResult = {
+    id: string;
+    onRequest?: (...params: Any) => void | Promise<void | RequestInit>;
+    onResponse?: (...params: Any) => void | Promise<void>;
+    onHandleRequest?: (...params: Any) => RouteReturn | Promise<RouteReturn>;
+    onConfigure?: (...params: Any) => void;
+    onSetContext?: (...params: Any) => void;
+};
+type Extension = (instance: Server) => ExtensionResult;
+declare enum ExtensionState {
+    onHandleRequest = "onHandleRequest",
+    onRequest = "onRequest",
+    onResponse = "onResposne"
 }
-type Extension = (instance: Server) => ExtensionResult | Promise<ExtensionResult>;
 type NilePoolConfig = PoolConfig & {
     afterCreate?: AfterCreate;
 };
@@ -788,10 +775,30 @@ interface APIError {
     statusCode: number;
 }
 type NileResponse<T> = Promise<T | NResponse<T & APIError>>;
+type ExtensionConfig = {
+    disableExtensions: string[];
+};
+type RouteReturn = void | Request | Response | ExtensionState;
+type RouteFunctions = {
+    GET: (req: Request, config?: ExtensionConfig, ...args: unknown[]) => Promise<RouteReturn>;
+    POST: (req: Request, config?: ExtensionConfig) => Promise<RouteReturn>;
+    DELETE: (req: Request, config?: ExtensionConfig) => Promise<RouteReturn>;
+    PUT: (req: Request, config?: ExtensionConfig) => Promise<RouteReturn>;
+};
+type ContextReturn = {
+    response: RouteReturn;
+    nile: Server;
+};
+type CTXHandlerType = {
+    GET: (req: Request) => Promise<ContextReturn>;
+    POST: (req: Request) => Promise<ContextReturn>;
+    DELETE: (req: Request) => Promise<ContextReturn>;
+    PUT: (req: Request) => Promise<ContextReturn>;
+};
 
 declare const TENANT_COOKIE = "nile.tenant-id";
 declare const USER_COOKIE = "nile.user-id";
 declare const HEADER_ORIGIN = "nile-origin";
 declare const HEADER_SECURE_COOKIES = "nile-secure-cookies";
 
-export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CreateBasicUserRequest, type CreateTenantUserRequest, type Extension, type ExtensionResult, HEADER_ORIGIN, HEADER_SECURE_COOKIES, type Invite, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type Providers, Server, TENANT_COOKIE, type Tenant, USER_COOKIE, type User, parseCSRF, parseCallback, parseToken };
+export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CTXHandlerType, type CreateBasicUserRequest, type CreateTenantUserRequest, type Extension, type ExtensionResult, ExtensionState, HEADER_ORIGIN, HEADER_SECURE_COOKIES, type Invite, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type Providers, type RouteFunctions, type RouteReturn, Server, TENANT_COOKIE, type Tenant, USER_COOKIE, type User, parseCSRF, parseCallback, parseResetToken, parseToken };

package/dist/index.d.ts

@@ -9,28 +9,25 @@ type Loggable = {
 };
 type LogReturn = (prefixes?: string | string[]) => Loggable;
 
+type ConfigurablePaths = {
+    get: string[];
+    post: string[];
+    delete: string[];
+    put: string[];
+};
+type ExtensionReturns = void | Response | Request | ExtensionState;
 type ExtensionCtx = {
-    handleOnRequest: (config: Config, _init: RequestInit & {
+    runExtensions: <T = ExtensionReturns>(toRun: ExtensionState, config: Config, params: any, _init?: RequestInit & {
         request: Request;
-    }, params: RequestInit) => Promise<void>;
+    }) => Promise<T>;
 };
 type ConfigConstructor = NileConfig & {
     extensionCtx?: ExtensionCtx;
 };
 declare class Config {
     routes: Routes;
-    handlers: {
-        GET: (req: Request) => Promise<void | Response>;
-        POST: (req: Request) => Promise<void | Response>;
-        DELETE: (req: Request) => Promise<void | Response>;
-        PUT: (req: Request) => Promise<void | Response>;
-    };
-    paths: {
-        get: string[];
-        post: string[];
-        delete: string[];
-        put: string[];
-    };
+    handlers: RouteFunctions;
+    paths: ConfigurablePaths;
     extensionCtx: ExtensionCtx;
     extensions?: Extension[];
     logger: LogReturn;
@@ -521,25 +518,10 @@ declare function parseCallback(headers?: Headers): string | undefined;
  * Extract the session token cookie from a set of headers.
  */
 declare function parseToken(headers?: Headers): string | undefined;
-
-type CTXHandlerType = {
-    GET: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-    POST: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-    DELETE: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-    PUT: (req: Request) => Promise<{
-        response: void | Response;
-        nile: Server;
-    }>;
-};
+/**
+ * Internal helper for the password reset flow.
+ */
+declare function parseResetToken(headers: Headers | void): string | void;
 
 declare class Server {
     #private;
@@ -550,23 +532,20 @@ declare class Server {
     get db(): pg.Pool & {
         clearConnections: () => void;
     };
+    get logger(): LogReturn;
+    get extensions(): {
+        remove: (id: string) => Promise<ExtensionResult[] | undefined>;
+        add: (extension: Extension) => void;
+    };
     /**
      * A convenience function that applies a config and ensures whatever was passed is set properly
      */
     getInstance<T = Request | Headers | Record<string, string>>(config: NileConfig, req?: T): Server;
-    getPaths(): {
-        get: string[];
-        post: string[];
-        delete: string[];
-        put: string[];
-    };
-    get handlers(): {
-        GET: (req: Request) => Promise<void | Response>;
-        POST: (req: Request) => Promise<void | Response>;
-        DELETE: (req: Request) => Promise<void | Response>;
-        PUT: (req: Request) => Promise<void | Response>;
+    get handlers(): RouteFunctions & {
         withContext: CTXHandlerType;
     };
+    get paths(): ConfigurablePaths;
+    set paths(paths: ConfigurablePaths);
     /**
      * Allow the setting of headers from a req or header object.
      * Makes it possible to handle REST requests easily
@@ -574,10 +553,10 @@ declare class Server {
      * @param req
      * @returns undefined
      */
-    setContext(req: Request | Headers | Record<string, string> | unknown | {
+    setContext: (req: Request | Headers | Record<string, string> | unknown | {
         tenantId?: string;
         userId?: string;
-    }): void;
+    }, ...remaining: unknown[]) => void;
     getContext(): {
         headers: Headers | undefined;
         userId: string | null | undefined;
@@ -591,13 +570,21 @@ type Opts = {
     basePath?: string;
     fetch?: typeof fetch;
 };
-interface ExtensionResult {
-    id?: string;
-    [key: string]: unknown;
-    onRequest?: (req: Request) => void | Promise<void | RequestInit>;
-    onResponse?: (res: Response) => void | Promise<void>;
+type Any = any;
+type ExtensionResult = {
+    id: string;
+    onRequest?: (...params: Any) => void | Promise<void | RequestInit>;
+    onResponse?: (...params: Any) => void | Promise<void>;
+    onHandleRequest?: (...params: Any) => RouteReturn | Promise<RouteReturn>;
+    onConfigure?: (...params: Any) => void;
+    onSetContext?: (...params: Any) => void;
+};
+type Extension = (instance: Server) => ExtensionResult;
+declare enum ExtensionState {
+    onHandleRequest = "onHandleRequest",
+    onRequest = "onRequest",
+    onResponse = "onResposne"
 }
-type Extension = (instance: Server) => ExtensionResult | Promise<ExtensionResult>;
 type NilePoolConfig = PoolConfig & {
     afterCreate?: AfterCreate;
 };
@@ -788,10 +775,30 @@ interface APIError {
     statusCode: number;
 }
 type NileResponse<T> = Promise<T | NResponse<T & APIError>>;
+type ExtensionConfig = {
+    disableExtensions: string[];
+};
+type RouteReturn = void | Request | Response | ExtensionState;
+type RouteFunctions = {
+    GET: (req: Request, config?: ExtensionConfig, ...args: unknown[]) => Promise<RouteReturn>;
+    POST: (req: Request, config?: ExtensionConfig) => Promise<RouteReturn>;
+    DELETE: (req: Request, config?: ExtensionConfig) => Promise<RouteReturn>;
+    PUT: (req: Request, config?: ExtensionConfig) => Promise<RouteReturn>;
+};
+type ContextReturn = {
+    response: RouteReturn;
+    nile: Server;
+};
+type CTXHandlerType = {
+    GET: (req: Request) => Promise<ContextReturn>;
+    POST: (req: Request) => Promise<ContextReturn>;
+    DELETE: (req: Request) => Promise<ContextReturn>;
+    PUT: (req: Request) => Promise<ContextReturn>;
+};
 
 declare const TENANT_COOKIE = "nile.tenant-id";
 declare const USER_COOKIE = "nile.user-id";
 declare const HEADER_ORIGIN = "nile-origin";
 declare const HEADER_SECURE_COOKIES = "nile-secure-cookies";
 
-export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CreateBasicUserRequest, type CreateTenantUserRequest, type Extension, type ExtensionResult, HEADER_ORIGIN, HEADER_SECURE_COOKIES, type Invite, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type Providers, Server, TENANT_COOKIE, type Tenant, USER_COOKIE, type User, parseCSRF, parseCallback, parseToken };
+export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CTXHandlerType, type CreateBasicUserRequest, type CreateTenantUserRequest, type Extension, type ExtensionResult, ExtensionState, HEADER_ORIGIN, HEADER_SECURE_COOKIES, type Invite, type JWT, type LoggerType, type LoginUserResponse, type LoginUserResponseToken, LoginUserResponseTokenTypeEnum, create as Nile, type NileConfig, type NileDb, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type Providers, type RouteFunctions, type RouteReturn, Server, TENANT_COOKIE, type Tenant, USER_COOKIE, type User, parseCSRF, parseCallback, parseResetToken, parseToken };