@punks/backend-entity-manager 0.0.89 → 0.0.91

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

@@ -31,4 +31,5 @@ export type EntitiesSampleDownloadOptions = {
 };
 export type EntitiesSampleDownloadResult = {
     file: EntitiesExportFile;
+    downloadUrl: string;
 };

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

@@ -1,8 +1,12 @@
 import { IEntitiesSampleDownloadCommand } from "../abstractions/commands";
 import { EntityServiceLocator } from "../providers/services";
-import { EntitiesSampleDownloadOptions, EntitiesSampleDownloadResult } from "../abstractions";
+import { EntitiesImportExportSettings, EntitiesSampleDownloadOptions, EntitiesSampleDownloadResult } from "../abstractions";
 export declare class EntitiesSampleDownloadCommand<TEntity> implements IEntitiesSampleDownloadCommand<TEntity> {
     private readonly services;
-    constructor(services: EntityServiceLocator<TEntity, unknown>);
+    private readonly settings;
+    constructor(services: EntityServiceLocator<TEntity, unknown>, settings: EntitiesImportExportSettings);
     execute(input: EntitiesSampleDownloadOptions): Promise<EntitiesSampleDownloadResult>;
+    private uploadSampleFile;
+    private buildAbsoluteBucketPath;
+    private get bucket();
 }

package/dist/cjs/types/platforms/nest/__test__/server/app/foos/foo.controller.d.ts

@@ -1,8 +1,6 @@
 /// <reference types="multer" />
-import { StreamableFile } from "@nestjs/common";
-import type { Response } from "express";
 import { FooActions } from "./foo.actions";
-import { FooCreateDto, FooDto, FooExportRequest, FooExportResponse, FooImportRequest, FooSampleDownloadRequest, FooSearchRequest, FooSearchResponse, FooUpdateDto } from "./foo.dto";
+import { FooCreateDto, FooDto, FooExportRequest, FooExportResponse, FooImportRequest, FooSampleDownloadRequest, FooSampleDownloadResponse, FooSearchRequest, FooSearchResponse, FooUpdateDto } from "./foo.dto";
 export declare class FooController {
     private readonly actions;
     constructor(actions: FooActions);
@@ -13,5 +11,5 @@ export declare class FooController {
     search(request: FooSearchRequest): Promise<FooSearchResponse>;
     import(file: Express.Multer.File, request: FooImportRequest): Promise<void>;
     export(request: FooExportRequest): Promise<FooExportResponse>;
-    sampleDownload(res: Response, request: FooSampleDownloadRequest): Promise<StreamableFile>;
+    sampleDownload(request: FooSampleDownloadRequest): Promise<FooSampleDownloadResponse>;
 }

package/dist/cjs/types/platforms/nest/__test__/server/app/foos/foo.dto.d.ts

@@ -37,11 +37,11 @@ export declare class FooExportRequest {
     filter?: FooSearchParameters;
 }
 export declare class FooExportResponse {
-    fileUrl: string;
+    downloadUrl: string;
 }
 export declare class FooSampleDownloadRequest {
     format: EntitySerializationFormat;
 }
 export declare class FooSampleDownloadResponse {
-    fileUrl: string;
+    downloadUrl: string;
 }

package/dist/esm/index.js

@@ -140,10 +140,16 @@ class EntitySerializer {
                 return {
                     fileName,
                     contentType: "text/csv",
-                    content: Buffer.from(csvBuild([{}], this.getDefinition().columns.map((c) => ({
-                        name: c.name,
-                        value: () => c.sampleValue ?? "",
-                    }))), "utf-8"),
+                    content: Buffer.from(csvBuild([{}], [
+                        {
+                            name: "_type",
+                            value: () => this.entityName,
+                        },
+                        ...this.getDefinition().columns.map((c) => ({
+                            name: c.name,
+                            value: () => c.sampleValue ?? "",
+                        })),
+                    ]), "utf-8"),
                 };
             case EntitySerializationFormat.Xlsx:
                 return {
@@ -152,11 +158,17 @@ class EntitySerializer {
                     content: Buffer.from(excelBuild({
                         data: [{}],
                         sheetName: this.entityName,
-                        columns: this.getDefinition().columns.map((c) => ({
-                            header: c.name,
-                            value: () => c.sampleValue ?? "",
-                            headerSize: c.colSpan,
-                        })),
+                        columns: [
+                            {
+                                header: "_type",
+                                value: () => this.entityName,
+                            },
+                            ...this.getDefinition().columns.map((c) => ({
+                                header: c.name,
+                                value: () => c.sampleValue ?? "",
+                                headerSize: c.colSpan,
+                            })),
+                        ],
                     })),
                 };
             case EntitySerializationFormat.Json:
@@ -710,11 +722,11 @@ class EntitiesSampleDownloadAction {
         this.logger = Log.getLogger(`${services.getEntityName()} -> Import`);
     }
     async execute(input) {
-        this.logger.debug("Import action started", { input });
+        this.logger.debug("Sample download action started", { input });
         const result = await this.services
             .resolveSampleDownloadCommand()
             .execute(input);
-        this.logger.debug("Import action completed", { input });
+        this.logger.debug("Sample download action completed", { input });
         return result;
     }
 }
@@ -916,7 +928,7 @@ class EntitiesExportCommand {
         });
     }
     buildAbsoluteBucketPath(relativePath) {
-        return `${this.settings.exportBucket.rootFolderPath ?? ""}/${createDayPath(new Date())}/${relativePath}`;
+        return `${this.settings.exportBucket.rootFolderPath ?? ""}/exports/${createDayPath(new Date())}/${relativePath}`;
     }
     async getExportEntities(filters) {
         return this.services.resolveSearchQuery().execute(filters ?? {});
@@ -937,21 +949,43 @@ class EntitiesImportCommand {
 }
 
 class EntitiesSampleDownloadCommand {
-    constructor(services) {
+    constructor(services, settings) {
         this.services = services;
+        this.settings = settings;
     }
     async execute(input) {
         const sample = await this.services
             .resolveSerializer()
             .createSample(input.format);
+        const downloadUrl = await this.uploadSampleFile(sample);
         return {
             file: {
                 content: sample.content,
                 contentType: sample.contentType,
                 name: sample.fileName,
             },
+            downloadUrl,
         };
     }
+    async uploadSampleFile(file) {
+        await this.bucket.fileUpload({
+            bucket: this.settings.exportBucket.bucket,
+            filePath: this.buildAbsoluteBucketPath(file.fileName),
+            content: file.content,
+            contentType: file.contentType,
+        });
+        return await this.bucket.filePublicUrlCreate({
+            bucket: this.settings.exportBucket.bucket,
+            expirationMinutes: this.settings.exportBucket.publicLinksExpirationMinutes,
+            filePath: this.buildAbsoluteBucketPath(file.fileName),
+        });
+    }
+    buildAbsoluteBucketPath(relativePath) {
+        return `${this.settings.exportBucket.rootFolderPath ?? ""}/samples/${createDayPath(new Date())}/${relativePath}`;
+    }
+    get bucket() {
+        return this.services.getRootServices().resolveBucketProvider();
+    }
 }
 
 class EntityUpdateCommand {
@@ -2098,7 +2132,7 @@ class EntityManagerServiceCollection {
         this.locator.registerExportAction(this.entityName, new EntitiesExportAction(this.resolver));
         this.locator.registerImportCommand(this.entityName, new EntitiesImportCommand(this.resolver, settings));
         this.locator.registerImportAction(this.entityName, new EntitiesImportAction(this.resolver));
-        this.locator.registerSampleDownloadCommand(this.entityName, new EntitiesSampleDownloadCommand(this.resolver));
+        this.locator.registerSampleDownloadCommand(this.entityName, new EntitiesSampleDownloadCommand(this.resolver, settings));
         this.locator.registerSampleDownloadAction(this.entityName, new EntitiesSampleDownloadAction(this.resolver));
         return this;
     }