@punks/backend-entity-manager 0.0.33 → 0.0.35

package/dist/index.d.ts

@@ -327,8 +327,8 @@ declare class EntitiesServiceLocator {
     getProvider(): ServiceLocator;
     resolveEventEmitter<TEventEmitter extends IEventEmitter>(): TEventEmitter;
     registerEventEmitter<TEventEmitter extends IEventEmitter>(instance: TEventEmitter): void;
-    resolveEmailProvider<TEmailProvider extends IEmailProvider>(): TEmailProvider;
-    registerEmailProvider<TEmailProvider extends IEmailProvider>(instance: TEmailProvider): void;
+    resolveEmailProvider<TEmailProvider extends IEmailProvider<unknown>>(): TEmailProvider;
+    registerEmailProvider<TEmailProvider extends IEmailProvider<unknown>>(instance: TEmailProvider): void;
     resolveEmailTemplatesCollection(): IEmailTemplatesCollection;
     registerEmailTemplatesCollection(instance: IEmailTemplatesCollection): void;
     resolveAuthenticationContextProvider<TAuthenticationContextProvider extends IAuthenticationContextProvider<TUserContext>, TUserContext>(): TAuthenticationContextProvider;
@@ -432,7 +432,7 @@ type TemplatedEmailInput<TPayload> = {
     to?: string[];
     cc?: string[];
     bcc?: string[];
-    subject?: string;
+    subjectTemplate?: string;
     templateId: string;
     payload: TPayload;
 };
@@ -441,12 +441,12 @@ interface HtmlEmailInput<TPayload> {
     to?: string[];
     cc?: string[];
     bcc?: string[];
-    subject: string;
+    subjectTemplate: string;
     htmlTemplate: string;
     payload: TPayload;
 }
-interface IEmailProvider {
-    sendTemplatedEmail<TPayload>(input: TemplatedEmailInput<TPayload>): Promise<void>;
+interface IEmailProvider<TTemplateData> {
+    sendTemplatedEmail<TPayload, TAugmentedPayload>(input: TemplatedEmailInput<TPayload>, template: IEmailTemplate<TTemplateData, TPayload, TAugmentedPayload>): Promise<void>;
     sendHtmlEmail<TPayload>(input: HtmlEmailInput<TPayload>): Promise<void>;
 }
 
@@ -760,6 +760,108 @@ type PasswordResetEmailPayload = {
     callbackUrl: string;
 };
 
+interface UserDisableInput {
+    userId: string;
+}
+
+interface UserEnableInput {
+    userId: string;
+}
+
+interface UserLoginInput<TUserContext extends IUserContext> {
+    userName: string;
+    password: string;
+    context?: TUserContext;
+}
+interface UserLoginResult {
+    token?: string;
+    success: boolean;
+}
+
+interface UserPasswordChangeInput {
+    userId: string;
+    newPassword: string;
+    temporary: boolean;
+}
+
+interface UserPasswordResetCompleteInput {
+    token: string;
+    newPassword: string;
+    temporary?: boolean;
+}
+
+type UserPasswordResetRequestCallbackTemplate = {
+    urlTemplate: string;
+    tokenPlaceholder: string;
+};
+interface UserPasswordResetRequestInput<TUserContext extends IUserContext> {
+    email: string;
+    callback: UserPasswordResetRequestCallbackTemplate;
+    context?: TUserContext;
+}
+interface UserPasswordResetRequestResult {
+    success: boolean;
+}
+
+interface AuthenticationModuleSettings {
+    passwordSalt: string;
+    jwtSecret: string;
+}
+type UserPasswordResetTokenPayload = {
+    userId: string;
+    email: string;
+    timestamp: number;
+};
+type EmailVerifyTokenPayload = {
+    userId: string;
+    email: string;
+    timestamp: number;
+};
+declare enum UserRegistrationError {
+    UserAlreadyExists = "userAlreadyExists"
+}
+
+type UserRegisterCallbackTemplate = {
+    urlTemplate: string;
+    tokenPlaceholder: string;
+};
+interface UserRegistrationInput<TUserRegistrationInfo, TUserContext extends IUserContext> {
+    email: string;
+    password: string;
+    registrationInfo: TUserRegistrationInfo;
+    callback: UserRegisterCallbackTemplate;
+    context?: TUserContext;
+}
+interface UserRegistrationResult {
+    success: boolean;
+    error?: UserRegistrationError;
+}
+
+interface UserTokenVerifyResult<TUserContext extends IUserContext> {
+    isValid: boolean;
+    data: IUserTokenData<TUserContext>;
+}
+interface UserTokenVerifyInput {
+    token: string;
+}
+
+interface UserVerifyCompleteInput {
+    token: string;
+}
+
+interface UserVerifyRequestInput<TUserContext extends IUserContext> {
+    email: string;
+    callback: UserVerifyRequestCallbackTemplate;
+    context?: TUserContext;
+}
+interface UserVerifyRequestResult {
+    success: boolean;
+}
+type UserVerifyRequestCallbackTemplate = {
+    urlTemplate: string;
+    tokenPlaceholder: string;
+};
+
 declare class AuthenticationError extends Error {
     constructor(message: string);
 }
@@ -796,6 +898,8 @@ declare class EmailService {
     constructor(registry: EntityManagerRegistry);
     sendTemplatedEmail<TPayload>(input: TemplatedEmailInput<TPayload>): Promise<void>;
     sendHtmlEmail<TPayload>(input: HtmlEmailInput<TPayload>): Promise<void>;
+    private getTemplate;
+    private get templates();
     private get provider();
 }
 
@@ -830,40 +934,6 @@ declare class PasswordHashingProvider {
     private buildUserSalt;
 }
 
-interface AuthenticationModuleSettings {
-    passwordSalt: string;
-    jwtSecret: string;
-}
-type UserPasswordResetTokenPayload = {
-    userId: string;
-    email: string;
-    timestamp: number;
-};
-type EmailVerifyTokenPayload = {
-    userId: string;
-    email: string;
-    timestamp: number;
-};
-declare enum UserRegistrationError {
-    UserAlreadyExists = 0
-}
-
-type CallbackTemplate$2 = {
-    urlTemplate: string;
-    tokenPlaceholder: string;
-};
-interface UserRegistrationInput<TUserRegistrationInfo, TUserContext extends IUserContext> {
-    email: string;
-    password: string;
-    registrationInfo: TUserRegistrationInfo;
-    callback: CallbackTemplate$2;
-    context?: TUserContext;
-}
-interface UserRegistrationResult {
-    success: boolean;
-    error?: UserRegistrationError;
-}
-
 declare class UserRegistrationHandler {
     private readonly services;
     private readonly passwordHashingProvider;
@@ -878,36 +948,18 @@ declare class UserRegistrationHandler {
     private resolveUser;
 }
 
-interface UserDisableInput {
-    userId: string;
-}
-
 declare class UserDisableHandler {
     private readonly services;
     constructor(services: AuthenticationServicesResolver);
     execute(input: UserDisableInput): Promise<void>;
 }
 
-interface UserEnableInput {
-    userId: string;
-}
-
 declare class UserEnableHandler {
     private readonly services;
     constructor(services: AuthenticationServicesResolver);
     execute(input: UserEnableInput): Promise<void>;
 }
 
-interface UserLoginInput<TUserContext extends IUserContext> {
-    userName: string;
-    password: string;
-    context?: TUserContext;
-}
-interface UserLoginResult {
-    token?: string;
-    success: boolean;
-}
-
 declare class UserLoginHandler {
     private readonly services;
     private readonly passwordHashingProvider;
@@ -918,12 +970,6 @@ declare class UserLoginHandler {
     private resolveUser;
 }
 
-interface UserPasswordChangeInput {
-    userId: string;
-    newPassword: string;
-    temporary: boolean;
-}
-
 declare class UserPasswordChangeHandler {
     private readonly services;
     private readonly passwordHashingProvider;
@@ -931,12 +977,6 @@ declare class UserPasswordChangeHandler {
     execute(input: UserPasswordChangeInput): Promise<void>;
 }
 
-interface UserPasswordResetCompleteInput {
-    token: string;
-    newPassword: string;
-    temporary?: boolean;
-}
-
 declare class UserPasswordResetCompleteHandler {
     private readonly services;
     private readonly passwordHashingProvider;
@@ -948,19 +988,6 @@ declare class UserPasswordResetCompleteHandler {
     private getUser;
 }
 
-type CallbackTemplate$1 = {
-    urlTemplate: string;
-    tokenPlaceholder: string;
-};
-interface UserPasswordResetRequestInput<TUserContext extends IUserContext> {
-    email: string;
-    callback: CallbackTemplate$1;
-    context?: TUserContext;
-}
-interface UserPasswordResetRequestResult {
-    success: boolean;
-}
-
 declare class UserPasswordResetRequestHandler {
     private readonly services;
     private readonly emailService;
@@ -972,10 +999,6 @@ declare class UserPasswordResetRequestHandler {
     private resolveUser;
 }
 
-interface UserVerifyCompleteInput {
-    token: string;
-}
-
 declare class UserVerifyCompleteHandler {
     private readonly services;
     private readonly jwtProvider;
@@ -986,14 +1009,6 @@ declare class UserVerifyCompleteHandler {
     private getUser;
 }
 
-interface UserTokenVerifyResult<TUserContext extends IUserContext> {
-    isValid: boolean;
-    data: IUserTokenData<TUserContext>;
-}
-interface UserTokenVerifyInput {
-    token: string;
-}
-
 declare class UserTokenVerifyHandler {
     private readonly jwtProvider;
     constructor(jwtProvider: JwtProvider);
@@ -1001,25 +1016,12 @@ declare class UserTokenVerifyHandler {
     private decodeUserJwtToken;
 }
 
-interface UserVerifyRequestInput<TUserContext extends IUserContext> {
-    email: string;
-    callback: CallbackTemplate;
-    context?: TUserContext;
-}
-interface UserVerifyResetRequestResult {
-    success: boolean;
-}
-type CallbackTemplate = {
-    urlTemplate: string;
-    tokenPlaceholder: string;
-};
-
 declare class UserVerifyRequestHandler {
     private readonly services;
     private readonly emailService;
     private readonly jwtProvider;
     constructor(services: AuthenticationServicesResolver, emailService: EmailService, jwtProvider: JwtProvider);
-    execute<TUserContext extends IUserContext>(input: UserVerifyRequestInput<TUserContext>): Promise<UserVerifyResetRequestResult>;
+    execute<TUserContext extends IUserContext>(input: UserVerifyRequestInput<TUserContext>): Promise<UserVerifyRequestResult>;
     private sendEmailVerifyEmail;
     private generateEmailVerifyToken;
     private resolveUser;
@@ -1044,7 +1046,7 @@ declare class AuthenticationService implements IAuthenticationService {
     userPasswordResetFinalize(input: UserPasswordResetCompleteInput): Promise<void>;
     userPasswordResetRequest<TUserContext extends IUserContext>(input: UserPasswordResetRequestInput<TUserContext>): Promise<UserPasswordResetRequestResult>;
     userRegister<TUserRegistrationInfo, TUserContext extends IUserContext>(input: UserRegistrationInput<TUserRegistrationInfo, TUserContext>): Promise<UserRegistrationResult>;
-    userVerifyRequest<TUserContext extends IUserContext>(input: UserVerifyRequestInput<TUserContext>): Promise<UserVerifyResetRequestResult>;
+    userVerifyRequest<TUserContext extends IUserContext>(input: UserVerifyRequestInput<TUserContext>): Promise<UserVerifyRequestResult>;
     userVerifyComplete(input: UserVerifyCompleteInput): Promise<void>;
     userTokenVerify<TUserContext extends IUserContext>(input: UserTokenVerifyInput): Promise<UserTokenVerifyResult<TUserContext>>;
 }
@@ -1124,6 +1126,78 @@ declare abstract class AppExceptionsFilterBase implements ExceptionFilter {
     protected abstract getCustomErrorStatusCode(exception: any): number | undefined;
 }
 
+type AwsSesEmailTemplateData = {
+    subjectTemplate: string;
+    htmlTemplate: string;
+    from?: string;
+    to?: string[];
+    cc?: string[];
+    bcc?: string[];
+    replyTo?: string;
+};
+
+declare abstract class AwsSesEmailTemplate<TPayload, TAugmentedPayload = TPayload> implements IEmailTemplate<AwsSesEmailTemplateData, TPayload, TAugmentedPayload> {
+    processPayload(payload: TPayload): Promise<TAugmentedPayload>;
+    getTemplateData(payload: TAugmentedPayload): Promise<AwsSesEmailTemplateData>;
+}
+
+declare const WpAwsSesEmailTemplate: (templateId: string, sendgridTemplateData: AwsSesEmailTemplateData) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+
+declare class AppInMemorySettings<T> {
+    private _instance;
+    constructor();
+    initialize(value: T): void;
+    get value(): T;
+}
+
+type AwsSesSettings = {
+    awsAccessKeyId?: string;
+    awsSecretAccessKey?: string;
+    region?: string;
+    defaultSender: string;
+    defaultCc?: string[];
+    defaultBcc?: string[];
+};
+
+declare class AwsEmailModule {
+    static forRoot(input: AwsSesSettings): DynamicModule;
+}
+
+type SendgridTemplateType = "template" | "html";
+type SendgridTemplateBaseData = {
+    from?: string;
+    to?: string[];
+    cc?: string[];
+    bcc?: string[];
+    replyTo?: string;
+};
+type SendgridEmailTemplateData = SendgridTemplateBaseData & ({
+    type: "template";
+    sendgridTemplateId: string;
+} | {
+    type: "html";
+    subjectTemplate: string;
+    bodyTemplate: string;
+});
+
+declare abstract class SendgridEmailTemplate<TPayload, TAugmentedPayload = TPayload> implements IEmailTemplate<SendgridEmailTemplateData, TPayload, TAugmentedPayload> {
+    processPayload(payload: TPayload): Promise<TAugmentedPayload>;
+    getTemplateData(payload: TAugmentedPayload): Promise<SendgridEmailTemplateData>;
+}
+
+declare const WpSendgridEmailTemplate: (templateId: string, sendgridTemplateData: SendgridEmailTemplateData) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+
+type SendgridSettings = {
+    apiKey: string;
+    defaultSender: string;
+    defaultCc?: string[];
+    defaultBcc?: string[];
+};
+
+declare class SendgridEmailModule {
+    static forRoot(input: SendgridSettings): DynamicModule;
+}
+
 declare class NestEventEmitter implements IEventEmitter {
     private eventEmitter;
     constructor();
@@ -1168,4 +1242,9 @@ declare class EntityManagerModule {
 
 declare const newUuid: () => string;
 
-export { AppExceptionsFilterBase, AppHashingService, AppSessionMiddleware, AppSessionService, AuthenticationEmailTemplates, AuthenticationError, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationModuleSettings, AuthenticationService, EmailService, EmailTemplateProps, EmailVerifyEmailPayload, EmailVerifyTokenPayload, EntityActionsProps, EntityAdapterProps, EntityAuthMiddlewareProps, EntityConnectorProps, EntityConverterProps, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerProps, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntityProps, EntityQueryBuilderProps, EntityRepositoryProps, 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, IReplicasConfiguration, ISearchFilters, ISearchOptions, ISearchRequestPaging, ISearchResultsPaging, ISearchSorting, ISearchSortingField, IUser, IUserContext, IUserOrganization, IUserProfile, IUserService, IUserTokenData, InvalidCredentialsError, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationTokenMismatchError, PasswordResetEmailPayload, QueryBuilderBase, RegistrationEmailPayload, ReplicaConfiguration, ReplicaOptions, ReplicationMode, RuntimeErrorInformation, SortDirection, SortingType, TemplatedEmailInput, UserPasswordResetTokenPayload, UserRegistrationError, WpAppInitializer, WpEmailTemplate, WpEntity, WpEntityActions, WpEntityAdapter, WpEntityAuthMiddleware, WpEntityConnector, WpEntityConverter, WpEntityManager, WpEntityQueryBuilder, WpEntityRepository, WpUserService, newUuid };
+declare const renderHandlebarsTemplate: <TContext extends object>(input: {
+    template: string;
+    context: TContext;
+}) => 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, 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, IReplicasConfiguration, ISearchFilters, ISearchOptions, ISearchRequestPaging, ISearchResultsPaging, ISearchSorting, ISearchSortingField, IUser, IUserContext, IUserOrganization, IUserProfile, IUserService, IUserTokenData, InvalidCredentialsError, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationTokenMismatchError, PasswordResetEmailPayload, QueryBuilderBase, RegistrationEmailPayload, ReplicaConfiguration, ReplicaOptions, ReplicationMode, RuntimeErrorInformation, SendgridEmailModule, SendgridEmailTemplate, SendgridEmailTemplateData, 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, newUuid, renderHandlebarsTemplate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@punks/backend-entity-manager",
-  "version": "0.0.33",
+  "version": "0.0.35",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -25,6 +25,7 @@
   "author": "WebPunks",
   "license": "ISC",
   "devDependencies": {
+    "@aws-sdk/client-ses": "^3.370.0",
     "@babel/core": "^7.21.0",
     "@nestjs/common": "^10.1.0",
     "@nestjs/core": "^10.1.0",
@@ -39,6 +40,7 @@
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^13.0.6",
     "@rollup/plugin-typescript": "^11.0.0",
+    "@sendgrid/mail": "^7.7.0",
     "@types/bcrypt": "^5.0.0",
     "@types/express": "^4.17.17",
     "@types/jest": "^29.5.2",
@@ -49,6 +51,7 @@
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "express": "^4.18.2",
+    "handlebars": "^4.7.7",
     "jest": "^29.6.1",
     "lodash": "^4.17.21",
     "pg": "^8.11.1",
@@ -66,6 +69,7 @@
     "typescript": "^5.1.6"
   },
   "peerDependencies": {
+    "@aws-sdk/client-ses": "^3.370.0",
     "@nestjs/common": "^10.1.0",
     "@nestjs/core": "^10.1.0",
     "@nestjs/event-emitter": "^2.0.0",
@@ -75,6 +79,7 @@
     "@nestjs/testing": "^10.1.0",
     "@nestjs/typeorm": "^10.0.0",
     "@punks/backend-core": "0.0.12",
+    "@sendgrid/mail": "^7.7.0",
     "bcrypt": "^5.1.0",
     "typeorm": "^0.3.17"
   },

package/readme.md

@@ -11,7 +11,7 @@ npm install @punks/backend-entity-manager @punks/backend-core class-transformer
 ## Add authentication
 
 ```bash
-npm install express async_hooks @nestjs/platform-express @nestjs/jwt
+npm install express async_hooks bcrypt @nestjs/platform-express @nestjs/jwt
 ```
 
 ## Supported ORMs:
@@ -22,6 +22,20 @@ npm install express async_hooks @nestjs/platform-express @nestjs/jwt
 npm install typeorm
 ```
 
+## Supported email providers:
+
+- [SendGrid](https://sendgrid.com/)
+
+```bash
+mpm install @sendgrid/mail
+```
+
+- [AWS SES](https://aws.amazon.com/ses/)
+
+```bash
+npm install @aws-sdk/client-ses
+```
+
 ## Supported platforms:
 
 - [NestJS](https://nestjs.com/)