@mbc-cqrs-serverless/import 0.1.74-beta.0

package/dist/interface/import-entity-profile.interface.d.ts

@@ -0,0 +1,23 @@
+import { Type } from '@nestjs/common';
+import { IImportStrategy } from './import-strategy.interface';
+import { IProcessStrategy } from './processing-strategy.interface';
+/**
+ * Defines the complete import configuration for a single entity type (tableName).
+ * This unified profile groups all related strategies and validators.
+ */
+export interface ImportEntityProfile {
+    /**
+     * A unique identifier for this data type (e.g., 'policies', 'users').
+     */
+    tableName: string;
+    /**
+     * The class that implements the initial import logic (transform & validate).
+     * Must be a class that adheres to the IImportStrategy interface.
+     */
+    importStrategy: Type<IImportStrategy<any, any>>;
+    /**
+     * The class that implements the business processing logic (compare & map).
+     * Must be a class that adheres to the IProcessStrategy interface.
+     */
+    processStrategy: Type<IProcessStrategy<any, any>>;
+}

package/dist/interface/import-entity-profile.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=import-entity-profile.interface.js.map

package/dist/interface/import-entity-profile.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-entity-profile.interface.js","sourceRoot":"","sources":["../../src/interface/import-entity-profile.interface.ts"],"names":[],"mappings":""}

package/dist/interface/import-strategy.interface.d.ts

@@ -0,0 +1,27 @@
+export interface IImportStrategy<TInput extends object, TAttributesDto extends object> {
+    /**
+     * Transforms a raw input object (from an API, CSV row, etc.)
+     * into a standardized DTO.
+     */
+    transform(input: TInput): Promise<TAttributesDto>;
+    /**
+     * Validates the standardized DTO.
+     * @throws {Error} or a custom exception if validation fails.
+     */
+    validate(data: TAttributesDto): Promise<void>;
+}
+/**
+ * A base class (framework) that provides partial logic for an Import Strategy.
+ * Users can extend this class to save effort.
+ */
+export declare abstract class BaseImportStrategy<TInput extends object, TAttributesDto extends object> implements IImportStrategy<TInput, TAttributesDto> {
+    transform(input: TInput): Promise<TAttributesDto>;
+    validate(data: TAttributesDto): Promise<void>;
+    /**
+     * Recursively flattens validation errors into a single array of strings.
+     * @param errors The array of ValidationError objects.
+     * @param parentPath The path of the parent property, used for building nested paths.
+     * @returns An array of human-readable error strings.
+     */
+    private flattenValidationErrors;
+}

package/dist/interface/import-strategy.interface.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseImportStrategy = void 0;
+const common_1 = require("@nestjs/common");
+const class_validator_1 = require("class-validator");
+/**
+ * A base class (framework) that provides partial logic for an Import Strategy.
+ * Users can extend this class to save effort.
+ */
+class BaseImportStrategy {
+    async transform(input) {
+        return input;
+    }
+    async validate(data) {
+        const errors = await (0, class_validator_1.validate)(data);
+        if (errors.length > 0) {
+            const flatMessages = this.flattenValidationErrors(errors);
+            throw new common_1.BadRequestException({
+                statusCode: 400,
+                message: flatMessages,
+                error: 'Bad Request',
+            });
+        }
+    }
+    /**
+     * Recursively flattens validation errors into a single array of strings.
+     * @param errors The array of ValidationError objects.
+     * @param parentPath The path of the parent property, used for building nested paths.
+     * @returns An array of human-readable error strings.
+     */
+    flattenValidationErrors(errors, parentPath = '') {
+        const messages = [];
+        for (const error of errors) {
+            const currentPath = parentPath
+                ? `${parentPath}.${error.property}`
+                : error.property;
+            // If there are children, recurse to find the nested errors
+            if (error.children && error.children.length > 0) {
+                messages.push(...this.flattenValidationErrors(error.children, currentPath));
+            }
+            // Otherwise, we've found the constraint. Format the message.
+            else if (error.constraints) {
+                // The default message from class-validator often includes the property name.
+                // To avoid duplication like "attributes.policyType: policyType must be...",
+                // we can simply replace the first word of the message with the full path.
+                const firstConstraint = Object.values(error.constraints)[0];
+                const message = firstConstraint.replace(error.property, currentPath);
+                messages.push(message);
+            }
+        }
+        return messages;
+    }
+}
+exports.BaseImportStrategy = BaseImportStrategy;
+//# sourceMappingURL=import-strategy.interface.js.map

package/dist/interface/import-strategy.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"import-strategy.interface.js","sourceRoot":"","sources":["../../src/interface/import-strategy.interface.ts"],"names":[],"mappings":";;;AAAA,2CAAoD;AACpD,qDAA2D;AAmB3D;;;GAGG;AACH,MAAsB,kBAAkB;IAKtC,KAAK,CAAC,SAAS,CAAC,KAAa;QAC3B,OAAO,KAAkC,CAAA;IAC3C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAoB;QACjC,MAAM,MAAM,GAAG,MAAM,IAAA,0BAAQ,EAAC,IAAI,CAAC,CAAA;QACnC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAA;YACzD,MAAM,IAAI,4BAAmB,CAAC;gBAC5B,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,YAAY;gBACrB,KAAK,EAAE,aAAa;aACrB,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACK,uBAAuB,CAC7B,MAAyB,EACzB,UAAU,GAAG,EAAE;QAEf,MAAM,QAAQ,GAAG,EAAE,CAAA;QACnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,WAAW,GAAG,UAAU;gBAC5B,CAAC,CAAC,GAAG,UAAU,IAAI,KAAK,CAAC,QAAQ,EAAE;gBACnC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAA;YAElB,2DAA2D;YAC3D,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChD,QAAQ,CAAC,IAAI,CACX,GAAG,IAAI,CAAC,uBAAuB,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAC7D,CAAA;YACH,CAAC;YACD,6DAA6D;iBACxD,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;gBAC3B,6EAA6E;gBAC7E,4EAA4E;gBAC5E,0EAA0E;gBAC1E,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;gBAC3D,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;gBACpE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YACxB,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF;AAvDD,gDAuDC"}

package/dist/interface/index.d.ts

@@ -0,0 +1,4 @@
+export * from './csv-mapping-strategy.interface';
+export * from './import-entity-profile.interface';
+export * from './import-strategy.interface';
+export * from './processing-strategy.interface';

package/dist/interface/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./csv-mapping-strategy.interface"), exports);
+__exportStar(require("./import-entity-profile.interface"), exports);
+__exportStar(require("./import-strategy.interface"), exports);
+__exportStar(require("./processing-strategy.interface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/interface/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interface/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mEAAgD;AAChD,oEAAiD;AACjD,8DAA2C;AAC3C,kEAA+C"}

package/dist/interface/processing-strategy.interface.d.ts

@@ -0,0 +1,57 @@
+import { CommandInputModel, CommandPartialInputModel, CommandService, DataModel } from '@mbc-cqrs-serverless/core';
+import { ComparisonStatus } from '../enum/comparison-status.enum';
+/**
+ * Defines the standardized result of a comparison operation.
+ * It indicates whether the imported data corresponds to a new, changed, or identical entity.
+ * @template TEntity The type of the database entity model, extending DataModel.
+ */
+export interface ComparisonResult<TEntity extends DataModel> {
+    status: ComparisonStatus;
+    /**
+     * If the status is 'CHANGED', this property holds the existing entity data
+     * retrieved from the database. It is undefined otherwise.
+     */
+    existingData?: TEntity;
+}
+/**
+ * The core strategy interface for processing a single, validated import record.
+ * Developers implement this interface to define the business logic for comparing
+ * imported data with existing records and mapping it to the final database model.
+ *
+ * @template TEntity The type of the final database entity model (e.g., ProductModel).
+ * @template TAttributesDto The type of the validated attributes DTO (e.g., CreateProductImportAttributesDto).
+ */
+export interface IProcessStrategy<TEntity extends DataModel, TAttributesDto extends object> {
+    /**
+     * Compares the validated import data with data already in the target system
+     * to determine if it's a new entity, a changed one, or identical.
+     * @param importAttributes The strongly-typed, validated attributes object.
+     * @param tenantCode The tenant code for the operation.
+     * @returns A promise that resolves with a ComparisonResult object.
+     */
+    compare(importAttributes: TAttributesDto, tenantCode: string): Promise<ComparisonResult<TEntity>>;
+    /**
+     * Maps the validated import data into the precise input model required by the CommandService.
+     * The implementer is responsible for constructing the correct payload for either a
+     * create (`CommandInputModel`) or an update (`CommandPartialInputModel`).
+     *
+     * @param status The result from the `compare` step ('NOT_EXIST' or 'CHANGED').
+     * @param importAttributes The strongly-typed, validated attributes object.
+     * @param tenantCode The tenant code for the operation.
+     * @param existingData The existing entity data, provided if status is 'CHANGED'.
+     * @returns A promise that resolves with the input model for the CommandService.
+     */
+    map(status: Exclude<ComparisonStatus, ComparisonStatus.EQUAL>, importAttributes: TAttributesDto, tenantCode: string, existingData?: TEntity): Promise<CommandInputModel | CommandPartialInputModel>;
+    /**
+     * Provides an instance of the command service for the final database write.
+     */
+    getCommandService(): CommandService;
+}
+/**
+ * A base class (framework) for a Process Strategy.
+ */
+export declare abstract class BaseProcessStrategy<TEntity extends DataModel, TTransformedDto extends object> implements IProcessStrategy<TEntity, TTransformedDto> {
+    abstract compare(transformedData: TTransformedDto, tenantCode: string): Promise<ComparisonResult<TEntity>>;
+    abstract map(status: Exclude<ComparisonStatus, ComparisonStatus.EQUAL>, transformedData: TTransformedDto, tenantCode: string, existingData?: TEntity): Promise<CommandInputModel | CommandPartialInputModel>;
+    abstract getCommandService(): CommandService;
+}

package/dist/interface/processing-strategy.interface.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseProcessStrategy = void 0;
+/**
+ * A base class (framework) for a Process Strategy.
+ */
+class BaseProcessStrategy {
+}
+exports.BaseProcessStrategy = BaseProcessStrategy;
+//# sourceMappingURL=processing-strategy.interface.js.map

package/dist/interface/processing-strategy.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processing-strategy.interface.js","sourceRoot":"","sources":["../../src/interface/processing-strategy.interface.ts"],"names":[],"mappings":";;;AAsEA;;GAEG;AACH,MAAsB,mBAAmB;CAkBxC;AAlBD,kDAkBC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@mbc-cqrs-serverless/import",
+  "version": "0.1.74-beta.0",
+  "description": "Import module",
+  "keywords": [
+    "mbc",
+    "cqrs",
+    "serverless",
+    "framework",
+    "event-driven",
+    "backend",
+    "aws",
+    "lambda",
+    "ecs",
+    "fargate",
+    "step-functions",
+    "sqs",
+    "typescript"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "scripts": {
+    "build": "rm -rf dist && nest build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mbc-net/mbc-cqrs-serverless.git"
+  },
+  "author": "Murakami Business Consulting, Inc.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mbc-net/mbc-cqrs-serverless/issues"
+  },
+  "homepage": "https://mbc-cqrs-serverless.mbc-net.com/",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@mbc-cqrs-serverless/core": "^0.1.74-beta.0",
+    "csv-parser": "^3.2.0"
+  },
+  "gitHead": "c3befdd5f0b905b0b285acd12e3129c37e3f5f36"
+}