@office-open/core 0.10.11 → 0.10.13

package/dist/index-CpNwAcem.d.mts

@@ -1,169 +0,0 @@
-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
-/**
- * Custom descriptor — hand-written stringify/parse for an OOXML part.
- *
- * `TInput` is the stringify input (the options shape callers build); `TOutput`
- * is the parse output (the shape parse produces). They default to the same
- * type, so the common case — a descriptor whose stringify and parse share one
- * options shape — is written as `CustomDescriptor<T>` unchanged. Only
- * descriptors whose parse yields a genuinely different shape (e.g. an
- * accumulator-based stringify vs. a structured parse result) pass a third
- * argument, which lets parse return its real type instead of lying via `as`.
- *
- * `Ctx` stays the second parameter to preserve the existing
- * `CustomDescriptor<T, BodyContext>` call sites that customize the write
- * context; `TOutput` is third so it never collides with that two-arg form.
- */
-interface CustomDescriptor<TInput, Ctx = WriteContext, TOutput = TInput> {
-  kind: "custom";
-  stringify(value: TInput, ctx: Ctx): string | undefined;
-  parse(el: Element, ctx: ReadContext): TOutput;
-}
-/** Alias for "any descriptor" — retained for call-site readability. */
-type Descriptor<TInput, Ctx = WriteContext, TOutput = TInput> = CustomDescriptor<TInput, Ctx, TOutput>;
-//#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$1<TInput, Ctx = WriteContext, TOutput = TInput>(desc: CustomDescriptor<TInput, Ctx, TOutput>, value: TInput, ctx: Ctx): string | undefined;
-/** Parse an XML Element into an Options object using its descriptor. */
-declare function parse$1<TInput, TOutput = TInput, Ctx = WriteContext>(desc: CustomDescriptor<TInput, Ctx, TOutput>, el: Element, ctx: ReadContext): TOutput;
-//#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/field-spec.d.ts
-/**
- * Declarative field-consistency spec for descriptors.
- *
- * The `CustomDescriptor<T>` closure carries no field metadata, so the three
- * places that must agree — the Options interface, the stringify body, and the
- * parse body — drift silently (reflection dropping 9/14 props, styles
- * round-trip loss, core-properties 8-interface/10-write/8-parse inflation).
- *
- * Each entry declares the three field sets in a single semantic dimension
- * (Options field names, not XML tags), so {@link diffTagSets} can surface the
- * asymmetries directly:
- *   - F1 write-loss  — declared on the interface but never written
- *   - F2 write-only  — written but absent from the interface (inflation)
- *   - F3 parse-loss  — written but never restored on parse (round-trip loss)
- *   - F5 parse-only  — restored but never written
- *
- * @module
- */
-interface DescriptorFieldSpec {
-  /** Stable identifier, matched to the descriptor under test. */
-  id: string;
-  /** Options interface name (documentation / assertion messages). */
-  optionsInterface: string;
-  /** Fields declared on the Options interface — the contract. */
-  interfaceFields: readonly string[];
-  /** Fields the stringify path actually emits; may carry inflation not on the interface. */
-  writeFields: readonly string[];
-  /** Fields the parse path actually restores. */
-  parseFields: readonly string[];
-  /** Expected child order when the XSD mandates sequence; omitted when order-independent. */
-  order?: readonly string[];
-  /** Sample exercising the interface fields, for F4 round-trip deep-equality. */
-  sampleOptions: unknown;
-  /**
-   * Interface fields excluded from the contract comparison — input-side sugar
-   * (thematicBreak→border, rightTabStop→tabStops) and control flags
-   * (includeIfEmpty) that map field→XML but XML→a different field, breaking the
-   * 1:1 round-trip assumption. The interface-drift test asserts
-   * `interfaceFields === (live interface fields − excludeFields)`.
-   */
-  excludeFields?: readonly string[];
-  notes?: string;
-}
-/**
- * Curated high-value targets — each maps to a known historical drift.
- * `settings` is intentionally absent: its round-trip is rawXml-based (byte
- * passthrough), so field-level diff would mislabel every field as F2.
- */
-declare const FIELD_SPECS: readonly DescriptorFieldSpec[];
-declare function findFieldSpec(id: string): DescriptorFieldSpec | undefined;
-//#endregion
-//#region src/descriptor/field-consistency.d.ts
-interface FieldConsistencyReport {
-  /** F1 — declared on the interface but never written (write-loss). */
-  f1WriteLoss: readonly string[];
-  /** F2 — written but absent from the interface (write-only inflation). */
-  f2WriteOnly: readonly string[];
-  /** F3 — written but never restored on parse (round-trip loss). */
-  f3ParseLoss: readonly string[];
-  /** F5 — restored on parse but never written (parse-only). */
-  f5ParseOnly: readonly string[];
-}
-/** Diff the interface / write / parse field sets declared on a spec. */
-declare function diffTagSets(spec: DescriptorFieldSpec): FieldConsistencyReport;
-interface RoundTripResult {
-  /** Present in the sample, absent after round-trip. */
-  lost: readonly string[];
-  /** Absent from the sample, present after round-trip. */
-  gained: readonly string[];
-  /** Present on both sides with differing values. */
-  mutated: readonly string[];
-}
-/**
- * Run a stringify→parse cycle over a sample and diff the result field set.
- * Returns the F4 round-trip drift. The caller supplies the descriptor's own
- * stringify/parse (a `CustomDescriptor` pair or a function pair).
- */
-declare function roundTripFields<T extends object, WC = unknown, RC = unknown>(stringifyFn: (opts: T, ctx: WC) => string | undefined, parseFn: (el: Element, ctx: RC) => T, sample: T, writeCtx: WC, readCtx: RC): RoundTripResult;
-interface OrderViolation {
-  /** Position of the offending child within its parent. */
-  index: number;
-  /** Local name of the child element (namespace prefix stripped). */
-  tag: string;
-  /** Why the child violates the expected sequence. */
-  reason: "unexpected" | "out-of-order";
-}
-/**
- * Verify the child element order of a stringified container against an XSD
- * sequence — the F6 check. Namespace prefixes are normalized, so `expected`
- * entries may be qualified (`w:pStyle`) or local (`pStyle`); both match a
- * `<w:pStyle>` child. Elements absent from `expected` are flagged "unexpected";
- * a child whose expected position precedes the previous child's is
- * "out-of-order".
- */
-declare function checkOrder(xml: string, expected: readonly string[]): readonly OrderViolation[];
-//#endregion
-export { Descriptor as _, diffTagSets as a, FIELD_SPECS as c, boolEncode as d, enumDecode as f, CustomDescriptor as g, stringify$1 as h, checkOrder as i, findFieldSpec as l, parse$1 as m, OrderViolation as n, roundTripFields as o, enumEncode as p, RoundTripResult as r, DescriptorFieldSpec as s, FieldConsistencyReport as t, boolDecode as u, ReadContext as v, WriteContext as y };