@cosmicdrift/kumiko-renderer-puppeteer-client 0.388.0 → 0.389.0

package/dist/index.d.ts

@@ -5,4 +5,4 @@ export { createRendererPuppeteerClientFeature } from "./feature.ts";
 export { countPdfPages } from "./pdf-page-count.ts";
 export { RendererPuppeteerClientQueries } from "./qualified-names.ts";
 export { puppeteerRender } from "./render.ts";
-export { type RenderedPdfUpload, type RenderPdfArgs, renderPdfBeforeTransaction, type StoredRenderedPdf, storeRenderedPdf, } from "./render-and-store.ts";
+export { type RenderedPdfBytes, type RenderedPdfUpload, type RenderPdfArgs, renderPdfBeforeTransaction, renderPdfBytes, type StoredRenderedPdf, storeRenderedPdf, } from "./render-and-store.ts";

package/dist/index.js

@@ -5,4 +5,4 @@ export { createRendererPuppeteerClientFeature } from "./feature.js";
 export { countPdfPages } from "./pdf-page-count.js";
 export { RendererPuppeteerClientQueries } from "./qualified-names.js";
 export { puppeteerRender } from "./render.js";
-export { renderPdfBeforeTransaction, storeRenderedPdf, } from "./render-and-store.js";
+export { renderPdfBeforeTransaction, renderPdfBytes, storeRenderedPdf, } from "./render-and-store.js";

package/dist/render-and-store.d.ts

@@ -31,5 +31,14 @@ export type StoredRenderedPdf = {
     readonly layout?: RenderedTemplateRef;
 };
 export declare function clientErrorForRenderFailure(e: unknown, ctx: HandlerContext, slug: string): KumikoError;
+export type RenderedPdfBytes = {
+    readonly fileName: string;
+    readonly pdfBytes: Uint8Array;
+    readonly pageCount: number;
+    readonly sizeBytes: number;
+    readonly template: RenderedTemplateRef;
+    readonly layout?: RenderedTemplateRef;
+};
+export declare function renderPdfBytes(ctx: HandlerContext, args: Pick<RenderPdfArgs, "slug" | "locale" | "variables">): Promise<WriteResult<RenderedPdfBytes>>;
 export declare function renderPdfBeforeTransaction(ctx: HandlerContext, args: RenderPdfArgs): Promise<BeforeTransactionResult<RenderedPdfUpload>>;
 export declare function storeRenderedPdf(ctx: HandlerContext, rendered: RenderedPdfUpload): Promise<WriteResult<StoredRenderedPdf>>;

package/dist/render-and-store.js

@@ -25,9 +25,9 @@ export function clientErrorForRenderFailure(e, ctx, slug) {
 function renderFailure(e, ctx, slug) {
     return writeFailure(clientErrorForRenderFailure(e, ctx, slug));
 }
-// Renders and uploads the PDF while no transaction is open: the print service call can take
-// seconds and must not hold a pool connection. Use as a handler's `beforeTransaction`.
-export async function renderPdfBeforeTransaction(ctx, args) {
+// Renders without storing: no file, no rendered-pdf row. For callers that keep the bytes
+// themselves (mail attachment, download); same no-transaction rule as renderPdfBeforeTransaction.
+export async function renderPdfBytes(ctx, args) {
     const tenantId = ctx.user.tenantId;
     const plugin = createRendererFoundationApi(collectRendererPlugins(ctx.registry)).createRendererForTenant({ tenantId, kind: "document-pdf" });
     let response;
@@ -53,15 +53,35 @@ export async function renderPdfBeforeTransaction(ctx, args) {
     if (template === undefined) {
         throw new RendererError(`renderer "${plugin.name}" did not report which template produced the PDF`, "other");
     }
+    return {
+        isSuccess: true,
+        data: {
+            fileName: response.fileName,
+            pdfBytes: response.pdfBytes,
+            pageCount: response.pageCount,
+            sizeBytes: response.sizeBytes,
+            template,
+            ...(layout !== undefined && { layout }),
+        },
+    };
+}
+// Renders and uploads the PDF while no transaction is open: the print service call can take
+// seconds and must not hold a pool connection. Use as a handler's `beforeTransaction`.
+export async function renderPdfBeforeTransaction(ctx, args) {
+    const rendered = await renderPdfBytes(ctx, args);
+    if (!rendered.isSuccess)
+        return rendered;
+    const { fileName, pdfBytes, pageCount, sizeBytes, template, layout } = rendered.data;
+    const tenantId = ctx.user.tenantId;
     const uploaded = await uploadFileBytesBeforeTransaction({
         db: ctx.db,
         files: fileContextForTenant(ctx, tenantId, tenantId),
         registry: ctx.registry,
         user: ctx.user,
     }, {
-        fileName: response.fileName,
+        fileName,
         mimeType: PDF_MIME_TYPE,
-        data: response.pdfBytes,
+        data: pdfBytes,
         ...(args.attachTo !== undefined && { attachTo: args.attachTo }),
     });
     if (!uploaded.isSuccess)
@@ -74,8 +94,8 @@ export async function renderPdfBeforeTransaction(ctx, args) {
             locale: args.locale,
             template,
             ...(layout !== undefined && { layout }),
-            pageCount: response.pageCount,
-            sizeBytes: response.sizeBytes,
+            pageCount,
+            sizeBytes,
         },
         ...(uploaded.release && { release: uploaded.release }),
     };

package/package.json

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

package/src/changes.json

@@ -1,4 +1,10 @@
 [
+  {
+    "version": "0.389.0",
+    "type": "improvement",
+    "title": "Render a PDF without storing it",
+    "detail": "renderPdfBytes is the render half of renderPdfBeforeTransaction. Use it when the bytes go straight into a mail or a download and no file or rendered-pdf row should exist."
+  },
   {
     "version": "0.388.0",
     "type": "fix",