@office-open/core 0.8.1 → 0.9.1

package/dist/index-D81RV9Vc.d.mts

@@ -0,0 +1,153 @@
+import { Element } from "@office-open/xml";
+
+//#region src/descriptor/context.d.ts
+/** Context passed during stringify (write path). */
+interface WriteContext {
+  /** Register a relationship and return its rId. */
+  addRelationship(type: string, target: string, mode?: string): string;
+  /** Add a media file and return its reference. */
+  addMedia(data: Uint8Array, type: string): string;
+}
+/** Context passed during parse (parse path). */
+interface ReadContext {
+  /** Resolve a relationship rId to its target path. */
+  resolveRelationship(rId: string): string | undefined;
+  /** Get a parsed XML part by path. */
+  getPart(path: string): Element | undefined;
+  /** Get raw binary data (images, media, etc.) by path. */
+  getRaw(path: string): Uint8Array | undefined;
+}
+//#endregion
+//#region src/descriptor/types.d.ts
+/** Element descriptor — declarative XML mapping. */
+interface ElementDescriptor<T> {
+  readonly kind: "element";
+  readonly tag: string;
+  readonly attrs?: readonly AttrSpec<T>[];
+  readonly content?: readonly ContentSpec<T>[];
+}
+/** Custom descriptor — for complex logic that doesn't fit the declarative model. */
+interface CustomDescriptor<T, Ctx = WriteContext> {
+  readonly kind: "custom";
+  stringify(value: T, ctx: Ctx): string | undefined;
+  parse(el: Element, ctx: ReadContext): T;
+}
+/** Union type for all descriptors. */
+type Descriptor<T> = ElementDescriptor<T> | CustomDescriptor<T>;
+interface AttrSpec<T> {
+  /** Property key in the Options object. */
+  readonly key: keyof T & string;
+  /** XML attribute name (e.g. "w:val"). */
+  readonly xmlName: string;
+  /** Default value — omitted during stringify when equal. */
+  readonly default?: unknown;
+  /** Encode a JS value to an XML attribute string. Return undefined to skip. */
+  readonly encode?: (v: any) => string | undefined;
+  /** Decode an XML attribute string to a JS value. */
+  readonly decode?: (raw: string) => any;
+}
+/** Single child element mapped to a property. */
+interface ChildSpec<T> {
+  readonly kind: "child";
+  readonly key: keyof T & string;
+  readonly tag: string;
+  readonly desc: Descriptor<any>;
+}
+/** Multiple child elements of the same tag mapped to an array property. */
+interface ChildrenSpec<T> {
+  readonly kind: "children";
+  readonly key: keyof T & string;
+  readonly tag: string;
+  readonly desc: Descriptor<any>;
+}
+/** Union child — one of several possible child elements. */
+interface UnionSpec<T> {
+  readonly kind: "union";
+  readonly key: keyof T & string;
+  readonly variants: readonly UnionVariant[];
+}
+/** Text content mapped to a property. */
+interface TextSpec<T> {
+  readonly kind: "text";
+  readonly key: keyof T & string;
+}
+interface UnionVariant {
+  readonly tag: string;
+  readonly match: (opts: any) => boolean;
+  readonly desc: Descriptor<any>;
+}
+/** Discriminated union of all content spec types. */
+type ContentSpec<T> = ChildSpec<T> | ChildrenSpec<T> | UnionSpec<T> | TextSpec<T> | CustomDescriptor<T>;
+//#endregion
+//#region src/descriptor/builder.d.ts
+declare function element$1<T extends object>(tag: string): DescriptorBuilder<T>;
+declare class DescriptorBuilder<T extends object> {
+  private readonly _tag;
+  private readonly _attrs;
+  private readonly _content;
+  constructor(tag: string);
+  /** Add an attribute mapping. */
+  attr(key: keyof T & string, xmlName: string, opts?: {
+    readonly default?: unknown;
+    readonly encode?: (v: any) => string | undefined;
+    readonly decode?: (raw: string) => any;
+  }): this;
+  /** Add a single child element mapping. */
+  child(key: keyof T & string, tag: string, desc: ChildSpec<T>["desc"]): this;
+  /** Add a repeating child element mapping. */
+  children(key: keyof T & string, tag: string, desc: ChildrenSpec<T>["desc"]): this;
+  /** Add a union (one-of-several) child mapping. */
+  union(key: keyof T & string, variants: readonly UnionVariant[]): this;
+  /** Add a text content mapping. */
+  text(key: keyof T & string): this;
+  /** Add a custom content handler. */
+  custom(spec: CustomDescriptor<T>): this;
+  /** Build the immutable ElementDescriptor. */
+  build(): ElementDescriptor<T>;
+}
+//#endregion
+//#region src/descriptor/runtime.d.ts
+/**
+ * Serialize an Options object to an XML string using its descriptor.
+ * Returns `undefined` when an optional element should be omitted.
+ */
+declare function stringify<T>(desc: Descriptor<T>, value: T, ctx: WriteContext): string | undefined;
+/**
+ * Parse an XML Element into an Options object using its descriptor.
+ */
+declare function parse<T>(desc: Descriptor<T>, el: Element, ctx: ReadContext): T;
+//#endregion
+//#region src/descriptor/helpers.d.ts
+/**
+ * OOXML-specific encode/decode helpers for descriptors.
+ *
+ * XML traversal helpers (findChild, etc.) are in @office-open/xml utils.
+ * This file only contains OOXML value encoding/decoding.
+ *
+ * @module
+ */
+/** Encode boolean for CT_OnOff: true → omit val, false → "0". */
+declare const boolEncode: (v: boolean | undefined) => string | undefined;
+/** Decode CT_OnOff: absent or "true"/"1" → true, "0"/"false" → false. */
+declare const boolDecode: (raw: string) => boolean;
+/** Create an enum encoder from a JS↔XML mapping. */
+declare const enumEncode: (map: Record<string, string>) => (v: string | undefined) => string | undefined;
+/** Create an enum decoder from a JS↔XML mapping (inverted). */
+declare const enumDecode: (map: Record<string, string>) => (raw: string) => string;
+//#endregion
+//#region src/descriptor/registry.d.ts
+declare class DescriptorRegistry {
+  private static readonly _map;
+  /** Register a descriptor with its XML tag. */
+  static register(tag: string, desc: Descriptor<any>): void;
+  /** Look up a descriptor by XML tag. */
+  static get(tag: string): Descriptor<any> | undefined;
+  /** Get all registered tags. */
+  static tags(): ReadonlySet<string>;
+  /** Check if a tag is registered. */
+  static has(tag: string): boolean;
+  /** Get the number of registered descriptors. */
+  static get size(): number;
+}
+//#endregion
+export { TextSpec as _, enumEncode as a, ReadContext as b, DescriptorBuilder as c, ChildSpec as d, ChildrenSpec as f, ElementDescriptor as g, Descriptor as h, enumDecode as i, element$1 as l, CustomDescriptor as m, boolDecode as n, parse as o, ContentSpec as p, boolEncode as r, stringify as s, DescriptorRegistry as t, AttrSpec as u, UnionSpec as v, WriteContext as x, UnionVariant as y };

package/dist/{index-BCUfgp9A.d.mts → index-DmPBJwSk.d.mts}

@@ -51,7 +51,7 @@ interface ElementWrapper {
 }
 interface RenderedParagraphNode {
   readonly text: string;
-  readonly runs: readonly IRenderedRunNode[];
+  readonly runs: readonly RenderedRunNode[];
   readonly index: number;
   readonly pathToParagraph: readonly number[];
 }
@@ -63,7 +63,7 @@ type IParts = {
   readonly text: string;
   readonly index: number;
 } & StartAndEnd;
-type IRenderedRunNode = {
+type RenderedRunNode = {
   readonly text: string;
   readonly parts: readonly IParts[];
   readonly index: number;

package/dist/{index-D0N5Bw2M.d.mts → index-eu1aFQCm.d.mts}

@@ -1,5 +1,3 @@
-import { b as XmlComponent } from "./index-CoTp4wVf.mjs";
-
 //#region src/smartart/categories.d.ts
 /** Layout ID → OOXML category type */
 declare const LAYOUT_CATEGORIES: Record<string, string>;
@@ -30,19 +28,30 @@ declare const DEFAULT_DRAWING_XML: string;
 //#endregion
 //#region src/smartart/data-model/connection.d.ts
 /**
- * dgm:cxn — SmartArt data model connection (edge).
+ * dgm:cxn — SmartArt data model connection (edge) XML stringifier.
  */
-declare class Connection extends XmlComponent {
-  constructor(modelId: string, srcId: string, destId: string, type?: string, srcOrd?: number, destOrd?: number, parTransId?: string, sibTransId?: string, presId?: string);
-}
+declare function stringifyConnection(opts: {
+  modelId: string | number;
+  srcId: string | number;
+  destId: string | number;
+  type?: string;
+  srcOrd?: number;
+  destOrd?: number;
+  parTransId?: string;
+  sibTransId?: string;
+  presId?: string;
+}): string;
 //#endregion
 //#region src/smartart/data-model/data-model.d.ts
 /**
- * CT_DataModel — the complete data model for a SmartArt diagram.
+ * CT_DataModel XML stringifier — assembles complete SmartArt data model XML.
+ *
+ * @module
  */
-declare class DataModel extends XmlComponent {
-  constructor(points: readonly XmlComponent[], connections: readonly Connection[]);
-}
+/**
+ * Build the complete dgm:dataModel XML from pre-serialized point and connection strings.
+ */
+declare function stringifyDataModel(points: readonly string[], connections: readonly string[]): string;
 //#endregion
 //#region src/smartart/data-model/point.d.ts
 interface PointPropertySetOptions {
@@ -82,34 +91,35 @@ interface PointPropertySetOptions {
   readonly colorStyleCategoryId?: string;
 }
 /**
- * dgm:pt — SmartArt data model point (node).
+ * dgm:pt — SmartArt data model point (node) XML stringifier.
  */
-declare class Point extends XmlComponent {
-  constructor(modelId: string, text: string, type?: string, propertySet?: PointPropertySetOptions);
-}
+declare function stringifyPoint(modelId: string | number, text: string, type?: string, propertySet?: PointPropertySetOptions): string;
 /**
- * Transition point (parTrans or sibTrans) — no text body, references a connection.
+ * dgm:pt — transition point (parTrans or sibTrans) XML stringifier.
  */
-declare class TransPoint extends XmlComponent {
-  constructor(modelId: string, type: string, cxnId: string);
-}
+declare function stringifyTransPoint(modelId: string, type: string, cxnId: string): string;
 //#endregion
 //#region src/smartart/smartart-collection.d.ts
+/**
+ * SmartArt data and collection for document generation.
+ *
+ * @module
+ */
 interface SmartArtData {
-  readonly key: string;
-  readonly dataModel: DataModel;
-  readonly layout: string;
-  readonly style: string;
-  readonly color: string;
+  key: string;
+  dataModelXml: string;
+  layout: string;
+  style: string;
+  color: string;
 }
 /**
  * Manages SmartArt parts in a document.
  */
 declare class SmartArtCollection {
-  private readonly map;
+  private map;
   constructor();
   addSmartArt(key: string, data: SmartArtData): void;
-  get array(): readonly SmartArtData[];
+  get array(): SmartArtData[];
 }
 //#endregion
 //#region src/smartart/tree-to-model.d.ts
@@ -118,8 +128,9 @@ interface TreeNode {
   readonly children?: readonly TreeNode[];
 }
 /**
- * Creates a DataModel from tree nodes with layout/style/color settings.
+ * Creates SmartArt data model XML from tree nodes with layout/style/color settings.
+ * Returns the XML string body (no XML declaration).
  */
-declare const createDataModel: (nodes: readonly TreeNode[], layout?: string, style?: string, color?: string) => DataModel;
+declare const createDataModel: (nodes: readonly TreeNode[], layout?: string, style?: string, color?: string) => string;
 //#endregion
-export { Point as a, DataModel as c, getColorXml as d, getLayoutXml as f, STYLE_CATEGORIES as g, LAYOUT_CATEGORIES as h, SmartArtData as i, Connection as l, COLOR_CATEGORIES as m, createDataModel as n, PointPropertySetOptions as o, getStyleXml as p, SmartArtCollection as r, TransPoint as s, TreeNode as t, DEFAULT_DRAWING_XML as u };
+export { PointPropertySetOptions as a, stringifyDataModel as c, getColorXml as d, getLayoutXml as f, STYLE_CATEGORIES as g, LAYOUT_CATEGORIES as h, SmartArtData as i, stringifyConnection as l, COLOR_CATEGORIES as m, createDataModel as n, stringifyPoint as o, getStyleXml as p, SmartArtCollection as r, stringifyTransPoint as s, TreeNode as t, DEFAULT_DRAWING_XML as u };

package/dist/index-xXbaecaB.d.mts

@@ -0,0 +1,137 @@
+import { m as CustomDescriptor } from "./index-D81RV9Vc.mjs";
+
+//#region src/chart/chart-collection.d.ts
+/**
+ * Chart data and collection for document generation.
+ *
+ * @module
+ */
+interface ChartData {
+  key: string;
+  chartSpaceXml: string;
+}
+declare class ChartCollection {
+  private map;
+  constructor();
+  addChart(key: string, chartData: ChartData): void;
+  get array(): ChartData[];
+}
+//#endregion
+//#region src/chart/types.d.ts
+/**
+ * Chart type definitions — interfaces and constants.
+ *
+ * Class implementations have been removed; all chart XML generation
+ * goes through chart-descriptors.ts (stringify/parse path).
+ *
+ * @module
+ */
+interface BubbleSeriesData {
+  readonly name: string;
+  readonly xValues: readonly number[];
+  readonly yValues: readonly number[];
+  readonly bubbleSize: readonly number[];
+}
+declare const TrendlineType: {
+  readonly EXP: "exp";
+  readonly LINEAR: "linear";
+  readonly LOG: "log";
+  readonly MOVING_AVG: "movingAvg";
+  readonly POLY: "poly";
+  readonly POWER: "power";
+};
+type TrendlineType = (typeof TrendlineType)[keyof typeof TrendlineType];
+interface TrendlineOptions {
+  readonly type?: TrendlineType;
+  readonly name?: string;
+  readonly order?: number;
+  readonly period?: number;
+  readonly forward?: number;
+  readonly backward?: number;
+  readonly intercept?: number;
+  readonly dispRSqr?: boolean;
+  readonly dispEq?: boolean;
+}
+declare const ErrorBarDirection: {
+  readonly BOTH: "both";
+  readonly X: "x";
+  readonly Y: "y";
+};
+type ErrorBarDirection = (typeof ErrorBarDirection)[keyof typeof ErrorBarDirection];
+declare const ErrorBarType: {
+  readonly BOTH: "both";
+  readonly MINUS: "minus";
+  readonly PLUS: "plus";
+};
+type ErrorBarType = (typeof ErrorBarType)[keyof typeof ErrorBarType];
+declare const ErrorValueType: {
+  readonly CUST: "cust";
+  readonly FIXED: "fixedVal";
+  readonly PERCENTAGE: "percentage";
+  readonly STD_DEV: "stdDev";
+  readonly STD_ERR: "stdErr";
+};
+type ErrorValueType = (typeof ErrorValueType)[keyof typeof ErrorValueType];
+interface ErrorBarOptions {
+  readonly direction?: ErrorBarDirection;
+  readonly barType?: ErrorBarType;
+  readonly valueType?: ErrorValueType;
+  readonly value?: number;
+}
+declare const DataLabelPosition: {
+  readonly BEST_FIT: "bestFit";
+  readonly B: "b";
+  readonly CTRL: "ctr";
+  readonly IN_BASE: "inBase";
+  readonly IN_END: "inEnd";
+  readonly L: "l";
+  readonly OUT_END: "outEnd";
+  readonly R: "r";
+  readonly T: "t";
+};
+type DataLabelPosition = (typeof DataLabelPosition)[keyof typeof DataLabelPosition];
+interface DataLabelsOptions {
+  readonly position?: DataLabelPosition;
+  readonly showVal?: boolean;
+  readonly showCatName?: boolean;
+  readonly showSerName?: boolean;
+  readonly showPercent?: boolean;
+  readonly showBubbleSize?: boolean;
+  readonly showLeaderLines?: boolean;
+}
+interface ChartSeriesData {
+  readonly name: string;
+  readonly values: readonly number[];
+  readonly trendlines?: readonly TrendlineOptions[];
+  readonly errorBars?: ErrorBarOptions;
+  readonly dataLabels?: DataLabelsOptions;
+}
+type ChartType = "column" | "bar" | "line" | "pie" | "area" | "scatter" | "bubble" | "doughnut" | "radar" | "stock" | "surface";
+type AxisChartType = Exclude<ChartType, "bubble">;
+interface ChartSpaceOptions {
+  readonly title?: string;
+  readonly type: ChartType;
+  readonly categories?: readonly string[];
+  readonly series: readonly ChartSeriesData[] | readonly BubbleSeriesData[];
+  readonly showLegend?: boolean;
+  readonly style?: number;
+  readonly threeD?: boolean;
+}
+declare const TimeUnit: {
+  readonly DAYS: "days";
+  readonly MONTHS: "months";
+  readonly YEARS: "years";
+};
+type TimeUnit = (typeof TimeUnit)[keyof typeof TimeUnit];
+interface View3DOptions {
+  readonly rotX?: number;
+  readonly rotY?: number;
+  readonly depthPercent?: number;
+  readonly rAngAx?: boolean;
+  readonly perspective?: number;
+}
+//#endregion
+//#region src/chart/chart-descriptors.d.ts
+declare const chartSpaceDesc: CustomDescriptor<ChartSpaceOptions>;
+//#endregion
+export { ChartCollection as _, ChartSpaceOptions as a, DataLabelsOptions as c, ErrorBarType as d, ErrorValueType as f, View3DOptions as g, TrendlineType as h, ChartSeriesData as i, ErrorBarDirection as l, TrendlineOptions as m, AxisChartType as n, ChartType as o, TimeUnit as p, BubbleSeriesData as r, DataLabelPosition as s, chartSpaceDesc as t, ErrorBarOptions as u, ChartData as v };