@json-to-office/core-docx 1.0.0 → 1.3.0

package/dist/renderers/docxjs/emit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/renderers/docxjs/emit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,aAAa,EAgBb,SAAS,EAMT,KAAK,EAIL,eAAe,EAQf,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAEhB,KAAK,cAAc,EACpB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EACV,WAAW,EAEX,cAAc,EAEd,cAAc,EACd,YAAY,EACZ,eAAe,EACf,yBAAyB,EAGzB,mBAAmB,EAEnB,WAAW,EAKZ,MAAM,gBAAgB,CAAC;AAExB,eAAO,MAAM,SAAS,EAAE,QAAQ,CAC9B,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC,CAQnE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEjE,+EAA+E;AAC/E,MAAM,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,CAAC;AAmBxE,wBAAgB,UAAU,CACxB,UAAU,EAAE,mBAAmB,GAAG,SAAS,GAC1C,WAAW,CA2Bb;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,SAAS,GAAE,aAAyB,GACnC,cAAc,EAAE,CAoJlB;AAyDD,gDAAgD;AAChD,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,cAAc,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAwEzB;AA4CD,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,yBAAyB,GAAG,SAAS,GAChD,OAAO,CAAC,iBAAiB,CAAC,CAyD5B;AAED,wBAAgB,aAAa,CAC3B,KAAK,EAAE,eAAe,EACtB,SAAS,GAAE,aAAyB,GACnC,SAAS,CAsBX;AAqCD,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,SAAS,GAAE,aAAyB,GACnC,SAAS,GAAG,KAAK,GAAG,eAAe,CAWrC;AAyDD,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,SAAS,GAAE,aAAyB,GACnC,KAAK,CA8BP"}
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/renderers/docxjs/emit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EACL,aAAa,EAgBb,SAAS,EAMT,KAAK,EAIL,eAAe,EAQf,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAEhB,KAAK,cAAc,EACpB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EACV,WAAW,EAEX,cAAc,EAEd,cAAc,EACd,YAAY,EACZ,eAAe,EACf,yBAAyB,EAGzB,mBAAmB,EAEnB,WAAW,EAKZ,MAAM,gBAAgB,CAAC;AAExB,eAAO,MAAM,SAAS,EAAE,QAAQ,CAC9B,MAAM,CAAC,MAAM,EAAE,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,OAAO,aAAa,CAAC,CAAC,CAQnE,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAEjE,+EAA+E;AAC/E,MAAM,MAAM,eAAe,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,cAAc,CAAC;AAmBxE,wBAAgB,UAAU,CACxB,UAAU,EAAE,mBAAmB,GAAG,SAAS,GAC1C,WAAW,CA2Bb;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,SAAS,GAAE,aAAyB,GACnC,cAAc,EAAE,CAqKlB;AAyDD,gDAAgD;AAChD,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,cAAc,GACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAwEzB;AA4CD,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,yBAAyB,GAAG,SAAS,GAChD,OAAO,CAAC,iBAAiB,CAAC,CAyD5B;AAED,wBAAgB,aAAa,CAC3B,KAAK,EAAE,eAAe,EACtB,SAAS,GAAE,aAAyB,GACnC,SAAS,CAsBX;AAqCD,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,SAAS,GAAE,aAAyB,GACnC,SAAS,GAAG,KAAK,GAAG,eAAe,CAWrC;AAyDD,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,SAAS,GAAE,aAAyB,GACnC,KAAK,CA8BP"}

package/dist/renderers/docxjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/renderers/docxjs/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAIL,QAAQ,EAUT,MAAM,MAAM,CAAC;AAGd,OAAO,KAAK,EACV,MAAM,EAOP,MAAM,gBAAgB,CAAC;AAOxB,OAAO,KAAK,EAAqB,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAChF,OAAO,EAKL,KAAK,aAAa,EAEnB,MAAM,QAAQ,CAAC;AAGhB,eAAO,MAAM,kBAAkB,EAAE,cAAyB,CAAC;AAoB3D,wBAAgB,oBAAoB,IAAI,YAAY,CA0BnD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,EAAE,EAAE,MAAM,EACV,SAAS,GAAE,aAAyB,GACnC,QAAQ,CA2CV"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/renderers/docxjs/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAIL,QAAQ,EAUT,MAAM,MAAM,CAAC;AAGd,OAAO,KAAK,EACV,MAAM,EAOP,MAAM,gBAAgB,CAAC;AAOxB,OAAO,KAAK,EAAqB,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAChF,OAAO,EAKL,KAAK,aAAa,EAEnB,MAAM,QAAQ,CAAC;AAGhB,eAAO,MAAM,kBAAkB,EAAE,cAAyB,CAAC;AA6B3D,wBAAgB,oBAAoB,IAAI,YAAY,CA0BnD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,EAAE,EAAE,MAAM,EACV,SAAS,GAAE,aAAyB,GACnC,QAAQ,CA2CV"}

package/dist/renderers/office-open/chartParts.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Packaging a native chart's missing half, for DOCX.
+ *
+ * The repairs themselves — the cell references that fill an empty `<c:f/>`, the
+ * series colours, the axis titles, the legend position and `c:externalData` —
+ * are format-neutral and live in `chart-parts` in
+ * `@json-to-office/shared/rendering`, which explains why a chart emitted by
+ * `@office-open` needs repairing at all. A `c:chartSpace` is DrawingML: the
+ * pptx sibling of this file makes exactly the same edits.
+ *
+ * What is here is only what a Word package spells its own way — `word/charts`,
+ * `word/embeddings`, the chart's rels part, the content-type override — plus
+ * adm-zip, which is this core's archive library.
+ */
+import type AdmZip from 'adm-zip';
+import type { DocxIrChartRun } from '../../ir/types';
+/**
+ * Give every chart in the package its workbook, colours and axis titles.
+ *
+ * Parts are matched to IR nodes by content rather than by position: the emitter
+ * fills its array while *building* the backend's document object and the
+ * backend numbers its parts while *stringifying* that object, and the two walks
+ * disagree the moment a chart sits in a header or footer. Pairing by position
+ * handed charts another chart's workbook, so a recipient choosing "Edit Data"
+ * saw a different chart's numbers.
+ */
+export declare function spliceChartParts(zip: AdmZip, charts: readonly DocxIrChartRun[]): void;
+//# sourceMappingURL=chartParts.d.ts.map

package/dist/renderers/office-open/chartParts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chartParts.d.ts","sourceRoot":"","sources":["../../../src/renderers/office-open/chartParts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAQlC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AA2CrD;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,SAAS,cAAc,EAAE,GAChC,IAAI,CAkCN"}

package/dist/renderers/office-open/emit.d.ts

@@ -12,17 +12,49 @@
  * anything this module cannot express has already been rejected before it is
  * called. Reaching a `throw` here is a bug, not a user error.
  */
-import type { DocxIrBlock, DocxIrFloating, DocxIrImageRun, DocxIrInline, DocxIrNumbering, DocxIrParagraph, DocxIrParagraphFormatting, DocxIrRunFormatting, DocxIrSection, DocxIrTable } from '../../ir/types';
+/// <reference types="node" />
+import type { DocxIrBlock, DocxIrChartRun, DocxIrFloating, DocxIrInline, DocxIrNumbering, DocxIrParagraph, DocxIrParagraphFormatting, DocxIrRunFormatting, DocxIrSection, DocxIrTable } from '../../ir/types';
 import { emuToPixels } from '../../ir/units';
 type Opts = Record<string, unknown>;
 /**
- * One prepared picture per placement.
+ * One prepared image per placement size.
  *
  * A vector image needs a rasterised fallback sized to the placement, and
  * producing it is asynchronous while this layer is not — so the renderer builds
- * the pictures first and this only places them.
+ * the media first and this only places it.
+ *
+ * Media rather than a whole picture because the same bytes are placed two
+ * different ways: a run-level `picture` states its size as a plain
+ * `MediaTransformation`, while a group child states an already-resolved
+ * `MediaDataTransformation` with an offset inside the group. Sharing the
+ * factory is what keeps a resource embedded once however it is drawn.
  */
-export type ImagePictureFactory = (image: DocxIrImageRun, drawingId: number) => Opts;
+export interface PreparedImage {
+    /** `png`, `jpg`, `svg`, … — the backend's media type tag. */
+    type: string;
+    data: Buffer;
+    /** The raster Word draws when it cannot draw the vector. */
+    fallback?: {
+        type: string;
+        data: Buffer;
+    };
+    /**
+     * The media part name these bytes are stored under.
+     *
+     * A run-level picture lets the backend allocate one. A *group child* cannot:
+     * the backend registers grouped media with a factory that ignores the name
+     * it is offered, so an unnamed child ends up referencing `{undefined}` and
+     * the package ships a part called `media/undefined`. Deriving the name from
+     * the resource and its drawn size keeps it deterministic and keeps two
+     * identical placements sharing one part.
+     */
+    fileName: string;
+    fallbackFileName?: string;
+}
+export type ImageMediaFactory = (placement: {
+    widthEmu: number;
+    heightEmu: number;
+}) => PreparedImage;
 /**
  * What emitting a document needs beyond the IR itself.
  *
@@ -34,10 +66,19 @@ export type ImagePictureFactory = (image: DocxIrImageRun, drawingId: number) =>
  * is deterministic and cannot leak between documents.
  */
 export interface EmitContext {
-    /** Prepared pictures, keyed by IR resource id. */
-    pictures: ReadonlyMap<string, ImagePictureFactory>;
+    /** Prepared image media, keyed by IR resource id. */
+    pictures: ReadonlyMap<string, ImageMediaFactory>;
     /** Allocate the next `wp:docPr` id for this document. */
     nextDrawingId: () => number;
+    /**
+     * Charts, in the order they were emitted.
+     *
+     * The backend numbers `word/charts/chartN.xml` by the order it stringifies
+     * chart runs, which is document order — the same order this array fills. The
+     * post-generation splice reads it to match each part with the data the
+     * backend dropped.
+     */
+    charts?: DocxIrChartRun[];
 }
 /** A context for content that holds no drawings, and for tests. */
 export declare function emptyContext(): EmitContext;

package/dist/renderers/office-open/emit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/renderers/office-open/emit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,KAAK,EACV,WAAW,EAGX,cAAc,EAGd,cAAc,EACd,YAAY,EACZ,eAAe,EACf,eAAe,EACf,yBAAyB,EAGzB,mBAAmB,EACnB,aAAa,EAGb,WAAW,EAKZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,WAAW,EAAe,MAAM,gBAAgB,CAAC;AAE1D,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpC;;;;;;GAMG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,MAAM,KACd,IAAI,CAAC;AAEV;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,kDAAkD;IAClD,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACnD,yDAAyD;IACzD,aAAa,EAAE,MAAM,MAAM,CAAC;CAC7B;AAED,mEAAmE;AACnE,wBAAgB,YAAY,IAAI,WAAW,CAG1C;AAsBD,wBAAgB,aAAa,CAC3B,UAAU,EAAE,mBAAmB,GAAG,SAAS,GAC1C,IAAI,CAwCN;AAUD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,GAAG,GAAE,WAA4B,GAChC,IAAI,EAAE,CA0HR;AA8CD,sDAAsD;AACtD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAsD9D;AA8DD,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,yBAAyB,GAAG,SAAS,GAChD,IAAI,CAgEN;AAOD,wBAAgB,SAAS,CACvB,KAAK,EAAE,eAAe,EACtB,GAAG,GAAE,WAA4B,GAChC,IAAI,CAsBN;AA+CD,iFAAiF;AACjF,wBAAgB,KAAK,CACnB,KAAK,EAAE,WAAW,EAClB,GAAG,GAAE,WAA4B,GAChC,IAAI,CAWN;AA4ED,wBAAgB,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,GAAG,IAAI,CAuBhE;AA0HD,wBAAgB,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,WAAW,GAAG,IAAI,CA0FpE;AA4CD,wBAAgB,eAAe,CAAC,SAAS,EAAE,eAAe,GAAG,IAAI,CAgChE;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/renderers/office-open/emit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;;AAGH,OAAO,KAAK,EACV,WAAW,EAMX,cAAc,EAGd,cAAc,EAId,YAAY,EACZ,eAAe,EACf,eAAe,EACf,yBAAyB,EAGzB,mBAAmB,EACnB,aAAa,EAGb,WAAW,EAKZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,WAAW,EAAe,MAAM,gBAAgB,CAAC;AAE1D,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEpC;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,aAAa;IAC5B,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,QAAQ,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1C;;;;;;;;;OASG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,SAAS,EAAE;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB,KAAK,aAAa,CAAC;AAEpB;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,qDAAqD;IACrD,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACjD,yDAAyD;IACzD,aAAa,EAAE,MAAM,MAAM,CAAC;IAC5B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,mEAAmE;AACnE,wBAAgB,YAAY,IAAI,WAAW,CAG1C;AAsBD,wBAAgB,aAAa,CAC3B,UAAU,EAAE,mBAAmB,GAAG,SAAS,GAC1C,IAAI,CAwCN;AAUD;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,GAAG,GAAE,WAA4B,GAChC,IAAI,EAAE,CAgIR;AA8CD,sDAAsD;AACtD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAsD9D;AA8TD,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,yBAAyB,GAAG,SAAS,GAChD,IAAI,CAgEN;AAOD,wBAAgB,SAAS,CACvB,KAAK,EAAE,eAAe,EACtB,GAAG,GAAE,WAA4B,GAChC,IAAI,CAsBN;AA+CD,iFAAiF;AACjF,wBAAgB,KAAK,CACnB,KAAK,EAAE,WAAW,EAClB,GAAG,GAAE,WAA4B,GAChC,IAAI,CAWN;AA4ED,wBAAgB,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,GAAG,IAAI,CAuBhE;AA0HD,wBAAgB,OAAO,CAAC,KAAK,EAAE,aAAa,EAAE,GAAG,EAAE,WAAW,GAAG,IAAI,CA0FpE;AA4CD,wBAAgB,eAAe,CAAC,SAAS,EAAE,eAAe,GAAG,IAAI,CAgChE;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/renderers/office-open/index.d.ts

@@ -11,7 +11,7 @@
  * the pipeline reject the document before any bytes exist, instead of shipping
  * a file with content quietly missing.
  */
-import type { DocxIR } from '../../ir/types';
+import type { DocxIR, DocxIrChartRun } from '../../ir/types';
 import type { DocxRenderer, DocxRendererId } from '../types';
 export declare const OFFICE_OPEN_DOCX_RENDERER_ID: DocxRendererId;
 export declare function createOfficeOpenDocxRenderer(): Promise<DocxRenderer>;
@@ -21,5 +21,5 @@ export declare function createOfficeOpenDocxRenderer(): Promise<DocxRenderer>;
  * Exported for tests: asserting on this object is far cheaper, and far more
  * legible, than unzipping a package.
  */
-export declare function buildDocumentOptions(ir: DocxIR): Promise<Record<string, unknown>>;
+export declare function buildDocumentOptions(ir: DocxIR, charts?: DocxIrChartRun[]): Promise<Record<string, unknown>>;
 //# sourceMappingURL=index.d.ts.map

package/dist/renderers/office-open/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/renderers/office-open/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,KAAK,EACV,MAAM,EAIP,MAAM,gBAAgB,CAAC;AAMxB,OAAO,KAAK,EAAqB,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAYhF,eAAO,MAAM,4BAA4B,EAAE,cAA8B,CAAC;AAwC1E,wBAAsB,4BAA4B,IAAI,OAAO,CAAC,YAAY,CAAC,CA0C1E;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,EAAE,EAAE,MAAM,GACT,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA2ClC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/renderers/office-open/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,KAAK,EACV,MAAM,EAEN,cAAc,EAGf,MAAM,gBAAgB,CAAC;AAOxB,OAAO,KAAK,EAAqB,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAWhF,eAAO,MAAM,4BAA4B,EAAE,cAA8B,CAAC;AAwC1E,wBAAsB,4BAA4B,IAAI,OAAO,CAAC,YAAY,CAAC,CAqD1E;AAED;;;;;GAKG;AACH,wBAAsB,oBAAoB,CACxC,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,cAAc,EAAO,GAC5B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CA4ClC"}