fauxbase 0.1.2 → 0.4.0

package/dist/index.d.cts

@@ -48,12 +48,19 @@ interface FieldOptions {
 }
 interface LocalDriverConfig {
     type: 'local';
-    persist?: 'memory' | 'localStorage';
+    persist?: 'memory' | 'localStorage' | 'indexeddb';
+    dbName?: string;
 }
 interface HttpDriverConfig {
     type: 'http';
     baseUrl: string;
     preset?: string;
+    timeout?: number;
+    retry?: {
+        maxRetries?: number;
+        baseDelay?: number;
+    };
+    headers?: Record<string, string>;
 }
 type DriverConfig = LocalDriverConfig | HttpDriverConfig;
 interface SeedDefinition<T = any> {
@@ -81,6 +88,22 @@ declare class ValidationError extends FauxbaseError {
 declare class ForbiddenError extends FauxbaseError {
     constructor(message?: string);
 }
+declare class NetworkError extends FauxbaseError {
+    constructor(message?: string);
+}
+declare class TimeoutError extends FauxbaseError {
+    constructor(message?: string);
+}
+declare class HttpError extends FauxbaseError {
+    readonly status: number;
+    constructor(message: string, status: number, details?: Record<string, string>);
+    toJSON(): {
+        status: number;
+        error: string;
+        code: string;
+        details?: Record<string, string>;
+    };
+}
 
 declare abstract class Entity {
     id: string;
@@ -129,8 +152,11 @@ declare abstract class Service<T extends Entity> {
     abstract endpoint: string;
     protected driver: Driver;
     protected resourceName: string;
+    protected client: any;
     /** @internal — called by createClient to wire the service */
     _init(driver: Driver, resourceName: string): void;
+    /** @internal — called by createClient to give services access to the client */
+    _setClient(client: any): void;
     list(query?: QueryParams): Promise<PagedResponse<T>>;
     get(id: string): Promise<ApiResponse<T>>;
     create(data: Partial<T>): Promise<ApiResponse<T>>;
@@ -150,15 +176,212 @@ declare abstract class Service<T extends Entity> {
     private runHooks;
 }
 
+type AuthProvider$1 = () => {
+    token: string;
+} | null;
+interface HttpDriverOptions extends HttpDriverConfig {
+    timeout?: number;
+    retry?: {
+        maxRetries?: number;
+        baseDelay?: number;
+    };
+    headers?: Record<string, string>;
+}
+declare class HttpDriver implements Driver {
+    private baseUrl;
+    private preset;
+    private timeout;
+    private maxRetries;
+    private baseDelay;
+    private defaultHeaders;
+    private endpoints;
+    private authProvider;
+    constructor(config: HttpDriverOptions);
+    setAuthProvider(provider: AuthProvider$1): void;
+    registerEndpoint(resource: string, endpoint: string): void;
+    private getEndpoint;
+    private buildUrl;
+    private buildHeaders;
+    private request;
+    private throwMappedError;
+    list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
+    get<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    create<T>(resource: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    update<T>(resource: string, id: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    delete<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    count(resource: string, filter?: Record<string, any>): Promise<number>;
+    bulkCreate<T>(resource: string, data: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+    bulkUpdate<T>(resource: string, updates: Array<{
+        id: string;
+        data: Partial<T>;
+    }>): Promise<ApiResponse<T[]>>;
+    bulkDelete(resource: string, ids: string[]): Promise<ApiResponse<{
+        count: number;
+    }>>;
+    seed(): void;
+    getSeedVersion(): string | null;
+    setSeedVersion(): void;
+    clear(): void;
+}
+
+interface LoginCredentials {
+    email: string;
+    password: string;
+}
+interface AuthState {
+    userId: string;
+    email: string;
+    userName?: string;
+    role?: string;
+    token: string;
+}
+interface AuthContext {
+    userId: string;
+    userName?: string;
+}
+declare abstract class AuthService<T extends Entity> extends Service<T> {
+    private authState;
+    private saveState;
+    private httpDriver;
+    /** @internal — called by createClient to wire persistence */
+    _initAuth(loadState: () => AuthState | null, saveState: (state: AuthState | null) => void): void;
+    /** @internal — called by createClient when using HttpDriver */
+    _setHttpMode(driver: HttpDriver): void;
+    login(credentials: LoginCredentials): Promise<T>;
+    register(data: Partial<T>): Promise<T>;
+    logout(): void;
+    get currentUser(): T | null;
+    get isLoggedIn(): boolean;
+    get token(): string | null;
+    hasRole(role: string): boolean;
+    getAuthContext(): AuthContext | null;
+    private localLogin;
+    private localRegister;
+    private httpLogin;
+    private httpRegister;
+    private generateToken;
+    private persistState;
+}
+
 type ClientServices<S extends Record<string, new (...args: any[]) => Service<any>>> = {
     [K in keyof S]: InstanceType<S[K]>;
 };
-declare function createClient<S extends Record<string, new (...args: any[]) => Service<any>>>(config: {
+type ClientResult<S extends Record<string, new (...args: any[]) => Service<any>>, A extends (new (...args: any[]) => AuthService<any>) | undefined> = ClientServices<S> & (A extends new (...args: any[]) => AuthService<any> ? {
+    auth: InstanceType<A>;
+} : {}) & {
+    readonly ready: Promise<void>;
+};
+declare function createClient<S extends Record<string, new (...args: any[]) => Service<any>>, A extends (new (...args: any[]) => AuthService<any>) | undefined = undefined>(config: {
     driver?: DriverConfig;
     services: S;
     seeds?: SeedDefinition[];
-}): ClientServices<S>;
+    auth?: A;
+    overrides?: Record<string, {
+        driver: DriverConfig;
+    }>;
+}): ClientResult<S, A>;
 
 declare function seed<T>(entityClass: new (...args: any[]) => T, data: Array<Partial<T>>): SeedDefinition<T>;
 
-export { type ApiResponse, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, FauxbaseError, type FauxbaseErrorPayload, type FieldOptions, type FilterOperator, ForbiddenError, type HookType, type HttpDriverConfig, type LocalDriverConfig, NotFoundError, type PageMeta, type PagedResponse, type QueryParams, type SeedDefinition, Service, type SortParams, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, field, relation, seed };
+interface StorageBackend {
+    getAll(resource: string): Record<string, any>[];
+    getById(resource: string, id: string): Record<string, any> | undefined;
+    set(resource: string, id: string, data: Record<string, any>): void;
+    remove(resource: string, id: string): void;
+    clear(resource: string): void;
+    getMeta(key: string): string | null;
+    setMeta(key: string, value: string): void;
+}
+type AuthProvider = () => {
+    userId: string;
+    userName?: string;
+} | null;
+declare class LocalDriver implements Driver {
+    private storage;
+    private entityClasses;
+    private authProvider;
+    private _ready;
+    private _isReady;
+    constructor(config: LocalDriverConfig);
+    get ready(): Promise<void>;
+    get isReady(): boolean;
+    setAuthProvider(provider: AuthProvider): void;
+    getStorageBackend(): StorageBackend;
+    registerEntity(resource: string, entityClass: Function): void;
+    list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
+    get<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    create<T>(resource: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    update<T>(resource: string, id: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    delete<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    count(resource: string, filter?: Record<string, any>): Promise<number>;
+    bulkCreate<T>(resource: string, data: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+    bulkUpdate<T>(resource: string, updates: Array<{
+        id: string;
+        data: Partial<T>;
+    }>): Promise<ApiResponse<T[]>>;
+    bulkDelete(resource: string, ids: string[]): Promise<ApiResponse<{
+        count: number;
+    }>>;
+    seed(resource: string, data: Array<Record<string, any>>, entityClass: Function): void;
+    getSeedVersion(): string | null;
+    setSeedVersion(version: string): void;
+    clear(resource: string): void;
+}
+
+type FilterStyle = 'django' | 'dot' | 'bracket' | 'nestjs';
+interface Preset {
+    name: string;
+    response: {
+        single: (raw: any) => {
+            data: any;
+        };
+        list: (raw: any) => {
+            items: any[];
+            meta: Record<string, any>;
+        };
+        error: (raw: any) => {
+            error: string;
+            code: string;
+            details?: Record<string, string>;
+        };
+    };
+    meta: {
+        page: string;
+        size: string;
+        totalItems: string;
+        totalPages: string;
+    };
+    query: {
+        filterStyle: FilterStyle;
+        pageParam: string;
+        sizeParam: string;
+        sortParam?: string;
+        sortFormat: string;
+        pageOffset?: number;
+    };
+    auth: {
+        loginUrl: string;
+        registerUrl: string;
+        logoutUrl?: string;
+        tokenField: string;
+        userField: string;
+        headerFormat: string;
+    };
+}
+declare function definePreset(config: Preset): Preset;
+
+declare const defaultPreset: Preset;
+
+declare const springBootPreset: Preset;
+
+declare const laravelPreset: Preset;
+
+declare const djangoPreset: Preset;
+
+declare const nestjsPreset: Preset;
+
+declare const expressPreset: Preset;
+
+declare function getPreset(name: string): Preset;
+
+export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, FauxbaseError, type FauxbaseErrorPayload, type FieldOptions, type FilterOperator, type FilterStyle, ForbiddenError, type HookType, HttpDriver, type HttpDriverConfig, HttpError, LocalDriver, type LocalDriverConfig, type LoginCredentials, NetworkError, NotFoundError, type PageMeta, type PagedResponse, type Preset, type QueryParams, type SeedDefinition, Service, type SortParams, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };

package/dist/index.d.ts

@@ -48,12 +48,19 @@ interface FieldOptions {
 }
 interface LocalDriverConfig {
     type: 'local';
-    persist?: 'memory' | 'localStorage';
+    persist?: 'memory' | 'localStorage' | 'indexeddb';
+    dbName?: string;
 }
 interface HttpDriverConfig {
     type: 'http';
     baseUrl: string;
     preset?: string;
+    timeout?: number;
+    retry?: {
+        maxRetries?: number;
+        baseDelay?: number;
+    };
+    headers?: Record<string, string>;
 }
 type DriverConfig = LocalDriverConfig | HttpDriverConfig;
 interface SeedDefinition<T = any> {
@@ -81,6 +88,22 @@ declare class ValidationError extends FauxbaseError {
 declare class ForbiddenError extends FauxbaseError {
     constructor(message?: string);
 }
+declare class NetworkError extends FauxbaseError {
+    constructor(message?: string);
+}
+declare class TimeoutError extends FauxbaseError {
+    constructor(message?: string);
+}
+declare class HttpError extends FauxbaseError {
+    readonly status: number;
+    constructor(message: string, status: number, details?: Record<string, string>);
+    toJSON(): {
+        status: number;
+        error: string;
+        code: string;
+        details?: Record<string, string>;
+    };
+}
 
 declare abstract class Entity {
     id: string;
@@ -129,8 +152,11 @@ declare abstract class Service<T extends Entity> {
     abstract endpoint: string;
     protected driver: Driver;
     protected resourceName: string;
+    protected client: any;
     /** @internal — called by createClient to wire the service */
     _init(driver: Driver, resourceName: string): void;
+    /** @internal — called by createClient to give services access to the client */
+    _setClient(client: any): void;
     list(query?: QueryParams): Promise<PagedResponse<T>>;
     get(id: string): Promise<ApiResponse<T>>;
     create(data: Partial<T>): Promise<ApiResponse<T>>;
@@ -150,15 +176,212 @@ declare abstract class Service<T extends Entity> {
     private runHooks;
 }
 
+type AuthProvider$1 = () => {
+    token: string;
+} | null;
+interface HttpDriverOptions extends HttpDriverConfig {
+    timeout?: number;
+    retry?: {
+        maxRetries?: number;
+        baseDelay?: number;
+    };
+    headers?: Record<string, string>;
+}
+declare class HttpDriver implements Driver {
+    private baseUrl;
+    private preset;
+    private timeout;
+    private maxRetries;
+    private baseDelay;
+    private defaultHeaders;
+    private endpoints;
+    private authProvider;
+    constructor(config: HttpDriverOptions);
+    setAuthProvider(provider: AuthProvider$1): void;
+    registerEndpoint(resource: string, endpoint: string): void;
+    private getEndpoint;
+    private buildUrl;
+    private buildHeaders;
+    private request;
+    private throwMappedError;
+    list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
+    get<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    create<T>(resource: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    update<T>(resource: string, id: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    delete<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    count(resource: string, filter?: Record<string, any>): Promise<number>;
+    bulkCreate<T>(resource: string, data: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+    bulkUpdate<T>(resource: string, updates: Array<{
+        id: string;
+        data: Partial<T>;
+    }>): Promise<ApiResponse<T[]>>;
+    bulkDelete(resource: string, ids: string[]): Promise<ApiResponse<{
+        count: number;
+    }>>;
+    seed(): void;
+    getSeedVersion(): string | null;
+    setSeedVersion(): void;
+    clear(): void;
+}
+
+interface LoginCredentials {
+    email: string;
+    password: string;
+}
+interface AuthState {
+    userId: string;
+    email: string;
+    userName?: string;
+    role?: string;
+    token: string;
+}
+interface AuthContext {
+    userId: string;
+    userName?: string;
+}
+declare abstract class AuthService<T extends Entity> extends Service<T> {
+    private authState;
+    private saveState;
+    private httpDriver;
+    /** @internal — called by createClient to wire persistence */
+    _initAuth(loadState: () => AuthState | null, saveState: (state: AuthState | null) => void): void;
+    /** @internal — called by createClient when using HttpDriver */
+    _setHttpMode(driver: HttpDriver): void;
+    login(credentials: LoginCredentials): Promise<T>;
+    register(data: Partial<T>): Promise<T>;
+    logout(): void;
+    get currentUser(): T | null;
+    get isLoggedIn(): boolean;
+    get token(): string | null;
+    hasRole(role: string): boolean;
+    getAuthContext(): AuthContext | null;
+    private localLogin;
+    private localRegister;
+    private httpLogin;
+    private httpRegister;
+    private generateToken;
+    private persistState;
+}
+
 type ClientServices<S extends Record<string, new (...args: any[]) => Service<any>>> = {
     [K in keyof S]: InstanceType<S[K]>;
 };
-declare function createClient<S extends Record<string, new (...args: any[]) => Service<any>>>(config: {
+type ClientResult<S extends Record<string, new (...args: any[]) => Service<any>>, A extends (new (...args: any[]) => AuthService<any>) | undefined> = ClientServices<S> & (A extends new (...args: any[]) => AuthService<any> ? {
+    auth: InstanceType<A>;
+} : {}) & {
+    readonly ready: Promise<void>;
+};
+declare function createClient<S extends Record<string, new (...args: any[]) => Service<any>>, A extends (new (...args: any[]) => AuthService<any>) | undefined = undefined>(config: {
     driver?: DriverConfig;
     services: S;
     seeds?: SeedDefinition[];
-}): ClientServices<S>;
+    auth?: A;
+    overrides?: Record<string, {
+        driver: DriverConfig;
+    }>;
+}): ClientResult<S, A>;
 
 declare function seed<T>(entityClass: new (...args: any[]) => T, data: Array<Partial<T>>): SeedDefinition<T>;
 
-export { type ApiResponse, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, FauxbaseError, type FauxbaseErrorPayload, type FieldOptions, type FilterOperator, ForbiddenError, type HookType, type HttpDriverConfig, type LocalDriverConfig, NotFoundError, type PageMeta, type PagedResponse, type QueryParams, type SeedDefinition, Service, type SortParams, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, field, relation, seed };
+interface StorageBackend {
+    getAll(resource: string): Record<string, any>[];
+    getById(resource: string, id: string): Record<string, any> | undefined;
+    set(resource: string, id: string, data: Record<string, any>): void;
+    remove(resource: string, id: string): void;
+    clear(resource: string): void;
+    getMeta(key: string): string | null;
+    setMeta(key: string, value: string): void;
+}
+type AuthProvider = () => {
+    userId: string;
+    userName?: string;
+} | null;
+declare class LocalDriver implements Driver {
+    private storage;
+    private entityClasses;
+    private authProvider;
+    private _ready;
+    private _isReady;
+    constructor(config: LocalDriverConfig);
+    get ready(): Promise<void>;
+    get isReady(): boolean;
+    setAuthProvider(provider: AuthProvider): void;
+    getStorageBackend(): StorageBackend;
+    registerEntity(resource: string, entityClass: Function): void;
+    list<T>(resource: string, query: QueryParams): Promise<PagedResponse<T>>;
+    get<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    create<T>(resource: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    update<T>(resource: string, id: string, data: Partial<T>): Promise<ApiResponse<T>>;
+    delete<T>(resource: string, id: string): Promise<ApiResponse<T>>;
+    count(resource: string, filter?: Record<string, any>): Promise<number>;
+    bulkCreate<T>(resource: string, data: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+    bulkUpdate<T>(resource: string, updates: Array<{
+        id: string;
+        data: Partial<T>;
+    }>): Promise<ApiResponse<T[]>>;
+    bulkDelete(resource: string, ids: string[]): Promise<ApiResponse<{
+        count: number;
+    }>>;
+    seed(resource: string, data: Array<Record<string, any>>, entityClass: Function): void;
+    getSeedVersion(): string | null;
+    setSeedVersion(version: string): void;
+    clear(resource: string): void;
+}
+
+type FilterStyle = 'django' | 'dot' | 'bracket' | 'nestjs';
+interface Preset {
+    name: string;
+    response: {
+        single: (raw: any) => {
+            data: any;
+        };
+        list: (raw: any) => {
+            items: any[];
+            meta: Record<string, any>;
+        };
+        error: (raw: any) => {
+            error: string;
+            code: string;
+            details?: Record<string, string>;
+        };
+    };
+    meta: {
+        page: string;
+        size: string;
+        totalItems: string;
+        totalPages: string;
+    };
+    query: {
+        filterStyle: FilterStyle;
+        pageParam: string;
+        sizeParam: string;
+        sortParam?: string;
+        sortFormat: string;
+        pageOffset?: number;
+    };
+    auth: {
+        loginUrl: string;
+        registerUrl: string;
+        logoutUrl?: string;
+        tokenField: string;
+        userField: string;
+        headerFormat: string;
+    };
+}
+declare function definePreset(config: Preset): Preset;
+
+declare const defaultPreset: Preset;
+
+declare const springBootPreset: Preset;
+
+declare const laravelPreset: Preset;
+
+declare const djangoPreset: Preset;
+
+declare const nestjsPreset: Preset;
+
+declare const expressPreset: Preset;
+
+declare function getPreset(name: string): Preset;
+
+export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, FauxbaseError, type FauxbaseErrorPayload, type FieldOptions, type FilterOperator, type FilterStyle, ForbiddenError, type HookType, HttpDriver, type HttpDriverConfig, HttpError, LocalDriver, type LocalDriverConfig, type LoginCredentials, NetworkError, NotFoundError, type PageMeta, type PagedResponse, type Preset, type QueryParams, type SeedDefinition, Service, type SortParams, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };