@fiado/type-kit 3.524.0 → 3.526.0

package/_test_/unit/pdfRender/pdfRenderDtos.test.ts

@@ -64,3 +64,23 @@ describe('pdfRender admin DTOs', () => {
         expect(await errorsOf(TemplateLocationRequest, {})).toEqual(['enterprise']);
     });
 });
+
+describe('pdfRender includeContent', () => {
+    it('is optional and must be boolean on the three generation requests', async () => {
+        const template = { enterprise: 'FIADOSA', documentType: 'X' };
+        expect(await errorsOf(RenderDocumentRequest, { template, data: {}, includeContent: true })).toEqual([]);
+        expect(await errorsOf(RenderDocumentRequest, { template, data: {}, includeContent: 'yes' })).toEqual(['includeContent']);
+        expect(await errorsOf(GeneratePdfRequest, { html: '<p/>', includeContent: false })).toEqual([]);
+        expect(await errorsOf(MergePdfsRequest, { pdfs: ['JVBERi0='], includeContent: 1 })).toEqual(['includeContent']);
+    });
+});
+
+describe('pdfRender referenceId', () => {
+    it('accepts the owner id and folder fields, and rejects unsafe segments', async () => {
+        const template = { enterprise: 'SUREKEEP', documentType: 'CREDITO_CONTRATO' };
+        expect(await errorsOf(RenderDocumentRequest, { template, data: {}, referenceId: '01JX9KAB12' })).toEqual([]);
+        expect(await errorsOf(RenderDocumentRequest, { template, data: {}, referenceId: '../x' })).toEqual(['referenceId']);
+        expect(await errorsOf(GeneratePdfRequest, { html: '<p/>', enterprise: 'SUREKEEP', documentType: 'CREDITO_RESUMEN', referenceId: 'abc' })).toEqual([]);
+        expect(await errorsOf(MergePdfsRequest, { pdfs: ['JVBERi0='], enterprise: 'A/B' })).toEqual(['enterprise']);
+    });
+});

package/bin/pdfRender/dtos/DocumentUrlResponse.d.ts

@@ -0,0 +1,10 @@
+/** Nueva URL firmada para un documento ya guardado. */
+export declare class DocumentUrlResponse {
+    key: string;
+    url: string;
+    /** ISO-8601. */
+    expiresAt: string;
+    sha256: string;
+    pages: number;
+    bytes: number;
+}

package/bin/pdfRender/dtos/DocumentUrlResponse.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentUrlResponse = void 0;
+/** Nueva URL firmada para un documento ya guardado. */
+class DocumentUrlResponse {
+}
+exports.DocumentUrlResponse = DocumentUrlResponse;

package/bin/pdfRender/dtos/GeneratePdfRequest.d.ts

@@ -1,4 +1,16 @@
 /** HTML ya resuelto por el consumidor; se imprime en A4 con márgenes de 2 mm. */
 export declare class GeneratePdfRequest {
     html: string;
+    /** Además de la URL, devuelve el PDF en base64 en la respuesta (tope de 4 MiB). */
+    includeContent?: boolean;
+    /** Empresa (tenant) dueña del documento; sin ella se guarda en una carpeta común. */
+    enterprise?: string;
+    /** Tipo de documento (carpeta en S3), p. ej. CREDITO_CONTRATO. */
+    documentType?: string;
+    /**
+     * Id de la entidad dueña del documento (crédito, cliente...). Forma parte de la llave en S3, igual
+     * que en el resto del bucket de contratos: {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf, o con partner
+     * {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf.
+     */
+    referenceId?: string;
 }

package/bin/pdfRender/dtos/GeneratePdfRequest.js

@@ -20,3 +20,26 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
 ], GeneratePdfRequest.prototype, "html", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], GeneratePdfRequest.prototype, "includeContent", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], GeneratePdfRequest.prototype, "enterprise", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], GeneratePdfRequest.prototype, "documentType", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], GeneratePdfRequest.prototype, "referenceId", void 0);

package/bin/pdfRender/dtos/MergePdfsRequest.d.ts

@@ -1,4 +1,16 @@
 /** PDFs en base64, en el orden en que deben quedar en el documento final. */
 export declare class MergePdfsRequest {
     pdfs: string[];
+    /** Además de la URL, devuelve el PDF en base64 en la respuesta (tope de 4 MiB). */
+    includeContent?: boolean;
+    /** Empresa (tenant) dueña del documento; sin ella se guarda en una carpeta común. */
+    enterprise?: string;
+    /** Tipo de documento (carpeta en S3), p. ej. CREDITO_CONTRATO. */
+    documentType?: string;
+    /**
+     * Id de la entidad dueña del documento (crédito, cliente...). Forma parte de la llave en S3, igual
+     * que en el resto del bucket de contratos: {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf, o con partner
+     * {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf.
+     */
+    referenceId?: string;
 }

package/bin/pdfRender/dtos/MergePdfsRequest.js

@@ -22,3 +22,26 @@ __decorate([
     (0, class_validator_1.IsString)({ each: true }),
     __metadata("design:type", Array)
 ], MergePdfsRequest.prototype, "pdfs", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], MergePdfsRequest.prototype, "includeContent", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], MergePdfsRequest.prototype, "enterprise", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], MergePdfsRequest.prototype, "documentType", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], MergePdfsRequest.prototype, "referenceId", void 0);

package/bin/pdfRender/dtos/PdfDocumentResponse.d.ts

@@ -1,5 +1,17 @@
+/**
+ * Documento PDF generado y guardado por pdf-render-business.
+ * `key` es la ubicación del documento por convención ({EMPRESA}/{TIPO}/{aaaa}/{mm}/{uuid}.pdf) y
+ * es lo que se guarda para pedir una URL nueva con GET /documents/url?key=... cuando venza la actual.
+ */
 export declare class PdfDocumentResponse {
-    base64: string;
+    key: string;
+    url: string;
+    /** ISO-8601. */
+    expiresAt: string;
+    /** SHA-256 en hexadecimal del PDF exacto que quedó guardado. */
+    sha256: string;
     pages: number;
     bytes: number;
+    /** Sólo cuando el request pidió `includeContent: true`. */
+    base64?: string;
 }

package/bin/pdfRender/dtos/PdfDocumentResponse.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PdfDocumentResponse = void 0;
+/**
+ * Documento PDF generado y guardado por pdf-render-business.
+ * `key` es la ubicación del documento por convención ({EMPRESA}/{TIPO}/{aaaa}/{mm}/{uuid}.pdf) y
+ * es lo que se guarda para pedir una URL nueva con GET /documents/url?key=... cuando venza la actual.
+ */
 class PdfDocumentResponse {
 }
 exports.PdfDocumentResponse = PdfDocumentResponse;

package/bin/pdfRender/dtos/RenderDocumentRequest.d.ts

@@ -3,4 +3,12 @@ export declare class RenderDocumentRequest {
     template: TemplateRefRequest;
     /** Variables de la plantilla. Se escapan como HTML salvo que la plantilla use {{{triple}}}. */
     data: Record<string, unknown>;
+    /** Además de la URL, devuelve el PDF en base64 en la respuesta (tope de 4 MiB). */
+    includeContent?: boolean;
+    /**
+     * Id de la entidad dueña del documento (crédito, cliente...). Forma parte de la llave en S3, igual
+     * que en el resto del bucket de contratos: {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf, o con partner
+     * {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf.
+     */
+    referenceId?: string;
 }

package/bin/pdfRender/dtos/RenderDocumentRequest.js

@@ -27,3 +27,14 @@ __decorate([
     (0, class_validator_1.IsObject)(),
     __metadata("design:type", Object)
 ], RenderDocumentRequest.prototype, "data", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsBoolean)(),
+    __metadata("design:type", Boolean)
+], RenderDocumentRequest.prototype, "includeContent", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9_-]{1,64}$/),
+    __metadata("design:type", String)
+], RenderDocumentRequest.prototype, "referenceId", void 0);

package/bin/pdfRender/index.d.ts

@@ -10,3 +10,4 @@ export * from './dtos/PublishTemplateResponse';
 export * from './dtos/UploadAssetRequest';
 export * from './dtos/UploadAssetResponse';
 export * from './dtos/TemplateSummaryResponse';
+export * from './dtos/DocumentUrlResponse';

package/bin/pdfRender/index.js

@@ -27,3 +27,4 @@ __exportStar(require("./dtos/PublishTemplateResponse"), exports);
 __exportStar(require("./dtos/UploadAssetRequest"), exports);
 __exportStar(require("./dtos/UploadAssetResponse"), exports);
 __exportStar(require("./dtos/TemplateSummaryResponse"), exports);
+__exportStar(require("./dtos/DocumentUrlResponse"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.524.0",
+  "version": "3.526.0",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/pdfRender/dtos/DocumentUrlResponse.ts

@@ -0,0 +1,10 @@
+/** Nueva URL firmada para un documento ya guardado. */
+export class DocumentUrlResponse {
+    key!: string;
+    url!: string;
+    /** ISO-8601. */
+    expiresAt!: string;
+    sha256!: string;
+    pages!: number;
+    bytes!: number;
+}

package/src/pdfRender/dtos/GeneratePdfRequest.ts

@@ -1,7 +1,27 @@
-import { IsNotEmpty, IsString } from "class-validator";
+import { IsBoolean, IsNotEmpty, IsOptional, IsString, Matches } from "class-validator";
 
 /** HTML ya resuelto por el consumidor; se imprime en A4 con márgenes de 2 mm. */
 export class GeneratePdfRequest {
     @IsString() @IsNotEmpty()
     html!: string;
+
+    /** Además de la URL, devuelve el PDF en base64 en la respuesta (tope de 4 MiB). */
+    @IsOptional() @IsBoolean()
+    includeContent?: boolean;
+
+    /** Empresa (tenant) dueña del documento; sin ella se guarda en una carpeta común. */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    enterprise?: string;
+
+    /** Tipo de documento (carpeta en S3), p. ej. CREDITO_CONTRATO. */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    documentType?: string;
+
+    /**
+     * Id de la entidad dueña del documento (crédito, cliente...). Forma parte de la llave en S3, igual
+     * que en el resto del bucket de contratos: {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf, o con partner
+     * {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf.
+     */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    referenceId?: string;
 }

package/src/pdfRender/dtos/MergePdfsRequest.ts

@@ -1,7 +1,27 @@
-import { ArrayMaxSize, ArrayMinSize, IsArray, IsString } from "class-validator";
+import { ArrayMaxSize, ArrayMinSize, IsArray, IsBoolean, IsOptional, IsString, Matches } from "class-validator";
 
 /** PDFs en base64, en el orden en que deben quedar en el documento final. */
 export class MergePdfsRequest {
     @IsArray() @ArrayMinSize(1) @ArrayMaxSize(50) @IsString({ each: true })
     pdfs!: string[];
+
+    /** Además de la URL, devuelve el PDF en base64 en la respuesta (tope de 4 MiB). */
+    @IsOptional() @IsBoolean()
+    includeContent?: boolean;
+
+    /** Empresa (tenant) dueña del documento; sin ella se guarda en una carpeta común. */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    enterprise?: string;
+
+    /** Tipo de documento (carpeta en S3), p. ej. CREDITO_CONTRATO. */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    documentType?: string;
+
+    /**
+     * Id de la entidad dueña del documento (crédito, cliente...). Forma parte de la llave en S3, igual
+     * que en el resto del bucket de contratos: {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf, o con partner
+     * {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf.
+     */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    referenceId?: string;
 }

package/src/pdfRender/dtos/PdfDocumentResponse.ts

@@ -1,5 +1,17 @@
+/**
+ * Documento PDF generado y guardado por pdf-render-business.
+ * `key` es la ubicación del documento por convención ({EMPRESA}/{TIPO}/{aaaa}/{mm}/{uuid}.pdf) y
+ * es lo que se guarda para pedir una URL nueva con GET /documents/url?key=... cuando venza la actual.
+ */
 export class PdfDocumentResponse {
-    base64!: string;
+    key!: string;
+    url!: string;
+    /** ISO-8601. */
+    expiresAt!: string;
+    /** SHA-256 en hexadecimal del PDF exacto que quedó guardado. */
+    sha256!: string;
     pages!: number;
     bytes!: number;
+    /** Sólo cuando el request pidió `includeContent: true`. */
+    base64?: string;
 }

package/src/pdfRender/dtos/RenderDocumentRequest.ts

@@ -1,4 +1,4 @@
-import { IsDefined, IsObject, ValidateNested } from "class-validator";
+import { IsBoolean, IsDefined, IsObject, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
 import { Type } from "class-transformer";
 import { TemplateRefRequest } from "./TemplateRefRequest";
 
@@ -9,4 +9,16 @@ export class RenderDocumentRequest {
     /** Variables de la plantilla. Se escapan como HTML salvo que la plantilla use {{{triple}}}. */
     @IsDefined() @IsObject()
     data!: Record<string, unknown>;
+
+    /** Además de la URL, devuelve el PDF en base64 en la respuesta (tope de 4 MiB). */
+    @IsOptional() @IsBoolean()
+    includeContent?: boolean;
+
+    /**
+     * Id de la entidad dueña del documento (crédito, cliente...). Forma parte de la llave en S3, igual
+     * que en el resto del bucket de contratos: {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf, o con partner
+     * {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf.
+     */
+    @IsOptional() @IsString() @Matches(/^[A-Za-z0-9_-]{1,64}$/)
+    referenceId?: string;
 }

package/src/pdfRender/index.ts

@@ -11,3 +11,4 @@ export * from './dtos/PublishTemplateResponse';
 export * from './dtos/UploadAssetRequest';
 export * from './dtos/UploadAssetResponse';
 export * from './dtos/TemplateSummaryResponse';
+export * from './dtos/DocumentUrlResponse';