@punks/backend-entity-manager 0.0.349 → 0.0.351

package/dist/cjs/index.js

@@ -19,6 +19,7 @@ var schedule = require('@nestjs/schedule');
 var require$$0 = require('child_process');
 var cqrs = require('@nestjs/cqrs');
 var require$$1 = require('fs');
+var swagger = require('@nestjs/swagger');
 var clientS3 = require('@aws-sdk/client-s3');
 var s3RequestPresigner = require('@aws-sdk/s3-request-presigner');
 var clientSes = require('@aws-sdk/client-ses');
@@ -193,8 +194,9 @@ class EntitySeeder {
 
 const DEFAULT_DELIMITER = ";";
 class EntitySerializer {
-    constructor(services) {
+    constructor(services, options) {
         this.services = services;
+        this.options = options;
         this.entityName = services.getEntityName();
         this.logger = backendCore.Log.getLogger(`${services.getEntityName()} -> Serializer`);
     }
@@ -225,13 +227,13 @@ class EntitySerializer {
     }
     parseCsv(data, definition) {
         const records = backendCore.csvParse(data, DEFAULT_DELIMITER);
-        return records.map((x) => this.convertSheetRecord(x, definition));
+        return records.map((x, i) => this.convertSheetRecord(x, definition, i));
     }
     parseXlsx(data, definition) {
         const records = backendCore.excelParse(data);
-        return records.map((x) => this.convertSheetRecord(x, definition));
+        return records.map((x, i) => this.convertSheetRecord(x, definition, i));
     }
-    convertSheetRecord(record, definition) {
+    convertSheetRecord(record, definition, rowIndex) {
         if (!record._type || record._type !== this.entityName) {
             throw new Error(`Invalid record type ${record._type} -> record: \n${JSON.stringify(record)}`);
         }
@@ -244,10 +246,26 @@ class EntitySerializer {
                 entity[column.selector] = this.parseColumnValue(record, column);
             }
         }
+        const validationErrors = [];
+        for (const column of definition.columns) {
+            for (const validator of column.validators ?? []) {
+                const result = validator.fn((item) => item[column.selector]);
+                if (!result.isValid) {
+                    validationErrors.push({
+                        errorCode: validator.key,
+                    });
+                }
+            }
+        }
         const idField = definition.columns.find((x) => x.idColumn || x.selector === "id");
         return {
             id: idField ? entity[idField.selector] : undefined,
             item: entity,
+            rowIndex,
+            status: {
+                isValid: validationErrors.length === 0,
+                validationErrors,
+            },
         };
     }
     parseColumnValue(row, definition) {
@@ -270,10 +288,14 @@ class EntitySerializer {
                     fileName,
                     contentType: "text/csv",
                     content: Buffer.from(backendCore.csvBuild([{}], [
-                        {
-                            name: "_type",
-                            value: () => this.entityName,
-                        },
+                        ...(this.options?.useTypeColumn
+                            ? [
+                                {
+                                    name: "_type",
+                                    value: () => this.entityName,
+                                },
+                            ]
+                            : []),
                         ...definition.columns.map((c) => ({
                             name: c.name,
                             value: () => c.sampleValue ?? "",
@@ -290,10 +312,14 @@ class EntitySerializer {
                         data: [{}],
                         sheetName: this.entityName,
                         columns: [
-                            {
-                                header: "_type",
-                                value: () => this.entityName,
-                            },
+                            ...(this.options?.useTypeColumn
+                                ? [
+                                    {
+                                        header: "_type",
+                                        value: () => this.entityName,
+                                    },
+                                ]
+                                : []),
                             ...definition.columns.map((c) => ({
                                 header: c.name,
                                 value: () => c.sampleValue ?? "",
@@ -309,6 +335,7 @@ class EntitySerializer {
     async serialize(data, format) {
         return await this.buildExportFile(data, format);
     }
+    validateSheetItem(item, allItems, context) { }
     async getContext() {
         return (await this.services
             .resolveAuthenticationContextProvider()
@@ -499,6 +526,19 @@ class EntitiesImportAction {
     }
 }
 
+class EntitiesParseAction {
+    constructor(services) {
+        this.services = services;
+        this.logger = backendCore.Log.getLogger(`${services.getEntityName()} -> Import`);
+    }
+    async execute(input) {
+        this.logger.debug("Parse action started", { input });
+        const result = await this.services.resolveParseCommand().execute(input);
+        this.logger.debug("Parse action completed", { input });
+        return result;
+    }
+}
+
 class EntitiesSampleDownloadAction {
     constructor(services) {
         this.services = services;
@@ -813,6 +853,12 @@ class EntitiesExportCommand {
     }
 }
 
+var InvalidEntityHandling;
+(function (InvalidEntityHandling) {
+    InvalidEntityHandling["Skip"] = "skip";
+    InvalidEntityHandling["Fail"] = "fail";
+})(InvalidEntityHandling || (InvalidEntityHandling = {}));
+
 class EntitiesImportCommand {
     constructor(services, settings) {
         this.services = services;
@@ -825,10 +871,19 @@ class EntitiesImportCommand {
             fileName: input.file.fileName,
         });
         const importEntities = await this.parseImportFile(input.file.content, input.format);
-        await this.services.resolveSerializer().import(importEntities.map((x) => x.item), input.payload);
+        const validEntities = importEntities.filter((x) => x.status.isValid);
+        const invalidEntities = importEntities.filter((x) => !x.status.isValid);
+        if (invalidEntities.length > 0 &&
+            input.options?.invalidEntitiesHandling !== InvalidEntityHandling.Skip) {
+            throw new Error(`Cannot import file due to invalid entities: ${invalidEntities
+                .map((x) => x.id)
+                .join(", ")}`);
+        }
+        await this.services.resolveSerializer().import(validEntities.map((x) => x.item), input.payload);
         return {
             statistics: {
-                importedCount: importEntities.length,
+                importedCount: validEntities.length,
+                skippedCount: invalidEntities.length,
                 createdCount: 0,
                 unchangedCount: 0,
                 updatedCount: 0,
@@ -854,6 +909,41 @@ class EntitiesImportCommand {
     }
 }
 
+class EntitiesParseCommand {
+    constructor(services, settings) {
+        this.services = services;
+        this.settings = settings;
+    }
+    async execute(input) {
+        await this.uploadImportFile({
+            content: input.file.content,
+            contentType: input.file.contentType,
+            fileName: input.file.fileName,
+        });
+        const entries = await this.parseImportFile(input.file.content, input.format);
+        return {
+            entries,
+        };
+    }
+    async parseImportFile(content, format) {
+        return await this.services.resolveSerializer().parse(content, format);
+    }
+    async uploadImportFile(file) {
+        await this.bucket.fileUpload({
+            bucket: this.settings.exportBucket.bucket,
+            filePath: this.buildAbsoluteBucketPath(file.fileName),
+            content: file.content,
+            contentType: file.contentType,
+        });
+    }
+    buildAbsoluteBucketPath(relativePath) {
+        return `${this.settings.exportBucket.rootFolderPath ?? ""}/parsers/${createDayPath$1(new Date())}/${relativePath}`;
+    }
+    get bucket() {
+        return this.services.getRootServices().resolveDefaultBucketProvider();
+    }
+}
+
 class EntitiesSampleDownloadCommand {
     constructor(services, settings) {
         this.services = services;
@@ -1130,6 +1220,9 @@ class EntityManager {
     get import() {
         return this.services.resolveImportCommand();
     }
+    get parse() {
+        return this.services.resolveParseCommand();
+    }
     get sampleDownload() {
         return this.services.resolveSampleDownloadCommand();
     }
@@ -1174,6 +1267,9 @@ class EntityActions {
     get import() {
         return this.services.resolveImportAction();
     }
+    get parse() {
+        return this.services.resolveParseAction();
+    }
     get sampleDownload() {
         return this.services.resolveSampleDownloadAction();
     }
@@ -1262,6 +1358,7 @@ const EntityServices = {
         IEntityDeleteAction: "IEntityDeleteAction",
         IEntityMergeAction: "IEntityMergeAction",
         IEntitiesExportAction: "IEntitiesExportAction",
+        IEntitiesParseAction: "IEntitiesParseAction",
         IEntitiesImportAction: "IEntitiesImportAction",
         IEntitiesSampleDownloadAction: "IEntitiesSampleDownloadAction",
         IEntityVersionsSearchAction: "IEntityVersionsSearchAction",
@@ -1280,6 +1377,7 @@ const EntityServices = {
         IEntitiesDeleteCommand: "IEntitiesDeleteCommand",
         IEntitiesExportCommand: "IEntitiesExportCommand",
         IEntitiesImportCommand: "IEntitiesImportCommand",
+        IEntitiesParseCommand: "IEntitiesParseCommand",
         IEntitiesSampleDownloadCommand: "IEntitiesSampleDownloadCommand",
     },
     Converters: {
@@ -1360,162 +1458,6 @@ const GlobalServices = {
     },
 };
 
-class EntityServiceLocator {
-    constructor(services, entityName) {
-        this.services = services;
-        this.entityName = entityName;
-    }
-    getRootServices() {
-        return this.services;
-    }
-    resolveAuthenticationContextProvider() {
-        return this.services.resolveAuthenticationContextProvider();
-    }
-    resolveEntityManager() {
-        return this.services.resolveEntityManager(this.entityName);
-    }
-    resolveEntityActions() {
-        return this.services.resolveEntityActions(this.entityName);
-    }
-    resolveRepository() {
-        return this.services.resolveRepository(this.entityName);
-    }
-    resolveEventsManager() {
-        return this.services.resolveEventsManager(this.entityName);
-    }
-    resolveVersioningProvider() {
-        return this.services.resolveEntityVersioningProvider();
-    }
-    resolveEntityConfiguration() {
-        return this.services.resolveEntityConfiguration(this.entityName);
-    }
-    resolveReplicaSyncManager() {
-        return this.services.resolveReplicaSyncManager(this.entityName);
-    }
-    resolveReplicaConfiguration() {
-        return this.services.resolveReplicaConfiguration(this.entityName);
-    }
-    resolveReplicaDeleteManager() {
-        return this.services.resolveReplicaDeleteManager(this.entityName);
-    }
-    resolveConnectorSyncManager() {
-        return this.services.resolveConnectorSyncManager(this.entityName);
-    }
-    resolveConnectorDeleteManager() {
-        return this.services.resolveConnectorDeleteManager(this.entityName);
-    }
-    resolveConnectorsConfiguration() {
-        return this.services.resolveConnectorsConfiguration(this.entityName);
-    }
-    resolveConverter() {
-        return this.services.resolveConverter(this.entityName);
-    }
-    resolveSerializer() {
-        return this.services.resolveSerializer(this.entityName);
-    }
-    resolveSnapshotService() {
-        return this.services.resolveSnapshotService(this.entityName);
-    }
-    resolveAdapter() {
-        return this.services.resolveAdapter(this.entityName);
-    }
-    resolveAuthorizationMiddleware() {
-        return this.services.resolveAuthorizationMiddleware(this.entityName);
-    }
-    resolveGetQuery() {
-        return this.services.resolveGetQuery(this.entityName);
-    }
-    resolveExistsQuery() {
-        return this.services.resolveExistsQuery(this.entityName);
-    }
-    resolveCountQuery() {
-        return this.services.resolveCountQuery(this.entityName);
-    }
-    resolveVersionsSearchQuery() {
-        return this.services.resolveVersionsSearchQuery(this.entityName);
-    }
-    resolveSearchQuery() {
-        return this.services.resolveSearchQuery(this.entityName);
-    }
-    resolveFindQuery() {
-        return this.services.resolveFindQuery(this.entityName);
-    }
-    resolveCreateCommand() {
-        return this.services.resolveCreateCommand(this.entityName);
-    }
-    resolveUpdateCommand() {
-        return this.services.resolveUpdateCommand(this.entityName);
-    }
-    resolveUpsertCommand() {
-        return this.services.resolveUpsertCommand(this.entityName);
-    }
-    resolveUpsertByCommand() {
-        return this.services.resolveUpsertByCommand(this.entityName);
-    }
-    resolveDeleteCommand() {
-        return this.services.resolveDeleteCommand(this.entityName);
-    }
-    resolveDeleteItemsCommand() {
-        return this.services.resolveDeleteItemsCommand(this.entityName);
-    }
-    resolveVersionCommand() {
-        return this.services.resolveVersionCommand(this.entityName);
-    }
-    resolveSampleDownloadCommand() {
-        return this.services.resolveSampleDownloadCommand(this.entityName);
-    }
-    resolveImportCommand() {
-        return this.services.resolveImportCommand(this.entityName);
-    }
-    resolveExportCommand() {
-        return this.services.resolveExportCommand(this.entityName);
-    }
-    resolveGetAction() {
-        return this.services.resolveGetAction(this.entityName);
-    }
-    resolveExistsAction() {
-        return this.services.resolveExistsAction(this.entityName);
-    }
-    resolveCountAction() {
-        return this.services.resolveCountAction(this.entityName);
-    }
-    resolveSearchAction() {
-        return this.services.resolveSearchAction(this.entityName);
-    }
-    resolveVersionsSearchAction() {
-        return this.services.resolveVersionsSearchAction(this.entityName);
-    }
-    resolveCreateAction() {
-        return this.services.resolveCreateAction(this.entityName);
-    }
-    resolveUpdateAction() {
-        return this.services.resolveUpdateAction(this.entityName);
-    }
-    resolveUpsertAction() {
-        return this.services.resolveUpsertAction(this.entityName);
-    }
-    resolveDeleteAction() {
-        return this.services.resolveDeleteAction(this.entityName);
-    }
-    resolveDeleteItemsAction() {
-        return this.services.resolveDeleteItemsAction(this.entityName);
-    }
-    resolveImportAction() {
-        return this.services.resolveImportAction(this.entityName);
-    }
-    resolveSampleDownloadAction() {
-        return this.services.resolveSampleDownloadAction(this.entityName);
-    }
-    resolveExportAction() {
-        return this.services.resolveExportAction(this.entityName);
-    }
-    resolveQueryBuilder() {
-        return this.services.resolveQueryBuilder(this.entityName);
-    }
-    getEntityName() {
-        return this.entityName;
-    }
-}
 class EntitiesServiceLocator {
     constructor(provider) {
         this.provider = provider;
@@ -1867,6 +1809,12 @@ class EntitiesServiceLocator {
     registerImportCommand(entityName, instance) {
         this.provider.registerEntityService(EntityServices.Commands.IEntitiesImportCommand, entityName, instance);
     }
+    resolveParseCommand(entityName) {
+        return this.provider.resolveEntityService(EntityServices.Commands.IEntitiesParseCommand, entityName);
+    }
+    registerParseCommand(entityName, instance) {
+        this.provider.registerEntityService(EntityServices.Commands.IEntitiesParseCommand, entityName, instance);
+    }
     resolveSampleDownloadCommand(entityName) {
         return this.provider.resolveEntityService(EntityServices.Commands.IEntitiesSampleDownloadCommand, entityName);
     }
@@ -1951,6 +1899,12 @@ class EntitiesServiceLocator {
     registerImportAction(entityName, instance) {
         this.provider.registerEntityService(EntityServices.Actions.IEntitiesImportAction, entityName, instance);
     }
+    resolveParseAction(entityName) {
+        return this.provider.resolveEntityService(EntityServices.Actions.IEntitiesParseAction, entityName);
+    }
+    registerParseAction(entityName, instance) {
+        this.provider.registerEntityService(EntityServices.Actions.IEntitiesParseAction, entityName, instance);
+    }
     resolveQueryBuilder(entityName) {
         return this.provider.resolveEntityService(EntityServices.Queries.IEntitiesQueryBuilder, entityName);
     }
@@ -1959,6 +1913,169 @@ class EntitiesServiceLocator {
     }
 }
 
+class EntityServiceLocator {
+    constructor(services, entityName) {
+        this.services = services;
+        this.entityName = entityName;
+    }
+    getRootServices() {
+        return this.services;
+    }
+    resolveAuthenticationContextProvider() {
+        return this.services.resolveAuthenticationContextProvider();
+    }
+    resolveEntityManager() {
+        return this.services.resolveEntityManager(this.entityName);
+    }
+    resolveEntityActions() {
+        return this.services.resolveEntityActions(this.entityName);
+    }
+    resolveRepository() {
+        return this.services.resolveRepository(this.entityName);
+    }
+    resolveEventsManager() {
+        return this.services.resolveEventsManager(this.entityName);
+    }
+    resolveVersioningProvider() {
+        return this.services.resolveEntityVersioningProvider();
+    }
+    resolveEntityConfiguration() {
+        return this.services.resolveEntityConfiguration(this.entityName);
+    }
+    resolveReplicaSyncManager() {
+        return this.services.resolveReplicaSyncManager(this.entityName);
+    }
+    resolveReplicaConfiguration() {
+        return this.services.resolveReplicaConfiguration(this.entityName);
+    }
+    resolveReplicaDeleteManager() {
+        return this.services.resolveReplicaDeleteManager(this.entityName);
+    }
+    resolveConnectorSyncManager() {
+        return this.services.resolveConnectorSyncManager(this.entityName);
+    }
+    resolveConnectorDeleteManager() {
+        return this.services.resolveConnectorDeleteManager(this.entityName);
+    }
+    resolveConnectorsConfiguration() {
+        return this.services.resolveConnectorsConfiguration(this.entityName);
+    }
+    resolveConverter() {
+        return this.services.resolveConverter(this.entityName);
+    }
+    resolveSerializer() {
+        return this.services.resolveSerializer(this.entityName);
+    }
+    resolveSnapshotService() {
+        return this.services.resolveSnapshotService(this.entityName);
+    }
+    resolveAdapter() {
+        return this.services.resolveAdapter(this.entityName);
+    }
+    resolveAuthorizationMiddleware() {
+        return this.services.resolveAuthorizationMiddleware(this.entityName);
+    }
+    resolveGetQuery() {
+        return this.services.resolveGetQuery(this.entityName);
+    }
+    resolveExistsQuery() {
+        return this.services.resolveExistsQuery(this.entityName);
+    }
+    resolveCountQuery() {
+        return this.services.resolveCountQuery(this.entityName);
+    }
+    resolveVersionsSearchQuery() {
+        return this.services.resolveVersionsSearchQuery(this.entityName);
+    }
+    resolveSearchQuery() {
+        return this.services.resolveSearchQuery(this.entityName);
+    }
+    resolveFindQuery() {
+        return this.services.resolveFindQuery(this.entityName);
+    }
+    resolveCreateCommand() {
+        return this.services.resolveCreateCommand(this.entityName);
+    }
+    resolveUpdateCommand() {
+        return this.services.resolveUpdateCommand(this.entityName);
+    }
+    resolveUpsertCommand() {
+        return this.services.resolveUpsertCommand(this.entityName);
+    }
+    resolveUpsertByCommand() {
+        return this.services.resolveUpsertByCommand(this.entityName);
+    }
+    resolveDeleteCommand() {
+        return this.services.resolveDeleteCommand(this.entityName);
+    }
+    resolveDeleteItemsCommand() {
+        return this.services.resolveDeleteItemsCommand(this.entityName);
+    }
+    resolveVersionCommand() {
+        return this.services.resolveVersionCommand(this.entityName);
+    }
+    resolveSampleDownloadCommand() {
+        return this.services.resolveSampleDownloadCommand(this.entityName);
+    }
+    resolveImportCommand() {
+        return this.services.resolveImportCommand(this.entityName);
+    }
+    resolveParseCommand() {
+        return this.services.resolveParseCommand(this.entityName);
+    }
+    resolveExportCommand() {
+        return this.services.resolveExportCommand(this.entityName);
+    }
+    resolveGetAction() {
+        return this.services.resolveGetAction(this.entityName);
+    }
+    resolveExistsAction() {
+        return this.services.resolveExistsAction(this.entityName);
+    }
+    resolveCountAction() {
+        return this.services.resolveCountAction(this.entityName);
+    }
+    resolveSearchAction() {
+        return this.services.resolveSearchAction(this.entityName);
+    }
+    resolveVersionsSearchAction() {
+        return this.services.resolveVersionsSearchAction(this.entityName);
+    }
+    resolveCreateAction() {
+        return this.services.resolveCreateAction(this.entityName);
+    }
+    resolveUpdateAction() {
+        return this.services.resolveUpdateAction(this.entityName);
+    }
+    resolveUpsertAction() {
+        return this.services.resolveUpsertAction(this.entityName);
+    }
+    resolveDeleteAction() {
+        return this.services.resolveDeleteAction(this.entityName);
+    }
+    resolveDeleteItemsAction() {
+        return this.services.resolveDeleteItemsAction(this.entityName);
+    }
+    resolveImportAction() {
+        return this.services.resolveImportAction(this.entityName);
+    }
+    resolveParseAction() {
+        return this.services.resolveParseAction(this.entityName);
+    }
+    resolveSampleDownloadAction() {
+        return this.services.resolveSampleDownloadAction(this.entityName);
+    }
+    resolveExportAction() {
+        return this.services.resolveExportAction(this.entityName);
+    }
+    resolveQueryBuilder() {
+        return this.services.resolveQueryBuilder(this.entityName);
+    }
+    getEntityName() {
+        return this.entityName;
+    }
+}
+
 class EntitiesCountQuery {
     constructor(services) {
         this.services = services;
@@ -2515,7 +2632,9 @@ class EntityManagerServiceCollection {
         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));
+        this.locator.registerParseCommand(this.entityName, new EntitiesParseCommand(this.resolver, settings));
         this.locator.registerImportAction(this.entityName, new EntitiesImportAction(this.resolver));
+        this.locator.registerParseAction(this.entityName, new EntitiesParseAction(this.resolver));
         this.locator.registerSampleDownloadCommand(this.entityName, new EntitiesSampleDownloadCommand(this.resolver, settings));
         this.locator.registerSampleDownloadAction(this.entityName, new EntitiesSampleDownloadAction(this.resolver));
         return this;
@@ -34722,6 +34841,37 @@ class AppExceptionsFilterBase {
     }
 }
 
+class EntityParseValidationError {
+}
+__decorate([
+    swagger.ApiProperty(),
+    __metadata("design:type", String)
+], EntityParseValidationError.prototype, "errorCode", void 0);
+class EntityParseStatus {
+}
+__decorate([
+    swagger.ApiProperty(),
+    __metadata("design:type", Boolean)
+], EntityParseStatus.prototype, "isValid", void 0);
+__decorate([
+    swagger.ApiProperty({ type: [EntityParseValidationError] }),
+    __metadata("design:type", Array)
+], EntityParseStatus.prototype, "validationErrors", void 0);
+class EntityParseResult {
+}
+__decorate([
+    swagger.ApiProperty(),
+    __metadata("design:type", Number)
+], EntityParseResult.prototype, "rowIndex", void 0);
+__decorate([
+    swagger.ApiProperty({ type: Object }),
+    __metadata("design:type", Object)
+], EntityParseResult.prototype, "item", void 0);
+__decorate([
+    swagger.ApiProperty(),
+    __metadata("design:type", EntityParseStatus)
+], EntityParseResult.prototype, "status", void 0);
+
 const buildCompletedStepsSequence = (step) => {
     const steps = [];
     let currentStep = step;
@@ -44204,6 +44354,8 @@ exports.EntityManagerSymbols = EntityManagerSymbols;
 exports.EntityManagerUnauthorizedException = EntityManagerUnauthorizedException;
 exports.EntityNotFoundException = EntityNotFoundException;
 exports.EntityOperationUnauthorizedException = EntityOperationUnauthorizedException;
+exports.EntityParseResult = EntityParseResult;
+exports.EntityParseValidationError = EntityParseValidationError;
 exports.EntitySeeder = EntitySeeder;
 exports.EntitySerializer = EntitySerializer;
 exports.EntitySnapshotService = EntitySnapshotService;