@punks/backend-entity-manager 0.0.326 → 0.0.328

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

@@ -21,3 +21,24 @@ export interface ILockRepository {
     releaseLock(input: LockReleaseInput): Promise<void>;
     getLock(lockUid: string): Promise<LockItem | undefined>;
 }
+export interface ExecuteSequentialInput<T> {
+    lockUid: string;
+    requestedBy?: string;
+    lockTimeout?: number;
+    lockPolling?: number;
+    operation: () => Promise<T>;
+}
+export declare class ExclusiveOperationResult<T> {
+    skipped: boolean;
+    result?: T;
+}
+export interface ExecuteExclusiveInput<T> {
+    lockUid: string;
+    requestedBy?: string;
+    lockTimeout?: number;
+    operation: () => Promise<T>;
+}
+export interface IOperationLockService {
+    executeSequential<T>(input: ExecuteSequentialInput<T>): Promise<T>;
+    executeExclusive<T>(input: ExecuteExclusiveInput<T>): Promise<ExclusiveOperationResult<T>>;
+}

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

@@ -0,0 +1,2 @@
+export type OperationLockServiceProps = {};
+export declare const WpOperationLockService: (props?: Omit<OperationLockServiceProps, "name">) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

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

@@ -1,4 +1,4 @@
-export interface PipelineTemplateProps {
+export type PipelineTemplateProps = {
     name: string;
-}
+};
 export declare const WpPipeline: (name: string, props?: Omit<PipelineTemplateProps, "name">) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

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

@@ -28,4 +28,5 @@ export declare const EntityManagerSymbols: {
     FileReferenceRepository: symbol;
     PipelineTemplate: symbol;
     CacheInstance: symbol;
+    OperationLockService: symbol;
 };

package/dist/cjs/types/platforms/nest/pipelines/template/template.d.ts

@@ -2,20 +2,29 @@ import { PipelineDefinition, PipelineResult } from "../../../../types";
 import { IPipelineTemplateBuilder } from "../builder/types";
 import { PipelineUtils } from "./utils";
 import { PipelineTemplateProps } from "../../decorators";
+export type PipelineConcurrency = "exclusive" | "sequential";
+export type PipelineTemplateOptions = {
+    concurrency?: PipelineConcurrency;
+};
 export declare abstract class NestPipelineTemplate<TPipelineInput, TPipelineOutput, TContext> {
+    private readonly options?;
+    constructor(options?: PipelineTemplateOptions | undefined);
     protected readonly logger: import("@punks/backend-core").ILogger;
     protected readonly utils: PipelineUtils<TPipelineInput, TPipelineOutput, TContext>;
     private cachedDefinition;
     protected abstract buildTemplate(builder: IPipelineTemplateBuilder<TPipelineInput, TContext>): PipelineDefinition<TPipelineInput, TPipelineOutput, TContext>;
     protected isAuthorized(context: TContext): boolean;
+    protected getConcurrencyKey(input: TPipelineInput): string;
     invoke(input: TPipelineInput): Promise<TPipelineOutput>;
     execute(data: {
         input: TPipelineInput;
         context: TContext;
     }): Promise<PipelineResult<TPipelineInput, TPipelineOutput>>;
+    private pipelineExecute;
     private getDefinition;
     private buildDefinition;
     private getContext;
+    private get operationsLockService();
     private get controller();
     private get registry();
     protected get metadata(): PipelineTemplateProps;

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

@@ -34,6 +34,7 @@ export declare class EntityManagerInitializer {
     private registerVersioningProviders;
     private registerEmailProviders;
     private registerEmailTemplates;
+    private registerOperationLockService;
     private registerPipelinesServices;
     private initializeProviders;
     private discoverEntities;
@@ -54,6 +55,7 @@ export declare class EntityManagerInitializer {
     private discoverEmailProviders;
     private discoverEventTrackingProviders;
     private discoverEmailLogger;
+    private discoverOperationLockService;
     private discoverBucketProviders;
     private discoverSecretsProviders;
     private discoverCacheInstances;

package/dist/cjs/types/platforms/nest/services/operations/operation-lock.service.d.ts

@@ -1,8 +1,6 @@
-import { ILockRepository } from "../../../../abstractions";
-import { ExclusiveOperationResult, ExecuteExclusiveInput, ExecuteSequentialInput } from "./types";
-export declare class OperationLockService {
+import { ExclusiveOperationResult, ExecuteExclusiveInput, ExecuteSequentialInput, ILockRepository, IOperationLockService } from "../../../../abstractions";
+export declare class OperationLockService implements IOperationLockService {
     private readonly operations;
-    private readonly logger;
     constructor(operations: ILockRepository);
     executeSequential: <T>(input: ExecuteSequentialInput<T>) => Promise<T>;
     executeExclusive: <T>(input: ExecuteExclusiveInput<T>) => Promise<ExclusiveOperationResult<T>>;

package/dist/cjs/types/platforms/nest/services/operations/types.d.ts

@@ -1,21 +1,4 @@
-export interface ExecuteExclusiveInput<T> {
-    lockUid: string;
-    requestedBy?: string;
-    lockTimeout?: number;
-    operation: () => Promise<T>;
-}
 export declare class ExecuteExclusiveTimeoutError extends Error {
 }
-export declare class ExclusiveOperationResult<T> {
-    skipped: boolean;
-    result?: T;
-}
-export interface ExecuteSequentialInput<T> {
-    lockUid: string;
-    requestedBy?: string;
-    lockTimeout?: number;
-    lockPolling?: number;
-    operation: () => Promise<T>;
-}
 export declare class ExecuteSequentialTimeoutError extends Error {
 }

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

@@ -1,4 +1,4 @@
-import { IAuthenticationContext, IAuthenticationContextProvider, IAuthenticationMiddleware, IBucketProvider, ICacheInstance, IEmailLogger, IEmailProvider, IEmailTemplatesCollection, IEntityFacets, IEntitySerializer, IEntitySnapshotService, IEntityVersioningProvider, IEventLog, IEventsTracker, IFileProvider, IFilesReferenceRepository, IMediaFolderRepository, IMediaProvider, IMediaReferenceRepository, ISecretsProvider } from "../abstractions";
+import { IAuthenticationContext, IAuthenticationContextProvider, IAuthenticationMiddleware, IBucketProvider, ICacheInstance, IEmailLogger, IEmailProvider, IEmailTemplatesCollection, IEntityFacets, IEntitySerializer, IEntitySnapshotService, IEntityVersioningProvider, IEventLog, IEventsTracker, IFileProvider, IFilesReferenceRepository, IMediaFolderRepository, IMediaProvider, IMediaReferenceRepository, IOperationLockService, ISecretsProvider } from "../abstractions";
 import { IEntitiesCountAction, IEntitiesDeleteAction, IEntitiesExportAction, IEntitiesImportAction, IEntitiesSampleDownloadAction, IEntitiesSearchAction, IEntityActions, IEntityCreateAction, IEntityDeleteAction, IEntityExistsAction, IEntityGetAction, IEntityUpdateAction, IEntityUpsertAction, IEntityVersionsSearchAction } from "../abstractions/actions";
 import { IEntityAdapter } from "../abstractions/adapters";
 import { IEntityAuthorizationMiddleware } from "../abstractions/authorization";
@@ -106,6 +106,8 @@ export declare class EntitiesServiceLocator {
     registerFilesReferenceRepositoryProviders<TFilesReferenceRepo extends IFilesReferenceRepository>(instance: TFilesReferenceRepo): void;
     resolveEventsTracker<TEventsTracker extends IEventsTracker<TEventLog>, TEventLog extends IEventLog<unknown>>(): TEventsTracker;
     registerEventsTracker<TEventsTracker extends IEventsTracker<TEventLog>, TEventLog extends IEventLog<unknown>>(instance: TEventsTracker): void;
+    resolveOperationLockService(): IOperationLockService;
+    registerOperationLockService(instance: IOperationLockService): void;
     resolveEmailTemplatesCollection(): IEmailTemplatesCollection;
     registerEmailTemplatesCollection(instance: IEmailTemplatesCollection): void;
     resolveEmailLogger(): IEmailLogger;

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

@@ -82,6 +82,9 @@ export declare const GlobalServices: {
         IAuthenticationContextProvider: string;
         IAuthenticationMiddleware: string;
     };
+    Operations: {
+        IOperationLockService: string;
+    };
     Pipelines: {
         IPipelineController: string;
     };

package/dist/esm/index.js

@@ -125,6 +125,8 @@ class MissingEntityIdError extends EntityManagerException {
 
 class LockNotFoundError extends Error {
 }
+class ExclusiveOperationResult {
+}
 
 var ReplicationMode;
 (function (ReplicationMode) {
@@ -1313,6 +1315,9 @@ const GlobalServices = {
         IAuthenticationContextProvider: "IAuthenticationContextProvider",
         IAuthenticationMiddleware: "IAuthenticationMiddleware",
     },
+    Operations: {
+        IOperationLockService: "IOperationLockService",
+    },
     Pipelines: {
         IPipelineController: "IPipelineController",
     },
@@ -1609,6 +1614,12 @@ class EntitiesServiceLocator {
     registerEventsTracker(instance) {
         this.provider.register(GlobalServices.Events.IEventsTracker, instance);
     }
+    resolveOperationLockService() {
+        return this.provider.resolve(GlobalServices.Operations.IOperationLockService);
+    }
+    registerOperationLockService(instance) {
+        this.provider.register(GlobalServices.Operations.IOperationLockService, instance);
+    }
     resolveEmailTemplatesCollection() {
         return this.provider.resolve(GlobalServices.Plugins.IEmailTemplatesCollection);
     }
@@ -3613,6 +3624,7 @@ const EntityManagerSymbols = {
     FileReferenceRepository: Symbol.for("WP:FILE_REFERENCE_REPO"),
     PipelineTemplate: Symbol.for("WP:PIPELINE_TEMPLATE"),
     CacheInstance: Symbol.for("WP:CACHE_INSTANCE"),
+    OperationLockService: Symbol.for("WP:OPERATION_LOCK_SERVICE"),
 };
 
 const WpEntityAuthMiddleware = (entityName, props = {}) => applyDecorators(Injectable(), SetMetadata(EntityManagerSymbols.EntityAuthMiddleware, {
@@ -21946,12 +21958,14 @@ function subDays(dirtyDate, dirtyAmount) {
   return addDays(dirtyDate, -amount);
 }
 
-var OperationLockService_1;
+const WpOperationLockService = (props = {}) => applyDecorators(Injectable(), SetMetadata(EntityManagerSymbols.OperationLockService, {
+    ...props,
+}));
+
 const DEFAULT_LOCK_POLLING = 100;
-let OperationLockService = OperationLockService_1 = class OperationLockService {
+let OperationLockService = class OperationLockService {
     constructor(operations) {
         this.operations = operations;
-        this.logger = Log.getLogger(OperationLockService_1.name);
         this.executeSequential = async (input) => {
             const lock = await this.operations.acquireLock({
                 lockUid: input.lockUid,
@@ -22014,8 +22028,8 @@ let OperationLockService = OperationLockService_1 = class OperationLockService {
         };
     }
 };
-OperationLockService = OperationLockService_1 = __decorate([
-    Injectable(),
+OperationLockService = __decorate([
+    WpOperationLockService(),
     __param(0, Inject(getEntityManagerProviderToken("OperationsLockRepository"))),
     __metadata("design:paramtypes", [Object])
 ], OperationLockService);
@@ -23166,6 +23180,7 @@ let EntityManagerInitializer = EntityManagerInitializer_1 = class EntityManagerI
         await this.registerBucketProviders();
         await this.registerSecretsProviders();
         await this.registerCacheInstances();
+        await this.registerOperationLockService();
         await this.executeInitializers(app);
         await this.executeSeeders();
         this.logger.log("Entity manager initialization completed 🚀");
@@ -23443,6 +23458,18 @@ let EntityManagerInitializer = EntityManagerInitializer_1 = class EntityManagerI
             .getEntitiesServicesLocator()
             .registerEmailTemplatesCollection(collection);
     }
+    async registerOperationLockService() {
+        const operationLockServices = await this.discoverOperationLockService();
+        if (!operationLockServices.length) {
+            this.logger.warn("No operation lock services found ⚠️");
+            return;
+        }
+        this.registry
+            .getContainer()
+            .getEntitiesServicesLocator()
+            .registerOperationLockService(operationLockServices[0].discoveredClass
+            .instance);
+    }
     async registerPipelinesServices() {
         this.registry
             .getContainer()
@@ -23508,6 +23535,9 @@ let EntityManagerInitializer = EntityManagerInitializer_1 = class EntityManagerI
     async discoverEmailLogger() {
         return await this.discover.providersWithMetaAtKey(EntityManagerSymbols.EmailLogger);
     }
+    async discoverOperationLockService() {
+        return await this.discover.providersWithMetaAtKey(EntityManagerSymbols.OperationLockService);
+    }
     async discoverBucketProviders() {
         return await this.discover.providersWithMetaAtKey(EntityManagerSymbols.BucketProvider);
     }
@@ -34362,13 +34392,17 @@ class PipelineUtils {
 }
 
 class NestPipelineTemplate {
-    constructor() {
+    constructor(options) {
+        this.options = options;
         this.logger = Log.getLogger(NestPipelineTemplate.name);
         this.utils = new PipelineUtils();
     }
     isAuthorized(context) {
         return true;
     }
+    getConcurrencyKey(input) {
+        return this.constructor.name;
+    }
     async invoke(input) {
         const result = await this.execute({
             input,
@@ -34380,6 +34414,26 @@ class NestPipelineTemplate {
         return result.output;
     }
     async execute(data) {
+        if (this.options?.concurrency === "sequential") {
+            return await this.operationsLockService.executeSequential({
+                lockUid: this.getConcurrencyKey(data.input),
+                operation: async () => {
+                    return await this.pipelineExecute(data);
+                },
+            });
+        }
+        if (this.options?.concurrency === "exclusive") {
+            const result = await this.operationsLockService.executeExclusive({
+                lockUid: this.getConcurrencyKey(data.input),
+                operation: async () => {
+                    return await this.pipelineExecute(data);
+                },
+            });
+            return result.result;
+        }
+        return await this.pipelineExecute(data);
+    }
+    async pipelineExecute(data) {
         const instanceId = newUuid$1();
         const logMetadata = {
             input: data.input,
@@ -34430,6 +34484,12 @@ class NestPipelineTemplate {
             .resolveAuthenticationContextProvider();
         return (await contextService?.getContext());
     }
+    get operationsLockService() {
+        return this.registry
+            .getContainer()
+            .getEntitiesServicesLocator()
+            .resolveOperationLockService();
+    }
     get controller() {
         return this.registry
             .getContainer()
@@ -43726,5 +43786,5 @@ InMemorySecretsProvider = __decorate([
     WpSecretsProvider("inMemorySecretsManager")
 ], InMemorySecretsProvider);
 
-export { AUTHENTICATION_EVENTS_NAMESPACE, ApiKeyAccess, AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSession, AppSessionMiddleware, AppSessionService, AuthGuard, Authenticated, AuthenticationEmailTemplates, AuthenticationError, AuthenticationEvents, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationService, AwsBucketModule, AwsEmailModule, AwsJobsModule, AwsS3BucketError, AwsS3BucketProvider, AwsS3MediaError, AwsS3MediaModule, AwsS3MediaProvider, AwsSecretsModule, AwsSecretsProvider, AwsSesEmailTemplate, BucketItemType, CacheService, ConnectorMode, CurrentUser, CustomDiscoveryModule, CustomDiscoveryService, EmailService, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntitySeeder, EntitySerializationFormat, EntitySerializer, EntitySnapshotService, EntityVersionOperation, EventsService, FilesManager, IEntityVersionsCursor, InMemoryBucketProvider, InMemoryEmailProvider, InMemoryMediaProvider, InMemorySecretsProvider, InvalidCredentialsError, JobConcurrency, JobInstance, JobProviderState, JobRunType, JobSchedule, JobStatus, JobsModule, JobsService, LockNotFoundError, MediaLibraryService, MemberOf, MissingEntityIdError, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestEntitySerializer, NestEntitySnapshotService, NestPipelineTemplate, NestTypeOrmEntitySeeder, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationLockService, OperationTokenMismatchError, PLATFORM_EVENT_NAMESPACE, Permissions, PipelineController, PipelineErrorType, PipelineInvocationError, PipelineStatus, PipelineStepErrorType, PipelinesBuilder, PipelinesRunner, PlatformEvents, Public, QueryBuilderBase, QueryBuilderOperation, ReplicationMode, Roles, SanityMediaError, SanityMediaModule, SanityMediaProvider, SecretsService, SendgridEmailModule, SendgridEmailTemplate, SortDirection, TrackingService, TypeOrmQueryBuilder, TypeOrmRepository, TypeormCacheInstance, TypeormOperationLockRepository, UserCreationError, UserRegistrationError, WpApiKeysService, WpAppInitializer, WpAwsSesEmailTemplate, WpBucketProvider, WpCacheInstance, WpEmailLogger, WpEmailProvider, WpEmailTemplate, WpEntity, WpEntityActions, WpEntityAdapter, WpEntityAuthMiddleware, WpEntityConnector, WpEntityConnectorMapper, WpEntityConverter, WpEntityManager, WpEntityQueryBuilder, WpEntityRepository, WpEntitySeeder, WpEntitySerializer, WpEntitySnapshotService, WpEntityVersioningProvider, WpEventsTracker, WpFileProvider, WpFileReferenceRepository, WpGlobalAuthenticationMiddleware, WpMediaFolderRepository, WpMediaProvider, WpMediaReferenceRepository, WpPermissionsService, WpPipeline, WpRolesService, WpSendgridEmailTemplate, WpUserRolesService, WpUserService, awsBatchSettings, buildPermissionsGuard, buildProviderToken, buildRolesGuard, createContainer, createExpressFileResponse, getEntityManagerProviderToken, getLocalizedText, newUuid, renderHandlebarsTemplate, sessionStorage, toEntitiesImportInput };
+export { AUTHENTICATION_EVENTS_NAMESPACE, ApiKeyAccess, AppExceptionsFilterBase, AppHashingService, AppInMemorySettings, AppSession, AppSessionMiddleware, AppSessionService, AuthGuard, Authenticated, AuthenticationEmailTemplates, AuthenticationError, AuthenticationEvents, AuthenticationExtensionSymbols, AuthenticationModule, AuthenticationService, AwsBucketModule, AwsEmailModule, AwsJobsModule, AwsS3BucketError, AwsS3BucketProvider, AwsS3MediaError, AwsS3MediaModule, AwsS3MediaProvider, AwsSecretsModule, AwsSecretsProvider, AwsSesEmailTemplate, BucketItemType, CacheService, ConnectorMode, CurrentUser, CustomDiscoveryModule, CustomDiscoveryService, EmailService, EntityManagerConfigurationError, EntityManagerException, EntityManagerInitializer, EntityManagerModule, EntityManagerRegistry, EntityManagerService, EntityManagerSymbols, EntityManagerUnauthorizedException, EntityNotFoundException, EntityOperationType, EntityOperationUnauthorizedException, EntitySeeder, EntitySerializationFormat, EntitySerializer, EntitySnapshotService, EntityVersionOperation, EventsService, ExclusiveOperationResult, FilesManager, IEntityVersionsCursor, InMemoryBucketProvider, InMemoryEmailProvider, InMemoryMediaProvider, InMemorySecretsProvider, InvalidCredentialsError, JobConcurrency, JobInstance, JobProviderState, JobRunType, JobSchedule, JobStatus, JobsModule, JobsService, LockNotFoundError, MediaLibraryService, MemberOf, MissingEntityIdError, ModulesContainerProvider, MultiTenancyModule, MultipleEntitiesFoundException, NestEntityActions, NestEntityAuthorizationMiddleware, NestEntityManager, NestEntitySerializer, NestEntitySnapshotService, NestPipelineTemplate, NestTypeOrmEntitySeeder, NestTypeOrmQueryBuilder, NestTypeOrmRepository, OperationLockService, OperationTokenMismatchError, PLATFORM_EVENT_NAMESPACE, Permissions, PipelineController, PipelineErrorType, PipelineInvocationError, PipelineStatus, PipelineStepErrorType, PipelinesBuilder, PipelinesRunner, PlatformEvents, Public, QueryBuilderBase, QueryBuilderOperation, ReplicationMode, Roles, SanityMediaError, SanityMediaModule, SanityMediaProvider, SecretsService, SendgridEmailModule, SendgridEmailTemplate, SortDirection, TrackingService, TypeOrmQueryBuilder, TypeOrmRepository, TypeormCacheInstance, TypeormOperationLockRepository, UserCreationError, UserRegistrationError, WpApiKeysService, WpAppInitializer, WpAwsSesEmailTemplate, WpBucketProvider, WpCacheInstance, WpEmailLogger, WpEmailProvider, WpEmailTemplate, WpEntity, WpEntityActions, WpEntityAdapter, WpEntityAuthMiddleware, WpEntityConnector, WpEntityConnectorMapper, WpEntityConverter, WpEntityManager, WpEntityQueryBuilder, WpEntityRepository, WpEntitySeeder, WpEntitySerializer, WpEntitySnapshotService, WpEntityVersioningProvider, WpEventsTracker, WpFileProvider, WpFileReferenceRepository, WpGlobalAuthenticationMiddleware, WpMediaFolderRepository, WpMediaProvider, WpMediaReferenceRepository, WpPermissionsService, WpPipeline, WpRolesService, WpSendgridEmailTemplate, WpUserRolesService, WpUserService, awsBatchSettings, buildPermissionsGuard, buildProviderToken, buildRolesGuard, createContainer, createExpressFileResponse, getEntityManagerProviderToken, getLocalizedText, newUuid, renderHandlebarsTemplate, sessionStorage, toEntitiesImportInput };
 //# sourceMappingURL=index.js.map