@geekmidas/constructs 0.0.14 → 0.0.16

package/src/endpoints/EndpointBuilder.ts

@@ -45,7 +45,9 @@ export class EndpointBuilder<
   TEventPublisher,
   TEventPublisherServiceName,
   TAuditStorage,
-  TAuditStorageServiceName
+  TAuditStorageServiceName,
+  TDatabase,
+  TDatabaseServiceName
 > {
   protected schemas: TInput = {} as TInput;
   protected _description?: string;
@@ -59,7 +61,6 @@ export class EndpointBuilder<
   _authorizerName?: TAuthorizers[number];
   _actorExtractor?: ActorExtractor<TServices, TSession, TLogger>;
   _audits: MappedAudit<TAuditAction, OutSchema>[] = [];
-  _databaseService?: Service<TDatabaseServiceName, TDatabase>;
 
   constructor(
     readonly route: TRoute,
@@ -75,6 +76,18 @@ export class EndpointBuilder<
     this._publisher = publisher;
   }
 
+  // Internal setter for EndpointFactory to set default auditor storage
+  _setAuditorStorage(
+    storage: Service<TAuditStorageServiceName, TAuditStorage>,
+  ) {
+    this._auditorStorage = storage;
+  }
+
+  // Internal setter for EndpointFactory to set default database service
+  _setDatabaseService(service: Service<TDatabaseServiceName, TDatabase>) {
+    this._databaseService = service;
+  }
+
   description(description: string): this {
     this._description = description;
     return this;
@@ -116,7 +129,10 @@ export class EndpointBuilder<
     TName,
     TAuthorizers,
     TAuditStorage,
-    TAuditStorageServiceName
+    TAuditStorageServiceName,
+    TAuditAction,
+    TDatabase,
+    TDatabaseServiceName
   > {
     this._publisher = publisher as unknown as Service<
       TEventPublisherServiceName,
@@ -135,7 +151,10 @@ export class EndpointBuilder<
       TName,
       TAuthorizers,
       TAuditStorage,
-      TAuditStorageServiceName
+      TAuditStorageServiceName,
+      TAuditAction,
+      TDatabase,
+      TDatabaseServiceName
     >;
   }
 

package/src/endpoints/EndpointFactory.ts

@@ -1,14 +1,15 @@
+import type { AuditStorage } from '@geekmidas/audit';
+import type { EventPublisher, MappedEvent } from '@geekmidas/events';
 import type { Logger } from '@geekmidas/logger';
 import { ConsoleLogger } from '@geekmidas/logger/console';
 import type { Service } from '@geekmidas/services';
 import uniqBy from 'lodash.uniqby';
+import type { HttpMethod } from '../types';
+import type { ActorExtractor } from './audit';
 import type { Authorizer } from './Authorizer';
 import type { AuthorizeFn, SessionFn } from './Endpoint';
 import { EndpointBuilder } from './EndpointBuilder';
 
-import type { EventPublisher, MappedEvent } from '@geekmidas/events';
-import type { HttpMethod } from '../types';
-
 const DEFAULT_LOGGER = new ConsoleLogger() as any;
 
 export class EndpointFactory<
@@ -19,6 +20,10 @@ export class EndpointFactory<
   TEventPublisher extends EventPublisher<any> | undefined = undefined,
   TEventPublisherServiceName extends string = string,
   TAuthorizers extends readonly string[] = readonly string[],
+  TAuditStorage extends AuditStorage | undefined = undefined,
+  TAuditStorageServiceName extends string = string,
+  TDatabase = undefined,
+  TDatabaseServiceName extends string = string,
 > {
   // @ts-ignore
   private defaultServices: TServices;
@@ -31,6 +36,13 @@ export class EndpointFactory<
   private defaultLogger: TLogger = DEFAULT_LOGGER;
   private availableAuthorizers: Authorizer[] = [];
   private defaultAuthorizerName?: TAuthorizers[number];
+  private defaultAuditorStorage:
+    | Service<TAuditStorageServiceName, TAuditStorage>
+    | undefined;
+  private defaultDatabaseService:
+    | Service<TDatabaseServiceName, TDatabase>
+    | undefined;
+  private defaultActorExtractor?: ActorExtractor<TServices, TSession, TLogger>;
 
   constructor({
     basePath,
@@ -42,6 +54,9 @@ export class EndpointFactory<
     defaultEventPublisher,
     availableAuthorizers = [],
     defaultAuthorizerName,
+    defaultAuditorStorage,
+    defaultDatabaseService,
+    defaultActorExtractor,
   }: EndpointFactoryOptions<
     TServices,
     TBasePath,
@@ -49,7 +64,11 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > = {}) {
     // Initialize default services
     this.defaultServices = uniqBy(
@@ -64,6 +83,9 @@ export class EndpointFactory<
     this.defaultEventPublisher = defaultEventPublisher;
     this.availableAuthorizers = availableAuthorizers;
     this.defaultAuthorizerName = defaultAuthorizerName;
+    this.defaultAuditorStorage = defaultAuditorStorage;
+    this.defaultDatabaseService = defaultDatabaseService;
+    this.defaultActorExtractor = defaultActorExtractor;
   }
 
   static joinPaths<TBasePath extends string, P extends string>(
@@ -113,7 +135,11 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    T
+    T,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     const authorizerConfigs = authorizers.map((name) => ({
       name,
@@ -125,7 +151,11 @@ export class EndpointFactory<
       TSession,
       TEventPublisher,
       TEventPublisherServiceName,
-      T
+      T,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: this.defaultServices,
       basePath: this.basePath,
@@ -135,6 +165,9 @@ export class EndpointFactory<
       defaultEventPublisher: this.defaultEventPublisher,
       availableAuthorizers: authorizerConfigs,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this.defaultActorExtractor,
     });
   }
 
@@ -148,7 +181,11 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     const newBasePath = EndpointFactory.joinPaths(path, this.basePath);
     return new EndpointFactory<
@@ -158,7 +195,11 @@ export class EndpointFactory<
       TSession,
       TEventPublisher,
       TEventPublisherServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: this.defaultServices,
       basePath: newBasePath,
@@ -168,6 +209,9 @@ export class EndpointFactory<
       defaultEventPublisher: this.defaultEventPublisher,
       availableAuthorizers: this.availableAuthorizers,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this.defaultActorExtractor,
     });
   }
 
@@ -181,7 +225,11 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     return new EndpointFactory<
       TServices,
@@ -190,7 +238,11 @@ export class EndpointFactory<
       TSession,
       TEventPublisher,
       TEventPublisherServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: this.defaultServices,
       basePath: this.basePath,
@@ -200,6 +252,9 @@ export class EndpointFactory<
       defaultEventPublisher: this.defaultEventPublisher,
       availableAuthorizers: this.availableAuthorizers,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this.defaultActorExtractor,
     });
   }
 
@@ -213,7 +268,11 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     return new EndpointFactory<
       [...S, ...TServices],
@@ -222,7 +281,11 @@ export class EndpointFactory<
       TSession,
       TEventPublisher,
       TEventPublisherServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: [...services, ...this.defaultServices],
       basePath: this.basePath,
@@ -232,6 +295,9 @@ export class EndpointFactory<
       defaultEventPublisher: this.defaultEventPublisher,
       availableAuthorizers: this.availableAuthorizers,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this.defaultActorExtractor,
     });
   }
 
@@ -244,7 +310,11 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     return new EndpointFactory<
       TServices,
@@ -253,7 +323,11 @@ export class EndpointFactory<
       TSession,
       TEventPublisher,
       TEventPublisherServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: this.defaultServices,
       basePath: this.basePath,
@@ -272,6 +346,10 @@ export class EndpointFactory<
       defaultEventPublisher: this.defaultEventPublisher,
       availableAuthorizers: this.availableAuthorizers,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this
+        .defaultActorExtractor as unknown as ActorExtractor<TServices, TSession, L>,
     });
   }
 
@@ -287,7 +365,11 @@ export class EndpointFactory<
     TSession,
     T,
     TServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     return new EndpointFactory<
       TServices,
@@ -296,7 +378,11 @@ export class EndpointFactory<
       TSession,
       T,
       TServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: this.defaultServices,
       basePath: this.basePath,
@@ -306,6 +392,9 @@ export class EndpointFactory<
       defaultEventPublisher: publisher,
       availableAuthorizers: this.availableAuthorizers,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this.defaultActorExtractor,
     });
   }
 
@@ -318,7 +407,11 @@ export class EndpointFactory<
     T,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
   > {
     return new EndpointFactory<
       TServices,
@@ -327,7 +420,11 @@ export class EndpointFactory<
       T,
       TEventPublisher,
       TEventPublisherServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
     >({
       defaultServices: this.defaultServices,
       basePath: this.basePath,
@@ -341,6 +438,147 @@ export class EndpointFactory<
       defaultEventPublisher: this.defaultEventPublisher,
       availableAuthorizers: this.availableAuthorizers,
       defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this
+        .defaultActorExtractor as unknown as ActorExtractor<TServices, T, TLogger>,
+    });
+  }
+
+  /**
+   * Set the database service for endpoints created from this factory.
+   * The database will be available in handler context as `db`.
+   */
+  database<T, TName extends string>(
+    service: Service<TName, T>,
+  ): EndpointFactory<
+    TServices,
+    TBasePath,
+    TLogger,
+    TSession,
+    TEventPublisher,
+    TEventPublisherServiceName,
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    T,
+    TName
+  > {
+    return new EndpointFactory<
+      TServices,
+      TBasePath,
+      TLogger,
+      TSession,
+      TEventPublisher,
+      TEventPublisherServiceName,
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      T,
+      TName
+    >({
+      defaultServices: this.defaultServices,
+      basePath: this.basePath,
+      defaultAuthorizeFn: this.defaultAuthorizeFn,
+      defaultLogger: this.defaultLogger,
+      defaultSessionExtractor: this.defaultSessionExtractor,
+      defaultEventPublisher: this.defaultEventPublisher,
+      availableAuthorizers: this.availableAuthorizers,
+      defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: service,
+    });
+  }
+
+  /**
+   * Set the auditor storage service for endpoints created from this factory.
+   * This enables audit functionality and makes `auditor` available in handler context.
+   */
+  auditor<T extends AuditStorage, TName extends string>(
+    storage: Service<TName, T>,
+  ): EndpointFactory<
+    TServices,
+    TBasePath,
+    TLogger,
+    TSession,
+    TEventPublisher,
+    TEventPublisherServiceName,
+    TAuthorizers,
+    T,
+    TName,
+    TDatabase,
+    TDatabaseServiceName
+  > {
+    return new EndpointFactory<
+      TServices,
+      TBasePath,
+      TLogger,
+      TSession,
+      TEventPublisher,
+      TEventPublisherServiceName,
+      TAuthorizers,
+      T,
+      TName,
+      TDatabase,
+      TDatabaseServiceName
+    >({
+      defaultServices: this.defaultServices,
+      basePath: this.basePath,
+      defaultAuthorizeFn: this.defaultAuthorizeFn,
+      defaultLogger: this.defaultLogger,
+      defaultSessionExtractor: this.defaultSessionExtractor,
+      defaultEventPublisher: this.defaultEventPublisher,
+      availableAuthorizers: this.availableAuthorizers,
+      defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: storage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: this.defaultActorExtractor,
+    });
+  }
+
+  /**
+   * Set the actor extractor function for endpoints created from this factory.
+   * The actor is extracted from the request context and attached to all audits.
+   */
+  actor(
+    extractor: ActorExtractor<TServices, TSession, TLogger>,
+  ): EndpointFactory<
+    TServices,
+    TBasePath,
+    TLogger,
+    TSession,
+    TEventPublisher,
+    TEventPublisherServiceName,
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    TDatabase,
+    TDatabaseServiceName
+  > {
+    return new EndpointFactory<
+      TServices,
+      TBasePath,
+      TLogger,
+      TSession,
+      TEventPublisher,
+      TEventPublisherServiceName,
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      TDatabase,
+      TDatabaseServiceName
+    >({
+      defaultServices: this.defaultServices,
+      basePath: this.basePath,
+      defaultAuthorizeFn: this.defaultAuthorizeFn,
+      defaultLogger: this.defaultLogger,
+      defaultSessionExtractor: this.defaultSessionExtractor,
+      defaultEventPublisher: this.defaultEventPublisher,
+      availableAuthorizers: this.availableAuthorizers,
+      defaultAuthorizerName: this.defaultAuthorizerName,
+      defaultAuditorStorage: this.defaultAuditorStorage,
+      defaultDatabaseService: this.defaultDatabaseService,
+      defaultActorExtractor: extractor,
     });
   }
 
@@ -357,7 +595,12 @@ export class EndpointFactory<
     TSession,
     TEventPublisher,
     TEventPublisherServiceName,
-    TAuthorizers
+    TAuthorizers,
+    TAuditStorage,
+    TAuditStorageServiceName,
+    any,
+    TDatabase,
+    TDatabaseServiceName
   > {
     const fullPath = EndpointFactory.joinPaths(path, this.basePath);
     const builder = new EndpointBuilder<
@@ -370,7 +613,12 @@ export class EndpointFactory<
       TSession,
       TEventPublisher,
       TEventPublisherServiceName,
-      TAuthorizers
+      TAuthorizers,
+      TAuditStorage,
+      TAuditStorageServiceName,
+      any,
+      TDatabase,
+      TDatabaseServiceName
     >(fullPath, method);
 
     if (this.defaultAuthorizeFn) {
@@ -404,6 +652,21 @@ export class EndpointFactory<
       builder._authorizerName = this.defaultAuthorizerName;
     }
 
+    // Set auditor storage if configured
+    if (this.defaultAuditorStorage) {
+      builder._setAuditorStorage(this.defaultAuditorStorage as any);
+    }
+
+    // Set database service if configured
+    if (this.defaultDatabaseService) {
+      builder._setDatabaseService(this.defaultDatabaseService as any);
+    }
+
+    // Set actor extractor if configured
+    if (this.defaultActorExtractor) {
+      builder._actorExtractor = this.defaultActorExtractor;
+    }
+
     return builder;
   }
 
@@ -467,6 +730,10 @@ export interface EndpointFactoryOptions<
   TEventPublisher extends EventPublisher<any> | undefined = undefined,
   TEventPublisherServiceName extends string = string,
   TAuthorizers extends readonly string[] = readonly string[],
+  TAuditStorage extends AuditStorage | undefined = undefined,
+  TAuditStorageServiceName extends string = string,
+  TDatabase = undefined,
+  TDatabaseServiceName extends string = string,
 > {
   defaultServices?: TServices;
   basePath?: TBasePath;
@@ -477,6 +744,9 @@ export interface EndpointFactoryOptions<
   defaultEvents?: MappedEvent<TEventPublisher, undefined>[];
   availableAuthorizers?: Authorizer[];
   defaultAuthorizerName?: TAuthorizers[number];
+  defaultAuditorStorage?: Service<TAuditStorageServiceName, TAuditStorage>;
+  defaultDatabaseService?: Service<TDatabaseServiceName, TDatabase>;
+  defaultActorExtractor?: ActorExtractor<TServices, TSession, TLogger>;
 }
 
 export const e = new EndpointFactory();