@fiado/type-kit 3.525.0 → 3.527.0

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

@@ -74,3 +74,13 @@ describe('pdfRender includeContent', () => {
         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: 'CREDIT_CONTRACT' };
+        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: 'CREDIT_SUMMARY', referenceId: 'abc' })).toEqual([]);
+        expect(await errorsOf(MergePdfsRequest, { pdfs: ['JVBERi0='], enterprise: 'A/B' })).toEqual(['enterprise']);
+    });
+});

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

@@ -1,12 +1,10 @@
 /** Nueva URL firmada para un documento ya guardado. */
 export declare class DocumentUrlResponse {
-    documentId: string;
+    key: string;
     url: string;
     /** ISO-8601. */
     expiresAt: string;
     sha256: string;
     pages: number;
     bytes: number;
-    /** ISO-8601 de la generación. */
-    createdAt: string;
 }

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

@@ -3,4 +3,14 @@ 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. CREDIT_CONTRACT. */
+    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

@@ -25,3 +25,21 @@ __decorate([
     (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

@@ -3,4 +3,14 @@ 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. CREDIT_CONTRACT. */
+    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

@@ -27,3 +27,21 @@ __decorate([
     (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,9 +1,11 @@
 /**
  * Documento PDF generado y guardado por pdf-render-business.
- * La URL firmada vence en `expiresAt`; para una nueva se usa GET /documents/{documentId}/url.
+ * `key` es la ubicación del documento en el bucket de contratos, por convención
+ * {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf (o {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{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 {
-    documentId: string;
+    key: string;
     url: string;
     /** ISO-8601. */
     expiresAt: string;

package/bin/pdfRender/dtos/PdfDocumentResponse.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PdfDocumentResponse = void 0;
 /**
  * Documento PDF generado y guardado por pdf-render-business.
- * La URL firmada vence en `expiresAt`; para una nueva se usa GET /documents/{documentId}/url.
+ * `key` es la ubicación del documento en el bucket de contratos, por convención
+ * {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf (o {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{uuid}.pdf),
+ * y es lo que se guarda para pedir una URL nueva con GET /documents/url?key=... cuando venza la actual.
  */
 class PdfDocumentResponse {
 }

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

@@ -5,4 +5,10 @@ export declare class RenderDocumentRequest {
     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

@@ -32,3 +32,9 @@ __decorate([
     (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/package.json

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

package/src/pdfRender/dtos/DocumentUrlResponse.ts

@@ -1,12 +1,10 @@
 /** Nueva URL firmada para un documento ya guardado. */
 export class DocumentUrlResponse {
-    documentId!: string;
+    key!: string;
     url!: string;
     /** ISO-8601. */
     expiresAt!: string;
     sha256!: string;
     pages!: number;
     bytes!: number;
-    /** ISO-8601 de la generación. */
-    createdAt!: string;
 }

package/src/pdfRender/dtos/GeneratePdfRequest.ts

@@ -1,4 +1,4 @@
-import { IsBoolean, IsNotEmpty, IsOptional, 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 {
@@ -8,4 +8,20 @@ export class GeneratePdfRequest {
     /** 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. CREDIT_CONTRACT. */
+    @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,4 +1,4 @@
-import { ArrayMaxSize, ArrayMinSize, IsArray, IsBoolean, IsOptional, 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 {
@@ -8,4 +8,20 @@ export class MergePdfsRequest {
     /** 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. CREDIT_CONTRACT. */
+    @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,9 +1,11 @@
 /**
  * Documento PDF generado y guardado por pdf-render-business.
- * La URL firmada vence en `expiresAt`; para una nueva se usa GET /documents/{documentId}/url.
+ * `key` es la ubicación del documento en el bucket de contratos, por convención
+ * {EMPRESA}/{TIPO}/{referenceId}/{uuid}.pdf (o {EMPRESA}/{PARTNER}/{CATEGORIA}/{referenceId}/{TIPO}/{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 {
-    documentId!: string;
+    key!: string;
     url!: string;
     /** ISO-8601. */
     expiresAt!: string;

package/src/pdfRender/dtos/RenderDocumentRequest.ts

@@ -1,4 +1,4 @@
-import { IsBoolean, IsDefined, IsObject, IsOptional, ValidateNested } from "class-validator";
+import { IsBoolean, IsDefined, IsObject, IsOptional, IsString, Matches, ValidateNested } from "class-validator";
 import { Type } from "class-transformer";
 import { TemplateRefRequest } from "./TemplateRefRequest";
 
@@ -13,4 +13,12 @@ export class RenderDocumentRequest {
     /** 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;
 }