chromiumly 4.5.0 → 5.1.0

package/dist/templates/generators/templates.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Templates = void 0;
+const main_config_1 = require("../../main.config");
+const templates_validators_1 = require("../validators/templates.validators");
+const generator_1 = require("./generator");
+class Templates extends generator_1.Generator {
+    constructor() {
+        super(main_config_1.TemplatesRoute.GENERATE);
+    }
+    async generate(request, options) {
+        const apiKey = main_config_1.Chromiumly.getGotenbergApiKey();
+        if (!apiKey) {
+            throw new Error('Templates requires an API key. Please configure it via Chromiumly.configure({ apiKey: "..." }).');
+        }
+        if (options?.validate) {
+            const validator = templates_validators_1.templateValidators[request.type];
+            if (validator && !validator(request.data)) {
+                throw new Error(`Invalid template data for type "${request.type}". Please ensure it matches the expected structure.`);
+            }
+        }
+        const response = await fetch(this.endpoint, {
+            method: 'POST',
+            headers: {
+                'X-Api-Key': apiKey,
+                'Content-Type': 'application/json'
+            },
+            body: JSON.stringify(request)
+        });
+        if (!response.ok) {
+            const body = await response.text();
+            const trace = response.headers.get('gotenberg-trace');
+            throw new Error(`Gotenberg API Error:\n` +
+                `Endpoint: ${this.endpoint}\n` +
+                `Status: ${response.status} ${response.statusText}\n` +
+                `Trace: ${trace || 'No trace'}\n` +
+                `Body: ${body}`);
+        }
+        const arrayBuffer = await response.arrayBuffer();
+        return Buffer.from(arrayBuffer);
+    }
+}
+exports.Templates = Templates;
+//# sourceMappingURL=templates.js.map

package/dist/templates/generators/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/templates/generators/templates.ts"],"names":[],"mappings":";;;AAAA,mDAA+D;AAE/D,6EAAwE;AACxE,2CAAwC;AAExC,MAAa,SAAU,SAAQ,qBAAS;IACpC;QACI,KAAK,CAAC,4BAAc,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,QAAQ,CACjB,OAA+B,EAC/B,OAAgC;QAEhC,MAAM,MAAM,GAAG,wBAAU,CAAC,kBAAkB,EAAE,CAAC;QAE/C,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CACX,iGAAiG,CACpG,CAAC;QACN,CAAC;QAED,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;YACpB,MAAM,SAAS,GAAG,yCAAkB,CAAC,OAAO,CAAC,IAAI,CAElC,CAAC;YAEhB,IAAI,SAAS,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxC,MAAM,IAAI,KAAK,CACX,mCAAmC,OAAO,CAAC,IAAI,qDAAqD,CACvG,CAAC;YACN,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;YACxC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACL,WAAW,EAAE,MAAM;gBACnB,cAAc,EAAE,kBAAkB;aACrC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YAEtD,MAAM,IAAI,KAAK,CACX,wBAAwB;gBACpB,aAAa,IAAI,CAAC,QAAQ,IAAI;gBAC9B,WAAW,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,IAAI;gBACrD,UAAU,KAAK,IAAI,UAAU,IAAI;gBACjC,SAAS,IAAI,EAAE,CACtB,CAAC;QACN,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QACjD,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACpC,CAAC;CACJ;AAtDD,8BAsDC"}

package/dist/templates/index.d.ts

@@ -0,0 +1,2 @@
+export { type Currency, type TemplateType, type TemplateRequest, type InvoiceSaasTemplateData, type InvoiceClassicTemplateData, type TemplateDataByType, type InvoiceItem, type TemplateParty } from './interfaces/templates.types';
+export { Templates } from './generators/templates';

package/dist/templates/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Templates = void 0;
+var templates_1 = require("./generators/templates");
+Object.defineProperty(exports, "Templates", { enumerable: true, get: function () { return templates_1.Templates; } });
+//# sourceMappingURL=index.js.map

package/dist/templates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":";;;AAWA,oDAAmD;AAA1C,sGAAA,SAAS,OAAA"}

package/dist/templates/interfaces/templates.types.d.ts

@@ -0,0 +1,46 @@
+export type Currency = 'USD' | 'EUR' | 'GBP' | 'JPY' | 'CNY' | 'CHF' | 'CAD' | 'AUD' | 'INR' | 'BRL' | 'MXN' | 'SGD' | 'HKD' | 'NOK' | 'SEK' | 'DKK' | 'NZD' | 'ZAR' | 'AED' | 'SAR' | 'KWD' | 'QAR' | 'BHD' | 'OMR' | 'JOD' | 'EGP' | 'MAD' | 'TND' | 'NGN' | 'KES' | 'GHS' | 'TZS' | 'UGX' | 'ETB' | 'XOF' | 'XAF' | 'TRY' | 'RUB' | 'PLN' | 'CZK' | 'HUF' | 'RON' | 'BGN' | 'HRK' | 'RSD' | 'UAH' | 'ILS' | 'PKR' | 'BDT' | 'LKR' | 'NPR' | 'MMK' | 'THB' | 'VND' | 'IDR' | 'MYR' | 'PHP' | 'KRW' | 'TWD' | 'MNT' | 'KZT' | 'UZS' | 'GEL' | 'AMD' | 'AZN' | 'IRR' | 'IQD' | 'CLP' | 'COP' | 'ARS' | 'PEN' | 'UYU' | 'BOB' | 'PYG' | 'VES' | 'CRC' | 'GTQ' | 'HNL' | 'NIO' | 'DOP' | 'CUP' | 'JMD' | 'TTD' | 'BBD' | 'XCD';
+export type TemplateType = 'invoice_freelancer' | 'invoice_saas' | 'invoice_classic' | 'invoice_minimal' | 'invoice_modern';
+export interface TemplateParty {
+    name: string;
+    addressLine1: string;
+    addressLine2?: string;
+    tax?: string;
+    iban?: string;
+    bic?: string;
+}
+export interface InvoiceItem {
+    description: string;
+    qty: number;
+    unitPrice: string;
+    amount: string;
+}
+export interface InvoiceSaasTemplateData {
+    invoiceNumber: string;
+    createdDate: string;
+    dueDate: string;
+    companyLogo?: string;
+    sender: TemplateParty;
+    receiver: TemplateParty;
+    items: InvoiceItem[];
+    currency: Currency;
+    subTotal: string;
+    taxRate: number;
+    taxAmount: string;
+    total: string;
+    footerNote: string;
+    footerDisclaimer?: string;
+}
+export interface InvoiceClassicTemplateData extends Omit<InvoiceSaasTemplateData, 'companyLogo'> {
+    companyLogo: string;
+}
+export interface TemplateDataByType {
+    invoice_saas: InvoiceSaasTemplateData;
+    invoice_freelancer: InvoiceSaasTemplateData;
+    invoice_classic: InvoiceClassicTemplateData;
+    invoice_minimal: InvoiceSaasTemplateData;
+    invoice_modern: InvoiceSaasTemplateData;
+}
+export type TemplateRequest<TType extends TemplateType> = {
+    type: TType;
+    data: TemplateDataByType[TType];
+};

package/dist/templates/interfaces/templates.types.js

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

package/dist/templates/interfaces/templates.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.types.js","sourceRoot":"","sources":["../../../src/templates/interfaces/templates.types.ts"],"names":[],"mappings":""}

package/dist/templates/validators/templates.validators.d.ts

@@ -0,0 +1,6 @@
+import { TemplateDataByType, TemplateType } from '../interfaces/templates.types';
+type Validator<T> = (data: unknown) => data is T;
+export declare const templateValidators: {
+    [T in TemplateType]?: Validator<TemplateDataByType[T]>;
+};
+export {};

package/dist/templates/validators/templates.validators.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templateValidators = void 0;
+const isObject = (value) => typeof value === 'object' && value !== null;
+const hasString = (obj, key) => typeof obj[key] === 'string' && obj[key] !== '';
+const hasNumber = (obj, key) => typeof obj[key] === 'number';
+const isValidUrl = (value) => {
+    if (typeof value !== 'string' || value === '')
+        return false;
+    try {
+        new URL(value);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+const validateInvoiceSaas = (data) => {
+    if (!isObject(data)) {
+        return false;
+    }
+    if (!hasString(data, 'invoiceNumber') ||
+        !hasString(data, 'createdDate') ||
+        !hasString(data, 'dueDate') ||
+        !hasString(data, 'currency') ||
+        !hasString(data, 'subTotal') ||
+        !hasNumber(data, 'taxRate') ||
+        !hasString(data, 'taxAmount') ||
+        !hasString(data, 'total') ||
+        !hasString(data, 'footerNote')) {
+        return false;
+    }
+    if (data.companyLogo !== undefined && !isValidUrl(data.companyLogo)) {
+        return false;
+    }
+    if (!Array.isArray(data.items) || data.items.length === 0) {
+        return false;
+    }
+    if (!isObject(data.sender) || !isObject(data.receiver)) {
+        return false;
+    }
+    const validateParty = (party) => hasString(party, 'name') && hasString(party, 'addressLine1');
+    if (!validateParty(data.sender) ||
+        !validateParty(data.receiver)) {
+        return false;
+    }
+    return data.items.every((item) => {
+        if (!isObject(item)) {
+            return false;
+        }
+        return (hasString(item, 'description') &&
+            hasNumber(item, 'qty') &&
+            hasString(item, 'unitPrice') &&
+            hasString(item, 'amount'));
+    });
+};
+const validateInvoiceClassic = (data) => validateInvoiceSaas(data) &&
+    isValidUrl(data['companyLogo']);
+exports.templateValidators = {
+    invoice_saas: validateInvoiceSaas,
+    invoice_classic: validateInvoiceClassic
+};
+//# sourceMappingURL=templates.validators.js.map

package/dist/templates/validators/templates.validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.validators.js","sourceRoot":"","sources":["../../../src/templates/validators/templates.validators.ts"],"names":[],"mappings":";;;AASA,MAAM,QAAQ,GAAG,CAAC,KAAc,EAAoC,EAAE,CAClE,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AAEhD,MAAM,SAAS,GAAG,CAAC,GAA4B,EAAE,GAAW,EAAW,EAAE,CACrE,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;AAEpD,MAAM,SAAS,GAAG,CAAC,GAA4B,EAAE,GAAW,EAAW,EAAE,CACrE,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC;AAEjC,MAAM,UAAU,GAAG,CAAC,KAAc,EAAW,EAAE;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC;IAC5D,IAAI,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAuC,CAC5D,IAAa,EACkB,EAAE;IACjC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IACI,CAAC,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC;QACjC,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;QAC/B,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC;QAC3B,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC;QAC5B,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC;QAC5B,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC;QAC3B,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC;QAC7B,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC;QACzB,CAAC,SAAS,CAAC,IAAI,EAAE,YAAY,CAAC,EAChC,CAAC;QACC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAClE,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACrD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,aAAa,GAAG,CAAC,KAA8B,EAAW,EAAE,CAC9D,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IAEjE,IACI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAiC,CAAC;QACtD,CAAC,aAAa,CAAC,IAAI,CAAC,QAAmC,CAAC,EAC1D,CAAC;QACC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAClB,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,CACH,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC;YAC9B,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC;YACtB,SAAS,CAAC,IAAI,EAAE,WAAW,CAAC;YAC5B,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAC5B,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAA0C,CAClE,IAAa,EACqB,EAAE,CACpC,mBAAmB,CAAC,IAAI,CAAC;IACzB,UAAU,CAAE,IAA2C,CAAC,aAAa,CAAC,CAAC,CAAC;AAE/D,QAAA,kBAAkB,GAE3B;IACA,YAAY,EAAE,mBAAmB;IACjC,eAAe,EAAE,sBAAsB;CAC1C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chromiumly",
-  "version": "4.5.0",
+  "version": "5.1.0",
   "description": "A lightweight Typescript library that interacts with Gotenberg's different modules to convert a variety of document formats to PDF files.",
   "main": "dist/main.js",
   "types": "dist/main.d.ts",
@@ -55,8 +55,8 @@
     "@types/dotenv": "8.2.3",
     "@types/jest": "30.0.0",
     "@types/node": "24.12.0",
-    "@typescript-eslint/eslint-plugin": "8.57.1",
-    "@typescript-eslint/parser": "8.57.1",
+    "@typescript-eslint/eslint-plugin": "8.57.2",
+    "@typescript-eslint/parser": "8.57.2",
     "commitizen": "4.3.1",
     "eslint": "8.57.0",
     "eslint-config-prettier": "^10.0.0",
@@ -70,7 +70,7 @@
     "ts-jest": "29.4.6",
     "ts-node": "10.9.2",
     "tslib": "2.8.1",
-    "typescript": "5.9.3"
+    "typescript": "6.0.2"
   },
   "optionalDependencies": {
     "config": "4.x",