@punks/backend-entity-manager 0.0.36 → 0.0.39

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/cjs/index.js +34 -13
  2. package/dist/cjs/index.js.map +1 -1
  3. package/dist/cjs/types/abstractions/email.d.ts +3 -1
  4. package/dist/cjs/types/abstractions/index.d.ts +1 -0
  5. package/dist/cjs/types/abstractions/localization.d.ts +4 -0
  6. package/dist/cjs/types/platforms/nest/__test__/server/app/auth/auth.dto.d.ts +3 -0
  7. package/dist/cjs/types/platforms/nest/extensions/authentication/handlers/user-password-reset-request/types.d.ts +1 -0
  8. package/dist/cjs/types/platforms/nest/extensions/authentication/handlers/user-register/types.d.ts +1 -0
  9. package/dist/cjs/types/platforms/nest/extensions/authentication/handlers/user-verify-request/types.d.ts +1 -0
  10. package/dist/cjs/types/platforms/nest/plugins/email/aws-ses/index.d.ts +1 -1
  11. package/dist/cjs/types/platforms/nest/plugins/email/sendgrid/abstractions/index.d.ts +3 -2
  12. package/dist/cjs/types/platforms/nest/plugins/email/sendgrid/index.d.ts +1 -0
  13. package/dist/cjs/types/platforms/nest/plugins/email/sendgrid/settings/index.d.ts +1 -0
  14. package/dist/cjs/types/utils/index.d.ts +2 -1
  15. package/dist/cjs/types/utils/localization.d.ts +2 -0
  16. package/dist/esm/index.js +34 -14
  17. package/dist/esm/index.js.map +1 -1
  18. package/dist/esm/types/abstractions/email.d.ts +3 -1
  19. package/dist/esm/types/abstractions/index.d.ts +1 -0
  20. package/dist/esm/types/abstractions/localization.d.ts +4 -0
  21. package/dist/esm/types/platforms/nest/__test__/server/app/auth/auth.dto.d.ts +3 -0
  22. package/dist/esm/types/platforms/nest/extensions/authentication/handlers/user-password-reset-request/types.d.ts +1 -0
  23. package/dist/esm/types/platforms/nest/extensions/authentication/handlers/user-register/types.d.ts +1 -0
  24. package/dist/esm/types/platforms/nest/extensions/authentication/handlers/user-verify-request/types.d.ts +1 -0
  25. package/dist/esm/types/platforms/nest/plugins/email/aws-ses/index.d.ts +1 -1
  26. package/dist/esm/types/platforms/nest/plugins/email/sendgrid/abstractions/index.d.ts +3 -2
  27. package/dist/esm/types/platforms/nest/plugins/email/sendgrid/index.d.ts +1 -0
  28. package/dist/esm/types/platforms/nest/plugins/email/sendgrid/settings/index.d.ts +1 -0
  29. package/dist/esm/types/utils/index.d.ts +2 -1
  30. package/dist/esm/types/utils/localization.d.ts +2 -0
  31. package/dist/index.d.ts +18 -5
  32. package/package.json +1 -1
@@ -13,15 +13,17 @@ export type TemplatedEmailInput<TPayload> = {
13
13
  bcc?: string[];
14
14
  subjectTemplate?: string;
15
15
  templateId: string;
16
+ languageId: string;
16
17
  payload: TPayload;
17
18
  };
18
19
  export interface HtmlEmailInput<TPayload> {
20
+ replyTo?: string;
19
21
  from?: string;
20
22
  to?: string[];
21
23
  cc?: string[];
22
24
  bcc?: string[];
23
25
  subjectTemplate: string;
24
- htmlTemplate: string;
26
+ bodyTemplate: string;
25
27
  payload: TPayload;
26
28
  }
27
29
  export interface IEmailProvider<TTemplateData> {
@@ -10,6 +10,7 @@ export * from "./email";
10
10
  export * from "./errors";
11
11
  export { IEntityEventsManager } from "./events";
12
12
  export * from "./filters";
13
+ export * from "./localization";
13
14
  export { IEntityManager } from "./manager";
14
15
  export { IEntityMapper } from "./mappers";
15
16
  export { IEntitiesSearchQuery, IEntityGetQuery, IEntitiesQueryBuilder, } from "./queries";
@@ -0,0 +1,4 @@
1
+ export type LocalizedMap<T> = {
2
+ [key: string]: T;
3
+ };
4
+ export type LocalizedTexts = LocalizedMap<string>;
@@ -27,6 +27,7 @@ export declare class UserRegisterRequest {
27
27
  data: UserRegistrationData;
28
28
  userContext: UserContext;
29
29
  callback: OperationCallbackTemplate;
30
+ languageId: string;
30
31
  }
31
32
  export declare class UserRegisterResponse {
32
33
  success: boolean;
@@ -36,6 +37,7 @@ export declare class UserPasswordResetRequest {
36
37
  userName: string;
37
38
  userContext?: UserContext;
38
39
  callback: OperationCallbackTemplate;
40
+ languageId: string;
39
41
  }
40
42
  export declare class UserPasswordResetCompleteRequest {
41
43
  token: string;
@@ -48,4 +50,5 @@ export declare class UserEmailVerifyRequest {
48
50
  email: string;
49
51
  userContext: UserContext;
50
52
  callback: OperationCallbackTemplate;
53
+ languageId: string;
51
54
  }
@@ -6,6 +6,7 @@ export type UserPasswordResetRequestCallbackTemplate = {
6
6
  export interface UserPasswordResetRequestInput<TUserContext extends IUserContext> {
7
7
  email: string;
8
8
  callback: UserPasswordResetRequestCallbackTemplate;
9
+ languageId: string;
9
10
  context?: TUserContext;
10
11
  }
11
12
  export interface UserPasswordResetRequestResult {
@@ -9,6 +9,7 @@ export interface UserRegistrationInput<TUserRegistrationInfo, TUserContext exten
9
9
  password: string;
10
10
  registrationInfo: TUserRegistrationInfo;
11
11
  callback: UserRegisterCallbackTemplate;
12
+ languageId: string;
12
13
  context?: TUserContext;
13
14
  }
14
15
  export interface UserRegistrationResult {
@@ -2,6 +2,7 @@ import { IUserContext } from "../../abstractions";
2
2
  export interface UserVerifyRequestInput<TUserContext extends IUserContext> {
3
3
  email: string;
4
4
  callback: UserVerifyRequestCallbackTemplate;
5
+ languageId: string;
5
6
  context?: TUserContext;
6
7
  }
7
8
  export interface UserVerifyRequestResult {
@@ -1,5 +1,5 @@
1
1
  export * from "./abstractions";
2
2
  export * from "./base";
3
3
  export * from "./decorators";
4
- export { AwsSesSettings } from "./settings";
5
4
  export { AwsEmailModule } from "./module";
5
+ export { AwsSesSettings } from "./settings";
@@ -1,3 +1,4 @@
1
+ import { LocalizedTexts } from "../../../../../../abstractions";
1
2
  export type SendgridTemplateType = "template" | "html";
2
3
  export type SendgridTemplateBaseData = {
3
4
  from?: string;
@@ -11,6 +12,6 @@ export type SendgridEmailTemplateData = SendgridTemplateBaseData & ({
11
12
  sendgridTemplateId: string;
12
13
  } | {
13
14
  type: "html";
14
- subjectTemplate: string;
15
- bodyTemplate: string;
15
+ subjectTemplate: string | LocalizedTexts;
16
+ bodyTemplate: string | LocalizedTexts;
16
17
  });
@@ -2,3 +2,4 @@ export * from "./abstractions";
2
2
  export * from "./base";
3
3
  export * from "./decorators";
4
4
  export { SendgridEmailModule } from "./module";
5
+ export { SendgridSettings } from "./settings";
@@ -2,6 +2,7 @@ import { AppInMemorySettings } from "../../../../../../settings";
2
2
  export type SendgridSettings = {
3
3
  apiKey: string;
4
4
  defaultSender: string;
5
+ defaultReplyTo?: string;
5
6
  defaultCc?: string[];
6
7
  defaultBcc?: string[];
7
8
  };
@@ -1,2 +1,3 @@
1
- export { newUuid } from "./uid";
1
+ export { getLocalizedText } from "./localization";
2
2
  export { renderHandlebarsTemplate } from "./rendering";
3
+ export { newUuid } from "./uid";
@@ -0,0 +1,2 @@
1
+ import { LocalizedTexts } from "../abstractions";
2
+ export declare const getLocalizedText: (item: string | LocalizedTexts, languageId: string, defaultLanguageId?: string) => string;
package/dist/index.d.ts CHANGED
@@ -434,15 +434,17 @@ type TemplatedEmailInput<TPayload> = {
434
434
  bcc?: string[];
435
435
  subjectTemplate?: string;
436
436
  templateId: string;
437
+ languageId: string;
437
438
  payload: TPayload;
438
439
  };
439
440
  interface HtmlEmailInput<TPayload> {
441
+ replyTo?: string;
440
442
  from?: string;
441
443
  to?: string[];
442
444
  cc?: string[];
443
445
  bcc?: string[];
444
446
  subjectTemplate: string;
445
- htmlTemplate: string;
447
+ bodyTemplate: string;
446
448
  payload: TPayload;
447
449
  }
448
450
  interface IEmailProvider<TTemplateData> {
@@ -484,6 +486,11 @@ declare class EntityManagerConfigurationError extends EntityManagerException {
484
486
 
485
487
  type FilterExpression<TEntity> = (entity: TEntity) => boolean;
486
488
 
489
+ type LocalizedMap<T> = {
490
+ [key: string]: T;
491
+ };
492
+ type LocalizedTexts = LocalizedMap<string>;
493
+
487
494
  interface IEntitySearchResults<TSearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TResult, TSorting extends SortingType, TCursor, TFacets> {
488
495
  request: TSearchParameters;
489
496
  items: TResult[];
@@ -797,6 +804,7 @@ type UserPasswordResetRequestCallbackTemplate = {
797
804
  interface UserPasswordResetRequestInput<TUserContext extends IUserContext> {
798
805
  email: string;
799
806
  callback: UserPasswordResetRequestCallbackTemplate;
807
+ languageId: string;
800
808
  context?: TUserContext;
801
809
  }
802
810
  interface UserPasswordResetRequestResult {
@@ -830,6 +838,7 @@ interface UserRegistrationInput<TUserRegistrationInfo, TUserContext extends IUse
830
838
  password: string;
831
839
  registrationInfo: TUserRegistrationInfo;
832
840
  callback: UserRegisterCallbackTemplate;
841
+ languageId: string;
833
842
  context?: TUserContext;
834
843
  }
835
844
  interface UserRegistrationResult {
@@ -852,6 +861,7 @@ interface UserVerifyCompleteInput {
852
861
  interface UserVerifyRequestInput<TUserContext extends IUserContext> {
853
862
  email: string;
854
863
  callback: UserVerifyRequestCallbackTemplate;
864
+ languageId: string;
855
865
  context?: TUserContext;
856
866
  }
857
867
  interface UserVerifyRequestResult {
@@ -1176,8 +1186,8 @@ type SendgridEmailTemplateData = SendgridTemplateBaseData & ({
1176
1186
  sendgridTemplateId: string;
1177
1187
  } | {
1178
1188
  type: "html";
1179
- subjectTemplate: string;
1180
- bodyTemplate: string;
1189
+ subjectTemplate: string | LocalizedTexts;
1190
+ bodyTemplate: string | LocalizedTexts;
1181
1191
  });
1182
1192
 
1183
1193
  declare abstract class SendgridEmailTemplate<TPayload, TAugmentedPayload = TPayload> implements IEmailTemplate<SendgridEmailTemplateData, TPayload, TAugmentedPayload> {
@@ -1190,6 +1200,7 @@ declare const WpSendgridEmailTemplate: (templateId: string, sendgridTemplateData
1190
1200
  type SendgridSettings = {
1191
1201
  apiKey: string;
1192
1202
  defaultSender: string;
1203
+ defaultReplyTo?: string;
1193
1204
  defaultCc?: string[];
1194
1205
  defaultBcc?: string[];
1195
1206
  };
@@ -1240,11 +1251,13 @@ declare class AppSessionMiddleware implements NestMiddleware {
1240
1251
  declare class EntityManagerModule {
1241
1252
  }
1242
1253
 
1243
- declare const newUuid: () => string;
1254
+ declare const getLocalizedText: (item: string | LocalizedTexts, languageId: string, defaultLanguageId?: string) => string;
1244
1255
 
1245
1256
  declare const renderHandlebarsTemplate: <TContext extends object>(input: {
1246
1257
  template: string;
1247
1258
  context: TContext;
1248
1259
  }) => string;
1249
1260
 
1250
- 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 };
1261
+ declare const newUuid: () => string;
1262
+
1263
+ 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, LocalizedMap, LocalizedTexts, 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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@punks/backend-entity-manager",
3
- "version": "0.0.36",
3
+ "version": "0.0.39",
4
4
  "description": "",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",