@formfeed/devkit 0.3.6 → 0.3.7

package/index.cjs

@@ -32,6 +32,7 @@ __export(index_exports, {
   diagnose: () => diagnose,
   findProject: () => findProject,
   generateTypes: () => generateTypes,
+  htmlSnapshot: () => htmlSnapshot,
   isIgnored: () => isIgnored,
   listLocalFiles: () => listLocalFiles,
   listTemplateSlugs: () => listTemplateSlugs,
@@ -538,6 +539,16 @@ async function renderOfficeLocal(project, tpl, data, options = {}) {
   if (options.locale) context.locale = options.locale;
   return (0, import_engine4.renderOffice)(tpl.file.bytes, { engine: tpl.meta.engine, data, context, images: options.images, random: options.random });
 }
+function htmlSnapshot(rendered) {
+  let snapshot = rendered.document;
+  if (rendered.headerHtml) snapshot += `
+<!-- formfeed:header -->
+${rendered.headerHtml}`;
+  if (rendered.footerHtml) snapshot += `
+<!-- formfeed:footer -->
+${rendered.footerHtml}`;
+  return snapshot;
+}
 function officeSnapshot(filled) {
   return (0, import_engine4.officeTextParts)(filled).map((part) => `--- ${part.name} ---
 ${prettyXml(part.xml)}`).join("\n");
@@ -1264,6 +1275,7 @@ function localTypeSource(tpl) {
   diagnose,
   findProject,
   generateTypes,
+  htmlSnapshot,
   isIgnored,
   listLocalFiles,
   listTemplateSlugs,

package/index.js

@@ -480,6 +480,16 @@ async function renderOfficeLocal(project, tpl, data, options = {}) {
   if (options.locale) context.locale = options.locale;
   return renderOffice(tpl.file.bytes, { engine: tpl.meta.engine, data, context, images: options.images, random: options.random });
 }
+function htmlSnapshot(rendered) {
+  let snapshot = rendered.document;
+  if (rendered.headerHtml) snapshot += `
+<!-- formfeed:header -->
+${rendered.headerHtml}`;
+  if (rendered.footerHtml) snapshot += `
+<!-- formfeed:footer -->
+${rendered.footerHtml}`;
+  return snapshot;
+}
 function officeSnapshot(filled) {
   return officeTextParts(filled).map((part) => `--- ${part.name} ---
 ${prettyXml(part.xml)}`).join("\n");
@@ -1205,6 +1215,7 @@ export {
   diagnose,
   findProject,
   generateTypes,
+  htmlSnapshot,
   isIgnored,
   listLocalFiles,
   listTemplateSlugs,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formfeed/devkit",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "description": "Formfeed template folders, project config and local rendering, shared by the CLI and @formfeed/testing.",
   "license": "MIT",
   "type": "module",
@@ -30,8 +30,8 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@formfeed/engine": "0.3.6",
-    "@formfeed/sdk": "0.3.6"
+    "@formfeed/engine": "0.3.7",
+    "@formfeed/sdk": "0.3.7"
   },
   "keywords": [
     "formfeed",

package/types/index.d.cts

@@ -6,7 +6,7 @@ export type { LocalOfficeFile, LocalTemplate, ProjectState, SharedPartialState,
 export { brandFromJson, brandPath, readBrand, writeBrand } from './lib/brand.cjs';
 export { collectPartials } from './lib/partials.cjs';
 export type { CollectedPartials } from './lib/partials.cjs';
-export { diagnose, officeSnapshot, prettyXml, previewDocument, renderContext, renderLocal, renderOfficeLocal, renderedSettings } from './lib/local-render.cjs';
+export { diagnose, htmlSnapshot, officeSnapshot, prettyXml, previewDocument, renderContext, renderLocal, renderOfficeLocal, renderedSettings } from './lib/local-render.cjs';
 export type { LocalDiagnostic, OfficeLocalOptions } from './lib/local-render.cjs';
 export { contentTypeFor, listLocalFiles, localFilePath, sha256File, writeLocalFile } from './lib/files.cjs';
 export type { LocalFile, LocalFileListing } from './lib/files.cjs';

package/types/index.d.ts

@@ -6,7 +6,7 @@ export type { LocalOfficeFile, LocalTemplate, ProjectState, SharedPartialState,
 export { brandFromJson, brandPath, readBrand, writeBrand } from './lib/brand.js';
 export { collectPartials } from './lib/partials.js';
 export type { CollectedPartials } from './lib/partials.js';
-export { diagnose, officeSnapshot, prettyXml, previewDocument, renderContext, renderLocal, renderOfficeLocal, renderedSettings } from './lib/local-render.js';
+export { diagnose, htmlSnapshot, officeSnapshot, prettyXml, previewDocument, renderContext, renderLocal, renderOfficeLocal, renderedSettings } from './lib/local-render.js';
 export type { LocalDiagnostic, OfficeLocalOptions } from './lib/local-render.js';
 export { contentTypeFor, listLocalFiles, localFilePath, sha256File, writeLocalFile } from './lib/files.js';
 export type { LocalFile, LocalFileListing } from './lib/files.js';

package/types/lib/local-render.d.cts

@@ -23,6 +23,13 @@ export interface OfficeLocalOptions {
 }
 /** Fills a Word or PowerPoint template with the shared engine, as the render-worker does. */
 export declare function renderOfficeLocal(project: Project, tpl: LocalTemplate, data: unknown, options?: OfficeLocalOptions): Promise<OfficeRenderResult>;
+/**
+ * An HTML template's snapshot: the assembled document, then the rendered header and footer under
+ * `<!-- formfeed:header -->` and `<!-- formfeed:footer -->` lines when the template has them.
+ * Chromium prints header and footer from templates of their own, outside the document, so a
+ * snapshot of the document alone passed a changed footer unnoticed.
+ */
+export declare function htmlSnapshot(rendered: Pick<RenderedDocument, 'document' | 'headerHtml' | 'footerHtml'>): string;
 /**
  * The filled parts of a Word or PowerPoint document as readable text for snapshots: each part's XML,
  * one element per line and indented, text kept beside its element, under a `--- <part> ---` line.

package/types/lib/local-render.d.ts

@@ -23,6 +23,13 @@ export interface OfficeLocalOptions {
 }
 /** Fills a Word or PowerPoint template with the shared engine, as the render-worker does. */
 export declare function renderOfficeLocal(project: Project, tpl: LocalTemplate, data: unknown, options?: OfficeLocalOptions): Promise<OfficeRenderResult>;
+/**
+ * An HTML template's snapshot: the assembled document, then the rendered header and footer under
+ * `<!-- formfeed:header -->` and `<!-- formfeed:footer -->` lines when the template has them.
+ * Chromium prints header and footer from templates of their own, outside the document, so a
+ * snapshot of the document alone passed a changed footer unnoticed.
+ */
+export declare function htmlSnapshot(rendered: Pick<RenderedDocument, 'document' | 'headerHtml' | 'footerHtml'>): string;
 /**
  * The filled parts of a Word or PowerPoint document as readable text for snapshots: each part's XML,
  * one element per line and indented, text kept beside its element, under a `--- <part> ---` line.