@reportwright/engine 0.12.1 → 0.13.0

package/dist/types/src/exporters/pdfstream.d.ts

@@ -1,16 +1,16 @@
 /**
- * @typedef {{ write(u8: Uint8Array): any, once?: (ev: string, cb: () => void) => any }} Sink
- *   write may return a promise (awaited: back-pressure), or false with a 'drain' event to wait for (a Node Writable).
- * @typedef {{ title: string, page: number, top?: number, level?: number }} OutlineEntry
- *   page: 1-based; top: the destination's y in PDF space (from the bottom), else the page fits the window.
+ * p, or signal's reason as soon as it aborts (p goes on, unwatched).
+ * @template T @param {Promise<T>} p @param {AbortSignal} [signal] @returns {Promise<T>}
  */
+export function raced<T>(p: Promise<T>, signal?: AbortSignal): Promise<T>;
 /**
  * @param {Sink} sink
  * @param {{ fontStore: import('../engine/text/fonts.js').FontStore, fonts?: string[],
  *   subset?: (font: Uint8Array, codePoints: Iterable<number>, opt?: { glyphs?: Iterable<number> }) => Promise<Uint8Array>,
- *   id?: string }} opt
+ *   id?: string, signal?: AbortSignal }} opt
  *   fonts: font keys to name now (F1, F2… in this order); any other font is named on first use.
  *   subset: subset.js's subsetter; without it fonts embed in full. id: the file ID (32 hex digits), else random.
+ *   signal: stops a wait for the sink (back-pressure) when it aborts.
  */
 export function createPdfStream(sink: Sink, opt: {
     fontStore: import("../engine/text/fonts.js").FontStore;
@@ -19,6 +19,7 @@ export function createPdfStream(sink: Sink, opt: {
         glyphs?: Iterable<number>;
     }) => Promise<Uint8Array>;
     id?: string;
+    signal?: AbortSignal;
 }): {
     /** @param {string} key @returns {string} the font's resource name (F1…) */
     fontName: (key: string) => string;
@@ -127,6 +128,9 @@ export function createPdfStream(sink: Sink, opt: {
  * opts: render()'s options and exportPdf's (fontStore, subset, title, author, creationDate, drillBase…). Tagged
  * (PDF/UA-1) and PDF/A files stream too; encrypted and signed files, save options and PDF/A without a colour profile
  * take the whole-model path (the result's why says which).
+ * timeoutMs (or deadline) bounds the whole export, waits for the sink included; signal (an AbortSignal) stops it at its
+ * next wait (a row batch, the sink, a sort, a page). Stopped or failed: it rejects (the signal's reason, an AbortError;
+ * a timeout: status 504, code 'ETIMEDOUT'), the rows' cursors are closed, a sort's temporary files removed.
  * @param {any} def @param {any} opts @param {Sink} sink
  * @returns {Promise<{ streamed: boolean, pages: number, warnings: string[], why?: string }>}
  */
@@ -158,12 +162,13 @@ export function paintPage(pg: any, H: number, env: any): {
 };
 /**
  * What paintPage draws with: a writer's resource names and glyph records (w), the fonts, shaped glyphs' texts.
- * @param {any} w @param {any} fontStore @param {{ drillBase?: string, pageRef?: (i: number) => any, tags?: any }} [o]
+ * @param {any} w @param {any} fontStore @param {{ drillBase?: string, pageRef?: (i: number) => any, tags?: any, embedAll?: boolean }} [o]
  */
 export function paintEnv(w: any, fontStore: any, o?: {
     drillBase?: string;
     pageRef?: (i: number) => any;
     tags?: any;
+    embedAll?: boolean;
 }): {
     shared: {
         font: (f: any) => any;
@@ -180,6 +185,8 @@ export function paintEnv(w: any, fontStore: any, o?: {
     reserve: () => any;
     drillBase: string;
     tags: any;
+    /** PDF/A, PDF/UA: standard fonts drawn in embedded stand-ins; the families that were @type {Set<string>|null} */
+    embedded: Set<string> | null;
 };
 /**
  * write may return a promise (awaited: back-pressure), or false with a 'drain' event to wait for (a Node Writable).

package/dist/types/src/exporters/subset.d.ts

@@ -1,3 +1,17 @@
+/**
+ * The tables of a single-face sfnt (TrueType or CFF) as a Map of tag to bytes. A collection (ttcf) gives an empty map.
+ * @param {Uint8Array} bytes
+ */
+export function sfntTables(bytes: Uint8Array): Map<any, any>;
+/** A sfnt from its tables: directory, 4-byte padding, table checksums and the head checkSumAdjustment. */
+export function buildSfnt(version: any, tables: any): Uint8Array<ArrayBuffer>;
+/**
+ * The name table with the given strings replaced (nameID to text). Each replaced string is written in its record's own
+ * encoding: UTF-16BE for Windows and Unicode, one byte per character for Macintosh.
+ * @param {Uint8Array} name
+ * @param {Map<number, string>} strings
+ */
+export function setNameStrings(name: Uint8Array, strings: Map<number, string>): Uint8Array<ArrayBuffer>;
 /** @param {() => Promise<ArrayBuffer|Uint8Array>} loadWasm */
 export function createSubsetter(loadWasm: () => Promise<ArrayBuffer | Uint8Array>): (font: Uint8Array, codePoints: Iterable<number>, opt?: {
     glyphs?: Iterable<number>;

package/dist/types/src/exporters/xlsxstream.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @param {{ name: string, title: string, columns: number[], timeZone: string|null, locale: string|null, currency: string|null, rows: () => AsyncGenerator<any> }} plan
+ * @param {(bytes: Uint8Array) => any} put the zip's bytes as they come (awaited: back-pressure)
+ * @param {{ currency?: string, title?: string, formulas?: boolean, maxRows?: number, timeZone?: string }} [opt]
+ */
+export function writeXlsxStream(plan: {
+    name: string;
+    title: string;
+    columns: number[];
+    timeZone: string | null;
+    locale: string | null;
+    currency: string | null;
+    rows: () => AsyncGenerator<any>;
+}, put: (bytes: Uint8Array) => any, opt?: {
+    currency?: string;
+    title?: string;
+    formulas?: boolean;
+    maxRows?: number;
+    timeZone?: string;
+}): Promise<void>;
+export const EXCEL_ROWS: 1048576;
+export const EXCEL_COLS: 16384;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reportwright/engine",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "publishConfig": {
     "access": "public"
   },
@@ -57,7 +57,8 @@
     "schema.json",
     "README.md",
     "CHANGELOG.md",
-    "LICENSE"
+    "LICENSE",
+    "THIRD-PARTY-NOTICES.md"
   ],
   "engines": {
     "node": ">=20.9"
@@ -66,12 +67,13 @@
   "dependencies": {
     "pdf-lib": "1.17.1",
     "@pdf-lib/fontkit": "1.1.1",
+    "@pdf-lib/standard-fonts": "1.0.0",
     "bwip-js": "4.11.4",
     "fflate": "0.8.3",
     "bidi-js": "1.0.3"
   },
   "peerDependencies": {
-    "@reportwright/fonts": "0.12.1"
+    "@reportwright/fonts": "0.13.0"
   },
   "peerDependenciesMeta": {
     "@reportwright/fonts": {

package/report.d.ts

@@ -344,6 +344,7 @@ export interface FormField extends ItemBase {
   type: 'field';
   kind?: 'text' | 'multiline' | 'checkbox' | 'choice';
   fieldName?: Expr<string>;
+  label?: Expr<string>;
   value?: Expr;
   options?: Expr;
   required?: boolean;

package/schema.json

@@ -1259,6 +1259,9 @@
             "fieldName": {
               "x-ts": "Expr<string>"
             },
+            "label": {
+              "x-ts": "Expr<string>"
+            },
             "value": {
               "x-ts": "Expr"
             },