@technomoron/api-server-base 2.0.0-beta.22 → 2.0.0-beta.24

package/dist/esm/api-server-base.d.ts

@@ -4,27 +4,64 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Application, Request, Response, type ErrorRequestHandler, type RequestHandler } from 'express';
+import { type FastifyInstance, type FastifyReply, type FastifyRequest } from 'fastify';
 import { ApiModule } from './api-module.js';
+import { type ClientInfo } from './base/client-info.js';
 import { TokenStore, type JwtDecodeResult, type JwtSignPayload, type JwtSignResult, type JwtVerifyResult } from './token/base.js';
-import type { ApiAuthClass, ApiAuthType, ApiKey } from './api-module.js';
+import type { ApiAuthClass, ApiAuthType, ApiHandler, ApiKey } from './api-module.js';
 import type { AuthProviderModule } from './auth-api/module.js';
 import type { AuthAdapter, AuthIdentifier } from './auth-api/types.js';
-import type { OAuthStore } from './oauth/base.js';
 import type { AuthCodeData, AuthCodeRequest, OAuthClient } from './oauth/types.js';
-import type { PasskeyService } from './passkey/service.js';
 import type { PasskeyChallenge, PasskeyChallengeParams, StoredPasskeyCredential, PasskeyVerificationParams, PasskeyVerificationResult } from './passkey/types.js';
 import type { Token } from './token/types.js';
-import type { UserStore } from './user/base.js';
 import type { JwtPayload, SignOptions, VerifyOptions } from 'jsonwebtoken';
-export type { Application, Request, Response, NextFunction, Router } from 'express';
-export type { Multer } from 'multer';
 export type { JwtPayload, SignOptions, VerifyOptions } from 'jsonwebtoken';
-export interface ExtendedReq extends Request {
-    file?: Express.Multer.File;
-    files?: Express.Multer.File[] | {
-        [fieldname: string]: Express.Multer.File[];
+export type { ClientAgentProfile, ClientInfo } from './base/client-info.js';
+export interface ApiCookieOptions {
+    httpOnly?: boolean;
+    secure?: boolean;
+    sameSite?: 'lax' | 'strict' | 'none';
+    domain?: string;
+    path?: string;
+    maxAge?: number;
+    expires?: Date;
+}
+export interface ApiUploadedFile {
+    fieldname: string;
+    originalname: string;
+    encoding: string;
+    mimetype: string;
+    size?: number;
+    buffer?: Buffer;
+    filepath?: string;
+}
+export interface ExtendedReq {
+    method: string;
+    url: string;
+    originalUrl?: string;
+    headers: Record<string, string | string[] | undefined>;
+    query: Record<string, unknown>;
+    body: unknown;
+    params: Record<string, unknown>;
+    cookies?: Record<string, string>;
+    ip?: string;
+    ips?: string[];
+    socket?: {
+        remoteAddress?: string;
     };
+    protocol?: string;
+    file?: ApiUploadedFile;
+    files?: ApiUploadedFile[] | Record<string, ApiUploadedFile[]>;
+    apiReq?: ApiRequest;
+}
+export interface ApiResponse {
+    locals: Record<string, unknown>;
+    headersSent: boolean;
+    status: (code: number) => ApiResponse;
+    json: (payload: unknown) => void;
+    send: (payload: unknown) => void;
+    cookie: (name: string, value: string, options?: ApiCookieOptions) => void;
+    clearCookie: (name: string, options?: ApiCookieOptions) => void;
 }
 export interface ApiTokenData extends JwtPayload, Partial<Token> {
     uid: unknown;
@@ -35,12 +72,11 @@ export type ApiAuthMethod = 'bearer' | 'cookie' | 'param' | 'apikey' | null;
 export interface ApiRequest {
     server: ApiServer;
     req: ExtendedReq;
-    res: Response;
+    res: ApiResponse;
     tokenData?: ApiTokenData | null;
     token?: string;
     authToken?: Token | null;
     apiKey?: ApiKey | null;
-    /** How this request was authenticated. null when unauthenticated. */
     authMethod?: ApiAuthMethod;
     clientInfo?: ClientInfo;
     realUid?: AuthIdentifier | null;
@@ -50,32 +86,13 @@ export interface ApiRequest {
     getRealUid: () => AuthIdentifier | null;
     isImpersonating: () => boolean;
 }
-export interface ExpressApiRequest extends ExtendedReq {
-    apiReq?: ApiRequest;
-}
+export type ExpressApiRequest = ExtendedReq;
 export interface ExpressApiLocals {
     apiReq?: ApiRequest;
 }
-export interface ClientAgentProfile {
-    ua: string;
-    browser: string;
-    os: string;
-    device: string;
-}
-export interface ClientInfo extends ClientAgentProfile {
-    ip: string | null;
-    ipchain: string[];
-}
-export interface ApiServerAuthStores {
-    userStore: UserStore<unknown, unknown>;
-    tokenStore: TokenStore;
-    passkeyService?: PasskeyService;
-    oauthStore?: OAuthStore;
-    canImpersonate?: (params: {
-        realUserId: AuthIdentifier;
-        effectiveUserId: AuthIdentifier;
-    }) => boolean | Promise<boolean>;
-}
+type CompatNext = (error?: unknown) => void;
+type CompatRequestHandler = (req: ExtendedReq, res: ApiResponse, next: CompatNext) => unknown;
+type CompatErrorHandler = (err: unknown, req: ExtendedReq, res: ApiResponse, next: CompatNext) => unknown;
 export { ApiModule } from './api-module.js';
 export type { ApiHandler, ApiAuthType, ApiAuthClass, ApiRoute, ApiKey } from './api-module.js';
 export interface ApiErrorParams {
@@ -103,32 +120,14 @@ export interface ApiServerConf {
     swaggerPath?: string;
     accessSecret: string;
     refreshSecret: string;
-    /** Cookie domain for auth cookies. Prefer leaving empty for localhost/development. */
     cookieDomain: string;
-    /** Cookie path for auth cookies. */
     cookiePath?: string;
-    /** Cookie SameSite attribute for auth cookies. */
     cookieSameSite?: 'lax' | 'strict' | 'none';
-    /**
-     * Cookie Secure attribute for auth cookies.
-     * - true: always secure
-     * - false: never secure
-     * - 'auto': secure when request is HTTPS (or forwarded as HTTPS)
-     */
     cookieSecure?: boolean | 'auto';
-    /** Cookie HttpOnly attribute for auth cookies. */
     cookieHttpOnly?: boolean;
-    /** Prefix used for API keys in Authorization Bearer tokens. */
     apiKeyPrefix: string;
-    /**
-     * Enable API key authentication on non-apikey routes (e.g. 'yes', 'strict', 'maybe').
-     * When false (default), API key lookups only run on routes with authType 'apikey'.
-     * Set to true if you need API keys to authenticate on JWT routes as well.
-     */
     apiKeyEnabled: boolean;
-    /** Optional request field name used to read auth tokens when Bearer is missing. */
     tokenParam: string;
-    /** Where to read `tokenParam` from. */
     tokenParamLocation: 'body' | 'query' | 'body-query';
     accessCookie: string;
     refreshCookie: string;
@@ -143,60 +142,51 @@ export interface ApiServerConf {
     apiVersion: string;
     minClientVersion: string;
     tokenStore?: TokenStore;
-    authStores?: ApiServerAuthStores;
     onStartError?: (error: Error) => void;
+    /**
+     * Controls trust in proxy headers (X-Forwarded-For, Forwarded, X-Real-IP).
+     * - `true` (default): trust all forwarded headers
+     * - `false`: only use the socket address, ignore forwarded headers
+     * - number: trust that many rightmost forwarded entries (e.g., 1 = one reverse proxy)
+     */
+    trustProxy: boolean | number;
 }
+/** Core Fastify-based API server with module mounting and auth integration hooks. */
 export declare class ApiServer {
-    app: Application;
+    readonly app: ((req: import('node:http').IncomingMessage, res: import('node:http').ServerResponse) => void) & {
+        listen: (...args: unknown[]) => import('node:http').Server;
+    };
+    readonly fastify: FastifyInstance;
     readonly config: ApiServerConf;
     readonly startedAt: number;
     private readonly apiBasePath;
-    private readonly apiRouter;
     private finalized;
     private storageAdapter;
     private moduleAdapter;
-    private serverAuthAdapter;
-    private apiNotFoundHandler;
     private apiErrorHandlerInstalled;
     private tokenStoreAdapter;
-    private userStoreAdapter;
-    private passkeyServiceAdapter;
-    private oauthStoreAdapter;
-    private canImpersonateAdapter;
     private readonly jwtHelper;
+    private compatGlobalErrorHandler;
+    private readonly readyPromise;
     private currReqDeprecationWarned;
-    /**
-     * @deprecated ApiServer does not track a global "current request". This value is always null.
-     * Use the per-request ApiRequest passed to handlers, or `req.apiReq` / `res.locals.apiReq`
-     * when mounting raw Express endpoints.
-     */
     get currReq(): ApiRequest | null;
     set currReq(_value: ApiRequest | null);
     constructor(config?: Partial<ApiServerConf>);
+    private setupRuntime;
+    private readRawBody;
+    private parseRawBody;
     private assertNotFinalized;
-    private toApiRouterPath;
     finalize(): this;
     authStorage<UserRow, SafeUser>(storage: AuthAdapter<UserRow, SafeUser>): this;
-    /**
-     * @deprecated Use {@link ApiServer.authStorage} instead.
-     */
     useAuthStorage<UserRow, SafeUser>(storage: AuthAdapter<UserRow, SafeUser>): this;
     authModule<UserRow>(module: AuthProviderModule<UserRow>): this;
-    /**
-     * @deprecated Use {@link ApiServer.authModule} instead.
-     */
     useAuthModule<UserRow>(module: AuthProviderModule<UserRow>): this;
     getAuthStorage<UserRow = unknown, SafeUser = unknown>(): AuthAdapter<UserRow, SafeUser>;
     getAuthModule<UserRow = unknown>(): AuthProviderModule<UserRow>;
     setTokenStore(store: TokenStore): this;
     getTokenStore(): TokenStore | null;
-    private ensureUserStore;
-    private ensureTokenStore;
-    private ensurePasskeyService;
     listUserCredentials(userId: AuthIdentifier): Promise<StoredPasskeyCredential[]>;
     deletePasskeyCredential(credentialId: Buffer | string): Promise<boolean>;
-    private ensureOAuthStore;
-    private getServerAuthAdapter;
     getUser(identifier: AuthIdentifier): Promise<unknown | null>;
     getUserPasswordHash(user: unknown): string;
     getUserId(user: unknown): AuthIdentifier;
@@ -236,17 +226,29 @@ export declare class ApiServer {
     }): Promise<boolean>;
     guessExceptionText(error: unknown, defMsg?: string): string;
     protected authorize(apiReq: ApiRequest, requiredClass: ApiAuthClass): Promise<void>;
-    private middlewares;
+    /**
+     * Authenticate and authorise an incoming Fastify request outside of the
+     * standard `defineRoutes` pipeline (e.g. TUS upload routes that need full
+     * control over their own response format).
+     *
+     * Throws `ApiError` on auth failure — callers should catch it and respond
+     * with the appropriate HTTP status code.
+     */
+    resolveRequest(request: FastifyRequest, reply: FastifyReply, auth: {
+        type: ApiAuthType;
+        req?: ApiAuthClass;
+    }): Promise<ApiRequest>;
     private installStaticDirs;
     private installPingHandler;
     private loadSwaggerSpec;
+    private readPackageVersion;
     private installSwaggerHandler;
     private normalizeApiBasePath;
     private installApiNotFoundHandler;
     private installApiErrorHandler;
-    private describeMissingEndpoint;
     start(): this;
     private internalServerErrorMessage;
+    private logUnhandledError;
     private verifyJWT;
     private jwtCookieOptions;
     private setAccessCookie;
@@ -261,16 +263,24 @@ export declare class ApiServer {
     private normalizeAuthIdentifier;
     private extractTokenUserId;
     private resolveRealUserId;
-    useExpress(path: string, ...handlers: Array<RequestHandler | ErrorRequestHandler>): this;
-    useExpress(...handlers: Array<RequestHandler | ErrorRequestHandler>): this;
+    private toExtendedReq;
     private createApiRequest;
+    useExpress(path: string, ...handlers: Array<CompatRequestHandler | CompatErrorHandler>): this;
+    useExpress(...handlers: Array<CompatRequestHandler | CompatErrorHandler>): this;
+    private runCompatHandlers;
+    private runCompatErrorHandlers;
     expressAuth(auth: {
         type: ApiAuthType;
         req: ApiAuthClass;
-    }): RequestHandler;
-    expressErrorHandler(): ErrorRequestHandler;
-    private handle_request;
+    }): CompatRequestHandler;
+    expressErrorHandler(): CompatErrorHandler;
+    private handleRequest;
+    protected handle_request(handler: ApiHandler, auth: {
+        type: ApiAuthType;
+        req: ApiAuthClass;
+    }): (req: ExtendedReq, res: ApiResponse, next: (error?: unknown) => void) => Promise<void>;
     api<T extends ApiModule<unknown>>(module: T): this;
+    private joinRoutePath;
     dumpRequest(apiReq: ApiRequest): void;
     private formatDebugValue;
     dumpResponse(apiReq: ApiRequest, payload: unknown, status: number): void;