@formfeed/devkit 0.3.12 → 0.3.14

package/index.cjs

@@ -31,6 +31,7 @@ __export(index_exports, {
   defaultProjectConfig: () => defaultProjectConfig,
   defaultTypesFile: () => defaultTypesFile,
   diagnose: () => diagnose,
+  diagnoseAccessibility: () => diagnoseAccessibility,
   diagnoseEinvoice: () => diagnoseEinvoice,
   findProject: () => findProject,
   generateTypes: () => generateTypes,
@@ -809,7 +810,8 @@ function previewDocument(tpl, rendered, mode, pagedScriptUrl) {
     settings: rendered.settings,
     kind
   };
-  return mode === "paged" && kind === "pdf" ? (0, import_engine4.pagedDocument)(draft, { pagedScriptUrl }) : (0, import_engine4.flowDocument)(draft);
+  const audit = kind === "pdf" && (0, import_engine4.resolveUa)(rendered.settings.pdf?.ua) !== null;
+  return mode === "paged" && kind === "pdf" ? (0, import_engine4.pagedDocument)(draft, { pagedScriptUrl, audit }) : (0, import_engine4.flowDocument)(draft, { audit });
 }
 
 // packages/devkit/src/lib/einvoice.ts
@@ -905,6 +907,62 @@ function localEinvoiceXml(tpl, data, override) {
   return { xml: result.xml, invoice: result.invoice, options };
 }
 
+// packages/devkit/src/lib/accessibility.ts
+var import_engine6 = require("@formfeed/engine");
+var nowhere3 = { start: { line: 1, column: 1 }, end: { line: 1, column: 1 } };
+var about = (severity, code, message) => ({
+  file: "settings.json",
+  diagnostics: [{ severity, code, message, range: nowhere3 }]
+});
+function diagnoseAccessibility(tpl) {
+  const declared = tpl.settings.pdf?.ua;
+  if (declared !== void 0 && !(0, import_engine6.isUaSetting)(declared))
+    return [
+      about(
+        "error",
+        "accessibility-setting",
+        'pdf.ua is true, false or { "check": "strict" | "report" }'
+      )
+    ];
+  const ua = (0, import_engine6.resolveUa)(declared);
+  if (!ua) return [];
+  if (tpl.meta.kind === "image")
+    return [
+      about(
+        "warning",
+        "accessibility-image",
+        "settings.json declares pdf.ua, which an image template never produces: PDF/UA is a format of PDF"
+      )
+    ];
+  if ((0, import_engine6.isOfficeKind)(tpl.meta.kind))
+    return [about("error", "accessibility-office", import_engine6.UA_REFUSALS.office)];
+  const out = [];
+  const body = [];
+  for (const found of (0, import_engine6.staticAuditDiagnostics)(
+    {
+      engine: tpl.meta.engine,
+      html: tpl.html,
+      head: tpl.head,
+      title: tpl.settings.pdf?.metadata?.title
+    },
+    ua
+  )) {
+    if (!found.location) {
+      out.push(about(found.severity, found.code, found.message));
+      continue;
+    }
+    body.push({
+      severity: found.severity,
+      code: found.code,
+      message: found.message,
+      range: { start: found.location, end: found.location }
+    });
+  }
+  if (body.length)
+    out.push({ file: templateFileName(tpl.meta.kind), diagnostics: body });
+  return out;
+}
+
 // packages/devkit/src/lib/files.ts
 var import_node_crypto2 = require("node:crypto");
 var import_node_fs5 = require("node:fs");
@@ -1043,7 +1101,7 @@ function isRecord(value) {
 }
 
 // packages/devkit/src/lib/types/index.ts
-var import_engine6 = require("@formfeed/engine");
+var import_engine7 = require("@formfeed/engine");
 
 // packages/devkit/src/lib/types/model.ts
 var isObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
@@ -1531,7 +1589,7 @@ function localTypeSource(tpl) {
   const sets = Object.values(tpl.dataSets);
   return {
     slug: tpl.slug,
-    schema: (0, import_engine6.inferSchemaFromDataSets)(sets.length ? sets : [{}]),
+    schema: (0, import_engine7.inferSchemaFromDataSets)(sets.length ? sets : [{}]),
     origin: "inferred"
   };
 }
@@ -1548,6 +1606,7 @@ function localTypeSource(tpl) {
   defaultProjectConfig,
   defaultTypesFile,
   diagnose,
+  diagnoseAccessibility,
   diagnoseEinvoice,
   findProject,
   generateTypes,

package/index.js

@@ -543,7 +543,8 @@ import {
   pagedDocument,
   parseDesign,
   renderOffice,
-  renderVersion
+  renderVersion,
+  resolveUa
 } from "@formfeed/engine";
 function diagnose(tpl, sampleData) {
   if (tpl.file) return diagnoseOffice(tpl, tpl.file.bytes, sampleData);
@@ -757,7 +758,8 @@ function previewDocument(tpl, rendered, mode, pagedScriptUrl) {
     settings: rendered.settings,
     kind
   };
-  return mode === "paged" && kind === "pdf" ? pagedDocument(draft, { pagedScriptUrl }) : flowDocument(draft);
+  const audit = kind === "pdf" && resolveUa(rendered.settings.pdf?.ua) !== null;
+  return mode === "paged" && kind === "pdf" ? pagedDocument(draft, { pagedScriptUrl, audit }) : flowDocument(draft, { audit });
 }
 
 // packages/devkit/src/lib/einvoice.ts
@@ -859,6 +861,68 @@ function localEinvoiceXml(tpl, data, override) {
   return { xml: result.xml, invoice: result.invoice, options };
 }
 
+// packages/devkit/src/lib/accessibility.ts
+import {
+  UA_REFUSALS,
+  isOfficeKind as isOfficeKind3,
+  isUaSetting,
+  resolveUa as resolveUa2,
+  staticAuditDiagnostics
+} from "@formfeed/engine";
+var nowhere3 = { start: { line: 1, column: 1 }, end: { line: 1, column: 1 } };
+var about = (severity, code, message) => ({
+  file: "settings.json",
+  diagnostics: [{ severity, code, message, range: nowhere3 }]
+});
+function diagnoseAccessibility(tpl) {
+  const declared = tpl.settings.pdf?.ua;
+  if (declared !== void 0 && !isUaSetting(declared))
+    return [
+      about(
+        "error",
+        "accessibility-setting",
+        'pdf.ua is true, false or { "check": "strict" | "report" }'
+      )
+    ];
+  const ua = resolveUa2(declared);
+  if (!ua) return [];
+  if (tpl.meta.kind === "image")
+    return [
+      about(
+        "warning",
+        "accessibility-image",
+        "settings.json declares pdf.ua, which an image template never produces: PDF/UA is a format of PDF"
+      )
+    ];
+  if (isOfficeKind3(tpl.meta.kind))
+    return [about("error", "accessibility-office", UA_REFUSALS.office)];
+  const out = [];
+  const body = [];
+  for (const found of staticAuditDiagnostics(
+    {
+      engine: tpl.meta.engine,
+      html: tpl.html,
+      head: tpl.head,
+      title: tpl.settings.pdf?.metadata?.title
+    },
+    ua
+  )) {
+    if (!found.location) {
+      out.push(about(found.severity, found.code, found.message));
+      continue;
+    }
+    body.push({
+      severity: found.severity,
+      code: found.code,
+      message: found.message,
+      range: { start: found.location, end: found.location }
+    });
+  }
+  if (body.length)
+    out.push({ file: templateFileName(tpl.meta.kind), diagnostics: body });
+  return out;
+}
+
 // packages/devkit/src/lib/files.ts
 import { createHash as createHash2 } from "node:crypto";
 import { existsSync as existsSync5, mkdirSync as mkdirSync3, readdirSync as readdirSync2, readFileSync as readFileSync5, statSync as statSync2, writeFileSync as writeFileSync4 } from "node:fs";
@@ -1501,6 +1565,7 @@ export {
   defaultProjectConfig,
   defaultTypesFile,
   diagnose,
+  diagnoseAccessibility,
   diagnoseEinvoice,
   findProject,
   generateTypes,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formfeed/devkit",
-  "version": "0.3.12",
+  "version": "0.3.14",
   "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.12",
-    "@formfeed/sdk": "0.3.12"
+    "@formfeed/engine": "0.3.14",
+    "@formfeed/sdk": "0.3.14"
   },
   "keywords": [
     "formfeed",

package/types/index.d.cts

@@ -10,6 +10,8 @@ export { diagnose, htmlSnapshot, officeSnapshot, prettyXml, previewDocument, ren
 export type { LocalDiagnostic, OfficeLocalOptions } from './lib/local-render.cjs';
 export { declaredEinvoice, diagnoseEinvoice, localEinvoiceXml, } from './lib/einvoice.cjs';
 export type { DataSetDiagnostics } from './lib/einvoice.cjs';
+export { diagnoseAccessibility } from './lib/accessibility.cjs';
+export type { FileDiagnostics } from './lib/accessibility.cjs';
 export { contentTypeFor, listLocalFiles, localFilePath, sha256File, writeLocalFile, } from './lib/files.cjs';
 export type { LocalFile, LocalFileListing } from './lib/files.cjs';
 export type { LocalRenderOptions } from './lib/local-render.cjs';

package/types/index.d.ts

@@ -10,6 +10,8 @@ export { diagnose, htmlSnapshot, officeSnapshot, prettyXml, previewDocument, ren
 export type { LocalDiagnostic, OfficeLocalOptions } from './lib/local-render.js';
 export { declaredEinvoice, diagnoseEinvoice, localEinvoiceXml, } from './lib/einvoice.js';
 export type { DataSetDiagnostics } from './lib/einvoice.js';
+export { diagnoseAccessibility } from './lib/accessibility.js';
+export type { FileDiagnostics } from './lib/accessibility.js';
 export { contentTypeFor, listLocalFiles, localFilePath, sha256File, writeLocalFile, } from './lib/files.js';
 export type { LocalFile, LocalFileListing } from './lib/files.js';
 export type { LocalRenderOptions } from './lib/local-render.js';

package/types/lib/accessibility.d.cts

@@ -0,0 +1,21 @@
+import type { LocalDiagnostic } from './local-render.cjs';
+import { type LocalTemplate } from './project.cjs';
+/**
+ * `pdf.ua` of a template folder (plan 21 §6): what can be said about a template that declares
+ * PDF/UA-1 without rendering it. `formfeed validate` and the MCP server's validation report it. It
+ * is the static half of the template check: a document without a title, an image written without
+ * `alt`, and a declaration the API will refuse. What depends on the data (heading levels, table
+ * rows, a chart's name) is found in the rendered page, by the editor's preview and by the render.
+ */
+/** The findings of one file of a template folder. */
+export interface FileDiagnostics {
+    /** Relative to the template folder: `template.html`, `settings.json`. */
+    file: string;
+    diagnostics: LocalDiagnostic[];
+}
+/**
+ * Empty for a template that does not declare `pdf.ua`. A fault the validator fails the file for is
+ * an error where the template is strict, since every render of it then fails, and a warning where
+ * it only reports; what a reader stumbles over without a rule failing is a warning either way.
+ */
+export declare function diagnoseAccessibility(tpl: LocalTemplate): FileDiagnostics[];

package/types/lib/accessibility.d.ts

@@ -0,0 +1,21 @@
+import type { LocalDiagnostic } from './local-render.js';
+import { type LocalTemplate } from './project.js';
+/**
+ * `pdf.ua` of a template folder (plan 21 §6): what can be said about a template that declares
+ * PDF/UA-1 without rendering it. `formfeed validate` and the MCP server's validation report it. It
+ * is the static half of the template check: a document without a title, an image written without
+ * `alt`, and a declaration the API will refuse. What depends on the data (heading levels, table
+ * rows, a chart's name) is found in the rendered page, by the editor's preview and by the render.
+ */
+/** The findings of one file of a template folder. */
+export interface FileDiagnostics {
+    /** Relative to the template folder: `template.html`, `settings.json`. */
+    file: string;
+    diagnostics: LocalDiagnostic[];
+}
+/**
+ * Empty for a template that does not declare `pdf.ua`. A fault the validator fails the file for is
+ * an error where the template is strict, since every render of it then fails, and a warning where
+ * it only reports; what a reader stumbles over without a rule failing is a warning either way.
+ */
+export declare function diagnoseAccessibility(tpl: LocalTemplate): FileDiagnostics[];