@asterdoc/render 0.0.0-stage → 0.9.0

package/dist/signatures-DPaL4gay.d.ts

@@ -0,0 +1,20 @@
+import { SignaturePlaceholderValue, SignatureCapturedValue } from '@asterdoc/types';
+
+interface DocxSignatureOptions {
+    placeholder?: {
+        signature?: SignaturePlaceholderValue;
+        initials?: SignaturePlaceholderValue;
+        signatureDate?: SignaturePlaceholderValue;
+        capacity?: SignaturePlaceholderValue;
+        printedName?: SignaturePlaceholderValue;
+    };
+    captured?: {
+        signature?: SignatureCapturedValue;
+        initials?: SignatureCapturedValue;
+        signatureDate?: SignatureCapturedValue;
+        capacity?: SignatureCapturedValue;
+        printedName?: SignatureCapturedValue;
+    };
+}
+
+export type { DocxSignatureOptions as D };

package/dist/signatures-cS3V0yR3.d.ts

@@ -0,0 +1,27 @@
+import { SignaturePlaceholderValue, SignatureCapturedValue } from '@asterdoc/types';
+
+interface TextSignatureOptions {
+    /**
+     * How signing marks print. Defaults from the layer's MIME type: `html` for
+     * `text/html`, `markdown` for `text/markdown`, else `text`.
+     */
+    format?: 'text' | 'html' | 'markdown';
+    placeholder?: {
+        signature?: SignaturePlaceholderValue;
+        initials?: SignaturePlaceholderValue;
+        signatureDate?: SignaturePlaceholderValue;
+        capacity?: SignaturePlaceholderValue;
+        printedName?: SignaturePlaceholderValue;
+    };
+    captured?: {
+        signature?: SignatureCapturedValue;
+        initials?: SignatureCapturedValue;
+        signatureDate?: SignatureCapturedValue;
+        capacity?: SignatureCapturedValue;
+        printedName?: SignatureCapturedValue;
+    };
+    altText?: string;
+    cssClass?: string;
+}
+
+export type { TextSignatureOptions as T };

package/dist/text/field-formatter.d.ts

@@ -0,0 +1,46 @@
+import { FormatIssue, FormatterProgressivePolicy, MoneyFormatOptions, Form, Formatter, Bindings, FormField } from '@asterdoc/types';
+
+/** Explicit policy for rendering a value that is missing or incomplete. */
+type ProgressiveFormattingOptions = FormatterProgressivePolicy;
+interface FieldFormattingOptions {
+    /** Enable placeholders for missing/incomplete values for a progressive preview. */
+    progressive?: ProgressiveFormattingOptions;
+    /**
+     * What a choice prints: its option label (the default) or its option value.
+     * A PDF box writes the value, the code the form expects, such as "C" or "5".
+     */
+    choices?: 'label' | 'value';
+    /**
+     * Options for every money value, applied over the formatter's own policy.
+     * A PDF layer that declares `format.money` passes it here.
+     */
+    money?: MoneyFormatOptions;
+}
+type RecordValue = Record<string, unknown>;
+/**
+ * A template value that keeps its source value for logic/property access while
+ * supplying the selected formatter's text for interpolation.
+ */
+declare class FormattedFieldValue {
+    constructor(value: unknown, text: string);
+    get raw(): unknown;
+    toString(): string;
+}
+declare function unwrapFormattedValue(value: unknown): unknown;
+/** Raised when a declared artifact value cannot be presented. */
+declare class ArtifactFieldFormatError extends Error {
+    readonly path: string;
+    readonly fieldType: string;
+    readonly status: string;
+    readonly issues: readonly FormatIssue[];
+    constructor(path: string, fieldType: string, status: string, issues: readonly FormatIssue[], cause?: unknown);
+}
+declare function formatFieldValue(formatter: Formatter, field: FormField, value: unknown, path: string, options?: FieldFormattingOptions): unknown;
+declare function formatDefinitionValue(formatter: Formatter, type: string, value: unknown, path: string, options?: FieldFormattingOptions): unknown;
+declare function formatParties(formatter: Formatter, form: Form, value: unknown, path: string, options?: FieldFormattingOptions, role?: string): unknown;
+/** Apply one formatter to all declared field-aware values in a text render payload. */
+declare function formatFieldData(data: RecordValue, form: Form, formatter: Formatter, options?: FieldFormattingOptions): RecordValue;
+/** Validate renderer binding sources against the declared artifact shape. */
+declare function validateFieldBindings(form: Form, bindings: Bindings): void;
+
+export { ArtifactFieldFormatError, type FieldFormattingOptions, FormattedFieldValue, type ProgressiveFormattingOptions, formatDefinitionValue, formatFieldData, formatFieldValue, formatParties, unwrapFormattedValue, validateFieldBindings };

package/dist/text/field-formatter.js

@@ -0,0 +1,21 @@
+import {
+  ArtifactFieldFormatError,
+  FormattedFieldValue,
+  formatDefinitionValue,
+  formatFieldData,
+  formatFieldValue,
+  formatParties,
+  unwrapFormattedValue,
+  validateFieldBindings
+} from "../chunk-ICQLU4FL.js";
+import "../chunk-4QVR6LUY.js";
+export {
+  ArtifactFieldFormatError,
+  FormattedFieldValue,
+  formatDefinitionValue,
+  formatFieldData,
+  formatFieldValue,
+  formatParties,
+  unwrapFormattedValue,
+  validateFieldBindings
+};

package/dist/text.d.ts

@@ -0,0 +1,44 @@
+import { Form, Formatter, FormatterProgressivePolicy, AsterdocRenderer, RendererLayer } from '@asterdoc/types';
+import { FieldFormattingOptions } from './text/field-formatter.js';
+export { ArtifactFieldFormatError, FormattedFieldValue, ProgressiveFormattingOptions, formatFieldData, unwrapFormattedValue, validateFieldBindings } from './text/field-formatter.js';
+import { T as TextSignatureOptions } from './signatures-cS3V0yR3.js';
+import { T as TemplateExpressionOptions } from './context-BmjDcc_j.js';
+export { S as SigningDirectiveUse, T as TemplateDiagnostic, a as TemplateError, b as TemplatePosition, d as checkTextTemplate, t as textTemplateSigningDirectives } from './check-BA5xdYgi.js';
+import '@asterdoc/expr';
+
+/** Places a signing mark for a party at a location: `signature`, `initials`, and the related directives. */
+type SigningDirective = (party: unknown, root: Record<string, unknown>, args: unknown[]) => unknown;
+
+interface RenderTextOptions {
+    template: string;
+    data: Record<string, unknown>;
+    form?: Form;
+    formatter?: Formatter;
+    progressive?: FieldFormattingOptions['progressive'];
+    signatureOptions?: TextSignatureOptions;
+    /** The expression context and configured functions templates read. */
+    expressions?: TemplateExpressionOptions;
+    /** The layer key, named in template errors. */
+    layer?: string;
+    /**
+     * The output MIME type. `text/html` escapes interpolated values; plain text
+     * and Markdown print them unchanged.
+     */
+    mimeType?: string;
+}
+declare function renderText(options: RenderTextOptions): string;
+
+interface TextRendererOptions {
+    formatter?: Formatter;
+    progressive?: FormatterProgressivePolicy;
+    signatureOptions?: TextSignatureOptions;
+    /** Configured functions templates can call when no artifact context is supplied. */
+    expressions?: Pick<TemplateExpressionOptions, 'functions' | 'signatures'>;
+}
+type TextLayer = RendererLayer & {
+    type: 'text';
+    content: string;
+};
+declare function textRenderer(options?: TextRendererOptions): AsterdocRenderer<TextLayer, string>;
+
+export { FieldFormattingOptions, type RenderTextOptions, type SigningDirective, TemplateExpressionOptions, type TextRendererOptions, TextSignatureOptions, renderText, textRenderer };

package/dist/text.js

@@ -0,0 +1,77 @@
+import {
+  TemplateError,
+  checkTextTemplate,
+  createTextSignatureDirectives,
+  escapeHtml,
+  renderTemplate,
+  requestExpressions,
+  templateData,
+  textTemplateSigningDirectives
+} from "./chunk-PNYKTSIT.js";
+import {
+  requestRenderData
+} from "./chunk-U7LF3GN4.js";
+import {
+  ArtifactFieldFormatError,
+  FormattedFieldValue,
+  formatFieldData,
+  unwrapFormattedValue,
+  validateFieldBindings
+} from "./chunk-ICQLU4FL.js";
+import "./chunk-4QVR6LUY.js";
+
+// src/text/render.ts
+import { defaultFormatter } from "@asterdoc/format";
+function escapeFor(mimeType) {
+  return mimeType?.toLowerCase() === "text/html" ? escapeHtml : (value) => value;
+}
+function renderText(options) {
+  const formatter = options.formatter ?? defaultFormatter;
+  const formattingOptions = options.progressive === void 0 ? void 0 : { progressive: options.progressive };
+  const data = options.form ? formatFieldData(options.data, options.form, formatter, formattingOptions) : options.data;
+  const { context, resolveData } = templateData(options.data, data, options.form, options.expressions);
+  return renderTemplate(options.template, {
+    context,
+    resolveData,
+    root: data,
+    formatter,
+    directives: createTextSignatureDirectives(options.signatureOptions, options.mimeType),
+    layer: options.layer,
+    escape: escapeFor(options.mimeType)
+  });
+}
+
+// src/text/renderer.ts
+import { defaultFormatter as defaultFormatter2 } from "@asterdoc/format";
+function textRenderer(options = {}) {
+  const formatter = options.formatter ?? defaultFormatter2;
+  return {
+    id: "text",
+    render(request) {
+      const { data, form } = requestRenderData(request);
+      return renderText({
+        template: request.template.content,
+        data,
+        form,
+        formatter: request.ctx?.formatter ?? formatter,
+        progressive: request.ctx?.progressive ?? options.progressive,
+        signatureOptions: options.signatureOptions,
+        expressions: requestExpressions(options.expressions, request.ctx?.expressions),
+        layer: request.template.key,
+        mimeType: request.template.mimeType
+      });
+    }
+  };
+}
+export {
+  ArtifactFieldFormatError,
+  FormattedFieldValue,
+  TemplateError,
+  checkTextTemplate,
+  formatFieldData,
+  renderText,
+  textRenderer,
+  textTemplateSigningDirectives,
+  unwrapFormattedValue,
+  validateFieldBindings
+};

package/package.json

@@ -1,6 +1,106 @@
 {
   "name": "@asterdoc/render",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.9.0",
+  "description": "Focused text, PDF, and DOCX rendering for Asterdoc",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./text": {
+      "types": "./dist/text.d.ts",
+      "import": "./dist/text.js",
+      "default": "./dist/text.js"
+    },
+    "./text/field-formatter": {
+      "types": "./dist/text/field-formatter.d.ts",
+      "import": "./dist/text/field-formatter.js",
+      "default": "./dist/text/field-formatter.js"
+    },
+    "./pdf": {
+      "types": "./dist/pdf.d.ts",
+      "import": "./dist/pdf.js",
+      "default": "./dist/pdf.js"
+    },
+    "./docx": {
+      "types": "./dist/docx.d.ts",
+      "import": "./dist/docx.js",
+      "default": "./dist/docx.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "asterdoc",
+    "documents",
+    "rendering",
+    "pdf",
+    "docx",
+    "markdown"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "Asterdoc",
+    "url": "https://asterdoc.com"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/asterdoc/asterdoc.git",
+    "directory": "packages/render"
+  },
+  "homepage": "https://asterdoc.com",
+  "bugs": {
+    "url": "https://github.com/asterdoc/asterdoc/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@asterdoc/types": "^0.9.0"
+  },
+  "dependencies": {
+    "fflate": "^0.8.3",
+    "@asterdoc/expr": "^0.9.0",
+    "@asterdoc/format": "^0.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.3",
+    "@vitest/coverage-v8": "^2.1.8",
+    "esbuild": "^0.27.2",
+    "eslint": "^9.34.0",
+    "pdfjs-dist": "4.10.38",
+    "tsup": "^8.4.0",
+    "typescript": "5.9.2",
+    "vitest": "^2.1.8",
+    "@asterdoc/eslint-config": "0.1.0",
+    "@asterdoc/typescript-config": "0.1.0",
+    "@asterdoc/types": "^0.9.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "prebuild": "pnpm run clean",
+    "pack:dry": "pnpm run build && npm pack --dry-run",
+    "lint": "eslint .",
+    "check-types": "tsc --noEmit",
+    "check": "pnpm lint && pnpm check-types",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "benchmark": "pnpm --silent run build >/dev/null && node scripts/benchmark.mjs",
+    "size-report": "pnpm --silent run build >/dev/null && node scripts/size-report.mjs"
+  }
 }