turbo-html2pdf-template 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 turbo-pdf contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,72 @@
+/** Anything that can be a child: a literal string or a nested builder result. */
+type Node = string | Node[];
+/** `{% if COND %} … {% endif %}` (§2.5). */
+declare function ifBlock(cond: string, ...children: Node[]): string;
+/** `{% elif COND %} …` — place inside an `ifBlock` body (§2.5). */
+declare function elseIf(cond: string, ...children: Node[]): string;
+/** `{% else %} …` — place inside an `ifBlock`/`each` body (§2.5/2.7). */
+declare function elseBlock(...children: Node[]): string;
+/** `{% for AS in OF %} … {% endfor %}` (§2.7). */
+declare function each(of: string, as: string, ...children: Node[]): string;
+/** `{% switch ON %} … {% endswitch %}` (§2.6). */
+declare function switchBlock(on: string, ...children: Node[]): string;
+/** `{% case V1, V2, … %} …` — inside a `switchBlock` (§2.6). */
+declare function caseBlock(value: string, ...children: Node[]): string;
+/** `{% default %} …` — last child of a `switchBlock` (§2.6). */
+declare function defaultBlock(...children: Node[]): string;
+/** `{% include SRC %}` / `{% include SRC with CTX %}` (§2.8). */
+declare function include(src: string, withCtx?: string): string;
+/** `{{ EXPR }}` interpolation (§2.4). */
+declare function expr(value: string): string;
+/** `<t:running-header>` (§3.0). */
+declare function runningHeader(opts: {
+    extent?: string;
+}, ...children: Node[]): string;
+/** `<t:running-footer>` (§3.0). */
+declare function runningFooter(opts: {
+    extent?: string;
+}, ...children: Node[]): string;
+/** `<t:page-master>` (§3.1). */
+declare function pageMaster(opts: {
+    name: string;
+    size?: string;
+    orientation?: string;
+    margin?: string;
+}, ...children: Node[]): string;
+/** `<t:region slot extent>` (§3.1). */
+declare function region(opts: {
+    slot: string;
+    extent?: string;
+}, ...children: Node[]): string;
+/** `<t:variant kind>` (§3.2). */
+declare function variant(kind: string, ...children: Node[]): string;
+/** `<t:use-master name/>` (§3.4). */
+declare function useMaster(name: string): string;
+/** `<t:footnote>` (§3.6). */
+declare function footnote(opts: {
+    mark?: string;
+    reset?: string;
+}, ...children: Node[]): string;
+/** `<t:counter name action step start/>` (§3.8). */
+declare function counter(opts: {
+    name: string;
+    action?: string;
+    step?: string;
+    start?: string;
+}): string;
+/** `<t:leader/>` (§3.10). */
+declare function leader(): string;
+/** A named running element via the `t:running` attribute on a host element (§3.5). */
+declare function running(opts: {
+    name: string;
+    tag?: string;
+    policy?: string;
+}, ...children: Node[]): string;
+/** `<t:page/>` (§3.3). */
+declare function page(): string;
+/** `<t:pages/>` (§3.3). */
+declare function pages(): string;
+/** Final assembly: concatenate top-level nodes and trim outer whitespace. */
+declare function compileTemplate(...children: Node[]): string;
+
+export { type Node, caseBlock, compileTemplate, counter, defaultBlock, each, elseBlock, elseIf, expr, footnote, ifBlock, include, leader, page, pageMaster, pages, region, running, runningFooter, runningHeader, switchBlock, useMaster, variant };

package/dist/index.js

@@ -0,0 +1,113 @@
+// src/index.ts
+function render(child) {
+  return Array.isArray(child) ? child.map(render).join("") : child;
+}
+function join(children) {
+  return children.map(render).join("");
+}
+function ifBlock(cond, ...children) {
+  return `{% if ${cond} %}${join(children)}{% endif %}`;
+}
+function elseIf(cond, ...children) {
+  return `{% elif ${cond} %}${join(children)}`;
+}
+function elseBlock(...children) {
+  return `{% else %}${join(children)}`;
+}
+function each(of, as, ...children) {
+  return `{% for ${as} in ${of} %}${join(children)}{% endfor %}`;
+}
+function switchBlock(on, ...children) {
+  return `{% switch ${on} %}${join(children)}{% endswitch %}`;
+}
+function caseBlock(value, ...children) {
+  return `{% case ${value} %}${join(children)}`;
+}
+function defaultBlock(...children) {
+  return `{% default %}${join(children)}`;
+}
+function include(src, withCtx) {
+  return withCtx ? `{% include ${src} with ${withCtx} %}` : `{% include ${src} %}`;
+}
+function expr(value) {
+  return `{{ ${value} }}`;
+}
+function attrs(map) {
+  let out = "";
+  for (const [key, value] of Object.entries(map)) {
+    if (value !== void 0) {
+      out += ` ${key}="${value}"`;
+    }
+  }
+  return out;
+}
+function directive(name, attrMap, children) {
+  const open = `t:${name}${attrs(attrMap)}`;
+  return `<${open}>${children === void 0 ? "" : join(children)}</t:${name}>`;
+}
+function runningHeader(opts, ...children) {
+  return directive("running-header", { extent: opts.extent }, children);
+}
+function runningFooter(opts, ...children) {
+  return directive("running-footer", { extent: opts.extent }, children);
+}
+function pageMaster(opts, ...children) {
+  return directive("page-master", opts, children);
+}
+function region(opts, ...children) {
+  return directive("region", opts, children);
+}
+function variant(kind, ...children) {
+  return directive("variant", { kind }, children);
+}
+function useMaster(name) {
+  return directive("use-master", { name });
+}
+function footnote(opts, ...children) {
+  return directive("footnote", { mark: opts.mark, "t:footnote-reset": opts.reset }, children);
+}
+function counter(opts) {
+  return directive("counter", opts);
+}
+function leader() {
+  return directive("leader", {});
+}
+function running(opts, ...children) {
+  const tag = opts.tag ?? "span";
+  const map = attrs({ "t:running": opts.name, "t:running-policy": opts.policy });
+  return `<${tag}${map}>${join(children)}</${tag}>`;
+}
+function page() {
+  return directive("page", {});
+}
+function pages() {
+  return directive("pages", {});
+}
+function compileTemplate(...children) {
+  return join(children).trim();
+}
+export {
+  caseBlock,
+  compileTemplate,
+  counter,
+  defaultBlock,
+  each,
+  elseBlock,
+  elseIf,
+  expr,
+  footnote,
+  ifBlock,
+  include,
+  leader,
+  page,
+  pageMaster,
+  pages,
+  region,
+  running,
+  runningFooter,
+  runningHeader,
+  switchBlock,
+  useMaster,
+  variant
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["// `turbo-html2pdf-template` — a deliberately tiny *second* authoring frontend.\n//\n// It exists to prove the core is frontend-agnostic (AC-8.9): a different tool, with\n// no shared code, emits the *same* turbo-pdf template source string (Jinja control\n// flow + `t:` directives + plain HTML) through the unchanged core. This one is a\n// framework-free tagged-template / builder helper — no React, no JSX, ~one file.\n//\n// Unlike React, nothing here HTML-escapes, so there is no sentinel machinery: the\n// helpers concatenate literal strings directly. The author is responsible for\n// escaping plain text where needed (mirroring hand-authored HTML).\n\n/** Anything that can be a child: a literal string or a nested builder result. */\nexport type Node = string | Node[];\n\n/** Flatten a child (string or nested array) into a single source string. */\nfunction render(child: Node): string {\n  return Array.isArray(child) ? child.map(render).join(\"\") : child;\n}\n\n/** Join a rest-args child list into one source string. */\nfunction join(children: Node[]): string {\n  return children.map(render).join(\"\");\n}\n\n// ---------------------------------------------------------------------------\n// Control flow -> Jinja statements\n// ---------------------------------------------------------------------------\n\n/** `{% if COND %} … {% endif %}` (§2.5). */\nexport function ifBlock(cond: string, ...children: Node[]): string {\n  return `{% if ${cond} %}${join(children)}{% endif %}`;\n}\n\n/** `{% elif COND %} …` — place inside an `ifBlock` body (§2.5). */\nexport function elseIf(cond: string, ...children: Node[]): string {\n  return `{% elif ${cond} %}${join(children)}`;\n}\n\n/** `{% else %} …` — place inside an `ifBlock`/`each` body (§2.5/2.7). */\nexport function elseBlock(...children: Node[]): string {\n  return `{% else %}${join(children)}`;\n}\n\n/** `{% for AS in OF %} … {% endfor %}` (§2.7). */\nexport function each(of: string, as: string, ...children: Node[]): string {\n  return `{% for ${as} in ${of} %}${join(children)}{% endfor %}`;\n}\n\n/** `{% switch ON %} … {% endswitch %}` (§2.6). */\nexport function switchBlock(on: string, ...children: Node[]): string {\n  return `{% switch ${on} %}${join(children)}{% endswitch %}`;\n}\n\n/** `{% case V1, V2, … %} …` — inside a `switchBlock` (§2.6). */\nexport function caseBlock(value: string, ...children: Node[]): string {\n  return `{% case ${value} %}${join(children)}`;\n}\n\n/** `{% default %} …` — last child of a `switchBlock` (§2.6). */\nexport function defaultBlock(...children: Node[]): string {\n  return `{% default %}${join(children)}`;\n}\n\n/** `{% include SRC %}` / `{% include SRC with CTX %}` (§2.8). */\nexport function include(src: string, withCtx?: string): string {\n  return withCtx ? `{% include ${src} with ${withCtx} %}` : `{% include ${src} %}`;\n}\n\n/** `{{ EXPR }}` interpolation (§2.4). */\nexport function expr(value: string): string {\n  return `{{ ${value} }}`;\n}\n\n// ---------------------------------------------------------------------------\n// Paged media -> `t:` directive elements (names per core's t_kind table)\n// ---------------------------------------------------------------------------\n\n/** Serialize an attribute map (skipping `undefined`) to ` name=\"value\"` pairs. */\nfunction attrs(map: Record<string, string | undefined>): string {\n  let out = \"\";\n  for (const [key, value] of Object.entries(map)) {\n    if (value !== undefined) {\n      out += ` ${key}=\"${value}\"`;\n    }\n  }\n  return out;\n}\n\n/**\n * Build a `t:`-prefixed directive element with attrs and optional children.\n *\n * Note the open/close pair even when empty (`<t:page></t:page>`): this matches the\n * exact bytes React's `renderToStaticMarkup` emits for custom elements, so the two\n * frontends are byte-identical (AC-8.9). html5ever parses this and the self-closing\n * `<t:page/>` form to the same node, so the choice is purely about string equality.\n */\nfunction directive(\n  name: string,\n  attrMap: Record<string, string | undefined>,\n  children?: Node[],\n): string {\n  const open = `t:${name}${attrs(attrMap)}`;\n  return `<${open}>${children === undefined ? \"\" : join(children)}</t:${name}>`;\n}\n\n/** `<t:running-header>` (§3.0). */\nexport function runningHeader(opts: { extent?: string }, ...children: Node[]): string {\n  return directive(\"running-header\", { extent: opts.extent }, children);\n}\n\n/** `<t:running-footer>` (§3.0). */\nexport function runningFooter(opts: { extent?: string }, ...children: Node[]): string {\n  return directive(\"running-footer\", { extent: opts.extent }, children);\n}\n\n/** `<t:page-master>` (§3.1). */\nexport function pageMaster(\n  opts: { name: string; size?: string; orientation?: string; margin?: string },\n  ...children: Node[]\n): string {\n  return directive(\"page-master\", opts, children);\n}\n\n/** `<t:region slot extent>` (§3.1). */\nexport function region(opts: { slot: string; extent?: string }, ...children: Node[]): string {\n  return directive(\"region\", opts, children);\n}\n\n/** `<t:variant kind>` (§3.2). */\nexport function variant(kind: string, ...children: Node[]): string {\n  return directive(\"variant\", { kind }, children);\n}\n\n/** `<t:use-master name/>` (§3.4). */\nexport function useMaster(name: string): string {\n  return directive(\"use-master\", { name });\n}\n\n/** `<t:footnote>` (§3.6). */\nexport function footnote(opts: { mark?: string; reset?: string }, ...children: Node[]): string {\n  return directive(\"footnote\", { mark: opts.mark, \"t:footnote-reset\": opts.reset }, children);\n}\n\n/** `<t:counter name action step start/>` (§3.8). */\nexport function counter(opts: {\n  name: string;\n  action?: string;\n  step?: string;\n  start?: string;\n}): string {\n  return directive(\"counter\", opts);\n}\n\n/** `<t:leader/>` (§3.10). */\nexport function leader(): string {\n  return directive(\"leader\", {});\n}\n\n/** A named running element via the `t:running` attribute on a host element (§3.5). */\nexport function running(\n  opts: { name: string; tag?: string; policy?: string },\n  ...children: Node[]\n): string {\n  const tag = opts.tag ?? \"span\";\n  const map = attrs({ \"t:running\": opts.name, \"t:running-policy\": opts.policy });\n  return `<${tag}${map}>${join(children)}</${tag}>`;\n}\n\n/** `<t:page/>` (§3.3). */\nexport function page(): string {\n  return directive(\"page\", {});\n}\n\n/** `<t:pages/>` (§3.3). */\nexport function pages(): string {\n  return directive(\"pages\", {});\n}\n\n/** Final assembly: concatenate top-level nodes and trim outer whitespace. */\nexport function compileTemplate(...children: Node[]): string {\n  return join(children).trim();\n}\n"],"mappings":";AAeA,SAAS,OAAO,OAAqB;AACnC,SAAO,MAAM,QAAQ,KAAK,IAAI,MAAM,IAAI,MAAM,EAAE,KAAK,EAAE,IAAI;AAC7D;AAGA,SAAS,KAAK,UAA0B;AACtC,SAAO,SAAS,IAAI,MAAM,EAAE,KAAK,EAAE;AACrC;AAOO,SAAS,QAAQ,SAAiB,UAA0B;AACjE,SAAO,SAAS,IAAI,MAAM,KAAK,QAAQ,CAAC;AAC1C;AAGO,SAAS,OAAO,SAAiB,UAA0B;AAChE,SAAO,WAAW,IAAI,MAAM,KAAK,QAAQ,CAAC;AAC5C;AAGO,SAAS,aAAa,UAA0B;AACrD,SAAO,aAAa,KAAK,QAAQ,CAAC;AACpC;AAGO,SAAS,KAAK,IAAY,OAAe,UAA0B;AACxE,SAAO,UAAU,EAAE,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC;AAClD;AAGO,SAAS,YAAY,OAAe,UAA0B;AACnE,SAAO,aAAa,EAAE,MAAM,KAAK,QAAQ,CAAC;AAC5C;AAGO,SAAS,UAAU,UAAkB,UAA0B;AACpE,SAAO,WAAW,KAAK,MAAM,KAAK,QAAQ,CAAC;AAC7C;AAGO,SAAS,gBAAgB,UAA0B;AACxD,SAAO,gBAAgB,KAAK,QAAQ,CAAC;AACvC;AAGO,SAAS,QAAQ,KAAa,SAA0B;AAC7D,SAAO,UAAU,cAAc,GAAG,SAAS,OAAO,QAAQ,cAAc,GAAG;AAC7E;AAGO,SAAS,KAAK,OAAuB;AAC1C,SAAO,MAAM,KAAK;AACpB;AAOA,SAAS,MAAM,KAAiD;AAC9D,MAAI,MAAM;AACV,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,GAAG,GAAG;AAC9C,QAAI,UAAU,QAAW;AACvB,aAAO,IAAI,GAAG,KAAK,KAAK;AAAA,IAC1B;AAAA,EACF;AACA,SAAO;AACT;AAUA,SAAS,UACP,MACA,SACA,UACQ;AACR,QAAM,OAAO,KAAK,IAAI,GAAG,MAAM,OAAO,CAAC;AACvC,SAAO,IAAI,IAAI,IAAI,aAAa,SAAY,KAAK,KAAK,QAAQ,CAAC,OAAO,IAAI;AAC5E;AAGO,SAAS,cAAc,SAA8B,UAA0B;AACpF,SAAO,UAAU,kBAAkB,EAAE,QAAQ,KAAK,OAAO,GAAG,QAAQ;AACtE;AAGO,SAAS,cAAc,SAA8B,UAA0B;AACpF,SAAO,UAAU,kBAAkB,EAAE,QAAQ,KAAK,OAAO,GAAG,QAAQ;AACtE;AAGO,SAAS,WACd,SACG,UACK;AACR,SAAO,UAAU,eAAe,MAAM,QAAQ;AAChD;AAGO,SAAS,OAAO,SAA4C,UAA0B;AAC3F,SAAO,UAAU,UAAU,MAAM,QAAQ;AAC3C;AAGO,SAAS,QAAQ,SAAiB,UAA0B;AACjE,SAAO,UAAU,WAAW,EAAE,KAAK,GAAG,QAAQ;AAChD;AAGO,SAAS,UAAU,MAAsB;AAC9C,SAAO,UAAU,cAAc,EAAE,KAAK,CAAC;AACzC;AAGO,SAAS,SAAS,SAA4C,UAA0B;AAC7F,SAAO,UAAU,YAAY,EAAE,MAAM,KAAK,MAAM,oBAAoB,KAAK,MAAM,GAAG,QAAQ;AAC5F;AAGO,SAAS,QAAQ,MAKb;AACT,SAAO,UAAU,WAAW,IAAI;AAClC;AAGO,SAAS,SAAiB;AAC/B,SAAO,UAAU,UAAU,CAAC,CAAC;AAC/B;AAGO,SAAS,QACd,SACG,UACK;AACR,QAAM,MAAM,KAAK,OAAO;AACxB,QAAM,MAAM,MAAM,EAAE,aAAa,KAAK,MAAM,oBAAoB,KAAK,OAAO,CAAC;AAC7E,SAAO,IAAI,GAAG,GAAG,GAAG,IAAI,KAAK,QAAQ,CAAC,KAAK,GAAG;AAChD;AAGO,SAAS,OAAe;AAC7B,SAAO,UAAU,QAAQ,CAAC,CAAC;AAC7B;AAGO,SAAS,QAAgB;AAC9B,SAAO,UAAU,SAAS,CAAC,CAAC;AAC9B;AAGO,SAAS,mBAAmB,UAA0B;AAC3D,SAAO,KAAK,QAAQ,EAAE,KAAK;AAC7B;","names":[]}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "turbo-html2pdf-template",
+  "version": "0.1.0",
+  "description": "Minimal framework-free template-string authoring frontend for turbo-pdf (proves the core is frontend-agnostic).",
+  "license": "MIT",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "tsup": "^8.0.0",
+    "vitest": "^2.0.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsgo --noEmit"
+  }
+}