@punks/backend-entity-manager 0.0.67 → 0.0.69

package/dist/index.d.ts

@@ -1,14 +1,15 @@
 /// <reference types="qs" />
 /// <reference types="express" />
 import * as _punks_backend_core from '@punks/backend-core';
-import { Type as Type$1, INestApplicationContext, DynamicModule, ExceptionFilter, ArgumentsHost, NestMiddleware } from '@nestjs/common';
+import * as _nestjs_common from '@nestjs/common';
+import { Type as Type$1, INestApplicationContext, CanActivate, ExecutionContext, NestModule, DynamicModule, MiddlewareConsumer, ExceptionFilter, ArgumentsHost, NestMiddleware } from '@nestjs/common';
 import { Module } from '@nestjs/core/injector/module';
 import { ModulesContainer } from '@nestjs/core/injector/modules-container';
 import { MetadataScanner } from '@nestjs/core/metadata-scanner';
+import { Reflector, ModulesContainer as ModulesContainer$1 } from '@nestjs/core';
 import { JwtService } from '@nestjs/jwt';
 import { ObjectLiteral, FindOneOptions, FindManyOptions, Repository, ObjectId, FindOptionsWhere, FindOptionsRelations } from 'typeorm';
 import { EventEmitter2 } from '@nestjs/event-emitter';
-import { ModulesContainer as ModulesContainer$1 } from '@nestjs/core';
 import * as express from 'express';
 import { Request, Response, NextFunction } from 'express';
 import * as qs from 'qs';
@@ -802,6 +803,11 @@ declare class StringFacet implements IEntityFacet<string> {
 
 interface IAuthService {
 }
+interface IAuthRole {
+    id: string;
+    uid: string;
+    name: string;
+}
 interface IAuthUserProfile {
     firstName: string;
     lastName: string;
@@ -827,6 +833,11 @@ interface IAuthUser {
 interface IAuthUserContext {
     organizationUid?: string;
 }
+interface IAuthUserTokenData<TContext extends IAuthUserContext> {
+    userId: string;
+    email: string;
+    context?: TContext;
+}
 interface IAuthUserService<TUser extends IAuthUser, TUserContext extends IAuthUserContext, TUserRegistrationInfo> {
     getById(id: string): Promise<TUser>;
     getByEmail(email: string, context?: TUserContext): Promise<TUser>;
@@ -835,18 +846,41 @@ interface IAuthUserService<TUser extends IAuthUser, TUserContext extends IAuthUs
     delete(id: string): Promise<void>;
     create(email: string, data: TUserRegistrationInfo, context?: TUserContext): Promise<TUser>;
 }
-interface IAuthUserTokenData<TContext extends IAuthUserContext> {
-    userId: string;
-    email: string;
-    context?: TContext;
+interface IAuthRoleService<TRole extends IAuthRole> {
+    create(data: Partial<TRole>): Promise<TRole>;
+    update(id: string, data: Partial<TRole>): Promise<void>;
+    delete(id: string): Promise<void>;
+    getById(id: string): Promise<TRole | undefined>;
+    getByUid(id: string): Promise<TRole | undefined>;
+}
+interface IAuthUserRolesService<TUser extends IAuthUser, TRole extends IAuthRole> {
+    getRoleUsers(roleId: string): Promise<TUser[]>;
+    getUserRoles(userId: string): Promise<TRole[]>;
+    getUserRolesByUid(roleUid: string): Promise<TRole[]>;
+    addUserToRole(userId: string, roleId: string): Promise<void>;
+    addUserToRoleByUid(userId: string, roleUid: string): Promise<void>;
+    removeUserFromRole(userId: string, roleId: string): Promise<void>;
+    removeUserFromRoleByUid(userId: string, roleUid: string): Promise<void>;
+    clearUserRoles(userId: string): Promise<TRole[]>;
 }
 
+declare const Public: () => _nestjs_common.CustomDecorator<string>;
+declare const Authenticated: () => _nestjs_common.CustomDecorator<string>;
+declare const Roles: (...roles: string[]) => _nestjs_common.CustomDecorator<string>;
+declare const MemberOf: (...groups: string[]) => _nestjs_common.CustomDecorator<string>;
+
 declare const AuthenticationExtensionSymbols: {
     UserService: symbol;
+    RolesService: symbol;
+    UserRolesService: symbol;
 };
 
+declare const WpRolesService: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+
 declare const WpUserService: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
 
+declare const WpUserRolesService: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+
 declare const AuthenticationEmailTemplates: {
     Registration: string;
     PasswordReset: string;
@@ -914,6 +948,18 @@ type UserPasswordResetCompletedEventPayload = {
     profile: UserProfile;
 };
 
+declare class AuthGuard implements CanActivate {
+    private reflector;
+    constructor(reflector: Reflector);
+    canActivate(context: ExecutionContext): boolean;
+    private isRoleMatching;
+    private getIsForAllAuthenticated;
+    private getIsPublic;
+    private getAllowedRoles;
+    private getCurrentAuth;
+    private getMetadata;
+}
+
 interface UserDisableInput {
     userId: string;
 }
@@ -992,6 +1038,7 @@ interface UserRegistrationInput<TUserRegistrationInfo, TUserContext extends IAut
 interface UserRegistrationResult {
     success: boolean;
     error?: UserRegistrationError;
+    userId?: string;
 }
 
 interface UserTokenVerifyResult<TUserContext extends IAuthUserContext> {
@@ -1074,8 +1121,14 @@ declare class TrackingService {
 
 declare class AuthenticationServicesResolver {
     private usersService;
+    private rolesService;
+    private usersRolesService;
     registerUsersService(usersService: IAuthUserService<any, any, any>): void;
+    registerRoleService(rolesService: IAuthRoleService<any>): void;
+    registerUserRolesService(userRolesService: IAuthUserRolesService<any, any>): void;
     getUsersService<TUser extends IAuthUser, TUserRegistrationInfo>(): IAuthUserService<TUser, any, TUserRegistrationInfo>;
+    getRoleService<TRole extends IAuthRole>(): IAuthRoleService<TRole>;
+    getUserRoleService<TUser extends IAuthUser, TRole extends IAuthRole>(): IAuthUserRolesService<TUser, TRole>;
 }
 
 declare class JwtProvider {
@@ -1208,7 +1261,8 @@ declare class AuthenticationService implements IAuthService {
     private readonly userTokenVerifyHandler;
     private readonly userVerifyRequestHandler;
     private readonly userVerifyCompleteHandler;
-    constructor(userDisableHandler: UserDisableHandler, userEnableHandler: UserEnableHandler, userLoginHandler: UserLoginHandler, userPasswordChangeHandler: UserPasswordChangeHandler, userPasswordResetFinalizeHandler: UserPasswordResetCompleteHandler, userPasswordResetRequestHandler: UserPasswordResetRequestHandler, userRegistrationHandler: UserRegistrationHandler, userTokenVerifyHandler: UserTokenVerifyHandler, userVerifyRequestHandler: UserVerifyRequestHandler, userVerifyCompleteHandler: UserVerifyCompleteHandler);
+    private readonly resolver;
+    constructor(userDisableHandler: UserDisableHandler, userEnableHandler: UserEnableHandler, userLoginHandler: UserLoginHandler, userPasswordChangeHandler: UserPasswordChangeHandler, userPasswordResetFinalizeHandler: UserPasswordResetCompleteHandler, userPasswordResetRequestHandler: UserPasswordResetRequestHandler, userRegistrationHandler: UserRegistrationHandler, userTokenVerifyHandler: UserTokenVerifyHandler, userVerifyRequestHandler: UserVerifyRequestHandler, userVerifyCompleteHandler: UserVerifyCompleteHandler, resolver: AuthenticationServicesResolver);
     userDisable(input: UserDisableInput): Promise<void>;
     userEnable(input: UserEnableInput): Promise<void>;
     userLogin<TUserContext extends IAuthUserContext>(input: UserLoginInput<TUserContext>): Promise<UserLoginResult>;
@@ -1219,10 +1273,14 @@ declare class AuthenticationService implements IAuthService {
     userVerifyRequest<TUserContext extends IAuthUserContext>(input: UserVerifyRequestInput<TUserContext>): Promise<UserVerifyRequestResult>;
     userVerifyComplete(input: UserVerifyCompleteInput): Promise<void>;
     userTokenVerify<TUserContext extends IAuthUserContext>(input: UserTokenVerifyInput): Promise<UserTokenVerifyResult<TUserContext>>;
+    get usersService(): IAuthUserService<IAuthUser, any, unknown>;
+    get rolesService(): IAuthRoleService<IAuthRole>;
+    get userRolesService(): IAuthUserRolesService<IAuthUser, IAuthRole>;
 }
 
-declare class AuthenticationModule {
+declare class AuthenticationModule implements NestModule {
     static forRoot(input: AuthenticationModuleSettings): DynamicModule;
+    configure(consumer: MiddlewareConsumer): void;
 }
 
 interface IAppTenant {
@@ -1260,6 +1318,8 @@ interface IAppUser {
     verified: boolean;
     disabled: boolean;
     profile: IAppUserProfile;
+    tenant: IAppTenant;
+    organization?: IAppOrganization;
 }
 interface IAppUserGroup {
     id: string;
@@ -1315,7 +1375,7 @@ declare abstract class TypeOrmQueryBuilder<TEntity extends ObjectLiteral, TEntit
     constructor(services: EntityServiceLocator<TEntity, unknown>);
     search(request: TEntitySearchParameters, context?: IAuthenticationContext<TUserContext>): Promise<IEntitiesSearchResults<TEntitySearchParameters, TEntity, TSorting, number, TFacets>>;
     protected findPagedQueryResults(request: TEntitySearchParameters, context?: IAuthenticationContext<TUserContext>): Promise<TEntity[]>;
-    protected getRelationsToLoad(request: TEntitySearchParameters, context?: IAuthenticationContext<TUserContext>): FindOptionsRelations<TEntity> | undefined;
+    protected getRelationsToLoad(request: TEntitySearchParameters, context: IAuthenticationContext<TUserContext> | undefined): FindOptionsRelations<TEntity> | undefined;
     protected buildPagingParameters(request: TEntitySearchParameters): {
         skip: number | undefined;
         take: number | undefined;
@@ -1488,4 +1548,4 @@ declare const renderHandlebarsTemplate: <TContext extends object>(input: {
 
 declare const newUuid: () => string;
 
-export { AUTHENTICATION_EVENTS_NAMESPACE, AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSessionMiddleware, AppSessionService, AuthenticationEmailTemplates, AuthenticationError, AuthenticationEvents, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationModuleSettings, AuthenticationService, AwsEmailModule, AwsSesEmailTemplate, AwsSesEmailTemplateData, AwsSesSettings, BooleanFacet, BooleanFacetItem, EmailService, EmailTemplateProps, EmailVerifyEmailPayload, EmailVerifyTokenPayload, EntityActionsProps, EntityAdapterProps, EntityAuthMiddlewareProps, EntityConnectorProps, EntityConverterProps, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerProps, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntityProps, EntityQueryBuilderProps, EntityRepositoryProps, EntitySeeder, EntitySeederProps, EventsService, EventsTrackerProps, FilterExpression, HtmlEmailInput, IAppCompany, IAppDivision, IAppOrganization, IAppRole, IAppTenant, IAppUser, IAppUserGroup, IAppUserProfile, IAuthService, IAuthUser, IAuthUserContext, IAuthUserOrganization, IAuthUserProfile, IAuthUserService, IAuthUserTokenData, IAuthenticationContext, IAuthenticationContextProvider, IAuthorizationResult, IEmailProvider, IEmailTemplate, IEmailTemplatesCollection, IEntitiesQueryBuilder, IEntitiesSearchAction, IEntitiesSearchQuery, IEntitiesSearchResults, IEntitiesSearchResultsPaging, IEntityActions, IEntityAdapter, IEntityAuthorizationMiddleware, IEntityConverter, IEntityCreateAction, IEntityCreateCommand, IEntityDeleteAction, IEntityDeleteCommand, IEntityEventsManager, IEntityFacet, IEntityFacetItem, IEntityFacets, IEntityGetAction, IEntityGetQuery, IEntityManager, IEntityManagerServiceCollection, IEntityManagerServiceRoot, IEntityMapper, IEntityReplicaDeleteManager, IEntityReplicaSyncManager, IEntityRepository, IEntitySearchParameters, IEntitySearchResults, IEntityUpdateAction, IEntityUpdateCommand, IEntityUpsertAction, IEntityUpsertCommand, IEventLog, IEventsTracker, IReplicasConfiguration, ISearchFilters, ISearchOptions, ISearchRequestPaging, ISearchResultsPaging, ISearchSorting, ISearchSortingField, InvalidCredentialsError, LocalizedMap, LocalizedTexts, MessagingEmailSentPayload, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmEntitySeeder, NestTypeOrmQueryBuilder, NestTypeOrmRepository, NumericFacet, NumericFacetItem, OperationTokenMismatchError, PLATFORM_EVENT_NAMESPACE, PasswordResetEmailPayload, PlatformEvents, QueryBuilderBase, RegistrationEmailPayload, ReplicaConfiguration, ReplicaOptions, ReplicationMode, RuntimeErrorInformation, SendgridEmailModule, SendgridEmailTemplate, SendgridEmailTemplateData, SendgridSettings, SendgridTemplateBaseData, SendgridTemplateType, SortDirection, SortingType, StringFacet, StringFacetItem, TemplatedEmailInput, TrackingService, 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, WpEntitySeeder, WpEventsTracker, WpSendgridEmailTemplate, WpUserService, getLocalizedText, newUuid, renderHandlebarsTemplate };
+export { AUTHENTICATION_EVENTS_NAMESPACE, AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSessionMiddleware, AppSessionService, AuthGuard, Authenticated, AuthenticationEmailTemplates, AuthenticationError, AuthenticationEvents, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationModuleSettings, AuthenticationService, AwsEmailModule, AwsSesEmailTemplate, AwsSesEmailTemplateData, AwsSesSettings, BooleanFacet, BooleanFacetItem, EmailService, EmailTemplateProps, EmailVerifyEmailPayload, EmailVerifyTokenPayload, EntityActionsProps, EntityAdapterProps, EntityAuthMiddlewareProps, EntityConnectorProps, EntityConverterProps, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerProps, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntityProps, EntityQueryBuilderProps, EntityRepositoryProps, EntitySeeder, EntitySeederProps, EventsService, EventsTrackerProps, FilterExpression, HtmlEmailInput, IAppCompany, IAppDivision, IAppOrganization, IAppRole, IAppTenant, IAppUser, IAppUserGroup, IAppUserProfile, IAuthRole, IAuthRoleService, IAuthService, IAuthUser, IAuthUserContext, IAuthUserOrganization, IAuthUserProfile, IAuthUserRolesService, IAuthUserService, IAuthUserTokenData, IAuthenticationContext, IAuthenticationContextProvider, IAuthorizationResult, IEmailProvider, IEmailTemplate, IEmailTemplatesCollection, IEntitiesQueryBuilder, IEntitiesSearchAction, IEntitiesSearchQuery, IEntitiesSearchResults, IEntitiesSearchResultsPaging, IEntityActions, IEntityAdapter, IEntityAuthorizationMiddleware, IEntityConverter, IEntityCreateAction, IEntityCreateCommand, IEntityDeleteAction, IEntityDeleteCommand, IEntityEventsManager, IEntityFacet, IEntityFacetItem, IEntityFacets, IEntityGetAction, IEntityGetQuery, IEntityManager, IEntityManagerServiceCollection, IEntityManagerServiceRoot, IEntityMapper, IEntityReplicaDeleteManager, IEntityReplicaSyncManager, IEntityRepository, IEntitySearchParameters, IEntitySearchResults, IEntityUpdateAction, IEntityUpdateCommand, IEntityUpsertAction, IEntityUpsertCommand, IEventLog, IEventsTracker, IReplicasConfiguration, ISearchFilters, ISearchOptions, ISearchRequestPaging, ISearchResultsPaging, ISearchSorting, ISearchSortingField, InvalidCredentialsError, LocalizedMap, LocalizedTexts, MemberOf, MessagingEmailSentPayload, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestTypeOrmEntitySeeder, NestTypeOrmQueryBuilder, NestTypeOrmRepository, NumericFacet, NumericFacetItem, OperationTokenMismatchError, PLATFORM_EVENT_NAMESPACE, PasswordResetEmailPayload, PlatformEvents, Public, QueryBuilderBase, RegistrationEmailPayload, ReplicaConfiguration, ReplicaOptions, ReplicationMode, Roles, RuntimeErrorInformation, SendgridEmailModule, SendgridEmailTemplate, SendgridEmailTemplateData, SendgridSettings, SendgridTemplateBaseData, SendgridTemplateType, SortDirection, SortingType, StringFacet, StringFacetItem, TemplatedEmailInput, TrackingService, 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, WpEntitySeeder, WpEventsTracker, WpRolesService, WpSendgridEmailTemplate, WpUserRolesService, WpUserService, getLocalizedText, newUuid, renderHandlebarsTemplate };

package/package.json

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