@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/shape/IShape.d.ts

@@ -0,0 +1,279 @@
+import { Point, Rectangle } from '@sheetxl/utils';
+import { IListener } from '../listener';
+import { IResource } from '../resource';
+import { IModel } from '../model';
+import { IHyperlink } from '../hyperlink';
+import { IFill } from '../fill';
+import { IStroke } from '../fill/IStroke';
+/**
+ * Interface for working with IShape.
+ *
+ * @remarks
+ *
+ * A shape does not position information
+ * **PLACEHOLDER**
+ */
+export interface IShape extends IModel {
+    toJSON(toResourceId?: (resource: IResource) => number | null): IShape.JSON | null;
+    /**
+     * Returns the name of the shape.
+     */
+    getName(): string;
+    /**
+     * Returns the description of the shape.
+     */
+    getDescription(): string;
+}
+/**
+ * {@inheritDoc IShape}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IShape}
+ */
+export declare namespace IShape {
+    /**
+     * A set of values that can be set on a IShape.
+     *
+     * @see
+     * {@link IShape}
+     */
+    interface Properties {
+        /**
+         * The unique name of the table
+         */
+        name?: string;
+        /**
+         * The preset Geometry for the shape. This could also be custom.
+         *
+         * @defaultValue 'rect'
+         */
+        geometry?: PresetGeometry | GeometryProperties;
+        /**
+         * The fill.
+         */
+        fill?: IFill.ISolid | IFill.IGradient | IFill.IPattern | IFill.INone;
+        /**
+         * The stroke.
+         */
+        stroke?: IStroke;
+        /**
+         * A hyperlink for the entire shape.
+         */
+        hyperlink?: string | IHyperlink.JSON;
+    }
+    /**
+     * A JSON representation useful for persistence.
+     */
+    interface JSON extends Omit<Properties, 'fill' | 'stroke' | 'geometry'> {
+        fill?: IFill.SolidJSON | IFill.GradientJSON | IFill.PatternJSON | IFill.NoneJSON;
+        stroke?: IStroke.JSON;
+        geometry?: string | GeometryJSON;
+        /** Which drawing element this was read from ("sp" | "cxnSp" | "grpSp") — `getType()` always
+         * reports "shape" regardless, so this is the only place the distinction survives a round trip. */
+        type?: string;
+        /** Opaque source XML fragment, captured verbatim from the source file and replayed as-is on
+         * save, for whatever this shape doesn't (yet) model structurally. */
+        xml?: string;
+        /** Original `cNvPr` id from the captured source fragment, if any; used to avoid id collisions
+         * with freshly-generated ids on write. */
+        sourceId?: number;
+    }
+    interface GeometryProperties {
+        geometry?: PresetGeometry;
+        ah: (PolarAdjustmentHandle | XYAdjustmentHandle)[];
+        av?: IShape.AdjustmentGuide[];
+        connections?: IShape.ConnectionSite[];
+        guides?: IShape.AdjustmentGuide[];
+        paths?: IShape.Path[] | string[] | string;
+        /**
+         * Specifies the rectangular bounding box for text within the shape.
+         * @defaultValue `null` - The bounds of the shape,
+         */
+        textBounds?: Rectangle;
+    }
+    interface Path {
+        paths: string[];
+        /**
+         * Specifies that the use of 3D extrusions are possible on this path. This allows the generating application to know whether
+         * 3D extrusion can be applied in any form.
+         *
+         * @defaultValue `false`
+         */
+        extrusionOk?: boolean;
+        /**
+         * Specifies how the corresponding path should be filled.
+         *
+         * @defaultValue `PathFill.Normal`
+         */
+        pathFill?: PathFill;
+        /**
+         * Specifies the height, or maximum y coordinate that should be used for within the path coordinate system. This value determines
+         * the vertical placement of all points within the corresponding path as they will all be calculated using this height attribute
+         * as the max y coordinate.
+         *
+         * @defaultValue `null`
+         */
+        h?: number;
+        /**
+         * Specifies if the corresponding path should have a path stroke shown. This is a boolean value that will effect on the outline of the path.
+         *
+         * @defaultValue `true`
+         */
+        stroke?: boolean;
+        /**
+         * Specifies the width, or maximum x coordinate that should be used for within the path coordinate system. This value determines
+         * the horizontal placement of all points within the corresponding path as they will all be calculated using this width attribute
+         * as the max x coordinate.
+         *
+         * @defaultValue `null`
+         */
+        w?: number;
+    }
+    /**
+     * Specifies the manner in which a path should be filled. The lightening and darkening of a path allow for certain parts of the shape
+     * to be colored lighter of darker depending on user preference.
+     */
+    const PathFill: {
+        readonly Darken: "darken";
+        readonly DarkenLess: "darkenLess";
+        readonly Lighten: "lighten";
+        readonly LightenLess: "lightenLess";
+        readonly None: "none";
+        readonly Normal: "normal";
+    };
+    type PathFill = typeof PathFill[keyof typeof PathFill];
+    /**
+     * Specifies the presence of a shape guide that will be used to govern the geometry of the specified shape.
+     */
+    interface AdjustmentGuide {
+        /**
+         * Specifies the name that will be used to reference to this guide. This name may be used just as a variable
+         * would within an equation. That is this name may be substituted for literal values within other guides or
+         * the specification of the shape path.
+         */
+        name: string;
+        /**
+         * Specifies the formula that will be used to calculate the value for a guide. Each formula has a certain
+         * number of arguments and a specific set of operations to perform on these arguments in order to generate a
+         * value for a guide. There are a total of 17 different formulas available. These are shown below with the usage
+         * for each defined
+         */
+        fmla: string;
+    }
+    /**
+     * These adjust handles will specify points within the geometric shape that can be used to perform certain
+     * transform operations on the shape.
+     */
+    interface AdjustmentHandle {
+        /**
+         * The point of the adjustment
+         */
+        pos: Point;
+    }
+    interface PolarAdjustmentHandle extends AdjustmentHandle {
+        type: 'polar';
+        /**
+         * Specifies the name of the guide that will be updated with the adjustment angle from this adjust handle.
+         */
+        gdRefAng: string;
+        /**
+         * Specifies the name of the guide that will be updated with the adjustment radius from this adjust handle.
+         */
+        gdRefR: string;
+        /**
+         * Specifies the maximum angle position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move angularly.
+         */
+        maxAng: number;
+        /**
+         * Specifies the maximum radial position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move radially.
+         */
+        maxR: number;
+        /**
+         * Specifies the minimum angle position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move angularly.
+         */
+        minAng: number;
+        /**
+         * Specifies the minimum radial position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move radially.
+         */
+        minR: number;
+    }
+    interface XYAdjustmentHandle extends AdjustmentHandle {
+        type: 'xy';
+        /**
+         * Specifies the name of the guide that will be updated with the adjustment x position from this adjust handle.
+         */
+        gdRefX: string;
+        /**
+         * Specifies the name of the guide that will be updated with the adjustment y position from this adjust handle.
+         */
+        gdRefY: string;
+        /**
+         * Specifies the maximum horizontal position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move in the x direction.
+         */
+        maxX: number;
+        /**
+         * Specifies the maximum vertical position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move in the y direction.
+         */
+        maxY: number;
+        /**
+         * Specifies the minimum horizontal position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move in the x direction.
+         */
+        minX: number;
+        /**
+         * Specifies the minimum vertical position that is allowed for this adjustment handle. If this attribute is omitted,
+         * then it will be assumed that this adjust handle cannot move in the y direction.
+         */
+        minY: number;
+    }
+    /**
+     * A connection site allows a `ConnectionShape` to be attached to this shape. This connection will be maintained
+     * when the shape is repositioned. It should be noted that this connection is placed within the shape
+     * bounding box using the transform coordinate system which is also called the shape coordinate system,
+     * as it encompasses the entire shape.
+     */
+    interface ConnectionSite {
+        /**
+         * Specifies the incoming connector angle. This angle is the angle around the connection site that an
+         * incoming connector will try to be routed to. This allows connectors to know where the shape is in
+         * relation to the connection site and route connectors so as to avoid any overlap with the shape.
+         */
+        angle: string;
+        /**
+         * Specifies a position coordinate within the shape bounding box. It should be noted that this coordinate
+         * is placed within the shape bounding box using the transform coordinate system which is also called the
+         * shape coordinate system, as it encompasses the entire shape.
+         */
+        pos: Point;
+    }
+    interface GeometryJSON extends GeometryProperties {
+    }
+    interface Events extends IModel.Events {
+    }
+    interface IListeners extends IListener.Callbacks<IShape, IShape.Events> {
+    }
+    interface IConnection {
+    }
+    interface Connection extends IShape.JSON {
+        cxnSp?: any;
+    }
+    /**
+     * @see {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_ShapeType_topic_ID0EBTFOB.html#topic_ID0EBTFOB}
+     */
+    const PresetGeometry: {
+        readonly Line: "line";
+        readonly LineInv: "lineInv";
+        readonly triangle: "triangle";
+        readonly rtTriangle: "rtTriangle";
+        readonly Rect: "rect";
+    };
+    type PresetGeometry = typeof PresetGeometry[keyof typeof PresetGeometry];
+}
+//# sourceMappingURL=IShape.d.ts.map

package/types/src/shape/IShape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IShape.d.ts","sourceRoot":"","sources":["../../../../src/shape/IShape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE5D,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE/C;;;;;;;GAOG;AAQH,MAAM,WAAW,MAAO,SAAQ,MAAM;IAEpC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,IAAI,GAAG,IAAI,CAAA;IACjF;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC;IAClB;;OAEG;IACH,cAAc,IAAI,MAAM,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,yBAAiB,MAAM,CAAC;IAOtB;;;;;OAKG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;;;;WAIG;QACH,QAAQ,CAAC,EAAE,cAAc,GAAG,kBAAkB,CAAC;QAC/C;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC;QACrE;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC;KAMtC;IAED;;OAEG;IACH,UAAiB,IAAK,SAAQ,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;QAC5E,IAAI,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,GAAG,KAAK,CAAC,QAAQ,CAAC;QACjF,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;QACjC;0GACkG;QAClG,IAAI,CAAC,EAAE,MAAM,CAAC;QACd;6EACqE;QACrE,GAAG,CAAC,EAAE,MAAM,CAAC;QACb;kDAC0C;QAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAID,UAAiB,kBAAkB;QAEjC,QAAQ,CAAC,EAAE,cAAc,CAAC;QAG1B,EAAE,EAAE,CAAC,qBAAqB,GAAG,kBAAkB,CAAC,EAAE,CAAC;QAInD,EAAE,CAAC,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC;QAG9B,WAAW,CAAC,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC;QAGtC,MAAM,CAAC,EAAE,MAAM,CAAC,eAAe,EAAE,CAAC;QAElC,KAAK,CAAC,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;QAE1C;;;WAGG;QACH,UAAU,CAAC,EAAE,SAAS,CAAC;KACxB;IAGD,UAAiB,IAAI;QAGnB,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB;;;;;WAKG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;QACtB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;QACpB;;;;;;WAMG;QACH,CAAC,CAAC,EAAE,MAAM,CAAC;QACX;;;;WAIG;QAEH,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB;;;;;;WAMG;QACH,CAAC,CAAC,EAAE,MAAM,CAAC;KACZ;IAED;;;OAGG;IACI,MAAM,QAAQ;;;;;;;KAOX,CAAC;IACX,KAAY,QAAQ,GAAG,OAAO,QAAQ,CAAC,MAAM,OAAO,QAAQ,CAAC,CAAC;IAE9D;;OAEG;IACH,UAAiB,eAAe;QAC9B;;;;WAIG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;;;WAKG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B;;WAEG;QACH,GAAG,EAAE,KAAK,CAAC;KACZ;IAGD,UAAiB,qBAAsB,SAAQ,gBAAgB;QAE7D,IAAI,EAAE,OAAO,CAAC;QACd;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,kBAAmB,SAAQ,gBAAgB;QAE1D,IAAI,EAAE,IAAI,CAAC;QACX;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED;;;;;OAKG;IACH,UAAiB,cAAc;QAC7B;;;;WAIG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;;WAIG;QACH,GAAG,EAAE,KAAK,CAAC;KACZ;IAED,UAAiB,YAAa,SAAQ,kBAAkB;KAEvD;IAED,UAAiB,MAAO,SAAQ,MAAM,CAAC,MAAM;KAE5C;IAED,UAAiB,UAAW,SAAQ,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;KAAG;IAGjF,UAAiB,WAAW;KAC3B;IAED,UAAiB,UAAW,SAAQ,MAAM,CAAC,IAAI;QAC7C,KAAK,CAAC,EAAE,GAAG,CAAC;KACb;IAED;;OAEG;IACI,MAAM,cAAc;;;;;;KA8LjB,CAAC;IACX,KAAY,cAAc,GAAG,OAAO,cAAc,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;CACjF"}

package/types/src/shape/Shape.d.ts

@@ -0,0 +1,54 @@
+import { IResource, IResourceCollection } from '../resource';
+import { IModel, AbstractModel } from '../model';
+import { IShape } from './IShape';
+interface State extends AbstractModel.State {
+    data?: any;
+}
+/**
+ * Implementation for {@link IShape}.
+ */
+export declare class Shape extends AbstractModel<State, IShape.JSON> implements IShape {
+    constructor(options: Shape.ConstructorOptions);
+    /** {@inheritDoc IModel.getType} */
+    getType(): string;
+    /** {@inheritDoc IShape.getName} */
+    getName(): string;
+    /** {@inheritDoc Movable.Content.getDescription} */
+    getDescription(): string;
+    /** {@inheritDoc Movable.Content.toJSON} */
+    toJSON(_toResourceId?: (resource: IResource) => number | null): IShape.JSON | null;
+    /** {@inheritDoc Movable.Content.getTypeDescription} */
+    getTypeDescription(): string;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}
+/**
+ * Interfaces for creating `Chart` items.
+ *
+ * @see
+ * ### **Interface**
+ *
+ * {@link Shape}
+ */
+export declare namespace Shape {
+    /**
+     * Options for creating a shape.
+     */
+    interface ConstructorOptions extends IModel.ConstructorOptions<IShape.JSON> {
+        /**
+         * Returns an IResource from the resourceId or null if not found.
+         */
+        fromResourceId?: (resourceId: number) => IResource;
+        /**
+         * Useful for load/save/copying.
+         */
+        beginPersistResource: () => IResourceCollection.IPersistScope<IResource.JSON>;
+        /**
+         * Allow for the default lock aspect ratio to be overwritten.
+         */
+        defaultLockAspectRatio?: boolean;
+        getName(): string;
+    }
+}
+export {};
+//# sourceMappingURL=Shape.d.ts.map

package/types/src/shape/Shape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Shape.d.ts","sourceRoot":"","sources":["../../../../src/shape/Shape.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,UAAU,KAAM,SAAQ,aAAa,CAAC,KAAK;IACzC,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAE,YAAW,MAAM;gBAEhE,OAAO,EAAE,KAAK,CAAC,kBAAkB;IAS7C,mCAAmC;IACnC,OAAO,IAAI,MAAM;IAIjB,mCAAmC;IACnC,OAAO,IAAI,MAAM;IAIjB,mDAAmD;IACnD,cAAc,IAAI,MAAM;IAKxB,2CAA2C;IAC3C,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,IAAI,GAAG,IAAI;IAYlF,uDAAuD;IACvD,kBAAkB,IAAI,MAAM;IAI5B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,QAAQ,IAAI,MAAM;CAGnB;AAGD;;;;;;;GAOG;AACH,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACH,UAAiB,kBAAmB,SAAQ,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,IAAI,CAAC;QAChF;;WAEG;QACH,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,SAAS,CAAC;QACnD;;WAEG;QACH,oBAAoB,EAAE,MAAM,mBAAmB,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC9E;;WAEG;QAEH,sBAAsB,CAAC,EAAE,OAAO,CAAC;QAEjC,OAAO,IAAI,MAAM,CAAC;KAEnB;CACF"}

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

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

package/types/src/shape/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/shape/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/types/src/sheet/CellRegion.d.ts

@@ -0,0 +1,106 @@
+import { IRange } from '@sheetxl/primitives';
+import { ICell } from '../cell';
+import { ICellRange, ICellRegion, ICellRegions } from '../cellRange';
+import { ISheetInternal } from './Sheet';
+/**
+ * Normalizes the requested features, ONCE, at the call.
+ *
+ * @remarks
+ * Every public {@link ICellRange.Feature} partitions today — there is no unsupported-feature
+ * throw left to raise here. (There used to be: the scalar kinds `String`/`Number`/`Boolean` could
+ * only be counted from values, and `Date` rode a format map that alone couldn't tell a real date
+ * from a date-formatted blank. The three scalars were retired from the vocabulary entirely —
+ * `getStats()` already answers "how many numbers" better — and `Date` was replaced by
+ * `DateFormat`, a real, directly indexed feature that just means what it says.)
+ * @internal
+ */
+export declare const resolveRegionFeatures: (features?: ICellRange.Feature | readonly ICellRange.Feature[]) => readonly ICellRange.Feature[];
+/**
+ * One member of a partition — a rectangle whose cells agree on every requested feature.
+ *
+ * @remarks
+ * Geometry plus two bridges, and deliberately not a `SheetRange`: see {@link ICellRegion} for
+ * why reading is an explicit hop rather than an inherited surface.
+ */
+export declare class CellRegion implements ICellRegion {
+    private readonly _coords;
+    private readonly _internal;
+    private readonly _features;
+    /** The extent the partition was computed over — what {@link isClipped} is answered against. */
+    private readonly _bounds;
+    /** The bridge range, built on demand — a listing never pays for one. */
+    private _range;
+    /** Memoized clip verdict: the probes are sheet reads, and a listing may ask twice. */
+    private _clipped;
+    constructor(coords: Readonly<IRange.Coords>, internal: ISheetInternal, features: readonly ICellRange.Feature[], bounds: Readonly<IRange.Coords>);
+    /** {@inheritDoc ICellRegion.getFeatures} */
+    getFeatures(): readonly ICellRange.Feature[];
+    /** {@inheritDoc ICellRegion.getCoords} */
+    getCoords(): Readonly<IRange.Coords>;
+    /** {@inheritDoc ICellRegion.getAddress} */
+    getAddress(r1c1?: boolean): string;
+    /** {@inheritDoc ICellRegion.getRowCount} */
+    getRowCount(): number;
+    /** {@inheritDoc ICellRegion.getColumnCount} */
+    getColumnCount(): number;
+    /** {@inheritDoc ICellRegion.isClipped} */
+    isClipped(): boolean;
+    /**
+     * An edge of this region sits ON an edge of the queried extent, and the line immediately beyond
+     * that edge still bears the partitioned features — so the block was cut, not merely adjacent.
+     *
+     * @remarks
+     * Testing "touches the boundary" alone would be wrong far more often than it is right: on an
+     * unconstrained `sheet.getRegions()` the extent starts at `A1`, so every block anchored at `A1`
+     * would report itself clipped. The probe beyond the edge is what separates *the query cut this*
+     * from *the data happens to start here*, and it is one thin range read per touching edge —
+     * paid only when an edge actually coincides.
+     * @internal
+     */
+    private _probeClipped;
+    /** {@inheritDoc ICellRegion.getCell} */
+    getCell(): ICell;
+    /** {@inheritDoc ICellRegion.getRange} */
+    getRange(): ICellRange;
+    /** {@inheritDoc ICellRegion.toString} */
+    toString(): string;
+    get [Symbol.toStringTag](): string;
+    /** {@inheritDoc ICellRegion.isICellRegion} */
+    get isICellRegion(): true;
+}
+/**
+ * A partition and the features it partitioned on — what `getRegions` returns.
+ *
+ * @remarks
+ * Lazily backed: constructing one costs nothing, and the partition is computed on first use and
+ * then memoized. Memoized rather than recomputed per pass so that `getCount()` and a subsequent
+ * iteration can never disagree — a report that prints `6` and then lists five regions is worse
+ * than a slightly stale one. The addresses are live pointers into the sheet either way.
+ */
+export declare class CellRegions implements ICellRegions {
+    private readonly _bounds;
+    private readonly _internal;
+    private readonly _features;
+    private readonly _options;
+    private _regions;
+    /** The extent as a range, built on demand — a listing that never asks never pays. */
+    private _range;
+    constructor(bounds: Readonly<IRange.Coords>, internal: ISheetInternal, features: readonly ICellRange.Feature[], options?: ICellRange.GetRegionsOptions);
+    /** {@inheritDoc ICellRegions.getFeatures} */
+    getFeatures(): readonly ICellRange.Feature[];
+    /** {@inheritDoc ICellRegions.getRange} */
+    getRange(): ICellRange;
+    /** {@inheritDoc ICellRegions.getCount} */
+    getCount(): number;
+    /** {@inheritDoc ICellRegions.[Symbol.iterator]} */
+    [Symbol.iterator](): IterableIterator<ICellRegion>;
+    /**
+     * The partition, computed once.
+     * @internal
+     */
+    private _materialize;
+    get [Symbol.toStringTag](): string;
+    /** {@inheritDoc ICellRegions.isICellRegions} */
+    get isICellRegions(): true;
+}
+//# sourceMappingURL=CellRegion.d.ts.map

package/types/src/sheet/CellRegion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CellRegion.d.ts","sourceRoot":"","sources":["../../../../src/sheet/CellRegion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC;AAG/E,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,SAAS,CAAC;AAQ9C;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,qBAAqB,GAChC,WAAW,UAAU,CAAC,OAAO,GAAG,SAAS,UAAU,CAAC,OAAO,EAAE,KAC5D,SAAS,UAAU,CAAC,OAAO,EAI7B,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,UAAW,YAAW,WAAW;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgC;IAC1D,+FAA+F;IAC/F,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,wEAAwE;IACxE,OAAO,CAAC,MAAM,CAA2B;IACzC,sFAAsF;IACtF,OAAO,CAAC,QAAQ,CAAwB;gBAGtC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAC/B,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,SAAS,UAAU,CAAC,OAAO,EAAE,EACvC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAQjC,4CAA4C;IAC5C,WAAW,IAAI,SAAS,UAAU,CAAC,OAAO,EAAE;IAI5C,0CAA0C;IAC1C,SAAS,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;IAIpC,2CAA2C;IAC3C,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM;IAMlC,4CAA4C;IAC5C,WAAW,IAAI,MAAM;IAKrB,+CAA+C;IAC/C,cAAc,IAAI,MAAM;IAKxB,0CAA0C;IAC1C,SAAS,IAAI,OAAO;IASpB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,aAAa;IA+BrB,wCAAwC;IACxC,OAAO,IAAI,KAAK;IAIhB,yCAAyC;IACzC,QAAQ,IAAI,UAAU;IAStB,yCAAyC;IACzC,QAAQ,IAAI,MAAM;IAIlB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,8CAA8C;IAC9C,IAAI,aAAa,IAAI,IAAI,CAAiB;CAC3C;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAY,YAAW,YAAY;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgC;IAC1D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA2C;IACpE,OAAO,CAAC,QAAQ,CAA6B;IAC7C,qFAAqF;IACrF,OAAO,CAAC,MAAM,CAA2B;gBAGvC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAC/B,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,SAAS,UAAU,CAAC,OAAO,EAAE,EACvC,OAAO,CAAC,EAAE,UAAU,CAAC,iBAAiB;IAQxC,6CAA6C;IAC7C,WAAW,IAAI,SAAS,UAAU,CAAC,OAAO,EAAE;IAI5C,0CAA0C;IAC1C,QAAQ,IAAI,UAAU;IAStB,0CAA0C;IAC1C,QAAQ,IAAI,MAAM;IAIlB,mDAAmD;IAClD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,WAAW,CAAC;IAInD;;;OAGG;IACH,OAAO,CAAC,YAAY;IAgBpB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED,gDAAgD;IAChD,IAAI,cAAc,IAAI,IAAI,CAAiB;CAC5C"}

package/types/src/sheet/ICellContainerOptions.d.ts

@@ -0,0 +1,97 @@
+import { IRuntime } from '@sheetxl/primitives';
+import { ITransaction } from '../transaction';
+import { IResourceCollection } from '../resource';
+import { IStringCollection } from '../string';
+import { ICellRange } from '../cellRange';
+import { INamedCollection } from '../named';
+import { IStyleCollection } from '../style';
+import { ICalculation } from '../calculation';
+import { IWorkbook } from '../workbook';
+/**
+ * Contains a set of resources that can be shared across multiple cell containers.
+ *
+ * @remarks
+ * Used by both workbooks and sheets.
+ */
+export interface ICellContainerOptions {
+    /**
+     * If `true` then the model is readonly and cannot be save.
+     *
+     * @defaultValue false
+     *
+     * @remarks
+     * Useful when you want to load a model for viewing only and prevent any accidental changes.
+     */
+    readonly?: boolean;
+    /**
+     * Initialize a cell container with a pre-defined runtime.
+     */
+    runtime?: IRuntime;
+    /**
+     * Option to provide shared strings.
+     */
+    strings?: IStringCollection;
+    /**
+     * Option to provide a shared StyleCollection. If not provided then a new StyleCollection with default theming will be used.
+     */
+    styles?: IStyleCollection;
+    /**
+     * Option to provide shared resources.
+     */
+    resources?: IResourceCollection;
+    /**
+     * Option to provide shared names.
+     *
+     * @remarks
+     * This is not the interface because we want the instance that allows
+     * for adding items other than named ranges.
+     */
+    names?: INamedCollection;
+    /**
+     * Option to provide a custom calculation.
+     */
+    calculation?: ICalculation;
+    /**
+     * If the parent has a workbook
+     */
+    workbook?: IWorkbook;
+    /**
+     * The store for all state changes. This is provided to enable versioning, undo/redo, distributed editing, etc.
+     *
+     * @remarks
+     * If not specified then an internal {@link ITransaction.IStore} will be created.
+     */
+    transactions?: ITransaction.IStore;
+    /**
+     * Allows for address to be resolved in custom ways.
+     *
+     * @remarks
+     * * This should return `null` if unresolvable but only throw and error if it is identified a a parsing error.
+     * * This is used by `INamedCollection` to created named ranges.
+     */
+    resolveRange?: (address?: ICellRange.Address) => ICellRange | null;
+    /**
+     * If `true` then the initial autoFit will not be called.
+     *
+     * @defaultValue `false`
+     *
+     * @remarks
+     * This is useful when loading large sheets where autoFit may be expensive and
+     * the font's are well known.
+     *
+     * * Excel does this with an attribute in the XML knownFonts.
+     */
+    disableLoadAutoFit?: boolean;
+    /**
+     * Opens an external hyperlink (e.g. an `http(s)`/`mailto` cell link).
+     *
+     * @defaultValue `window.open`
+     *
+     * @remarks
+     * In-sheet `#...` navigation is resolved internally and never reaches this callback. Override it to
+     * route links through a host that cannot use `window.open` — e.g. a VS Code webview or an Electron
+     * shell — which open links via their own shell API. On a workbook this applies to all of its sheets.
+     */
+    opener?: (url: string, target?: string, features?: string) => void;
+}
+//# sourceMappingURL=ICellContainerOptions.d.ts.map

package/types/src/sheet/ICellContainerOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICellContainerOptions.d.ts","sourceRoot":"","sources":["../../../../src/sheet/ICellContainerOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAM7C;;;;;GAKG;AAEH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAChC;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC;IACnC;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,KAAK,UAAU,GAAG,IAAI,CAAC;IACnE;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACpE"}