fauxbase 0.4.0 → 0.5.0

package/dist/index.d.cts

@@ -143,6 +143,51 @@ interface Driver {
     clear(resource: string): void;
 }
 
+type EventAction = 'created' | 'updated' | 'deleted' | 'bulkCreated' | 'bulkUpdated' | 'bulkDeleted';
+interface FauxbaseEvent<T = any> {
+    action: EventAction;
+    resource: string;
+    data?: T;
+    id?: string;
+    ids?: string[];
+    timestamp: number;
+    source: 'local' | 'remote';
+}
+type EventHandler<T = any> = (event: FauxbaseEvent<T>) => void;
+interface EventSourceAdapter {
+    connect(): void;
+    disconnect(): void;
+}
+interface SSEConfig {
+    type: 'sse';
+    url: string;
+    eventMap: Record<string, string>;
+    withCredentials?: boolean;
+}
+interface STOMPConfig {
+    type: 'stomp';
+    brokerUrl: string;
+    subscriptions: Record<string, string>;
+    connectHeaders?: Record<string, string>;
+}
+type EventSourceConfig = SSEConfig | STOMPConfig;
+interface EventHandlersConfig {
+    [resource: string]: EventHandler;
+}
+type EventsConfig = true | {
+    source?: EventSourceConfig;
+    handlers?: EventHandlersConfig;
+};
+
+declare class EventBus {
+    private listeners;
+    private anyListeners;
+    on(resource: string, handler: EventHandler): () => void;
+    onAny(handler: EventHandler): () => void;
+    emit(event: FauxbaseEvent): void;
+    destroy(): void;
+}
+
 declare function beforeCreate(): MethodDecorator;
 declare function beforeUpdate(): MethodDecorator;
 declare function afterCreate(): MethodDecorator;
@@ -153,6 +198,8 @@ declare abstract class Service<T extends Entity> {
     protected driver: Driver;
     protected resourceName: string;
     protected client: any;
+    /** @internal */
+    _eventBus?: EventBus;
     /** @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 */
@@ -164,15 +211,16 @@ declare abstract class Service<T extends Entity> {
     delete(id: string): Promise<ApiResponse<T>>;
     count(filter?: Record<string, any>): Promise<number>;
     get bulk(): {
-        create: (items: Array<Partial<T>>) => Promise<ApiResponse<T[]>>;
-        update: (updates: Array<{
+        create(items: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+        update(updates: Array<{
             id: string;
             data: Partial<T>;
-        }>) => Promise<ApiResponse<T[]>>;
-        delete: (ids: string[]) => Promise<ApiResponse<{
+        }>): Promise<ApiResponse<T[]>>;
+        delete(ids: string[]): Promise<ApiResponse<{
             count: number;
         }>>;
     };
+    private emitEvent;
     private runHooks;
 }
 
@@ -270,6 +318,9 @@ type ClientResult<S extends Record<string, new (...args: any[]) => Service<any>>
     auth: InstanceType<A>;
 } : {}) & {
     readonly ready: Promise<void>;
+} & {
+    _eventBus?: EventBus;
+    disconnect?: () => 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;
@@ -279,6 +330,7 @@ declare function createClient<S extends Record<string, new (...args: any[]) => S
     overrides?: Record<string, {
         driver: DriverConfig;
     }>;
+    events?: EventsConfig;
 }): ClientResult<S, A>;
 
 declare function seed<T>(entityClass: new (...args: any[]) => T, data: Array<Partial<T>>): SeedDefinition<T>;
@@ -384,4 +436,4 @@ 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 };
+export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, type EventAction, EventBus, type EventHandler, type EventHandlersConfig, type EventSourceAdapter, type EventSourceConfig, type EventsConfig, FauxbaseError, type FauxbaseErrorPayload, type FauxbaseEvent, 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 SSEConfig, type STOMPConfig, 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

@@ -143,6 +143,51 @@ interface Driver {
     clear(resource: string): void;
 }
 
+type EventAction = 'created' | 'updated' | 'deleted' | 'bulkCreated' | 'bulkUpdated' | 'bulkDeleted';
+interface FauxbaseEvent<T = any> {
+    action: EventAction;
+    resource: string;
+    data?: T;
+    id?: string;
+    ids?: string[];
+    timestamp: number;
+    source: 'local' | 'remote';
+}
+type EventHandler<T = any> = (event: FauxbaseEvent<T>) => void;
+interface EventSourceAdapter {
+    connect(): void;
+    disconnect(): void;
+}
+interface SSEConfig {
+    type: 'sse';
+    url: string;
+    eventMap: Record<string, string>;
+    withCredentials?: boolean;
+}
+interface STOMPConfig {
+    type: 'stomp';
+    brokerUrl: string;
+    subscriptions: Record<string, string>;
+    connectHeaders?: Record<string, string>;
+}
+type EventSourceConfig = SSEConfig | STOMPConfig;
+interface EventHandlersConfig {
+    [resource: string]: EventHandler;
+}
+type EventsConfig = true | {
+    source?: EventSourceConfig;
+    handlers?: EventHandlersConfig;
+};
+
+declare class EventBus {
+    private listeners;
+    private anyListeners;
+    on(resource: string, handler: EventHandler): () => void;
+    onAny(handler: EventHandler): () => void;
+    emit(event: FauxbaseEvent): void;
+    destroy(): void;
+}
+
 declare function beforeCreate(): MethodDecorator;
 declare function beforeUpdate(): MethodDecorator;
 declare function afterCreate(): MethodDecorator;
@@ -153,6 +198,8 @@ declare abstract class Service<T extends Entity> {
     protected driver: Driver;
     protected resourceName: string;
     protected client: any;
+    /** @internal */
+    _eventBus?: EventBus;
     /** @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 */
@@ -164,15 +211,16 @@ declare abstract class Service<T extends Entity> {
     delete(id: string): Promise<ApiResponse<T>>;
     count(filter?: Record<string, any>): Promise<number>;
     get bulk(): {
-        create: (items: Array<Partial<T>>) => Promise<ApiResponse<T[]>>;
-        update: (updates: Array<{
+        create(items: Array<Partial<T>>): Promise<ApiResponse<T[]>>;
+        update(updates: Array<{
             id: string;
             data: Partial<T>;
-        }>) => Promise<ApiResponse<T[]>>;
-        delete: (ids: string[]) => Promise<ApiResponse<{
+        }>): Promise<ApiResponse<T[]>>;
+        delete(ids: string[]): Promise<ApiResponse<{
             count: number;
         }>>;
     };
+    private emitEvent;
     private runHooks;
 }
 
@@ -270,6 +318,9 @@ type ClientResult<S extends Record<string, new (...args: any[]) => Service<any>>
     auth: InstanceType<A>;
 } : {}) & {
     readonly ready: Promise<void>;
+} & {
+    _eventBus?: EventBus;
+    disconnect?: () => 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;
@@ -279,6 +330,7 @@ declare function createClient<S extends Record<string, new (...args: any[]) => S
     overrides?: Record<string, {
         driver: DriverConfig;
     }>;
+    events?: EventsConfig;
 }): ClientResult<S, A>;
 
 declare function seed<T>(entityClass: new (...args: any[]) => T, data: Array<Partial<T>>): SeedDefinition<T>;
@@ -384,4 +436,4 @@ 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 };
+export { type ApiResponse, type AuthContext, AuthService, type AuthState, type BaseFields, ConflictError, type Driver, type DriverConfig, Entity, type EventAction, EventBus, type EventHandler, type EventHandlersConfig, type EventSourceAdapter, type EventSourceConfig, type EventsConfig, FauxbaseError, type FauxbaseErrorPayload, type FauxbaseEvent, 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 SSEConfig, type STOMPConfig, 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.js

@@ -181,6 +181,8 @@ var Service = class {
   driver;
   resourceName;
   client;
+  /** @internal */
+  _eventBus;
   /** @internal — called by createClient to wire the service */
   _init(driver, resourceName) {
     this.driver = driver;
@@ -201,27 +203,56 @@ var Service = class {
     await this.runHooks("beforeCreate", data, allItems);
     const result = await this.driver.create(this.resourceName, data);
     await this.runHooks("afterCreate", result.data);
+    this.emitEvent("created", { data: result.data, id: result.data.id });
     return result;
   }
   async update(id, data) {
     await this.runHooks("beforeUpdate", id, data);
     const result = await this.driver.update(this.resourceName, id, data);
     await this.runHooks("afterUpdate", result.data);
+    this.emitEvent("updated", { data: result.data, id });
     return result;
   }
   async delete(id) {
-    return this.driver.delete(this.resourceName, id);
+    const result = await this.driver.delete(this.resourceName, id);
+    this.emitEvent("deleted", { data: result.data, id });
+    return result;
   }
   async count(filter) {
     return this.driver.count(this.resourceName, filter);
   }
   get bulk() {
+    const self = this;
     return {
-      create: (items) => this.driver.bulkCreate(this.resourceName, items),
-      update: (updates) => this.driver.bulkUpdate(this.resourceName, updates),
-      delete: (ids) => this.driver.bulkDelete(this.resourceName, ids)
+      async create(items) {
+        const result = await self.driver.bulkCreate(self.resourceName, items);
+        self.emitEvent("bulkCreated", { data: result.data });
+        return result;
+      },
+      async update(updates) {
+        const result = await self.driver.bulkUpdate(self.resourceName, updates);
+        self.emitEvent("bulkUpdated", { data: result.data, ids: updates.map((u) => u.id) });
+        return result;
+      },
+      async delete(ids) {
+        const result = await self.driver.bulkDelete(self.resourceName, ids);
+        self.emitEvent("bulkDeleted", { ids });
+        return result;
+      }
     };
   }
+  emitEvent(action, extra) {
+    if (!this._eventBus) return;
+    this._eventBus.emit({
+      action,
+      resource: this.resourceName,
+      data: extra.data,
+      id: extra.id,
+      ids: extra.ids,
+      timestamp: Date.now(),
+      source: "local"
+    });
+  }
   async runHooks(hookType, ...args) {
     const methods = getHooks(this.constructor, hookType);
     for (const methodName of methods) {
@@ -1358,6 +1389,146 @@ var HttpDriver = class {
   }
 };
 
+// src/events/event-bus.ts
+var EventBus = class {
+  listeners = /* @__PURE__ */ new Map();
+  anyListeners = /* @__PURE__ */ new Set();
+  on(resource, handler) {
+    if (!this.listeners.has(resource)) {
+      this.listeners.set(resource, /* @__PURE__ */ new Set());
+    }
+    this.listeners.get(resource).add(handler);
+    return () => {
+      this.listeners.get(resource)?.delete(handler);
+    };
+  }
+  onAny(handler) {
+    this.anyListeners.add(handler);
+    return () => {
+      this.anyListeners.delete(handler);
+    };
+  }
+  emit(event) {
+    const resourceListeners = this.listeners.get(event.resource);
+    if (resourceListeners) {
+      for (const handler of resourceListeners) {
+        handler(event);
+      }
+    }
+    for (const handler of this.anyListeners) {
+      handler(event);
+    }
+  }
+  destroy() {
+    this.listeners.clear();
+    this.anyListeners.clear();
+  }
+};
+
+// src/events/sse-source.ts
+var SSESource = class {
+  constructor(config, eventBus) {
+    this.config = config;
+    this.eventBus = eventBus;
+  }
+  eventSource = null;
+  connect() {
+    this.eventSource = new EventSource(this.config.url, {
+      withCredentials: this.config.withCredentials
+    });
+    for (const [eventType, resource] of Object.entries(this.config.eventMap)) {
+      this.eventSource.addEventListener(eventType, (e) => {
+        const parsed = this.parseEvent(e, resource);
+        if (parsed) {
+          this.eventBus.emit(parsed);
+        }
+      });
+    }
+  }
+  disconnect() {
+    if (this.eventSource) {
+      this.eventSource.close();
+      this.eventSource = null;
+    }
+  }
+  parseEvent(e, resource) {
+    try {
+      const raw = JSON.parse(e.data);
+      return {
+        action: raw.action,
+        resource,
+        data: raw.data,
+        id: raw.id,
+        ids: raw.ids,
+        timestamp: raw.timestamp ?? Date.now(),
+        source: "remote"
+      };
+    } catch {
+      return null;
+    }
+  }
+};
+
+// src/events/stomp-source.ts
+var STOMPSource = class {
+  constructor(config, eventBus) {
+    this.config = config;
+    this.eventBus = eventBus;
+  }
+  client = null;
+  connect() {
+    this.connectAsync();
+  }
+  async connectAsync() {
+    let StompJs;
+    try {
+      const moduleName = "@stomp/stompjs";
+      StompJs = await Function("m", "return import(m)")(moduleName);
+    } catch {
+      throw new Error(
+        "STOMP source requires @stomp/stompjs. Install it: npm install @stomp/stompjs"
+      );
+    }
+    this.client = new StompJs.Client({
+      brokerURL: this.config.brokerUrl,
+      connectHeaders: this.config.connectHeaders,
+      onConnect: () => {
+        for (const [destination, resource] of Object.entries(this.config.subscriptions)) {
+          this.client.subscribe(destination, (message) => {
+            const parsed = this.parseMessage(message, resource);
+            if (parsed) {
+              this.eventBus.emit(parsed);
+            }
+          });
+        }
+      }
+    });
+    this.client.activate();
+  }
+  disconnect() {
+    if (this.client) {
+      this.client.deactivate();
+      this.client = null;
+    }
+  }
+  parseMessage(message, resource) {
+    try {
+      const raw = JSON.parse(message.body);
+      return {
+        action: raw.action,
+        resource,
+        data: raw.data,
+        id: raw.id,
+        ids: raw.ids,
+        timestamp: raw.timestamp ?? Date.now(),
+        source: "remote"
+      };
+    } catch {
+      return null;
+    }
+  }
+};
+
 // src/seed.ts
 function seed(entityClass, data) {
   const entityName = entityClass.name.toLowerCase();
@@ -1456,6 +1627,33 @@ function createClient(config) {
       svc._setClient(client);
     }
   }
+  let eventSource = null;
+  if (config.events) {
+    const eventBus = new EventBus();
+    client._eventBus = eventBus;
+    for (const [name, ServiceClass] of Object.entries(config.services)) {
+      const svc = client[name];
+      svc._eventBus = eventBus;
+    }
+    const eventsConfig = config.events === true ? {} : config.events;
+    if (eventsConfig.handlers) {
+      for (const [resource, handler] of Object.entries(eventsConfig.handlers)) {
+        eventBus.on(resource, handler);
+      }
+    }
+    if (eventsConfig.source) {
+      if (eventsConfig.source.type === "sse") {
+        eventSource = new SSESource(eventsConfig.source, eventBus);
+      } else if (eventsConfig.source.type === "stomp") {
+        eventSource = new STOMPSource(eventsConfig.source, eventBus);
+      }
+      eventSource?.connect();
+    }
+    client.disconnect = () => {
+      eventSource?.disconnect();
+      eventBus.destroy();
+    };
+  }
   let readyPromise;
   if (defaultDriver instanceof LocalDriver) {
     if (defaultDriver.isReady) {
@@ -1501,6 +1699,6 @@ function applySeedsIfNeeded(driver, seeds) {
   driver.setSeedVersion(newVersion);
 }
 
-export { AuthService, ConflictError, Entity, FauxbaseError, ForbiddenError, HttpDriver, HttpError, LocalDriver, NetworkError, NotFoundError, Service, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };
+export { AuthService, ConflictError, Entity, EventBus, FauxbaseError, ForbiddenError, HttpDriver, HttpError, LocalDriver, NetworkError, NotFoundError, Service, TimeoutError, ValidationError, afterCreate, afterUpdate, beforeCreate, beforeUpdate, computed, createClient, defaultPreset, definePreset, djangoPreset, expressPreset, field, getPreset, laravelPreset, nestjsPreset, relation, seed, springBootPreset };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map