@niledatabase/server 5.0.0-alpha.25 → 5.0.0-alpha.27

package/dist/index.d.mts

@@ -6,6 +6,7 @@ type Loggable = {
     debug: LogFunction;
     warn: LogFunction;
     error: LogFunction;
+    silly: LogFunction;
 };
 type LogReturn = (prefixes?: string | string[]) => Loggable;
 
@@ -17,7 +18,7 @@ type ConfigurablePaths = {
 };
 type ExtensionReturns = void | Response | Request | ExtensionState;
 type ExtensionCtx = {
-    runExtensions: <T = ExtensionReturns>(toRun: ExtensionState, config: Config, params: any, _init?: RequestInit & {
+    runExtensions: <T = ExtensionReturns>(toRun: ExtensionState, config: Config, params?: any, _init?: RequestInit & {
         request: Request;
     }) => Promise<T>;
 };
@@ -31,18 +32,7 @@ declare class Config {
     extensionCtx: ExtensionCtx;
     extensions?: Extension[];
     logger: LogReturn;
-    /**
-     * Stores the set tenant id from Server for use in sub classes
-     */
-    tenantId: string | null | undefined;
-    /**
-     * Stores the set user id from Server for use in sub classes
-     */
-    userId: string | null | undefined;
-    /**
-     * Stores the headers to be used in `fetch` calls
-     */
-    headers: Headers;
+    context: PartialContext;
     /**
      * The nile-auth url
      */
@@ -522,6 +512,10 @@ declare function parseToken(headers?: Headers): string | undefined;
  * Internal helper for the password reset flow.
  */
 declare function parseResetToken(headers: Headers | void): string | void;
+/**
+ * Extract the tenantId cookie from a set of headers.
+ */
+declare function parseTenantId(headers?: Headers): string | null | undefined;
 
 declare class Server {
     #private;
@@ -534,28 +528,23 @@ declare class Server {
     };
     get logger(): LogReturn;
     get extensions(): {
-        remove: (id: string) => Promise<ExtensionResult[] | undefined>;
+        remove: (id: string) => Promise<ExtensionResult<any>[] | 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): this;
     get handlers(): NileHandlers;
     get paths(): ConfigurablePaths;
     set paths(paths: ConfigurablePaths);
+    /** Allows setting of context outside of the request lifecycle
+     * Basically means you want to disregard cookies and do everything manually
+     * If we elect to DDL, we don't want to use tenant id or user id, so remove those.
+     */
+    withContext(context?: ContextParams): Promise<this>;
+    withContext<T>(context: ContextParams, fn: (sdk: this) => Promise<T>): Promise<T>;
     /**
-     * Allow the setting of headers from a req or header object.
-     * Makes it possible to handle REST requests easily
-     * Also makes it easy to set user + tenant in some way
-     * @param req
-     * @returns undefined
+     *
+     * @returns the last used (basically global) context object, useful for debugging or making your own context
      */
-    setContext: (req: Request | Headers | Record<string, string> | unknown | {
-        tenantId?: string;
-        userId?: string;
-    }, ...remaining: unknown[]) => void;
-    getContext(): any;
+    getContext(): Context;
 }
 declare function create<T = Server>(config?: NileConfig): T;
 
@@ -563,15 +552,35 @@ type Opts = {
     basePath?: string;
     fetch?: typeof fetch;
 };
+type Context = {
+    headers: Headers;
+    tenantId: string | undefined | null;
+    userId: string | undefined | null;
+    preserveHeaders: boolean;
+};
+type PartialContext = {
+    headers?: null | Headers;
+    tenantId?: string | undefined | null;
+    userId?: string | undefined | null;
+    preserveHeaders?: boolean;
+};
+type ContextParams = PartialContext & {
+    ddl?: boolean;
+};
+type CTX = {
+    run: <T>(ctx: Partial<Context>, fn: () => T) => T;
+    get: () => Context;
+    set: (partial: Partial<PartialContext>) => void;
+    getLastUsed: () => Context;
+};
 type Any = any;
-type ExtensionResult = {
+type ExtensionResult<TParams> = {
     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;
-    onGetContext?: () => Any;
+    withContext?: (ctx: CTX) => Promise<void>;
+    onRequest?: (params: TParams, ctx: CTX) => void | Promise<void | RequestInit>;
+    onResponse?: (params: TParams, ctx: CTX) => void | Promise<void>;
+    onHandleRequest?: (params?: TParams) => RouteReturn | Promise<RouteReturn>;
+    onConfigure?: (params?: TParams) => void;
     replace?: {
         handlers: (handlers: NileHandlers) => Any;
     };
@@ -579,11 +588,12 @@ type ExtensionResult = {
 type NileHandlers = RouteFunctions & {
     withContext: CTXHandlerType;
 };
-type Extension = (instance: Server) => ExtensionResult;
+type Extension<TParams = Any> = (instance: Server) => ExtensionResult<TParams>;
 declare enum ExtensionState {
     onHandleRequest = "onHandleRequest",
     onRequest = "onRequest",
-    onResponse = "onResponse"
+    onResponse = "onResponse",
+    withContext = "withContext"
 }
 type NilePoolConfig = PoolConfig & {
     afterCreate?: AfterCreate;
@@ -802,4 +812,4 @@ 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 CTXHandlerType, type ContextReturn, 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 NileHandlers, 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 };
+export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CTX, type CTXHandlerType, type Context, type ContextParams, type ContextReturn, 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 NileHandlers, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type PartialContext, type Providers, type RouteFunctions, type RouteReturn, Server, TENANT_COOKIE, type Tenant, USER_COOKIE, type User, parseCSRF, parseCallback, parseResetToken, parseTenantId, parseToken };

package/dist/index.d.ts

@@ -6,6 +6,7 @@ type Loggable = {
     debug: LogFunction;
     warn: LogFunction;
     error: LogFunction;
+    silly: LogFunction;
 };
 type LogReturn = (prefixes?: string | string[]) => Loggable;
 
@@ -17,7 +18,7 @@ type ConfigurablePaths = {
 };
 type ExtensionReturns = void | Response | Request | ExtensionState;
 type ExtensionCtx = {
-    runExtensions: <T = ExtensionReturns>(toRun: ExtensionState, config: Config, params: any, _init?: RequestInit & {
+    runExtensions: <T = ExtensionReturns>(toRun: ExtensionState, config: Config, params?: any, _init?: RequestInit & {
         request: Request;
     }) => Promise<T>;
 };
@@ -31,18 +32,7 @@ declare class Config {
     extensionCtx: ExtensionCtx;
     extensions?: Extension[];
     logger: LogReturn;
-    /**
-     * Stores the set tenant id from Server for use in sub classes
-     */
-    tenantId: string | null | undefined;
-    /**
-     * Stores the set user id from Server for use in sub classes
-     */
-    userId: string | null | undefined;
-    /**
-     * Stores the headers to be used in `fetch` calls
-     */
-    headers: Headers;
+    context: PartialContext;
     /**
      * The nile-auth url
      */
@@ -522,6 +512,10 @@ declare function parseToken(headers?: Headers): string | undefined;
  * Internal helper for the password reset flow.
  */
 declare function parseResetToken(headers: Headers | void): string | void;
+/**
+ * Extract the tenantId cookie from a set of headers.
+ */
+declare function parseTenantId(headers?: Headers): string | null | undefined;
 
 declare class Server {
     #private;
@@ -534,28 +528,23 @@ declare class Server {
     };
     get logger(): LogReturn;
     get extensions(): {
-        remove: (id: string) => Promise<ExtensionResult[] | undefined>;
+        remove: (id: string) => Promise<ExtensionResult<any>[] | 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): this;
     get handlers(): NileHandlers;
     get paths(): ConfigurablePaths;
     set paths(paths: ConfigurablePaths);
+    /** Allows setting of context outside of the request lifecycle
+     * Basically means you want to disregard cookies and do everything manually
+     * If we elect to DDL, we don't want to use tenant id or user id, so remove those.
+     */
+    withContext(context?: ContextParams): Promise<this>;
+    withContext<T>(context: ContextParams, fn: (sdk: this) => Promise<T>): Promise<T>;
     /**
-     * Allow the setting of headers from a req or header object.
-     * Makes it possible to handle REST requests easily
-     * Also makes it easy to set user + tenant in some way
-     * @param req
-     * @returns undefined
+     *
+     * @returns the last used (basically global) context object, useful for debugging or making your own context
      */
-    setContext: (req: Request | Headers | Record<string, string> | unknown | {
-        tenantId?: string;
-        userId?: string;
-    }, ...remaining: unknown[]) => void;
-    getContext(): any;
+    getContext(): Context;
 }
 declare function create<T = Server>(config?: NileConfig): T;
 
@@ -563,15 +552,35 @@ type Opts = {
     basePath?: string;
     fetch?: typeof fetch;
 };
+type Context = {
+    headers: Headers;
+    tenantId: string | undefined | null;
+    userId: string | undefined | null;
+    preserveHeaders: boolean;
+};
+type PartialContext = {
+    headers?: null | Headers;
+    tenantId?: string | undefined | null;
+    userId?: string | undefined | null;
+    preserveHeaders?: boolean;
+};
+type ContextParams = PartialContext & {
+    ddl?: boolean;
+};
+type CTX = {
+    run: <T>(ctx: Partial<Context>, fn: () => T) => T;
+    get: () => Context;
+    set: (partial: Partial<PartialContext>) => void;
+    getLastUsed: () => Context;
+};
 type Any = any;
-type ExtensionResult = {
+type ExtensionResult<TParams> = {
     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;
-    onGetContext?: () => Any;
+    withContext?: (ctx: CTX) => Promise<void>;
+    onRequest?: (params: TParams, ctx: CTX) => void | Promise<void | RequestInit>;
+    onResponse?: (params: TParams, ctx: CTX) => void | Promise<void>;
+    onHandleRequest?: (params?: TParams) => RouteReturn | Promise<RouteReturn>;
+    onConfigure?: (params?: TParams) => void;
     replace?: {
         handlers: (handlers: NileHandlers) => Any;
     };
@@ -579,11 +588,12 @@ type ExtensionResult = {
 type NileHandlers = RouteFunctions & {
     withContext: CTXHandlerType;
 };
-type Extension = (instance: Server) => ExtensionResult;
+type Extension<TParams = Any> = (instance: Server) => ExtensionResult<TParams>;
 declare enum ExtensionState {
     onHandleRequest = "onHandleRequest",
     onRequest = "onRequest",
-    onResponse = "onResponse"
+    onResponse = "onResponse",
+    withContext = "withContext"
 }
 type NilePoolConfig = PoolConfig & {
     afterCreate?: AfterCreate;
@@ -802,4 +812,4 @@ 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 CTXHandlerType, type ContextReturn, 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 NileHandlers, 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 };
+export { type APIError, APIErrorErrorCodeEnum, type ActiveSession, type AfterCreate, type CTX, type CTXHandlerType, type Context, type ContextParams, type ContextReturn, 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 NileHandlers, type NilePoolConfig, type NileRequest, type NileResponse, type Opts, type PartialContext, type Providers, type RouteFunctions, type RouteReturn, Server, TENANT_COOKIE, type Tenant, USER_COOKIE, type User, parseCSRF, parseCallback, parseResetToken, parseTenantId, parseToken };