@sheetxl/sdk 0.8.0-beta.1 → 0.8.0-beta.10

package/types/src/text/TextBoxAlignment.d.ts

@@ -1,5 +1,5 @@
 import { ITextFrame } from './ITextFrame';
-import { IStyle } from '../style';
+import { ICellStyle } from '../style';
 /**
  * Provided options for aligned text within a bounding box.
  */
@@ -13,7 +13,7 @@ export interface ITextBoxAlignment {
      *
      * @param horizontal The horizontal alignment
      */
-    setHorizontal(horizontal: ITextFrame.HorizontalAlignment | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setHorizontal(horizontal: ITextFrame.HorizontalAlignment | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * Types of horizontal alignment.
      */
@@ -23,7 +23,7 @@ export interface ITextBoxAlignment {
      *
      * @param vertical The vertical alignment
      */
-    setVertical(vertical: ITextFrame.VerticalAlignment | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setVertical(vertical: ITextFrame.VerticalAlignment | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * An integer value, where an increment of 1 represents 3 spaces.
      * Indicates the number of spaces (of the normal style font) of indentation for text in a cell.
@@ -37,7 +37,7 @@ export interface ITextBoxAlignment {
      *
      * @param indent The indentation
      */
-    setIndent(indent: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setIndent(indent: number | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * Indicates additional number of spaces of indentation to adjust for text in a cell.
      */
@@ -47,7 +47,7 @@ export interface ITextBoxAlignment {
      *
      * @param relativeIndent The relative indentation
      */
-    setRelativeIndent(relativeIndent: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setRelativeIndent(relativeIndent: number | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * The behavior for text that does not fit with the cell bounds.
      * @see
@@ -59,28 +59,37 @@ export interface ITextBoxAlignment {
      *
      * @param overflow The overflow behavior
      */
-    setOverflow(overflow: ITextFrame.Overflow | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setOverflow(overflow: ITextFrame.Overflow | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
-     * Rotation of the text.
+     * Rotation of the text, in degrees `0…360` (counter-clockwise, as OOXML stores it).
      * @defaultValue 0
      */
     getRotation(): number;
     /**
-     * Sets the rotation
+     * Sets the rotation.
      *
-     * @param rotation The rotation
+     * @param rotation The rotation in degrees; negative values are normalized (`-45` is `315`).
+     *
+     * @remarks
+     * Rotation and {@link setStacked stacked} are one orientation setting: setting a rotation turns
+     * stacking off.
      */
-    setRotation(rotation: number | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setRotation(rotation: number | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
-     * If the text should stack vertically instead of horizontally.
+     * If the text is stacked — every glyph upright, one below the other (Excel's "Vertical Text").
+     * @defaultValue false
      */
     getStacked(): boolean;
     /**
-     * Sets the stacked
+     * Sets whether the text is stacked.
      *
-     * @param stacked The stacked
+     * @param stacked `true` to stack the glyphs vertically.
+     *
+     * @remarks
+     * Stacked and {@link setRotation rotation} are one orientation setting: stacking clears any
+     * rotation.
      */
-    setStacked(stacked: boolean | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setStacked(stacked: boolean | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * If the cells justified or distributed alignment should be used on the last line of text.
      * (This is typical for East Asian alignments but not typical in other contexts.)
@@ -91,7 +100,7 @@ export interface ITextBoxAlignment {
      *
      * @param justifyLastLine The justified last line
      */
-    setJustifyLastLine(justifyLastLine: boolean | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setJustifyLastLine(justifyLastLine: boolean | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     /**
      * The direction the cell is being read.
      */
@@ -101,7 +110,7 @@ export interface ITextBoxAlignment {
      *
      * @param readingDirection The reading direction
      */
-    setReadingDirection(readingDirection: ITextFrame.ReadingDirection | null, options?: IStyle.UpdateOptions): ITextBoxAlignment;
+    setReadingDirection(readingDirection: ITextFrame.ReadingDirection | null, options?: ICellStyle.UpdateOptions): ITextBoxAlignment;
     toJSON(): ITextBoxAlignment.JSON;
     /**
      * For runtime type checking.

package/types/src/text/TextFrame.d.ts

@@ -20,6 +20,8 @@ export declare class TextFrame {
     layout(size?: Partial<Size> | null): ITextFrame;
     clone(visitor?: TextVisitor): ITextFrame;
     equals(other: ITextParagraph): boolean;
+    /** {@inheritDoc ITextFrame.IText.getText} */
+    getText(): string;
     /** {@inheritDoc ITextFrame.createTextFrame} */
     createTextFrame(text: string, allowWrap?: boolean): ITextFrame;
     get bounds(): Bounds;
@@ -39,5 +41,7 @@ export declare class TextFrame {
     get isSpaceFirstLastPara(): boolean;
     get presetTextWarp(): string | null;
     get paragraphs(): ITextParagraph[];
+    /** {@inheritDoc ITextFrame.isITextFrame} */
+    get isITextFrame(): true;
 }
 //# sourceMappingURL=TextFrame.d.ts.map

package/types/src/text/TextLine.d.ts

@@ -9,6 +9,8 @@ export interface ITextLine {
     readonly runs: ITextRun[];
     readonly bounds: Bounds;
     readonly baseline: number;
+    /** For runtime type checking. */
+    readonly isITextLine: true;
 }
 /**
  * A default text line.
@@ -20,5 +22,7 @@ export declare class DefaultTextLine implements ITextLine {
     get baseline(): any;
     get runs(): any;
     get bullet(): null;
+    /** {@inheritDoc ITextLine.isITextLine} */
+    get isITextLine(): true;
 }
 //# sourceMappingURL=TextLine.d.ts.map

package/types/src/text/TextParagraph.d.ts

@@ -24,6 +24,8 @@ export interface ITextParagraph {
     readonly rightMargin: number;
     readonly bullet: IBullet | null;
     readonly runs: ITextRun[];
+    /** For runtime type checking. */
+    readonly isITextParagraph: true;
 }
 export interface PlacedTextParagraph extends ITextParagraph {
     /**
@@ -57,5 +59,7 @@ export declare class DefaultTextParagraph implements ITextParagraph, PlacedTextP
     get rightMargin(): number;
     get bullet(): IBullet | null;
     get runs(): ITextRun[];
+    /** {@inheritDoc ITextParagraph.isITextParagraph} */
+    get isITextParagraph(): true;
 }
 //# sourceMappingURL=TextParagraph.d.ts.map

package/types/src/text/TextRotation.d.ts

@@ -26,7 +26,7 @@ import { ITextFrame } from './ITextFrame';
 export interface Line {
     /**
      * Where the strip's un-rotated top-left sits (content-box coordinate space). The strip is the
-     * line's box (`size`) rotated by the layout {@link Layout.angle angle} **about this point**.
+     * line's box (`size`) rotated by the layout {@link RotatedLayout.angle angle} **about this point**.
      */
     origin: Point;
     /** The un-rotated strip box: the line's text width × line height. */
@@ -37,7 +37,7 @@ export interface Line {
 /**
  * The placed geometry for all lines — see {@link layoutLines}.
  */
-export interface Layout {
+export interface RotatedLayout {
     /** The rotation, CSS degrees clockwise, normalized to [0, 360). Never 0 or 180 (callers skip). */
     angle: number;
     /**
@@ -102,5 +102,5 @@ export declare function getAdvance(lineHeight: number, deg: number): number;
  * The footprint may exceed the content box in either axis — rotated text overflows; clipping is a
  * consumer decision.
  */
-export declare function layoutLines(lineSizes: readonly Size[], deg: number, content: Bounds, horizontal: ITextFrame.HorizontalAlignment, vertical: ITextFrame.VerticalAlignment): Layout;
+export declare function layoutLines(lineSizes: readonly Size[], deg: number, content: Bounds, horizontal: ITextFrame.HorizontalAlignment, vertical: ITextFrame.VerticalAlignment): RotatedLayout;
 //# sourceMappingURL=TextRotation.d.ts.map

package/types/src/text/TextRun.d.ts

@@ -52,6 +52,13 @@ export interface ITextRun {
      * Specifies the strikethrough style applied to the text.
      */
     readonly strikeStyle: IText.StrikeStyle;
+    /**
+       * Specifies the baseline for both the superscript and subscript fonts.
+       * The size is specified using a percentage where 1000 is equal to 1 percent
+       * of the font size and 100000 is equal to 100 percent font of the font size.
+       */
+    /** For runtime type checking. */
+    readonly isITextRun: true;
 }
 export interface PlacedTextRun extends ITextRun {
     /**
@@ -81,5 +88,7 @@ export declare class DefaultTextRun implements ITextRun, PlacedTextRun, Cloneabl
     get smallCaps(): IText.SmallCaps;
     get offset(): number;
     get strikeStyle(): IText.StrikeStyle;
+    /** {@inheritDoc ITextRun.isITextRun} */
+    get isITextRun(): true;
 }
 //# sourceMappingURL=TextRun.d.ts.map

package/types/src/text/TextStacked.d.ts

@@ -0,0 +1,83 @@
+import { Bounds } from '@sheetxl/utils';
+import { ITextFrame } from './ITextFrame';
+/**
+ * Stacked cell-text layout — Excel's "Vertical Text" (`textRotation="255"`).
+ *
+ * Stacked text is not rotated. Every glyph stays upright and occupies one SLOT of the font's line
+ * pitch, glyphs advancing downward in a column. Measured against Excel (hidden-COM probes, see
+ * `VERTICAL-TEXT-PLAN.md`):
+ *
+ * 1. Columns come from explicit line breaks — one column per line, left → right in reading order —
+ *    and, when the cell wraps, from breaking a column that would exceed the content height: greedy
+ *    at spaces (the space at a break is consumed), per glyph inside a word longer than the capacity.
+ *    It is the horizontal wrap rule transposed. An unwrapped cell keeps one column; a line break
+ *    there is a blank slot.
+ * 2. Leading and trailing spaces of a column are measured but never painted (see
+ *    {@link layoutColumns}); inner spaces are blank slots.
+ * 3. Each column is aligned on its own by the vertical alignment (Top / Center / Bottom; Justify
+ *    and Distributed behave as Top and Center — nothing is spread). The horizontal alignment places
+ *    the group of columns; the caller resolves General (Excel centers it). Columns are one pitch
+ *    wide and glyphs center in them.
+ * 4. Nothing overflows: the footprint clips to the cell on both axes.
+ *
+ * All output is pure geometry, renderer-agnostic: a DOM renderer maps each column to a box of
+ * `pitch` line-height with one glyph per line; a canvas renderer paints each glyph centered in
+ * its slot.
+ */
+/**
+ * One stacked column.
+ */
+export interface Column {
+    /** The slot texts, top to bottom — one glyph each; a blank slot is `' '`. */
+    glyphs: readonly string[];
+    /** The column box (content-box coordinate space): one pitch wide, `glyphs.length · pitch` tall. */
+    bounds: Bounds;
+}
+/**
+ * The placed geometry for all columns — see {@link layoutColumns}.
+ */
+export interface StackedLayout {
+    /** The slot pitch: the font's line height. Also the column width. */
+    pitch: number;
+    /** One entry per column, in reading order (left → right). */
+    columns: readonly Column[];
+    /** The axis-aligned union of all columns. */
+    bounds: Bounds;
+}
+/**
+ * Splits text into the units that take a slot each. Code points, so a surrogate pair is one slot.
+ */
+export declare function splitGlyphs(text: string): string[];
+/**
+ * Splits text into columns of slots.
+ *
+ * @param text The text to stack (line breaks are `\n`).
+ * @param wrapped `true` when the cell wraps: line breaks start new columns and a column longer than
+ *  `capacity` breaks (see the module notes). `false` keeps one column with a line break as a blank
+ *  slot.
+ * @param capacity The slots per column before a wrapped column breaks. Pass
+ *  `Number.MAX_SAFE_INTEGER` to split on line breaks only (the measure Excel's autofit uses).
+ *
+ * @remarks
+ * Columns keep their leading/trailing spaces — those count for measurement. {@link layoutColumns}
+ * trims them for painting.
+ */
+export declare function toColumns(text: string, wrapped: boolean, capacity: number): string[][];
+/**
+ * The slot count a measure uses: the longest column, spaces included.
+ */
+export declare function slotCount(columns: readonly (readonly string[])[]): number;
+/**
+ * Lays out stacked columns within a content box.
+ *
+ * @param columns The columns' slot glyphs, in reading order (see {@link toColumns}). Leading and
+ *  trailing spaces are trimmed here — Excel measures them but does not paint them.
+ * @param pitch The slot pitch (the font's line height); also the column width.
+ * @param content The content box (cell box minus insets), in the caller's coordinate space.
+ * @param horizontal The resolved horizontal alignment (`General` already resolved). Places the
+ *  group of columns: Left/Justify at the left edge, Right at the right edge, otherwise centered.
+ * @param vertical The vertical alignment, applied to EACH column: Top/Justify hug the top edge,
+ *  Center/Distributed center, Bottom (the default) hugs the bottom.
+ */
+export declare function layoutColumns(columns: readonly (readonly string[])[], pitch: number, content: Bounds, horizontal: ITextFrame.HorizontalAlignment, vertical: ITextFrame.VerticalAlignment): StackedLayout;
+//# sourceMappingURL=TextStacked.d.ts.map

package/types/src/text/index.d.ts

@@ -4,4 +4,5 @@ export * from './richtext';
 export * from './TextBoxAlignment';
 export * as TextUtils from './TextUtils';
 export * as TextRotation from './TextRotation';
+export * as TextStacked from './TextStacked';
 //# sourceMappingURL=index.d.ts.map

package/types/src/text/richtext/IRichText.d.ts

@@ -0,0 +1,36 @@
+import { IStyledFont } from './IStyledFont';
+/**
+ * Text with formatting: a list of {@link IRichText.Run | runs}, each a span of text with the font
+ * properties it sets.
+ *
+ * @remarks
+ * A run records only what it sets. Everything it leaves out is inherited from the font of whatever
+ * holds the text (a note's default, a cell's style).
+ */
+export declare namespace IRichText {
+    /**
+     * One formatted span.
+     */
+    interface Run {
+        /**
+         * The text of the span.
+         */
+        text: string;
+        /**
+         * The font properties this span sets, or nothing when it has none of its own.
+         *
+         * @remarks
+         * The same properties a cell's font has, so a bold span is `{ weight: 700 }`, italic is
+         * `{ style: 'italic' }`. The color is any string a font's color takes; one read from a file keeps
+         * its theme or indexed color that way.
+         */
+        font?: IStyledFont.JSON;
+    }
+    /**
+     * The serialized form: the runs, in order.
+     */
+    interface JSON {
+        runs: Run[];
+    }
+}
+//# sourceMappingURL=IRichText.d.ts.map

package/types/src/text/richtext/IStyledFont.d.ts

@@ -1,7 +1,7 @@
 import { Properties as CSSProperties } from 'csstype';
 import { IColor } from '../../color';
 import { IFont } from '../../font';
-import { IStyle } from '../../style';
+import { ICellStyle } from '../../style';
 /**
  * Represents a font with styling color.
  */
@@ -21,7 +21,7 @@ export interface IStyledFont {
      *
      * @see {@link IStyledFont.getFamily}
      */
-    setFamily(family: string | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setFamily(family: string | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * A list of fonts and their fallbacks. These can also be provided in the fontFamily attribute but will
      * be normalized to here.
@@ -30,7 +30,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setFallbacks}
      */
-    setFallbacks(fallbacks: string[] | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setFallbacks(fallbacks: string[] | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Font size is either a number in points or a string that can be converted such as '14px', '1.5em'.
      */
@@ -38,7 +38,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setSize}
      */
-    setSize(size: number | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setSize(size: number | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The weight of the characters.
      */
@@ -46,7 +46,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setWeight}
      */
-    setWeight(weight: number | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setWeight(weight: number | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Convenience for {@link IStyledFont.getWeight}. Returns `true` when the weight is bold (> 400).
      */
@@ -62,7 +62,7 @@ export interface IStyledFont {
      *
      * @see {@link IStyledFont.getBold}
      */
-    setBold(bold: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setBold(bold: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * @default `IFont.Style.Normal`
      */
@@ -70,7 +70,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setStyle}
      */
-    setStyle(style: IFont.Style | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setStyle(style: IFont.Style | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Convenience for {@link IStyledFont.getStyle}. Returns `true` when the style is italic.
      */
@@ -86,7 +86,7 @@ export interface IStyledFont {
      *
      * @see {@link IStyledFont.getItalic}
      */
-    setItalic(italic: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setItalic(italic: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The text color.
      */
@@ -94,7 +94,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.getColor}
      */
-    setColor(color: IColor | string | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setColor(color: IColor | string | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Adds or removes additional spacing between the characters.
      */
@@ -102,7 +102,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setLetterSpacing}
      */
-    setLetterSpacing(letterSpacing: number | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setLetterSpacing(letterSpacing: number | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Sets the underline style. If true defaults to single. If false or null defaults to none.
      *
@@ -112,7 +112,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setUnderline}
      */
-    setUnderline(underline: IFont.UnderlineStyle | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setUnderline(underline: IFont.UnderlineStyle | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The effect draws the text with a line through it.
      */
@@ -120,7 +120,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setStrike}
      */
-    setStrike(strike: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setStrike(strike: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The theme font this font refers to, if any. A `major` or `minor` scheme makes the font follow
      * the theme's heading or body font, overriding {@link IStyledFont.getFamily | family}.
@@ -134,7 +134,7 @@ export interface IStyledFont {
      *
      * @see {@link IStyledFont.getScheme}
      */
-    setScheme(scheme: IFont.Scheme | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setScheme(scheme: IFont.Scheme | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Returns the vertical alignment of the text within a text line.
      *
@@ -145,7 +145,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setVerticalAlignment}
      */
-    setVerticalAlignment(verticalAlignment: IFont.VerticalAlignment | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setVerticalAlignment(verticalAlignment: IFont.VerticalAlignment | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The effect draws a shadow around the text.
      *
@@ -156,7 +156,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setShadow}
      */
-    setShadow(shadow: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setShadow(shadow: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The effect draws the text as an outline.
      *
@@ -167,7 +167,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setOutline}
      */
-    setOutline(outline: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setOutline(outline: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The effect extends or stretches out the text.
      *
@@ -178,7 +178,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.setExtend}
      */
-    setExtend(extend: boolean | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setExtend(extend: boolean | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * The character set the font was authored against, or `null` when the font does not name one.
      *
@@ -191,7 +191,7 @@ export interface IStyledFont {
     /**
      * @see {@link IStyledFont.getCharset}
      */
-    setCharset(charset: IFont.Charset | null, options?: IStyle.UpdateOptions): IStyledFont;
+    setCharset(charset: IFont.Charset | null, options?: ICellStyle.UpdateOptions): IStyledFont;
     /**
      * Returns `true` if the font is either a superscript or a subscript.
      */

package/types/src/text/richtext/index.d.ts

@@ -1,2 +1,3 @@
 export * from './IStyledFont';
+export * from './IRichText';
 //# sourceMappingURL=index.d.ts.map

package/types/src/theme/ITheme.d.ts

@@ -1,4 +1,5 @@
 import { IColor } from '../color';
+import { IFont } from '../font';
 import { IFill, IStroke, IEffect } from '../fill';
 import { buildPalette as _buildPalette } from './_ThemeUtils';
 /**
@@ -27,6 +28,12 @@ export interface ITheme {
      * A set of fonts that are used in a document.
      */
     getFontScheme(): ITheme.IFontScheme;
+    /**
+     * The fills, lines, effects and background fills a shape's or chart's style references
+     * ({@link ITheme.StyleRefsJSON}) name by position. Each list the theme does not state is
+     * Office's.
+     */
+    getFormatScheme(): ITheme.FormatScheme;
     /**
      * This is available for functions that want to resolve themed colors
      *
@@ -54,6 +61,8 @@ export interface ITheme {
      * @param includeInherited If true then the inherited properties will be included.
      */
     toJSON(includeInherited?: boolean): ITheme.JSON;
+    /** For runtime type checking. */
+    readonly isITheme: true;
 }
 /**
  * {@inheritDoc ITheme}
@@ -208,6 +217,39 @@ export declare namespace ITheme {
     }
     interface FontSchemeJSON extends Partial<FontSchemeProperties> {
     }
+    /**
+     * One reference into a theme style list (`fillRef`, `lnRef`, `effectRef`): the one-based position
+     * in the list, `0` for none, and the color the list entry's placeholder (`phClr`) takes.
+     */
+    interface StyleRefJSON {
+        index: number;
+        color?: string;
+    }
+    /** The font a theme style refers to: the theme's `major` or `minor` font, or `none`, and the text color. */
+    interface FontRefJSON {
+        index: IFont.Scheme;
+        color?: string;
+    }
+    /**
+     * References into the theme's format scheme — what a shape or chart draws with wherever it
+     * states nothing of its own: DrawingML's `style` element.
+     */
+    interface StyleRefsJSON {
+        fill?: StyleRefJSON;
+        stroke?: StyleRefJSON;
+        effect?: StyleRefJSON;
+        font?: FontRefJSON;
+    }
+    /**
+     * A theme's format scheme (DrawingML's `fmtScheme`): the lists a {@link StyleRefsJSON} indexes
+     * into, one-based. See the fields of the same names on {@link ITheme.JSON}.
+     */
+    interface FormatScheme {
+        fillStyleLst: readonly IFill.JSON[];
+        lnStyleLst: readonly IStroke.JSON[];
+        effectStyleLst: readonly IEffect.JSON[][];
+        bgFillStyleLst: readonly IFill.JSON[];
+    }
     interface JSON {
         name: string;
         fonts?: ITheme.FontSchemeJSON;
@@ -241,10 +283,9 @@ export declare namespace ITheme {
          * list.
          *
          * @remarks
-         * Used only when the source `fmtScheme` contains something {@link fillStyleLst}/{@link lnStyleLst}/
-         * {@link effectStyleLst}/{@link bgFillStyleLst} can't fully represent — otherwise those typed
-         * fields are populated instead and this is left unset. Not yet exposed on `ITheme` itself —
-         * pending real format-scheme modeling (see `format`/`objectDefaults` below).
+         * Set only when the source `fmtScheme` contains something {@link fillStyleLst}/{@link lnStyleLst}/
+         * {@link effectStyleLst}/{@link bgFillStyleLst} can't fully represent. The lists that can be
+         * represented are still populated, so the theme draws with them.
          */
         formatSchemeXml?: string;
     }

package/types/src/theme/IThemeCollection.d.ts

@@ -53,6 +53,8 @@ export interface IThemeCollection extends ICollection<ITheme> {
      * @returns The previous default theme.
      */
     setDefaultTheme: (theme: ITheme) => ITheme;
+    /** For runtime type checking. */
+    readonly isIThemeCollection: true;
 }
 /**
  * {@inheritDoc IThemeCollection}

package/types/src/theme/ThemeCollection.d.ts

@@ -1,3 +1,4 @@
+import { AbstractCollection } from '../type';
 import { IColor } from '../color';
 import { ITheme } from './ITheme';
 import { IThemeCollection } from './IThemeCollection';
@@ -14,6 +15,7 @@ export declare class Theme implements ITheme {
     private _lnStyleLst;
     private _effectStyleLst;
     private _bgFillStyleLst;
+    private _formatScheme;
     private _cacheColors;
     /** System epoch at which `_cacheColors` was populated (for host-theme invalidation). */
     private _cacheEpoch;
@@ -27,17 +29,21 @@ export declare class Theme implements ITheme {
     getColorScheme(): ITheme.IColorScheme;
     /** {@inheritDoc ITheme.getFontScheme} */
     getFontScheme(): ITheme.IFontScheme;
+    /** {@inheritDoc ITheme.getFormatScheme} */
+    getFormatScheme(): ITheme.FormatScheme;
     /** {@inheritDoc ITheme.schemeLookup} */
     schemeLookup(): IColor.SchemeLookup;
     /** {@inheritDoc ITheme.parseColor} */
     parseColor(str: string): IColor;
     /** {@inheritDoc ITheme.toJSON} */
     toJSON(): ITheme.JSON;
+    /** {@inheritDoc ITheme.isITheme} */
+    get isITheme(): true;
 }
 /**
  * Collection of themes
  */
-export declare class ThemeCollection implements IThemeCollection {
+export declare class ThemeCollection extends AbstractCollection<ITheme, IThemeCollection.GetItemsOptions> implements IThemeCollection {
     private _customMap;
     private _defaultTheme;
     private _isReadOnly;
@@ -48,15 +54,13 @@ export declare class ThemeCollection implements IThemeCollection {
     setDefaultTheme(theme: ITheme): ITheme;
     /** {@inheritDoc IThemeCollection.getByName} */
     getByName(name: string): ITheme | null;
-    /** {@inheritDoc ICollection.[Symbol.iterator]} */
-    [Symbol.iterator](): IterableIterator<ITheme>;
-    /** {@inheritDoc IThemeCollection.getByName} */
-    getItems(options?: IThemeCollection.GetItemsOptions): ITheme[];
-    /** {@inheritDoc IThemeCollection.getCount} */
-    getCount(): number;
+    /** {@inheritDoc AbstractCollection._getItems} */
+    protected _getItems(options?: IThemeCollection.GetItemsOptions): ITheme[];
     /** {@inheritDoc IThemeCollection.setCustomTheme} */
     setCustomTheme(theme: ITheme): ITheme | null;
     /** {@inheritDoc IThemeCollection.deleteCustomTheme} */
     deleteCustomTheme(theme: ITheme | string): ITheme | null;
+    /** {@inheritDoc IThemeCollection.isIThemeCollection} */
+    get isIThemeCollection(): true;
 }
 //# sourceMappingURL=ThemeCollection.d.ts.map

package/types/src/theme/_OfficeFormatScheme.d.ts

@@ -0,0 +1,3 @@
+import { ITheme } from './ITheme';
+export declare const OFFICE_FORMAT_SCHEME: ITheme.FormatScheme;
+//# sourceMappingURL=_OfficeFormatScheme.d.ts.map