@punks/backend-entity-manager 0.0.139 → 0.0.141

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

@@ -2,6 +2,7 @@ import { SortingType } from "./common";
 import { EntitiesExportInput, EntitiesExportResult, EntitiesSampleDownloadOptions, EntitiesSampleDownloadResult } from "./export";
 import { EntitiesImportInput, EntitiesImportResult } from "./import";
 import { IEntitySearchParameters, ISearchFilters, ISearchSorting } from "./searchParameters";
+import { EntityVersionOperation } from "./versioning";
 export interface IEntityCreateCommand<TEntity, TEntityCreateData> {
     execute(input: TEntityCreateData): Promise<TEntity>;
 }
@@ -14,6 +15,14 @@ export interface IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData> {
 export interface IEntityDeleteCommand<TEntity, TEntityId> {
     execute(id: TEntityId): Promise<void>;
 }
+export type EntityVersionCommandInput<TEntity, TEntityId> = {
+    operation: EntityVersionOperation;
+    id: TEntityId;
+    entity?: TEntity;
+};
+export interface IEntityVersionCommand<TEntity, TEntityId> {
+    execute(input: EntityVersionCommandInput<TEntity, TEntityId>): Promise<void>;
+}
 export interface IEntitiesDeleteParameters<TSorting> {
     filters?: ISearchFilters;
     sorting?: ISearchSorting<TSorting>;

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

@@ -3,7 +3,7 @@ export { IEntityAdapter } from "./adapters";
 export * from "./authentication";
 export * from "./buckets";
 export { IAuthorizationResult, IEntityAuthorizationMiddleware, } from "./authorization";
-export { IEntityCreateCommand, IEntityUpdateCommand, IEntityUpsertCommand, IEntityDeleteCommand, IEntitiesImportCommand, IEntitiesExportCommand, IEntitiesDeleteParameters, IEntitiesDeleteCommand, IEntitiesDeleteResult, IEntitiesSampleDownloadCommand, } from "./commands";
+export { IEntityCreateCommand, IEntityUpdateCommand, IEntityUpsertCommand, IEntityDeleteCommand, IEntityVersionCommand, IEntitiesImportCommand, IEntitiesExportCommand, IEntitiesDeleteParameters, IEntitiesDeleteCommand, IEntitiesDeleteResult, IEntitiesSampleDownloadCommand, } from "./commands";
 export { SortingType, ClassType, EnumType } from "./common";
 export { IEntityManagerServiceRoot, IEntityManagerServiceCollection, } from "./configuration";
 export { IEntityConverter } from "./converters";

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

@@ -1,4 +1,4 @@
-import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand } from "./commands";
+import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand, IEntityVersionCommand } from "./commands";
 import { SortingType } from "./common";
 import { IEntitiesCountQuery, IEntitiesFindQuery, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "./queries";
 import { IEntitySearchParameters } from "./searchParameters";
@@ -9,6 +9,7 @@ export interface IEntityManager<TEntity, TEntityId, TEntityCreateData, TEntityUp
     get find(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     get exists(): IEntityExistsQuery<TEntity, NonNullable<TEntitySearchParameters["filters"]>>;
     get count(): IEntitiesCountQuery<TEntity, NonNullable<TEntitySearchParameters["filters"]>>;
+    get version(): IEntityVersionCommand<TEntity, TEntityId>;
     get create(): IEntityCreateCommand<TEntity, TEntityCreateData>;
     get update(): IEntityUpdateCommand<TEntity, TEntityId, TEntityUpdateData>;
     get upsert(): IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData>;

package/dist/cjs/types/commands/version.d.ts

@@ -0,0 +1,7 @@
+import { EntityVersionCommandInput, IEntityVersionCommand } from "../abstractions/commands";
+import { EntityServiceLocator } from "../providers/services";
+export declare class EntityVersionCommand<TEntity, TEntityId> implements IEntityVersionCommand<TEntity, TEntityId> {
+    private readonly services;
+    constructor(services: EntityServiceLocator<TEntity, TEntityId>);
+    execute({ id, operation, entity, }: EntityVersionCommandInput<TEntity, TEntityId>): Promise<void>;
+}

package/dist/cjs/types/concrete/index.d.ts

@@ -1,5 +1,5 @@
 import { IEntitiesCountAction, IEntitiesDeleteAction, IEntitiesExportAction, IEntitiesImportAction, IEntitiesSampleDownloadAction, IEntitiesSearchAction, IEntityActions, IEntityCreateAction, IEntityDeleteAction, IEntityExistsAction, IEntityGetAction, IEntityUpdateAction, IEntityUpsertAction, IEntityVersionsSearchAction } from "../abstractions/actions";
-import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand } from "../abstractions/commands";
+import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand, IEntityVersionCommand } from "../abstractions/commands";
 import { SortingType } from "../abstractions/common";
 import { IEntityManager } from "../abstractions/manager";
 import { IEntitiesCountQuery, IEntitiesFindQuery, IEntitiesSearchQuery, IEntityExistsQuery, IEntityGetQuery, IEntityVersionsSearchQuery } from "../abstractions/queries";
@@ -15,6 +15,7 @@ export declare class EntityManager<TEntity, TEntityId, TEntityCreateData, TEntit
     get get(): IEntityGetQuery<TEntity, TEntityId>;
     get search(): IEntitiesSearchQuery<TEntity, TEntitySearchParameters, TSorting, TCursor, TFacets>;
     get find(): IEntitiesFindQuery<TEntity, TEntitySearchParameters, TSorting, TCursor>;
+    get version(): IEntityVersionCommand<TEntity, TEntityId>;
     get create(): IEntityCreateCommand<TEntity, TEntityCreateData>;
     get update(): IEntityUpdateCommand<TEntity, TEntityId, TEntityUpdateData>;
     get upsert(): IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData>;

package/dist/cjs/types/platforms/nest/__test__/server/database/core/entities/foo.entity.d.ts

@@ -1,6 +1,7 @@
 import { AppTenantEntity } from "./appTenant.entity";
+export type FooEntityId = string;
 export declare class FooEntity {
-    id: string;
+    id: FooEntityId;
     name: string;
     uid?: string;
     age?: number;

package/dist/cjs/types/platforms/nest/__test__/server/entities/foos/foo.snapshot.d.ts

@@ -1,8 +1,8 @@
 import { EntityManagerRegistry } from "../../../../../..";
 import { NestEntitySnapshotService } from "../../../../base/entitySnapshotService";
-import { FooEntity } from "../../database/core/entities/foo.entity";
+import { FooEntity, FooEntityId } from "../../database/core/entities/foo.entity";
 import { FooRepository } from "../../database/core/repositories/foo.repository";
-export declare class FooEntitySnapshotService extends NestEntitySnapshotService<FooEntity, string, FooRepository> {
+export declare class FooEntitySnapshotService extends NestEntitySnapshotService<FooEntity, FooEntityId, FooRepository, FooEntity> {
     constructor(registry: EntityManagerRegistry);
-    getSnapshot(id: FooEntity): Promise<any>;
+    getSnapshot(id: FooEntityId): Promise<FooEntity>;
 }

package/dist/cjs/types/platforms/nest/base/entitySnapshotService.d.ts

@@ -1,7 +1,7 @@
 import { EntitySnapshotService } from "../../../base/snapshot";
 import { EntityServiceLocator } from "../../../providers/services";
 import { EntityManagerRegistry } from "../ioc";
-export declare abstract class NestEntitySnapshotService<TEntity, TEntityId, TEntityRepository> extends EntitySnapshotService<TEntity, TEntityId> {
+export declare abstract class NestEntitySnapshotService<TEntity, TEntityId, TEntityRepository, TEntitySnapshot> extends EntitySnapshotService<TEntityId, TEntitySnapshot> {
     protected readonly services: EntityServiceLocator<TEntity, unknown>;
     constructor(entityName: string, registry: EntityManagerRegistry);
     get repository(): TEntityRepository;

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

@@ -2,7 +2,7 @@ import { IAuthenticationContext, IAuthenticationContextProvider, IBucketProvider
 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";
-import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand } from "../abstractions/commands";
+import { IEntitiesDeleteCommand, IEntitiesDeleteParameters, IEntitiesExportCommand, IEntitiesImportCommand, IEntitiesSampleDownloadCommand, IEntityCreateCommand, IEntityDeleteCommand, IEntityUpdateCommand, IEntityUpsertCommand, IEntityVersionCommand } from "../abstractions/commands";
 import { SortingType } from "../abstractions/common";
 import { IConnectorsConfiguration, IEntityConnectorDeleteManager, IEntityConnectorSyncManager } from "../abstractions/connectors";
 import { IEntityConverter } from "../abstractions/converters";
@@ -49,6 +49,7 @@ export declare class EntityServiceLocator<TEntity, TEntityId> {
     resolveUpsertCommand<TEntityUpdateData>(): IEntityUpsertCommand<TEntity, TEntityId, TEntityUpdateData>;
     resolveDeleteCommand<TEntityId>(): IEntityDeleteCommand<TEntity, TEntityId>;
     resolveDeleteItemsCommand<TEntitiesDeleteParameters extends IEntitiesDeleteParameters<TSorting>, TSorting>(): IEntitiesDeleteCommand<TEntity, TEntitiesDeleteParameters, TSorting>;
+    resolveVersionCommand(): IEntityVersionCommand<TEntity, TEntityId>;
     resolveSampleDownloadCommand(): IEntitiesSampleDownloadCommand<TEntity>;
     resolveImportCommand(): IEntitiesImportCommand<TEntity>;
     resolveExportCommand<TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(): IEntitiesExportCommand<TEntity, TEntitySearchParameters, TSorting, TCursor>;
@@ -150,6 +151,8 @@ export declare class EntitiesServiceLocator {
     registerDeleteItemsCommand<TEntity, TEntitiesDeleteParameters extends IEntitiesDeleteParameters<TSorting>, TSorting>(entityName: string, instance: IEntitiesDeleteCommand<TEntity, TEntitiesDeleteParameters, TSorting>): void;
     resolveDeleteCommand<TEntity, TEntityId>(entityName: string): IEntityDeleteCommand<TEntity, TEntityId>;
     registerDeleteCommand<TEntity, TEntityId>(entityName: string, instance: IEntityDeleteCommand<TEntity, TEntityId>): void;
+    resolveVersionCommand<TEntity, TEntityId>(entityName: string): IEntityVersionCommand<TEntity, TEntityId>;
+    registerVersionCommand<TEntity, TEntityId>(entityName: string, instance: IEntityVersionCommand<TEntity, TEntityId>): void;
     resolveExportCommand<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(entityName: string): IEntitiesExportCommand<TEntity, TEntitySearchParameters, TSorting, TCursor>;
     registerExportCommand<TEntity, TEntitySearchParameters extends IEntitySearchParameters<TSorting, TCursor>, TSorting extends SortingType, TCursor>(entityName: string, instance: IEntitiesExportCommand<TEntity, TEntitySearchParameters, TSorting, TCursor>): void;
     resolveImportCommand<TEntity>(entityName: string): IEntitiesImportCommand<TEntity>;

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

@@ -24,6 +24,7 @@ export declare const EntityServices: {
         IEntityUpsertCommand: string;
         IEntityMergeCommand: string;
         IEntityDeleteCommand: string;
+        IEntityVersionCommand: string;
         IEntitiesDeleteCommand: string;
         IEntitiesExportCommand: string;
         IEntitiesImportCommand: string;

package/dist/esm/index.js

@@ -520,16 +520,10 @@ class EntityCreateCommand {
         if (!versioning) {
             return;
         }
-        const contextService = this.services.resolveAuthenticationContextProvider();
-        const context = await contextService?.getContext();
-        const snapshotService = this.services.resolveSnapshotService();
-        const snapshot = (await snapshotService?.getSnapshot(id)) ?? entity;
-        await versioning.createVersion({
-            operationType: EntityVersionOperation.Create,
-            entityId: id,
-            entityType: this.services.getEntityName(),
-            data: snapshot,
-            modifiedByUserId: context?.userId,
+        await this.services.resolveVersionCommand().execute({
+            id,
+            entity,
+            operation: EntityVersionOperation.Create,
         });
     }
     isVersioningEnabled() {
@@ -572,20 +566,9 @@ class EntityDeleteCommand {
         if (!this.isVersioningEnabled()) {
             return;
         }
-        const versioning = this.services.resolveVersioningProvider();
-        if (!versioning) {
-            return;
-        }
-        const contextService = this.services.resolveAuthenticationContextProvider();
-        const context = await contextService?.getContext();
-        const snapshotService = this.services.resolveSnapshotService();
-        const snapshot = await snapshotService?.getSnapshot(id);
-        await versioning.createVersion({
-            operationType: EntityVersionOperation.Delete,
-            entityId: id,
-            entityType: this.services.getEntityName(),
-            data: snapshot,
-            modifiedByUserId: context?.userId,
+        await this.services.resolveVersionCommand().execute({
+            id,
+            operation: EntityVersionOperation.Delete,
         });
     }
     isVersioningEnabled() {
@@ -818,20 +801,10 @@ class EntityUpdateCommand {
         if (!this.isVersioningEnabled()) {
             return;
         }
-        const versioning = this.services.resolveVersioningProvider();
-        if (!versioning) {
-            return;
-        }
-        const contextService = this.services.resolveAuthenticationContextProvider();
-        const context = await contextService?.getContext();
-        const snapshotService = this.services.resolveSnapshotService();
-        const snapshot = (await snapshotService?.getSnapshot(id)) ?? entity;
-        await versioning.createVersion({
-            operationType: EntityVersionOperation.Update,
-            entityId: id,
-            entityType: this.services.getEntityName(),
-            data: snapshot,
-            modifiedByUserId: context?.userId,
+        await this.services.resolveVersionCommand().execute({
+            id,
+            entity,
+            operation: EntityVersionOperation.Update,
         });
     }
     isVersioningEnabled() {
@@ -887,25 +860,38 @@ class EntityUpsertCommand {
         if (!this.isVersioningEnabled()) {
             return;
         }
-        const versioning = this.services.resolveVersioningProvider();
-        if (!versioning) {
-            return;
+        await this.services.resolveVersionCommand().execute({
+            id,
+            entity,
+            operation: EntityVersionOperation.Upsert,
+        });
+    }
+    isVersioningEnabled() {
+        return (this.services.resolveEntityConfiguration().versioning?.enabled ?? false);
+    }
+}
+
+class EntityVersionCommand {
+    constructor(services) {
+        this.services = services;
+    }
+    async execute({ id, operation, entity, }) {
+        const versioningProvider = this.services.resolveVersioningProvider();
+        if (!versioningProvider) {
+            throw new Error("Versioning provider is not configured");
         }
         const contextService = this.services.resolveAuthenticationContextProvider();
         const context = await contextService?.getContext();
         const snapshotService = this.services.resolveSnapshotService();
         const snapshot = (await snapshotService?.getSnapshot(id)) ?? entity;
-        await versioning.createVersion({
-            operationType: EntityVersionOperation.Upsert,
+        await versioningProvider.createVersion({
+            operationType: operation,
             entityId: id,
             entityType: this.services.getEntityName(),
             data: snapshot,
             modifiedByUserId: context?.userId,
         });
     }
-    isVersioningEnabled() {
-        return (this.services.resolveEntityConfiguration().versioning?.enabled ?? false);
-    }
 }
 
 class EntityManager {
@@ -930,6 +916,9 @@ class EntityManager {
     get find() {
         return this.services.resolveFindQuery();
     }
+    get version() {
+        return this.services.resolveVersionCommand();
+    }
     get create() {
         return this.services.resolveCreateCommand();
     }
@@ -1092,6 +1081,7 @@ const EntityServices = {
         IEntityUpsertCommand: "IEntityUpsertCommand",
         IEntityMergeCommand: "IEntityMergeCommand",
         IEntityDeleteCommand: "IEntityDeleteCommand",
+        IEntityVersionCommand: "IEntityVersionCommand",
         IEntitiesDeleteCommand: "IEntitiesDeleteCommand",
         IEntitiesExportCommand: "IEntitiesExportCommand",
         IEntitiesImportCommand: "IEntitiesImportCommand",
@@ -1259,6 +1249,9 @@ class EntityServiceLocator {
     resolveDeleteItemsCommand() {
         return this.services.resolveDeleteItemsCommand(this.entityName);
     }
+    resolveVersionCommand() {
+        return this.services.resolveVersionCommand(this.entityName);
+    }
     resolveSampleDownloadCommand() {
         return this.services.resolveSampleDownloadCommand(this.entityName);
     }
@@ -1572,6 +1565,12 @@ class EntitiesServiceLocator {
     registerDeleteCommand(entityName, instance) {
         this.provider.registerEntityService(EntityServices.Commands.IEntityDeleteCommand, entityName, instance);
     }
+    resolveVersionCommand(entityName) {
+        return this.provider.resolveEntityService(EntityServices.Commands.IEntityVersionCommand, entityName);
+    }
+    registerVersionCommand(entityName, instance) {
+        this.provider.registerEntityService(EntityServices.Commands.IEntityVersionCommand, entityName, instance);
+    }
     resolveExportCommand(entityName) {
         return this.provider.resolveEntityService(EntityServices.Commands.IEntitiesExportCommand, entityName);
     }
@@ -2198,6 +2197,7 @@ class EntityManagerServiceCollection {
         return this;
     }
     mapImportExport(settings) {
+        this.locator.registerVersionCommand(this.entityName, new EntityVersionCommand(this.resolver));
         this.locator.registerExportCommand(this.entityName, new EntitiesExportCommand(this.resolver, settings));
         this.locator.registerExportAction(this.entityName, new EntitiesExportAction(this.resolver));
         this.locator.registerImportCommand(this.entityName, new EntitiesImportCommand(this.resolver, settings));