@uniorganization/uni-lib 4.0.38 → 4.0.39

package/dist/entities/ticket-service-center-match-process.entity.d.ts

@@ -16,6 +16,8 @@ export declare class TicketServiceCenterMatchProcessEntity {
     sourceFileId: number | null;
     outputFile?: FileEntity | null;
     outputFileId: number | null;
+    excelOutputFile?: FileEntity | null;
+    excelOutputFileId: number | null;
     createdDate: Date;
     updatedDate: Date;
     deletedDate: Date | null;

package/dist/entities/ticket-service-center-match-process.entity.js

@@ -76,6 +76,15 @@ __decorate([
     (0, typeorm_1.Column)({ name: 'output_file_id', type: 'integer', nullable: true }),
     __metadata("design:type", Number)
 ], TicketServiceCenterMatchProcessEntity.prototype, "outputFileId", void 0);
+__decorate([
+    (0, typeorm_1.ManyToOne)(() => file_entity_1.FileEntity),
+    (0, typeorm_1.JoinColumn)({ name: 'excel_output_file_id' }),
+    __metadata("design:type", file_entity_1.FileEntity)
+], TicketServiceCenterMatchProcessEntity.prototype, "excelOutputFile", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ name: 'excel_output_file_id', type: 'integer', nullable: true }),
+    __metadata("design:type", Number)
+], TicketServiceCenterMatchProcessEntity.prototype, "excelOutputFileId", void 0);
 __decorate([
     (0, typeorm_1.CreateDateColumn)({ name: 'created_date', type: 'timestamp' }),
     __metadata("design:type", Date)

package/dist/enums/index.d.ts

@@ -1,3 +1,4 @@
 export * from './feedback-role.enum';
 export * from './service-center-status.enum';
 export * from './ticket-service-center-match-process-status.enum';
+export * from './ticket-service-center-match-progress-phase.enum';

package/dist/enums/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./feedback-role.enum"), exports);
 __exportStar(require("./service-center-status.enum"), exports);
 __exportStar(require("./ticket-service-center-match-process-status.enum"), exports);
+__exportStar(require("./ticket-service-center-match-progress-phase.enum"), exports);

package/dist/enums/ticket-service-center-match-progress-phase.enum.d.ts

@@ -0,0 +1,12 @@
+export declare enum TicketServiceCenterMatchProgressPhase {
+    PENDING = "PENDING",
+    PARSING = "PARSING",
+    MATCHING = "MATCHING",
+    GENERATING_CSV = "GENERATING_CSV",
+    GENERATING_EXCEL = "GENERATING_EXCEL",
+    UPLOADING_CSV = "UPLOADING_CSV",
+    UPLOADING_EXCEL = "UPLOADING_EXCEL",
+    FINALIZING = "FINALIZING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}

package/dist/enums/ticket-service-center-match-progress-phase.enum.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TicketServiceCenterMatchProgressPhase = void 0;
+var TicketServiceCenterMatchProgressPhase;
+(function (TicketServiceCenterMatchProgressPhase) {
+    TicketServiceCenterMatchProgressPhase["PENDING"] = "PENDING";
+    TicketServiceCenterMatchProgressPhase["PARSING"] = "PARSING";
+    TicketServiceCenterMatchProgressPhase["MATCHING"] = "MATCHING";
+    TicketServiceCenterMatchProgressPhase["GENERATING_CSV"] = "GENERATING_CSV";
+    TicketServiceCenterMatchProgressPhase["GENERATING_EXCEL"] = "GENERATING_EXCEL";
+    TicketServiceCenterMatchProgressPhase["UPLOADING_CSV"] = "UPLOADING_CSV";
+    TicketServiceCenterMatchProgressPhase["UPLOADING_EXCEL"] = "UPLOADING_EXCEL";
+    TicketServiceCenterMatchProgressPhase["FINALIZING"] = "FINALIZING";
+    TicketServiceCenterMatchProgressPhase["COMPLETED"] = "COMPLETED";
+    TicketServiceCenterMatchProgressPhase["FAILED"] = "FAILED";
+})(TicketServiceCenterMatchProgressPhase || (exports.TicketServiceCenterMatchProgressPhase = TicketServiceCenterMatchProgressPhase = {}));

package/dist/modules/file-storage/constants.d.ts

@@ -8,6 +8,7 @@ export declare const FILE_STORAGE_BUCKET_ENV_KEYS: readonly ["BUCKET_NAME", "BUC
 export declare const FILE_TYPE_CODES: {
     readonly SERVICE_CENTER_TICKET_MATCH_SOURCE: "SERVICE_CENTER_TICKET_MATCH_SOURCE";
     readonly SERVICE_CENTER_TICKET_MATCH_OUTPUT: "SERVICE_CENTER_TICKET_MATCH_OUTPUT";
+    readonly SERVICE_CENTER_TICKET_MATCH_EXCEL_OUTPUT: "SERVICE_CENTER_TICKET_MATCH_EXCEL_OUTPUT";
 };
 export declare const FILE_STORAGE_DEFAULT_BUCKET_PREFIX = "";
 export declare const FILE_STORAGE_ALLOWED_PATH_SEPARATOR = "/";

package/dist/modules/file-storage/constants.js

@@ -18,6 +18,7 @@ exports.FILE_STORAGE_BUCKET_ENV_KEYS = [
 exports.FILE_TYPE_CODES = {
     SERVICE_CENTER_TICKET_MATCH_SOURCE: 'SERVICE_CENTER_TICKET_MATCH_SOURCE',
     SERVICE_CENTER_TICKET_MATCH_OUTPUT: 'SERVICE_CENTER_TICKET_MATCH_OUTPUT',
+    SERVICE_CENTER_TICKET_MATCH_EXCEL_OUTPUT: 'SERVICE_CENTER_TICKET_MATCH_EXCEL_OUTPUT',
 };
 exports.FILE_STORAGE_DEFAULT_BUCKET_PREFIX = '';
 exports.FILE_STORAGE_ALLOWED_PATH_SEPARATOR = '/';

package/dist/modules/file-storage/file-storage.service.d.ts

@@ -20,6 +20,7 @@ export declare class FileStorageService {
     private readonly s3Client;
     constructor(fileRepository: Repository<FileEntity>, fileTypeRepository: Repository<FileTypeEntity>);
     uploadDocument(file: FileStorageUploadFile, options: FileStorageUploadOptions): Promise<FileEntity>;
+    deleteDocument(file: Pick<FileEntity, 'id' | 'path'>): Promise<void>;
     downloadDocument(bucketPath: string): Promise<Buffer>;
     resolveFileType(fileTypeCode?: string, fileTypeId?: number): Promise<FileTypeEntity>;
     private createS3Client;

package/dist/modules/file-storage/file-storage.service.js

@@ -74,11 +74,18 @@ let FileStorageService = FileStorageService_1 = class FileStorageService {
                 return yield this.fileRepository.save(fileRecord);
             }
             catch (error) {
-                yield this.deleteObject(bucketName, bucketPath);
+                yield this.deleteObject(bucketName, bucketPath, true);
                 throw error;
             }
         });
     }
+    deleteDocument(file) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bucketName = this.getRequiredEnv(constants_1.FILE_STORAGE_BUCKET_NAME_ENV);
+            yield this.deleteObject(bucketName, file.path);
+            yield this.fileRepository.softDelete(file.id);
+        });
+    }
     downloadDocument(bucketPath) {
         return __awaiter(this, void 0, void 0, function* () {
             const bucketName = this.getRequiredEnv(constants_1.FILE_STORAGE_BUCKET_NAME_ENV);
@@ -169,8 +176,8 @@ let FileStorageService = FileStorageService_1 = class FileStorageService {
             }
         });
     }
-    deleteObject(bucketName, bucketPath) {
-        return __awaiter(this, void 0, void 0, function* () {
+    deleteObject(bucketName_1, bucketPath_1) {
+        return __awaiter(this, arguments, void 0, function* (bucketName, bucketPath, suppressError = false) {
             try {
                 yield this.s3Client.send(new client_s3_1.DeleteObjectCommand({
                     Bucket: bucketName,
@@ -179,7 +186,10 @@ let FileStorageService = FileStorageService_1 = class FileStorageService {
             }
             catch (error) {
                 const errorMessage = error instanceof Error ? error.message : String(error);
-                this.logger.warn(`Uploaded object "${bucketPath}" could not be deleted after DB save failure: ${errorMessage}`);
+                this.logger.warn(`Object "${bucketPath}" could not be deleted: ${errorMessage}`);
+                if (!suppressError) {
+                    throw error;
+                }
             }
         });
     }

package/dist/modules/file-storage/file-storage.service.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/modules/file-storage/file-storage.service.spec.js

@@ -0,0 +1,107 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_s3_1 = require("@aws-sdk/client-s3");
+const file_storage_service_1 = require("./file-storage.service");
+const BUCKET_ENV_KEYS = [
+    'BUCKET_NAME',
+    'BUCKET_REGION',
+    'BUCKET_ACCESS_KEY_ID',
+    'BUCKET_SECRET_ACCESS_KEY',
+    'BUCKET_ENDPOINT',
+];
+describe('FileStorageService', () => {
+    let originalBucketEnv;
+    let fileRepository;
+    let fileTypeRepository;
+    let service;
+    let send;
+    beforeEach(() => {
+        originalBucketEnv = Object.fromEntries(BUCKET_ENV_KEYS.map((key) => [key, process.env[key]]));
+        process.env.BUCKET_NAME = 'documents';
+        process.env.BUCKET_REGION = 'us-east-1';
+        process.env.BUCKET_ACCESS_KEY_ID = 'access-key';
+        process.env.BUCKET_SECRET_ACCESS_KEY = 'secret-key';
+        process.env.BUCKET_ENDPOINT = 'https://storage.example.com';
+        fileRepository = {
+            softDelete: jest.fn().mockResolvedValue({ raw: [], affected: 1 }),
+            create: jest.fn(),
+            save: jest.fn(),
+        };
+        fileTypeRepository = { findOne: jest.fn() };
+        service = new file_storage_service_1.FileStorageService(fileRepository, fileTypeRepository);
+        jest.spyOn(service.logger, 'warn').mockImplementation(() => undefined);
+        send = jest.fn().mockResolvedValue({});
+        service.s3Client.send = send;
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+        for (const key of BUCKET_ENV_KEYS) {
+            const originalValue = originalBucketEnv[key];
+            if (originalValue === undefined) {
+                delete process.env[key];
+            }
+            else {
+                process.env[key] = originalValue;
+            }
+        }
+    });
+    describe('deleteDocument', () => {
+        it('deletes the bucket object before soft-deleting file metadata', () => __awaiter(void 0, void 0, void 0, function* () {
+            yield service.deleteDocument({ id: 44, path: 'outputs/file.csv' });
+            expect(send).toHaveBeenCalledTimes(1);
+            const command = send.mock.calls[0][0];
+            expect(command).toBeInstanceOf(client_s3_1.DeleteObjectCommand);
+            expect(command.input).toEqual({
+                Bucket: 'documents',
+                Key: 'outputs/file.csv',
+            });
+            expect(fileRepository.softDelete).toHaveBeenCalledWith(44);
+            expect(send.mock.invocationCallOrder[0]).toBeLessThan(fileRepository.softDelete.mock.invocationCallOrder[0]);
+        }));
+        it('rejects without soft-deleting metadata when bucket deletion fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            const deletionError = new Error('bucket unavailable');
+            send.mockRejectedValue(deletionError);
+            yield expect(service.deleteDocument({ id: 44, path: 'outputs/file.csv' })).rejects.toBe(deletionError);
+            expect(fileRepository.softDelete).not.toHaveBeenCalled();
+        }));
+    });
+    describe('uploadDocument', () => {
+        it('preserves the DB save error when rollback object deletion fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            const dbSaveError = new Error('distinctive DB save failure');
+            const cleanupError = new Error('rollback delete failure');
+            const fileRecord = { id: 44, path: 'pending/file.csv' };
+            fileTypeRepository.findOne.mockResolvedValue({
+                id: 7,
+                code: 'SOURCE_FILES',
+            });
+            fileRepository.create.mockReturnValue(fileRecord);
+            fileRepository.save.mockRejectedValue(dbSaveError);
+            send.mockImplementation((command) => {
+                if (command instanceof client_s3_1.PutObjectCommand) {
+                    return Promise.resolve({});
+                }
+                if (command instanceof client_s3_1.DeleteObjectCommand) {
+                    return Promise.reject(cleanupError);
+                }
+                throw new Error('Unexpected S3 command');
+            });
+            yield expect(service.uploadDocument({
+                originalname: 'tickets.csv',
+                mimetype: 'text/csv',
+                buffer: Buffer.from('ticket'),
+            }, { fileTypeCode: 'SOURCE_FILES' })).rejects.toBe(dbSaveError);
+            expect(send).toHaveBeenCalledTimes(2);
+            expect(send.mock.calls[0][0]).toBeInstanceOf(client_s3_1.PutObjectCommand);
+            expect(send.mock.calls[1][0]).toBeInstanceOf(client_s3_1.DeleteObjectCommand);
+        }));
+    });
+});

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from './object.utils';
 export * from './string.utils';
 export * from './parse.util';
+export * from './ticket-service-center-match-progress.util';

package/dist/utils/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./object.utils"), exports);
 __exportStar(require("./string.utils"), exports);
 __exportStar(require("./parse.util"), exports);
+__exportStar(require("./ticket-service-center-match-progress.util"), exports);

package/dist/utils/ticket-service-center-match-progress.util.d.ts

@@ -0,0 +1,9 @@
+import { TicketServiceCenterMatchProgressPhase } from '../enums/ticket-service-center-match-progress-phase.enum';
+export interface TicketServiceCenterMatchProgressState {
+    phase: TicketServiceCenterMatchProgressPhase;
+    totalTickets: number | null;
+    previousPhase?: TicketServiceCenterMatchProgressPhase;
+    error?: string;
+}
+export declare const serializeTicketServiceCenterMatchProgress: (state: TicketServiceCenterMatchProgressState) => string;
+export declare const parseTicketServiceCenterMatchProgress: (value: string | null | undefined) => TicketServiceCenterMatchProgressState | null;

package/dist/utils/ticket-service-center-match-progress.util.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTicketServiceCenterMatchProgress = exports.serializeTicketServiceCenterMatchProgress = void 0;
+const ticket_service_center_match_progress_phase_enum_1 = require("../enums/ticket-service-center-match-progress-phase.enum");
+const progressPhases = new Set(Object.values(ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase));
+const isProgressPhase = (value) => typeof value === 'string' && progressPhases.has(value);
+const isValidTotalTickets = (value) => value === null || (typeof value === 'number' && Number.isInteger(value) && value >= 0);
+const serializeTicketServiceCenterMatchProgress = (state) => JSON.stringify(state);
+exports.serializeTicketServiceCenterMatchProgress = serializeTicketServiceCenterMatchProgress;
+const parseTicketServiceCenterMatchProgress = (value) => {
+    if (!value) {
+        return null;
+    }
+    try {
+        const state = JSON.parse(value);
+        if (typeof state !== 'object' || state === null || Array.isArray(state)) {
+            return null;
+        }
+        const candidate = state;
+        const { phase, totalTickets, previousPhase, error } = candidate;
+        if (!isProgressPhase(phase) || !isValidTotalTickets(totalTickets)) {
+            return null;
+        }
+        const progressState = {
+            phase,
+            totalTickets,
+        };
+        if (previousPhase !== undefined) {
+            if (!isProgressPhase(previousPhase)) {
+                return null;
+            }
+            progressState.previousPhase = previousPhase;
+        }
+        if (error !== undefined) {
+            if (typeof error !== 'string') {
+                return null;
+            }
+            progressState.error = error;
+        }
+        return progressState;
+    }
+    catch (_a) {
+        return null;
+    }
+};
+exports.parseTicketServiceCenterMatchProgress = parseTicketServiceCenterMatchProgress;

package/dist/utils/ticket-service-center-match-progress.util.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/ticket-service-center-match-progress.util.spec.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ticket_service_center_match_progress_phase_enum_1 = require("../enums/ticket-service-center-match-progress-phase.enum");
+const ticket_service_center_match_progress_util_1 = require("./ticket-service-center-match-progress.util");
+describe('ticket service center match progress', () => {
+    it('round-trips matching progress', () => {
+        const state = {
+            phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.MATCHING,
+            totalTickets: 100,
+        };
+        expect((0, ticket_service_center_match_progress_util_1.parseTicketServiceCenterMatchProgress)((0, ticket_service_center_match_progress_util_1.serializeTicketServiceCenterMatchProgress)(state))).toEqual(state);
+    });
+    it.each([
+        ['null', null],
+        ['empty text', ''],
+        ['legacy error text', 'Failed to process uploaded ticket file'],
+        ['malformed JSON', '{"phase":'],
+    ])('returns null for %s', (_description, value) => {
+        expect((0, ticket_service_center_match_progress_util_1.parseTicketServiceCenterMatchProgress)(value)).toBeNull();
+    });
+    it.each([
+        ['missing phase', { totalTickets: 10 }],
+        ['invalid phase', { phase: 'IMPORTING', totalTickets: 10 }],
+        ['missing totalTickets', { phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.PARSING }],
+        ['negative totalTickets', { phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.PARSING, totalTickets: -1 }],
+        ['fractional totalTickets', { phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.PARSING, totalTickets: 1.5 }],
+        ['string totalTickets', { phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.PARSING, totalTickets: '10' }],
+        [
+            'invalid previousPhase',
+            { phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.FAILED, totalTickets: 10, previousPhase: 'IMPORTING' },
+        ],
+        ['non-string error', { phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.FAILED, totalTickets: 10, error: 500 }],
+    ])('returns null for a state with %s', (_description, state) => {
+        expect((0, ticket_service_center_match_progress_util_1.parseTicketServiceCenterMatchProgress)(JSON.stringify(state))).toBeNull();
+    });
+    it('retains failure context', () => {
+        const state = {
+            phase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.FAILED,
+            previousPhase: ticket_service_center_match_progress_phase_enum_1.TicketServiceCenterMatchProgressPhase.UPLOADING_EXCEL,
+            totalTickets: 12,
+            error: 'Excel upload failed',
+        };
+        expect((0, ticket_service_center_match_progress_util_1.parseTicketServiceCenterMatchProgress)((0, ticket_service_center_match_progress_util_1.serializeTicketServiceCenterMatchProgress)(state))).toEqual(state);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniorganization/uni-lib",
-  "version": "4.0.38",
+  "version": "4.0.39",
   "description": "UNI Library",
   "author": "Jhomiguel",
   "main": "dist/index.js",