@punks/backend-entity-manager 0.0.50 → 0.0.52

package/dist/esm/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/esm/types/abstractions/tracking.d.ts

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

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

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

package/dist/esm/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/esm/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/esm/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/esm/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/esm/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/esm/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/esm/types/platforms/nest/extensions/authentication/events/index.d.ts

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

package/dist/esm/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/esm/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/esm/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/esm/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/esm/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/index.d.ts

@@ -329,6 +329,8 @@ 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;
@@ -506,7 +508,18 @@ interface ISearchResultsPaging<TCursor> {
     prevPageCursor?: TCursor;
 }
 
-declare const GlobalEvents: {
+interface IEventLog<TPayload> {
+    type: string;
+    payload?: TPayload;
+    userId?: string;
+    userName?: string;
+    timestamp: Date;
+}
+interface IEventsTracker<TEventLog extends IEventLog<unknown>> {
+    track(log: TEventLog): Promise<void>;
+}
+
+declare const PlatformEvents: {
     Messaging: {
         EmailSent: string;
     };
@@ -585,6 +598,7 @@ declare const WpEntityQueryBuilder: (entityName: string, props?: Omit<EntityQuer
 
 declare const EntityManagerSymbols: {
     AppInitializer: symbol;
+    EventsTracker: symbol;
     Entity: symbol;
     EntityActions: symbol;
     EntityAdapter: symbol;
@@ -598,6 +612,11 @@ declare const EntityManagerSymbols: {
     EmailTemplate: symbol;
 };
 
+interface EventsTrackerProps {
+    disabled?: boolean;
+}
+declare const WpEventsTracker: (props?: EventsTrackerProps) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+
 interface DiscoveredModule<T = object> {
     name: string;
     instance: T;
@@ -784,6 +803,51 @@ type PasswordResetEmailPayload = {
     callbackUrl: string;
 };
 
+declare class AuthenticationError extends Error {
+    constructor(message: string);
+}
+declare class InvalidCredentialsError extends AuthenticationError {
+    constructor(message: string);
+}
+declare class OperationTokenMismatchError extends AuthenticationError {
+    constructor(message: string);
+}
+
+declare const AuthenticationEvents: {
+    UserLogin: string;
+    UserRegistrationStarted: string;
+    UserRegistrationCompleted: string;
+    UserPasswordResetStarted: string;
+    UserPasswordResetCompleted: string;
+};
+
+type UserProfile = {
+    firstName: string;
+    lastName: string;
+};
+type UserLoginEventPayload = {
+    userId: string;
+    email: string;
+    profile: UserProfile;
+};
+type UserRegistrationStartedEventPayload = {
+    email: string;
+    profile: UserProfile;
+};
+type UserRegistrationCompletedEventPayload = {
+    userId: string;
+    email: string;
+    profile: UserProfile;
+};
+type UserPasswordResetStartedEventPayload = {
+    email: string;
+};
+type UserPasswordResetCompletedEventPayload = {
+    userId: string;
+    email: string;
+    profile: UserProfile;
+};
+
 interface UserDisableInput {
     userId: string;
 }
@@ -889,16 +953,6 @@ type UserVerifyRequestCallbackTemplate = {
     tokenPlaceholder: string;
 };
 
-declare class AuthenticationError extends Error {
-    constructor(message: string);
-}
-declare class InvalidCredentialsError extends AuthenticationError {
-    constructor(message: string);
-}
-declare class OperationTokenMismatchError extends AuthenticationError {
-    constructor(message: string);
-}
-
 declare class AppSessionService {
     getValue<T>(key: string): T;
     setValue<T>(key: string, value: T): void;
@@ -1256,6 +1310,7 @@ declare class EntityManagerInitializer {
     private registerAuthentication;
     private registerEntities;
     private executeInitializers;
+    private registerEventTrackingProviders;
     private registerEmailProviders;
     private registerEmailTemplates;
     private initializeProviders;
@@ -1267,6 +1322,7 @@ declare class EntityManagerInitializer {
     private discoverAppInitializers;
     private discoverEmailTemplates;
     private discoverEmailProviders;
+    private discoverEventTrackingProviders;
 }
 
 declare class AppSessionMiddleware implements NestMiddleware {
@@ -1285,4 +1341,4 @@ declare const renderHandlebarsTemplate: <TContext extends object>(input: {
 
 declare const newUuid: () => string;
 
-export { AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSessionMiddleware, AppSessionService, AuthenticationEmailTemplates, AuthenticationError, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationModuleSettings, AuthenticationService, AwsEmailModule, AwsSesEmailTemplate, AwsSesEmailTemplateData, AwsSesSettings, EmailService, EmailTemplateProps, EmailVerifyEmailPayload, EmailVerifyTokenPayload, EntityActionsProps, EntityAdapterProps, EntityAuthMiddlewareProps, EntityConnectorProps, EntityConverterProps, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerProps, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntityProps, EntityQueryBuilderProps, EntityRepositoryProps, EventsService, FilterExpression, GlobalEvents, HtmlEmailInput, IAuthenticationContext, IAuthenticationContextProvider, IAuthenticationService, IAuthorizationResult, IEmailProvider, IEmailTemplate, IEmailTemplatesCollection, IEntitiesQueryBuilder, IEntitiesSearchAction, IEntitiesSearchQuery, IEntitiesSearchResults, IEntitiesSearchResultsPaging, IEntityActions, IEntityAdapter, IEntityAuthorizationMiddleware, IEntityConverter, IEntityCreateAction, IEntityCreateCommand, IEntityDeleteAction, IEntityDeleteCommand, IEntityEventsManager, IEntityGetAction, IEntityGetQuery, IEntityManager, IEntityManagerServiceCollection, IEntityManagerServiceRoot, IEntityMapper, IEntityReplicaDeleteManager, IEntityReplicaSyncManager, IEntityRepository, IEntitySearchParameters, IEntitySearchResults, IEntityUpdateAction, IEntityUpdateCommand, IEntityUpsertAction, IEntityUpsertCommand, IReplicasConfiguration, ISearchFilters, ISearchOptions, ISearchRequestPaging, ISearchResultsPaging, ISearchSorting, ISearchSortingField, IUser, IUserContext, IUserOrganization, IUserProfile, IUserService, IUserTokenData, InvalidCredentialsError, LocalizedMap, LocalizedTexts, MessagingEmailSentPayload, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationTokenMismatchError, PasswordResetEmailPayload, QueryBuilderBase, RegistrationEmailPayload, ReplicaConfiguration, ReplicaOptions, ReplicationMode, RuntimeErrorInformation, SendgridEmailModule, SendgridEmailTemplate, SendgridEmailTemplateData, SendgridSettings, SendgridTemplateBaseData, SendgridTemplateType, SortDirection, SortingType, TemplatedEmailInput, UserDisableInput, UserEnableInput, UserLoginInput, UserLoginResult, UserPasswordChangeInput, UserPasswordResetCompleteInput, UserPasswordResetRequestCallbackTemplate, UserPasswordResetRequestInput, UserPasswordResetRequestResult, UserPasswordResetTokenPayload, UserRegisterCallbackTemplate, UserRegistrationError, UserRegistrationInput, UserRegistrationResult, UserTokenVerifyInput, UserTokenVerifyResult, UserVerifyCompleteInput, UserVerifyRequestCallbackTemplate, UserVerifyRequestInput, UserVerifyRequestResult as UserVerifyResetRequestResult, 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, AuthenticationModuleSettings, AuthenticationService, AwsEmailModule, AwsSesEmailTemplate, AwsSesEmailTemplateData, AwsSesSettings, EmailService, EmailTemplateProps, EmailVerifyEmailPayload, EmailVerifyTokenPayload, EntityActionsProps, EntityAdapterProps, EntityAuthMiddlewareProps, EntityConnectorProps, EntityConverterProps, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerProps, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntityProps, EntityQueryBuilderProps, EntityRepositoryProps, EventsService, EventsTrackerProps, FilterExpression, HtmlEmailInput, IAuthenticationContext, IAuthenticationContextProvider, IAuthenticationService, IAuthorizationResult, IEmailProvider, IEmailTemplate, IEmailTemplatesCollection, IEntitiesQueryBuilder, IEntitiesSearchAction, IEntitiesSearchQuery, IEntitiesSearchResults, IEntitiesSearchResultsPaging, IEntityActions, IEntityAdapter, IEntityAuthorizationMiddleware, IEntityConverter, IEntityCreateAction, IEntityCreateCommand, IEntityDeleteAction, IEntityDeleteCommand, IEntityEventsManager, IEntityGetAction, IEntityGetQuery, IEntityManager, IEntityManagerServiceCollection, IEntityManagerServiceRoot, IEntityMapper, IEntityReplicaDeleteManager, IEntityReplicaSyncManager, IEntityRepository, IEntitySearchParameters, IEntitySearchResults, IEntityUpdateAction, IEntityUpdateCommand, IEntityUpsertAction, IEntityUpsertCommand, IEventLog, IEventsTracker, IReplicasConfiguration, ISearchFilters, ISearchOptions, ISearchRequestPaging, ISearchResultsPaging, ISearchSorting, ISearchSortingField, IUser, IUserContext, IUserOrganization, IUserProfile, IUserService, IUserTokenData, InvalidCredentialsError, LocalizedMap, LocalizedTexts, MessagingEmailSentPayload, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationTokenMismatchError, PasswordResetEmailPayload, PlatformEvents, QueryBuilderBase, RegistrationEmailPayload, ReplicaConfiguration, ReplicaOptions, ReplicationMode, RuntimeErrorInformation, SendgridEmailModule, SendgridEmailTemplate, SendgridEmailTemplateData, SendgridSettings, SendgridTemplateBaseData, SendgridTemplateType, SortDirection, SortingType, TemplatedEmailInput, UserDisableInput, UserEnableInput, UserLoginEventPayload, UserLoginInput, UserLoginResult, UserPasswordChangeInput, UserPasswordResetCompleteInput, UserPasswordResetCompletedEventPayload, UserPasswordResetRequestCallbackTemplate, UserPasswordResetRequestInput, UserPasswordResetRequestResult, UserPasswordResetStartedEventPayload, UserPasswordResetTokenPayload, UserProfile, UserRegisterCallbackTemplate, UserRegistrationCompletedEventPayload, UserRegistrationError, UserRegistrationInput, UserRegistrationResult, UserRegistrationStartedEventPayload, UserTokenVerifyInput, UserTokenVerifyResult, UserVerifyCompleteInput, UserVerifyRequestCallbackTemplate, UserVerifyRequestInput, UserVerifyRequestResult as UserVerifyResetRequestResult, WpAppInitializer, WpAwsSesEmailTemplate, WpEmailTemplate, WpEntity, WpEntityActions, WpEntityAdapter, WpEntityAuthMiddleware, WpEntityConnector, WpEntityConverter, WpEntityManager, WpEntityQueryBuilder, WpEntityRepository, WpEventsTracker, WpSendgridEmailTemplate, WpUserService, getLocalizedText, newUuid, renderHandlebarsTemplate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@punks/backend-entity-manager",
-  "version": "0.0.50",
+  "version": "0.0.52",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",