@cosmicdrift/kumiko-renderer-puppeteer-client 0.374.0 → 0.378.0

package/dist/document-pdf.js

@@ -4,11 +4,13 @@
 import { sanitizePdfAttachmentFileName } from "@cosmicdrift/kumiko-bundled-features/delivery";
 import { FileRefTooLargeError, readFileRefContent, } from "@cosmicdrift/kumiko-bundled-features/file-foundation";
 import { RendererError, } from "@cosmicdrift/kumiko-bundled-features/renderer-foundation";
-import { collectDocumentResourceKeys, compileDocumentBodyToHandlebars, createTemplateResolverApi, DEFAULT_PDF_LAYOUT_SLUG, PDF_DEFAULT_MARGIN_MM, PDF_FOOTER_MARGIN_MM, PDF_HEADER_MARGIN_MM, prepareDocumentForPrint, readLayoutRegions, readPdfTemplateMeta, readTemplateResourceMaxBytes, resolveTemplateVariables, sanitizeDocumentHtml, sanitizeLayoutHtml, TemplateNotFoundError, toResourceDataUri, } from "@cosmicdrift/kumiko-bundled-features/template-resolver";
+import { collectDocumentImageVariables, collectDocumentResourceKeys, compileDocumentBodyToHandlebars, createTemplateResolverApi, DEFAULT_PDF_LAYOUT_SLUG, isResourceImageContentType, PDF_DEFAULT_MARGIN_MM, PDF_FOOTER_MARGIN_MM, PDF_HEADER_MARGIN_MM, prepareDocumentForPrint, readLayoutRegions, readPdfTemplateMeta, readTemplateResourceMaxBytes, resolveTemplateVariables, sanitizeDocumentHtml, sanitizeLayoutHtml, TemplateNotFoundError, toResourceDataUri, } from "@cosmicdrift/kumiko-bundled-features/template-resolver";
 import { SYSTEM_TENANT_ID } from "@cosmicdrift/kumiko-framework/engine";
 import { collectRegionResourceKeys, compileDocumentSource, createDocumentHandlebars, mergeResourceFileRefs, readBrandingAccentColor, readDocumentFormat, readTenantName, resolveResourceFileRefs, } from "@cosmicdrift/kumiko-renderer-mail-html";
 const LINE_BREAKS = /[\r\n]+/g;
 const IMAGE_CONTENT_TYPE_PREFIX = "image/";
+const MAX_RECORD_IMAGES = 24;
+const MAX_RECORD_IMAGES_TOTAL_BYTES = 20 * 1024 * 1024;
 const PREVIEW_PAGE_NUMBER = "1";
 const EMPTY_CHROMIUM_REGION = "<span></span>";
 const PAGE_NUMBER_HTML = '<span class="pageNumber"></span>';
@@ -26,6 +28,9 @@ const PRINT_CSS = [
     "[data-align=justify]{text-align:justify}",
     "[data-size=small]{font-size:8pt;color:#555}",
     "img{max-width:100%}",
+    ".kumiko-doc-images{display:grid;grid-template-columns:1fr 1fr;gap:6px;margin:8px 0}",
+    ".kumiko-doc-images:empty{display:none}",
+    ".kumiko-doc-images img{width:100%;break-inside:avoid;page-break-inside:avoid}",
 ].join("");
 const EMPTY_REGIONS = { header: "", signature: "", footer: "" };
 function describe(e) {
@@ -129,6 +134,67 @@ async function loadResourceDataUris(ctx, fileRefIds) {
     }
     return dataUris;
 }
+function fileRefIdsOf(value) {
+    if (typeof value === "string")
+        return [value];
+    return Array.isArray(value)
+        ? value.filter((entry) => typeof entry === "string")
+        : [];
+}
+// Own tenant only (no system files): the ids come from the app's record, so a foreign or
+// unreadable id drops silently like a missing image instead of failing the document.
+async function readRecordImage(ctx, filesForTenant, fileRefId, maxBytes) {
+    try {
+        const found = await readFileRefContent({
+            db: ctx.db,
+            filesForTenant,
+            fileRefId,
+            allowedTenantIds: [ctx.tenantId],
+            maxBytes,
+        });
+        if (found === null || !isResourceImageContentType(found.contentType))
+            return null;
+        return { dataUri: toResourceDataUri(found.contentType, found.content), size: found.size };
+    }
+    catch (e) {
+        if (e instanceof FileRefTooLargeError)
+            return null;
+        throw e;
+    }
+}
+async function loadRecordImageDataUris(ctx, variables, imageVariableNames) {
+    const dataUrisByVariable = new Map();
+    const { filesForTenant } = ctx;
+    if (filesForTenant === undefined || imageVariableNames.length === 0)
+        return dataUrisByVariable;
+    const maxBytes = await readTemplateResourceMaxBytes(ctx.config, ctx.registry);
+    const seenIds = new Set();
+    let loadedCount = 0;
+    let loadedBytes = 0;
+    for (const name of imageVariableNames) {
+        const dataUris = [];
+        for (const fileRefId of fileRefIdsOf(variables[name])) {
+            if (seenIds.has(fileRefId))
+                continue;
+            seenIds.add(fileRefId);
+            if (loadedCount >= MAX_RECORD_IMAGES)
+                break;
+            const image = await readRecordImage(ctx, filesForTenant, fileRefId, Math.min(maxBytes, MAX_RECORD_IMAGES_TOTAL_BYTES - loadedBytes));
+            if (image === null)
+                continue;
+            loadedCount += 1;
+            loadedBytes += image.size;
+            dataUris.push(image.dataUri);
+        }
+        dataUrisByVariable.set(name, dataUris);
+    }
+    return dataUrisByVariable;
+}
+// Text context without images variables: their value is file ids, which no placeholder,
+// title or file name pattern may print.
+function withoutImageVariables(variables, definitions) {
+    return Object.fromEntries(Object.entries(variables).filter(([name]) => !(Object.hasOwn(definitions, name) && definitions[name]?.type === "images")));
+}
 function renderRegion(hbs, region, context, resourceSrc) {
     if (region.trim() === "")
         return "";
@@ -221,7 +287,7 @@ async function findOwnPdfTemplate(tplApi, ctx, slug, locale, scope) {
         ...(scope === "system" && { scope }),
     });
 }
-async function assembleDocument(input, ctx, markers) {
+async function assembleDocument(input, ctx, markers, recordImages = "placeholder") {
     const { slug, locale, variables } = input;
     const tplApi = createTemplateResolverApi(ctx.db);
     const template = input.draft === undefined
@@ -237,7 +303,18 @@ async function assembleDocument(input, ctx, markers) {
             readBrandingAccentColor(ctx),
         ]);
         const hbs = createDocumentHandlebars(format);
-        const context = { ...variables, tenantName, signature: "", imprint: "", page: "", pages: "" };
+        const variableDefinitions = resolveTemplateVariables(ctx.registry, slug, template.variableSchema);
+        const context = {
+            ...withoutImageVariables(variables, variableDefinitions),
+            tenantName,
+            signature: "",
+            imprint: "",
+            page: "",
+            pages: "",
+        };
+        const recordImageUris = recordImages === "resolve"
+            ? await loadRecordImageDataUris(ctx, variables, collectDocumentImageVariables(template.content))
+            : new Map();
         const bodyKeys = collectDocumentResourceKeys(template.content);
         const layoutKeys = collectRegionResourceKeys(layout.regions);
         const bodyRefs = await resolveResourceFileRefs(tplApi, ctx, template, bodyKeys);
@@ -247,7 +324,12 @@ async function assembleDocument(input, ctx, markers) {
         const dataUris = await loadResourceDataUris(ctx, mergeResourceFileRefs(bodyRefs, layoutRefs));
         const resourceSrc = (key) => dataUris.get(key);
         const missingResourceKeys = [...new Set([...bodyKeys, ...layoutKeys])].filter((key) => !dataUris.has(key));
-        const bodySource = compileDocumentBodyToHandlebars(template.content, resolveTemplateVariables(ctx.registry, slug, template.variableSchema), { resourceSrc, ...(accentColor !== undefined && { stepsColor: accentColor }) });
+        const bodySource = compileDocumentBodyToHandlebars(template.content, variableDefinitions, {
+            resourceSrc,
+            recordImagesSrc: (variable) => recordImageUris.get(variable) ?? [],
+            recordImagesPlaceholder: recordImages === "placeholder",
+            ...(accentColor !== undefined && { stepsColor: accentColor }),
+        });
         const bodyHtml = prepareDocumentForPrint(compileDocumentSource(hbs, bodySource)(context));
         const signatureHtml = renderRegion(hbs, layout.regions.signature, context, resourceSrc);
         const pagedContext = markers === "chromium"
@@ -283,7 +365,7 @@ async function assembleDocument(input, ctx, markers) {
     }
 }
 export async function buildDocumentPdfRequest(req, ctx) {
-    return toPdfRequest(await assembleDocument(req.payload, ctx, "chromium"), req.payload.locale);
+    return toPdfRequest(await assembleDocument(req.payload, ctx, "chromium", "resolve"), req.payload.locale);
 }
 // Prints an unsaved draft; the stored template of the slug only supplies images and the variable schema.
 export async function buildDocumentDraftPdfRequest(req, ctx) {

package/dist/entity.d.ts

@@ -14,7 +14,7 @@ export declare const renderedPdfEntity: import("@cosmicdrift/kumiko-types/fields
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -37,7 +37,7 @@ export declare const renderedPdfEntity: import("@cosmicdrift/kumiko-types/fields
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -60,7 +60,7 @@ export declare const renderedPdfEntity: import("@cosmicdrift/kumiko-types/fields
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -83,7 +83,7 @@ export declare const renderedPdfEntity: import("@cosmicdrift/kumiko-types/fields
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -125,7 +125,7 @@ export declare const renderedPdfEntity: import("@cosmicdrift/kumiko-types/fields
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -148,7 +148,7 @@ export declare const renderedPdfEntity: import("@cosmicdrift/kumiko-types/fields
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -211,7 +211,7 @@ export declare const renderedPdfsTable: import("@cosmicdrift/kumiko-framework/db
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -234,7 +234,7 @@ export declare const renderedPdfsTable: import("@cosmicdrift/kumiko-framework/db
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -257,7 +257,7 @@ export declare const renderedPdfsTable: import("@cosmicdrift/kumiko-framework/db
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -280,7 +280,7 @@ export declare const renderedPdfsTable: import("@cosmicdrift/kumiko-framework/db
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -322,7 +322,7 @@ export declare const renderedPdfsTable: import("@cosmicdrift/kumiko-framework/db
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {
@@ -345,7 +345,7 @@ export declare const renderedPdfsTable: import("@cosmicdrift/kumiko-framework/db
         readonly sensitive?: boolean;
         readonly writeOnly?: boolean;
         readonly readAsInstruction?: boolean;
-        readonly format?: "email" | "url" | "phone" | "password";
+        readonly format?: "email" | "url" | "phone" | "password" | "month";
         readonly default?: string;
         readonly access?: import("@cosmicdrift/kumiko-types/fields").FieldAccess;
         readonly multiline?: boolean | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-renderer-puppeteer-client",
-  "version": "0.374.0",
+  "version": "0.378.0",
   "description": "Renderer-Foundation plugin: HTTP client for puppeteer-service (PDF + image snapshot via remote browser).",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",
@@ -19,13 +19,13 @@
     }
   },
   "dependencies": {
-    "@cosmicdrift/kumiko-bundled-features": "0.374.0",
-    "@cosmicdrift/kumiko-framework": "0.374.0",
-    "@cosmicdrift/kumiko-renderer-mail-html": "0.374.0",
-    "@cosmicdrift/kumiko-types": "0.374.0"
+    "@cosmicdrift/kumiko-bundled-features": "0.378.0",
+    "@cosmicdrift/kumiko-framework": "0.378.0",
+    "@cosmicdrift/kumiko-renderer-mail-html": "0.378.0",
+    "@cosmicdrift/kumiko-types": "0.378.0"
   },
   "devDependencies": {
-    "@cosmicdrift/kumiko-testing": "0.374.0"
+    "@cosmicdrift/kumiko-testing": "0.378.0"
   },
   "repository": {
     "type": "git",