@punks/backend-entity-manager 0.0.49 → 0.0.51

package/dist/cjs/types/abstractions/index.d.ts

@@ -18,3 +18,4 @@ export { IReplicasConfiguration, ReplicationMode, ReplicaOptions, ReplicaConfigu
 export { IEntityRepository } from "./repository";
 export * from "./searchParameters";
 export { IEntitySearchResults, ISearchResultsPaging } from "./searchResults";
+export * from "./tracking";

package/dist/cjs/types/abstractions/tracking.d.ts

@@ -0,0 +1,9 @@
+export interface IEventLog<TPayload> {
+    type: string;
+    payload: TPayload;
+    userId?: string;
+    timestamp: Date;
+}
+export interface IEventsTracker<TEventLog extends IEventLog<unknown>> {
+    track(log: TEventLog): Promise<void>;
+}

package/dist/cjs/types/events/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./globalEvents";
+export * from "./platformEvents";
 export * from "./types";

package/dist/cjs/types/events/{globalEvents.d.ts → platformEvents.d.ts}

@@ -1,4 +1,4 @@
-export declare const GlobalEvents: {
+export declare const PlatformEvents: {
     Messaging: {
         EmailSent: string;
     };

package/dist/cjs/types/platforms/nest/__test__/server/database/core/entities/eventLog.entity.d.ts

@@ -0,0 +1,10 @@
+export declare class EventLogEntity {
+    id: string;
+    type: string;
+    userId?: string;
+    userName?: string;
+    payload?: any;
+    timestamp: Date;
+    createdOn: Date;
+    updatedOn: Date;
+}

package/dist/cjs/types/platforms/nest/decorators/index.d.ts

@@ -10,3 +10,4 @@ export { WpEntityRepository, EntityRepositoryProps } from "./repository";
 export { WpEntityManager, EntityManagerProps } from "./manager";
 export { WpEntityQueryBuilder, EntityQueryBuilderProps } from "./queryBuilder";
 export { EntityManagerSymbols } from "./symbols";
+export { WpEventsTracker, EventsTrackerProps } from "./tracking";

package/dist/cjs/types/platforms/nest/decorators/symbols.d.ts

@@ -1,5 +1,6 @@
 export declare const EntityManagerSymbols: {
     AppInitializer: symbol;
+    EventsTracker: symbol;
     Entity: symbol;
     EntityActions: symbol;
     EntityAdapter: symbol;

package/dist/cjs/types/platforms/nest/decorators/tracking.d.ts

@@ -0,0 +1,4 @@
+export interface EventsTrackerProps {
+    disabled?: boolean;
+}
+export declare const WpEventsTracker: (props?: EventsTrackerProps) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

package/dist/cjs/types/platforms/nest/extensions/authentication/events/consts.d.ts

@@ -0,0 +1,7 @@
+export declare const AuthenticationEvents: {
+    UserLogin: string;
+    UserRegistrationStarted: string;
+    UserRegistrationCompleted: string;
+    UserPasswordResetStarted: string;
+    UserPasswordResetCompleted: string;
+};

package/dist/cjs/types/platforms/nest/extensions/authentication/events/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./consts";
+export * from "./types";

package/dist/cjs/types/platforms/nest/extensions/authentication/events/types.d.ts

@@ -0,0 +1,26 @@
+export type UserProfile = {
+    firstName: string;
+    lastName: string;
+};
+export type UserLoginEventPayload = {
+    userId: string;
+    email: string;
+    profile: UserProfile;
+};
+export type UserRegistrationStartedEventPayload = {
+    email: string;
+    profile: UserProfile;
+};
+export type UserRegistrationCompletedEventPayload = {
+    userId: string;
+    email: string;
+    profile: UserProfile;
+};
+export type UserPasswordResetStartedEventPayload = {
+    email: string;
+};
+export type UserPasswordResetCompletedEventPayload = {
+    userId: string;
+    email: string;
+    profile: UserProfile;
+};

package/dist/cjs/types/platforms/nest/extensions/authentication/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./abstractions";
 export * from "./decorators";
 export * from "./email";
+export * from "./errors";
+export * from "./events";
 export * from "./handlers";
 export * from "./errors";
 export * from "./services";

package/dist/cjs/types/platforms/nest/processors/initializer/index.d.ts

@@ -20,6 +20,7 @@ export declare class EntityManagerInitializer {
     private registerAuthentication;
     private registerEntities;
     private executeInitializers;
+    private registerEventTrackingProviders;
     private registerEmailProviders;
     private registerEmailTemplates;
     private initializeProviders;
@@ -31,4 +32,5 @@ export declare class EntityManagerInitializer {
     private discoverAppInitializers;
     private discoverEmailTemplates;
     private discoverEmailProviders;
+    private discoverEventTrackingProviders;
 }

package/dist/cjs/types/providers/services.d.ts

@@ -1,4 +1,4 @@
-import { IAuthenticationContext, IAuthenticationContextProvider, IEmailProvider, IEmailTemplatesCollection } from "../abstractions";
+import { IAuthenticationContext, IAuthenticationContextProvider, IEmailProvider, IEmailTemplatesCollection, IEventLog, IEventsTracker } from "../abstractions";
 import { IEntitiesSearchAction, IEntityActions, IEntityCreateAction, IEntityDeleteAction, IEntityGetAction, IEntityUpdateAction, IEntityUpsertAction } from "../abstractions/actions";
 import { IEntityAdapter } from "../abstractions/adapters";
 import { IEntityAuthorizationMiddleware } from "../abstractions/authorization";
@@ -55,6 +55,8 @@ export declare class EntitiesServiceLocator {
     registerEventEmitter<TEventEmitter extends IEventEmitter>(instance: TEventEmitter): void;
     resolveEmailProvider<TEmailProvider extends IEmailProvider<unknown>>(): TEmailProvider;
     registerEmailProvider<TEmailProvider extends IEmailProvider<unknown>>(instance: TEmailProvider): void;
+    resolveEventsTracker<TEventsTracker extends IEventsTracker<TEventLog>, TEventLog extends IEventLog<unknown>>(): TEventsTracker;
+    registerEventsTracker<TEventsTracker extends IEventsTracker<TEventLog>, TEventLog extends IEventLog<unknown>>(instance: TEventsTracker): void;
     resolveEmailTemplatesCollection(): IEmailTemplatesCollection;
     registerEmailTemplatesCollection(instance: IEmailTemplatesCollection): void;
     resolveAuthenticationContextProvider<TAuthenticationContextProvider extends IAuthenticationContextProvider<TUserContext>, TUserContext>(): TAuthenticationContextProvider;

package/dist/cjs/types/symbols/ioc.d.ts

@@ -51,6 +51,7 @@ export declare const EntityServices: {
 export declare const GlobalServices: {
     Events: {
         IEventEmitter: string;
+        IEventsTracker: string;
     };
     Authentication: {
         IAuthenticationContextProvider: string;

package/dist/esm/index.js

@@ -79,9 +79,9 @@ var SortDirection;
     SortDirection["Desc"] = "desc";
 })(SortDirection || (SortDirection = {}));
 
-const GlobalEvents = {
+const PlatformEvents = {
     Messaging: {
-        EmailSent: "messaging:email.sent",
+        EmailSent: "platform:messaging:email.sent",
     },
 };
 
@@ -119,6 +119,7 @@ class NestEntityManager {
 
 const EntityManagerSymbols = {
     AppInitializer: Symbol.for("WP:APP_INITIALIZER"),
+    EventsTracker: Symbol.for("WP:EVENTS_TRACKER"),
     Entity: Symbol.for("WP:ENTITY"),
     EntityActions: Symbol.for("WP:ENTITY_ACTIONS"),
     EntityAdapter: Symbol.for("WP:ENTITY_ADAPTER"),
@@ -186,6 +187,10 @@ const WpEntityQueryBuilder = (entityName, props = {}) => applyDecorators(Injecta
     ...props,
 }));
 
+const WpEventsTracker = (props = {}) => applyDecorators(Injectable(), SetMetadata(EntityManagerSymbols.EventsTracker, {
+    ...props,
+}));
+
 const AuthenticationExtensionSymbols = {
     UserService: Symbol.for("WP.EXT:AUTHENTICATION.USER_SERVICE"),
 };
@@ -217,6 +222,14 @@ class OperationTokenMismatchError extends AuthenticationError {
     }
 }
 
+const AuthenticationEvents = {
+    UserLogin: "authentication:user.login",
+    UserRegistrationStarted: "authentication:user.registrationStarted",
+    UserRegistrationCompleted: "authentication:user.registrationCompleted",
+    UserPasswordResetStarted: "authentication:user.passwordResetStarted",
+    UserPasswordResetCompleted: "authentication:user.passwordResetCompleted",
+};
+
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -650,6 +663,7 @@ const EntityServices = {
 const GlobalServices = {
     Events: {
         IEventEmitter: "IEventEmitter",
+        IEventsTracker: "IEventsTracker",
     },
     Authentication: {
         IAuthenticationContextProvider: "IAuthenticationContextProvider",
@@ -777,6 +791,12 @@ class EntitiesServiceLocator {
     registerEmailProvider(instance) {
         this.provider.register(GlobalServices.Messaging.IEmailProvider, instance);
     }
+    resolveEventsTracker() {
+        return this.provider.resolve(GlobalServices.Events.IEventsTracker);
+    }
+    registerEventsTracker(instance) {
+        this.provider.register(GlobalServices.Events.IEventsTracker, instance);
+    }
     resolveEmailTemplatesCollection() {
         return this.provider.resolve(GlobalServices.Messaging.IEmailTemplatesCollection);
     }
@@ -19547,6 +19567,7 @@ let EntityManagerInitializer = EntityManagerInitializer_1 = class EntityManagerI
         }
         await this.registerEmailTemplates();
         await this.registerEmailProviders();
+        await this.registerEventTrackingProviders();
         await this.executeInitializers(app);
         this.logger.log("Entity manager initialization completed 🚀");
     }
@@ -19600,6 +19621,19 @@ let EntityManagerInitializer = EntityManagerInitializer_1 = class EntityManagerI
             this.logger.log(`Entity manager app initializer ${initializer.discoveredClass.name} initialized 💪`);
         }
     }
+    async registerEventTrackingProviders() {
+        const providers = await this.discoverEventTrackingProviders();
+        if (!providers.length) {
+            this.logger.warn("No events tracker ⚠️");
+            return;
+        }
+        // todo: handle multiple trackers
+        this.registry
+            .getContainer()
+            .getEntitiesServicesLocator()
+            .registerEventsTracker(providers[0].discoveredClass.instance);
+        this.logger.log(`Events tracker ${providers[0].discoveredClass.name} registered 🚜`);
+    }
     async registerEmailProviders() {
         const providers = await this.discoverEmailProviders();
         if (!providers.length) {
@@ -19655,6 +19689,9 @@ let EntityManagerInitializer = EntityManagerInitializer_1 = class EntityManagerI
     async discoverEmailProviders() {
         return await this.discover.providersWithMetaAtKey(EntityManagerSymbols.EmailProvider);
     }
+    async discoverEventTrackingProviders() {
+        return await this.discover.providersWithMetaAtKey(EntityManagerSymbols.EventsTracker);
+    }
 };
 EntityManagerInitializer = EntityManagerInitializer_1 = __decorate([
     Injectable(),
@@ -25095,7 +25132,7 @@ let SendgridEmailProvider = class SendgridEmailProvider {
             });
         }
         await this.client.send(request);
-        await this.eventsService.emitEvent(GlobalEvents.Messaging.EmailSent, {
+        await this.eventsService.emitEvent(PlatformEvents.Messaging.EmailSent, {
             from: request.from,
             to: request.to,
             cc: request.cc,
@@ -25136,7 +25173,7 @@ let SendgridEmailProvider = class SendgridEmailProvider {
             });
         }
         await this.client.send(request);
-        await this.eventsService.emitEvent(GlobalEvents.Messaging.EmailSent, {
+        await this.eventsService.emitEvent(PlatformEvents.Messaging.EmailSent, {
             from: request.from,
             to: request.to,
             cc: request.cc,
@@ -25160,6 +25197,7 @@ SendgridEmailProvider = __decorate([
 
 var SendgridEmailModule_1;
 const ModuleData = {
+    imports: [EntityManagerModule],
     providers: [SendgridEmailProvider],
 };
 let SendgridEmailModule = SendgridEmailModule_1 = class SendgridEmailModule {
@@ -25214,5 +25252,5 @@ AppSessionMiddleware = __decorate([
     Injectable()
 ], AppSessionMiddleware);
 
-export { AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSessionMiddleware, AppSessionService, AuthenticationEmailTemplates, AuthenticationError, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationService, AwsEmailModule, AwsSesEmailTemplate, EmailService, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EventsService, GlobalEvents, InvalidCredentialsError, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationTokenMismatchError, QueryBuilderBase, ReplicationMode, SendgridEmailModule, SendgridEmailTemplate, SortDirection, UserRegistrationError, WpAppInitializer, WpAwsSesEmailTemplate, WpEmailTemplate, WpEntity, WpEntityActions, WpEntityAdapter, WpEntityAuthMiddleware, WpEntityConnector, WpEntityConverter, WpEntityManager, WpEntityQueryBuilder, WpEntityRepository, WpSendgridEmailTemplate, WpUserService, getLocalizedText, newUuid, renderHandlebarsTemplate };
+export { AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSessionMiddleware, AppSessionService, AuthenticationEmailTemplates, AuthenticationError, AuthenticationEvents, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationService, AwsEmailModule, AwsSesEmailTemplate, EmailService, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EventsService, InvalidCredentialsError, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationTokenMismatchError, PlatformEvents, QueryBuilderBase, ReplicationMode, SendgridEmailModule, SendgridEmailTemplate, SortDirection, UserRegistrationError, WpAppInitializer, WpAwsSesEmailTemplate, WpEmailTemplate, WpEntity, WpEntityActions, WpEntityAdapter, WpEntityAuthMiddleware, WpEntityConnector, WpEntityConverter, WpEntityManager, WpEntityQueryBuilder, WpEntityRepository, WpEventsTracker, WpSendgridEmailTemplate, WpUserService, getLocalizedText, newUuid, renderHandlebarsTemplate };
 //# sourceMappingURL=index.js.map