@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/font/IFont.d.ts

@@ -0,0 +1,261 @@
+/**
+ * Namespace for fonts
+ *
+ * {@link IFont}
+ */
+export declare namespace IFont {
+    /**
+     * Specifies the style of the font (normal, italic).
+     */
+    const Style: {
+        /**
+         * The standard, non-italicized font style.
+         */
+        readonly Normal: "normal";
+        /**
+         * The italicized font style.
+         */
+        readonly Italic: "italic";
+    };
+    type Style = typeof Style[keyof typeof Style];
+    /**
+     * Specifies the font scheme, indicating its role in the document's typography.
+     */
+    const Scheme: {
+        /**
+         * The primary font used for headings and major text elements.
+         */
+        readonly Major: "major";
+        /**
+         * The secondary font used for body text and less prominent elements.
+         */
+        readonly Minor: "minor";
+        /**
+         * No specific font scheme is assigned.
+         */
+        readonly None: "none";
+    };
+    type Scheme = typeof Scheme[keyof typeof Scheme];
+    /**
+     * The character set a font was authored against.
+     *
+     * @remarks
+     * These are the Windows `LOGFONT.lfCharSet` values. The character set does not change which
+     * characters a cell contains - the text is always Unicode - it is a hint used to pick a
+     * substitute face when the named one is not installed, so a workbook authored in a Simplified
+     * Chinese locale still resolves to a font with the glyphs it needs.
+     *
+     * Any value in `0-255` is legal; the named ones are the sets Excel writes.
+     */
+    const Charset: {
+        /** Windows-1252 / Latin-1. */
+        readonly Ansi: 0;
+        /** Whatever the system locale implies. */
+        readonly Default: 1;
+        /** The face is a symbol font (Symbol, Wingdings); its code points are not Unicode text. */
+        readonly Symbol: 2;
+        /** Mac OS Roman. */
+        readonly Mac: 77;
+        /** Japanese (Shift-JIS). */
+        readonly ShiftJIS: 128;
+        /** Korean (Wansung). */
+        readonly Hangul: 129;
+        /** Korean (Johab). */
+        readonly Johab: 130;
+        /** Simplified Chinese (GB2312). */
+        readonly GB2312: 134;
+        /** Traditional Chinese (Big5). */
+        readonly ChineseBig5: 136;
+        /** Greek. */
+        readonly Greek: 161;
+        /** Turkish. */
+        readonly Turkish: 162;
+        /** Vietnamese. */
+        readonly Vietnamese: 163;
+        /** Hebrew. */
+        readonly Hebrew: 177;
+        /** Arabic. */
+        readonly Arabic: 178;
+        /** Baltic. */
+        readonly Baltic: 186;
+        /** Cyrillic. */
+        readonly Russian: 204;
+        /** Thai. */
+        readonly Thai: 222;
+        /** Central European. */
+        readonly EastEurope: 238;
+        /** The font's own OEM code page. */
+        readonly Oem: 255;
+    };
+    /**
+     * A {@link IFont.Charset} value. Not narrowed to the named sets - any `0-255` value is legal.
+     */
+    type Charset = number;
+    /**
+     * Specifies the style of underline applied to text.
+     */
+    const UnderlineStyle: {
+        /**
+         * No underline.
+         */
+        readonly None: "none";
+        /**
+         * A double underline.
+         */
+        readonly Double: "double";
+        /**
+         * A double underline used in accounting contexts (typically thicker and below the descenders).
+         */
+        readonly DoubleAccounting: "doubleAccounting";
+        /**
+         * A single underline.
+         */
+        readonly Single: "single";
+        /**
+         * A single underline used in accounting contexts (typically below the descenders).
+         */
+        readonly SingleAccounting: "singleAccounting";
+    };
+    type UnderlineStyle = typeof UnderlineStyle[keyof typeof UnderlineStyle];
+    /**
+     * Vertical alignment of text within a line.
+     * @see
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align}
+     */
+    const VerticalAlignment: {
+        /**
+         * Aligns the baseline of the cell with the baseline of all other cells in the row that are baseline-aligned.
+         */
+        readonly Baseline: "baseline";
+        /**
+         * Aligns the baseline of the element with the subscript-baseline of its parent.
+         */
+        readonly Sub: "sub";
+        /**
+         * Aligns the baseline of the element with the superscript-baseline of its parent.
+         */
+        readonly Super: "super";
+    };
+    type VerticalAlignment = typeof VerticalAlignment[keyof typeof VerticalAlignment];
+    /**
+     * Advanced text metrics.
+     */
+    interface ExtendedMetrics extends Partial<TextMetrics>, Partial<IFont.Metrics> {
+        /**
+         * This is the lineHeight and includes the lineGap
+         */
+        readonly lineHeight: number;
+    }
+    interface Metrics {
+        readonly underlinePosition?: number;
+        readonly underlineThickness?: number;
+        readonly strikePosition?: number;
+        readonly strikeThickness?: number;
+        readonly italicAngle?: number;
+        readonly lineHeight: number;
+        readonly baseline: number;
+        readonly lineGap: number;
+    }
+    interface MetricOptions {
+        isBold?: boolean;
+        isItalic?: boolean;
+        letterSpacing?: number;
+    }
+    interface Measurer {
+        (text: string, size: number, family: string, options?: IFont.MetricOptions): IFont.ExtendedMetrics;
+    }
+    /**
+     * The contract a per-environment measurer module must satisfy. The active default is resolved
+     * via the `@sheetxl/sdk/font/FontMeasurer` conditional export:
+     * `browser` -> canvas, `node` -> fontkit, `default` -> simple (the zero-dependency char counter,
+     * the only universally-safe fallback - never pull a native/node-only measurer through `default`).
+     *
+     * Override the active measurer at runtime with {@link setSharedMeasurer} (e.g. force the simple
+     * measurer in unit tests), or at build time by aliasing the `@sheetxl/sdk/font/FontMeasurer`
+     * import in the bundler config.
+     */
+    interface MeasurerProvider {
+        /** The best measurer for the current environment (may itself fall back to the simple measurer). */
+        getInstance(): IFont.Measurer;
+        /** The device scale for the current environment. */
+        getDeviceScale(): number;
+    }
+    /**
+     * Override the default mechanism for measuring text.
+     *
+     * @param measurer {@link IFont.Measurer}
+     */
+    function setSharedMeasurer(measurer: IFont.Measurer): void;
+    /**
+     * Returns the {@link IFont.Measurer} used for measuring text.
+     *
+     * @see
+     * {@link setSharedMeasurer}
+     */
+    function getSharedMeasurer(): IFont.Measurer;
+    /**
+     * Returns scaling to use for the current device.
+     */
+    function getDeviceScale(): number;
+    /**
+     * Provides a font-family fallback based on the PANOSE hex string.
+     *
+     * @param hexPanose The PANOSE string.
+     * @returns a font-family fallback.
+     */
+    function getPanoseFallback(hexPanose: string): string;
+    /**
+     * Represents a font face, encapsulating information about a specific typeface.
+     */
+    interface IFontFace {
+        /**
+         * Serializes the font face information into a JSON-compatible object.
+         *
+         * @returns A plain JavaScript object representing the font face data.
+         */
+        toJSON(): any;
+        /**
+         * The name of the font face (e.g., 'Arial', 'Times New Roman').
+         */
+        getFamily(): string;
+        /**
+         * The pitch (or classification) of the font face (e.g., 'variable', 'fixed').
+         */
+        getPitch(): string;
+        /**
+         * The Panose classification string for the font face, providing information about its visual characteristics.
+         * @returns `null` if unable to generate.
+         */
+        getPanose(): string | null;
+        /**
+         * Returns a string representation of the font face.
+         */
+        toString(): string;
+        /**
+         * A flag indicating that this object is an `IFont` instance.
+         * Useful for runtime type checking.
+         */
+        readonly isIFont: true;
+    }
+    /**
+     * Font families supported by all/most browsers/platforms.
+     */
+    const GenericName: {
+        readonly Serif: "serif";
+        readonly SanSerif: "sans-serif";
+        readonly MonoSpace: "monospace";
+        readonly Cursive: "cursive";
+        readonly Fantasy: "fantasy";
+        readonly SystemUI: "system-ui";
+        readonly UISystem: "ui-system";
+        readonly UISerif: "ui-serif";
+        readonly UISanSerif: "ui-sans-serif";
+        readonly UIMonoSpace: "ui-monospace";
+        readonly UIRounded: "ui-rounded";
+        readonly Math: "math";
+        readonly Emoji: "emoji";
+        readonly Fangsong: "fangsong";
+    };
+    type GenericName = typeof GenericName[keyof typeof GenericName];
+}
+//# sourceMappingURL=IFont.d.ts.map

package/types/src/font/IFont.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFont.d.ts","sourceRoot":"","sources":["../../../../src/font/IFont.ts"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,yBAAiB,KAAK,CAAC;IACrB;;OAEG;IACI,MAAM,KAAK;QAChB;;WAEG;;QAGH;;WAEG;;KAIK,CAAC;IACX,KAAY,KAAK,GAAG,OAAO,KAAK,CAAC,MAAM,OAAO,KAAK,CAAC,CAAC;IAErD;;OAEG;IACI,MAAM,MAAM;QACjB;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;KAEK,CAAC;IACX,KAAY,MAAM,GAAG,OAAO,MAAM,CAAC,MAAM,OAAO,MAAM,CAAC,CAAC;IAExD;;;;;;;;;;OAUG;IACI,MAAM,OAAO;QAClB,8BAA8B;;QAE9B,0CAA0C;;QAE1C,2FAA2F;;QAE3F,oBAAoB;;QAEpB,4BAA4B;;QAE5B,wBAAwB;;QAExB,sBAAsB;;QAEtB,mCAAmC;;QAEnC,kCAAkC;;QAElC,aAAa;;QAEb,eAAe;;QAEf,kBAAkB;;QAElB,cAAc;;QAEd,cAAc;;QAEd,cAAc;;QAEd,gBAAgB;;QAEhB,YAAY;;QAEZ,wBAAwB;;QAExB,oCAAoC;;KAE5B,CAAC;IACX;;OAEG;IACH,KAAY,OAAO,GAAG,MAAM,CAAC;IAE7B;;OAEG;IACI,MAAM,cAAc;QACzB;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;KAEK,CAAC;IACX,KAAY,cAAc,GAAG,OAAO,cAAc,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;IAEhF;;;;OAIG;IAEI,MAAM,iBAAiB;QAC5B;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;KAEK,CAAC;IACX,KAAY,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,MAAM,OAAO,iBAAiB,CAAC,CAAC;IAEzF;;OAEG;IACH,UAAiB,eAAgB,SAAQ,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QACnF;;WAEG;QACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;KAC7B;IAED,UAAiB,OAAO;QAEtB,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;QACpC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;QACpC,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;QACjC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAA;QAEjC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAE9B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;QAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,aAAa;QAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;IACD,UAAiB,QAAQ;QACvB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,KAAK,CAAC,eAAe,CAAC;KACpG;IAED;;;;;;;;;OASG;IACH,UAAiB,gBAAgB;QAC/B,mGAAmG;QACnG,WAAW,IAAI,KAAK,CAAC,QAAQ,CAAC;QAC9B,oDAAoD;QACpD,cAAc,IAAI,MAAM,CAAC;KAC1B;IAyBD;;;;OAIG;IACH,SAAgB,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,GAAG,IAAI,CAEhE;IAED;;;;;OAKG;IACH,SAAgB,iBAAiB,IAAI,KAAK,CAAC,QAAQ,CAMlD;IAED;;OAEG;IACH,SAAgB,cAAc,IAAI,MAAM,CAEvC;IAED;;;;;OAKG;IAEH,SAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAkC3D;IAED;;OAEG;IACH,UAAiB,SAAS;QACxB;;;;WAIG;QAEH,MAAM,IAAI,GAAG,CAAC;QAEd;;WAEG;QACH,SAAS,IAAI,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,IAAI,MAAM,CAAC;QAEnB;;;WAGG;QACH,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,QAAQ,IAAI,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;KACxB;IAED;;OAEG;IACI,MAAM,WAAW;;;;;;;;;;;;;;;KAed,CAAC;IACX,KAAY,WAAW,GAAG,OAAO,WAAW,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;CAExE"}

package/types/src/font/IFontCollection.d.ts

@@ -0,0 +1,31 @@
+import { IFont } from './IFont';
+export interface FontHandle {
+    /** `null` is used as a cached 'no match' sentinel (see {@link findBestMatch}). */
+    fontRef: IFont.IFontFace | null;
+    loaded: boolean;
+}
+export declare function setFontList(fontList: IFont.IFontFace[] | string[]): void;
+export declare function getFontList(): readonly FontHandle[];
+export interface FindBestMatchOptions {
+    /**
+     * Defaults to false
+     */
+    bold?: boolean;
+    /**
+     * Defaults to false
+     */
+    italic?: boolean;
+    /**
+     * A list of font names or generic font family
+     */
+    fallbacks?: string[];
+    panose?: string;
+}
+/**
+ * Tries to find a font that match the fontName exactly. If this is not found then it will use the fallback
+ * options if provided. If there is no font and no font fallback it will return null.
+ * @param fontName The font name to find
+ * @returns The FontHandle
+ */
+export declare function findBestMatch(fontName: string, options?: FindBestMatchOptions): FontHandle | null;
+//# sourceMappingURL=IFontCollection.d.ts.map

package/types/src/font/IFontCollection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFontCollection.d.ts","sourceRoot":"","sources":["../../../../src/font/IFontCollection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAqDhC,MAAM,WAAW,UAAU;IACzB,kFAAkF;IAClF,OAAO,EAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC;IAChC,MAAM,EAAE,OAAO,CAAC;CACjB;AAQD,wBAAgB,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,EAAE,GAAG,MAAM,EAAE,QA4BjE;AAED,wBAAgB,WAAW,IAAK,SAAS,UAAU,EAAE,CAEpD;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAKD;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,UAAU,GAAG,IAAI,CAmCjG"}

package/types/src/font/SimpleFontMeasurer.d.ts

@@ -0,0 +1,4 @@
+import { IFont } from './IFont';
+export declare function getInstance(): IFont.Measurer;
+export declare function getDeviceScale(): number;
+//# sourceMappingURL=SimpleFontMeasurer.d.ts.map

package/types/src/font/SimpleFontMeasurer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleFontMeasurer.d.ts","sourceRoot":"","sources":["../../../../src/font/SimpleFontMeasurer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAmFhC,wBAAgB,WAAW,IAAI,KAAK,CAAC,QAAQ,CAE5C;AAED,wBAAgB,cAAc,IAAI,MAAM,CAEvC"}

package/types/src/font/_FontUtils.d.ts

@@ -0,0 +1,22 @@
+import { IFont } from './IFont';
+export declare const DefaultMinFontSize: number;
+export declare const DefaultMaxFontSize: number;
+export declare const DefaultMaxFontPrecision: number;
+export declare const DefaultLineHeightMultiplier: number;
+export declare function defaultHorizontalPadding(fontSize: number): number;
+export declare function defaultVerticalPadding(_fontSize: number): number;
+/**
+ * The size to scale a font for super/sub text.
+ * @remarks
+ * **NOT IMPLEMENTED** This should read from the font but is currently hardcoded to `0.6`.
+ * * This will be moved to 'Measurer'
+ */
+export declare function superSubScale(_fontFamily: string, _fontSize?: number, _verticalAlign?: IFont.VerticalAlignment): number;
+/**
+ * The distance in pixels to shift a font for super/sub text.
+ * @remarks
+ * **NOT IMPLEMENTED** This should read from the font but is currently hardcoded to `+1/5 -1/5`.
+ * * This will be moved to 'Measurer'
+ */
+export declare function superSubShift(fontFamily: string, fontSize?: number, verticalAlign?: IFont.VerticalAlignment): number;
+//# sourceMappingURL=_FontUtils.d.ts.map

package/types/src/font/_FontUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_FontUtils.d.ts","sourceRoot":"","sources":["../../../../src/font/_FontUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,eAAO,MAAM,kBAAkB,EAAE,MAAU,CAAC;AAC5C,eAAO,MAAM,kBAAkB,EAAE,MAAY,CAAC;AAC9C,eAAO,MAAM,uBAAuB,EAAE,MAAU,CAAC;AACjD,eAAO,MAAM,2BAA2B,EAAE,MAAY,CAAC;AAEvD,wBAAgB,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAYjE;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAEhE;AAED;;;;;GAKG;AAEH,wBAAgB,aAAa,CAC3B,WAAW,EAAE,MAAM,EACnB,SAAS,CAAC,EAAE,MAAM,EAClB,cAAc,CAAC,EAAE,KAAK,CAAC,iBAAiB,GACvC,MAAM,CAER;AAED;;;;;GAKG;AAEH,wBAAgB,aAAa,CAC3B,UAAU,EAAE,MAAM,EAClB,QAAQ,CAAC,EAAE,MAAM,EACjB,aAAa,CAAC,EAAE,KAAK,CAAC,iBAAiB,GACtC,MAAM,CAWR"}

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

@@ -0,0 +1,5 @@
+export * as IFontCollection from './IFontCollection';
+export * from './IFont';
+export * from './Font';
+export * as FontUtils from './FontUtils';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/font/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,eAAe,MAAM,mBAAmB,CAAC;AAErD,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AAEvB,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC"}

package/types/src/history/IHistory.d.ts

@@ -0,0 +1,110 @@
+import { ReferenceableClipboard } from '@sheetxl/utils';
+/**
+ * Encapsulates functionalities crucial for maintaining a comprehensive version history
+ * and audit trail within the spreadsheet application. It provides mechanisms to capture, store,
+ * and manage snapshots of the spreadsheet's state at various points in time.
+ *
+ * The primary motivations behind this namespace are:
+ *
+ * - **Versioning and Undo/Redo**: Maintain a detailed history of changes, allowing for easy rollback or review.
+ * - **Copy/Paste**: Create transferable references.
+ * - **Auditing/Change logs**: Enable accountability by tracking who made changes and when they occurred.
+ * - **Snapshot Management**: Efficiently capture and restore spreadsheet states for backup,
+ *   analysis, or reuse.
+ *
+ * By offering robust versioning and auditing capabilities, this namespace contributes to a more
+ * reliable, transparent, and user-friendly spreadsheet experience.
+ */
+export declare namespace IHistory {
+    /**
+     * Represents an immutable reference to an `Record`, capturing its content and metadata.
+     * @template D The type of the destination for `copyTo`.
+     * @template S The type of the source for `getSource``.
+     * @template C The type of the coordinates the snapshot is bound to.
+     * @template J The type of the JSON for `toJSON`.
+     */
+    interface ISnapshot<D = any, S = any, C = any, J = any> {
+        /**
+         * Copies the snapshot to the specified range.
+         *
+         * @param destination The destination `Snapshot source` where the snapshot will be copied.
+         * @param options {@link IHistory.CopyToOptions}
+         *
+         * @returns A promise that resolves when the copy is complete, or `void` if no asynchronous operation is required.
+         */
+        copyTo(destination: D, options?: IHistory.CopyToOptions): Promise<C> | C;
+        /**
+         * The source that created the snapshot.
+         * This is used to quickly do comparisons.
+         */
+        getSource(): S;
+        /**
+         * Retrieves the coordinates that bound the current snapshot.
+         *
+         * @remarks
+         * Different types of snapshots may have different coordinate systems.
+         */
+        getCoords?(): Readonly<C>;
+        /**
+         * Converts the snapshot to a plain text representation.
+         *
+         * @returns A string or promise resolving to the text representation of the snapshot.
+         */
+        toText?(): Promise<string> | string;
+        /**
+         * Converts the snapshot to an HTML representation.
+         *
+         * @returns A string or promise resolving to the HTML representation of the snapshot.
+         */
+        toHtml?(): Promise<string> | string;
+        /**
+         * Converts the snapshot to an image blob.
+         *
+         * @returns A `Blob` or promise resolving to the image representation of the snapshot.
+         */
+        toImage?(): Promise<Blob> | Blob;
+        /**
+         * Converts the snapshot to a JSON object.
+         *
+         * @returns A JSON object or promise resolving to the JSON representation of the snapshot.
+         */
+        toJSON?(): Promise<J> | J;
+        /**
+         * A user friendly name of a the snapshot item.
+         */
+        getName?(): string;
+        /**
+         * Return the options used when creating.
+         * @remarks
+         * This is done so that we can create a copy.
+         */
+        getMarkOptions(): ReferenceableClipboard.CopyOptions;
+        /**
+         * For runtime type checking.
+         */
+        readonly isISnapshot: true;
+    }
+    /**
+     * Options for creating {@link IHistory.ISnapshot}.
+     * **PLACEHOLDER**
+     */
+    interface GetSnapshotOptions {
+    }
+    /**
+     * Copy options for {@link IHistory.ISnapshot}.
+     * **PLACEHOLDER**
+     */
+    interface CopyToOptions extends GetSnapshotOptions {
+    }
+    /**
+     * Interface for objects that supports returning ISnapshot.
+     */
+    interface ISnapshotSource<D = any, S = any, C = any, J = any> {
+        /**
+         * Represents an immutable reference to an `ICellRange`, capturing its content and metadata.
+         * It may include complex objects such as tables, shapes, images, listeners, or other items.
+         */
+        getSnapshot(options?: ReferenceableClipboard.CopyOptions): IHistory.ISnapshot<D, S, C, J>;
+    }
+}
+//# sourceMappingURL=IHistory.d.ts.map

package/types/src/history/IHistory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHistory.d.ts","sourceRoot":"","sources":["../../../../src/history/IHistory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAE7D;;;;;;;;;;;;;;;GAeG;AAEH,yBAAiB,QAAQ,CAAC;IACxB;;;;;;OAMG;IACH,UAAiB,SAAS,CAAC,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG;QACnD;;;;;;;WAOG;QACH,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACzE;;;WAGG;QACH,SAAS,IAAI,CAAC,CAAC;QACf;;;;;WAKG;QACH,SAAS,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC;QAC1B;;;;WAIG;QACH,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;QACpC;;;;WAIG;QACH,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;QACpC;;;;WAIG;QACH,OAAO,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACjC;;;;WAIG;QACH,MAAM,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC1B;;WAEG;QACH,OAAO,CAAC,IAAI,MAAM,CAAC;QACnB;;;;WAIG;QAEH,cAAc,IAAI,sBAAsB,CAAC,WAAW,CAAC;QACrD;;WAEG;QACH,QAAQ,CAAC,WAAW,EAAE,IAAI,CAAC;KAC5B;IAED;;;OAGG;IACH,UAAiB,kBAAkB;KAClC;IAED;;;OAGG;IAEH,UAAiB,aAAc,SAAQ,kBAAkB;KAExD;IAED;;OAEG;IACH,UAAiB,eAAe,CAAC,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG,EAAE,CAAC,GAAC,GAAG;QACzD;;;WAGG;QACH,WAAW,CAAC,OAAO,CAAC,EAAE,sBAAsB,CAAC,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;KAK3F;CACF"}

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

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

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

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

package/types/src/hyperlink/IHyperlink.d.ts

@@ -0,0 +1,96 @@
+/**
+ * Represents a hyperlink for linking to either a URL or a cell address.
+ */
+export interface IHyperlink {
+    /**
+     * Open the hyperlink.
+     *
+     * @param target Specifies where to open the linked document. DefaultValue `getTarget()`.
+     * @param features Passed to the window open context for external resource.
+     *
+     * @see
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Window/open)
+     */
+    open(target?: '_self' | '_blank', features?: string): Promise<boolean>;
+    /**
+     * The text shown for the link. This is the text of the cell it is attached to,
+     * falling back to `getAddress()` when the cell has none.
+     */
+    getTextToDisplay(): string;
+    /**
+     * Where the link points; a url, a location within this workbook, or both.
+     *
+     * @remarks
+     * The two destinations are folded into this single value and separated by a `#`:
+     *
+     * * `https://sheetxl.com/` - a url.
+     * * `#Sheet1!A1` - a location within this workbook. (nothing precedes the `#`)
+     * * `https://sheetxl.com/#pricing` - a url with a fragment.
+     *
+     * Excel keeps the two apart as an address and a document reference; folding them is
+     * a deliberate difference and a leading `#` is the only way to write an internal link.
+     *
+     * A location within this workbook is a string and not a reference. It does not follow
+     * the cells it points at when rows or columns are inserted, deleted, or moved. (The
+     * cell the link is attached to does move.)
+     */
+    getAddress(): string;
+    /**
+     * Text showing additional information about the link that will be
+     * displayed as a tooltip.
+     *
+     * @remarks
+     * Excel has an undocumented screen tip length limit of 255 characters.
+     */
+    getScreenTip(): string | null;
+    /**
+     * Specifies the target frame to use when opening this hyperlink.
+     *
+     * @remarks
+     * This has no counterpart in Excel; it is ours and applies to links opened in a browser.
+     *
+     * @defaultValue `_self` for a location within this workbook, otherwise `_blank`.
+     */
+    getTarget(): string;
+    /**
+     * For runtime type checking.
+     */
+    readonly isIHyperlink: true;
+}
+/**
+ * {@inheritDoc IHyperlink}
+ * @see
+ * ### **Interface**
+ *
+ * {@link IHyperlink}
+ */
+export declare namespace IHyperlink {
+    /**
+     * Modifiers describe a partial list of properties that can be set with values or shorthand strings.
+     */
+    type Modifiers = Partial<IHyperlink.Properties>;
+    /**
+     * Used when updating the the value.
+     * @see
+     * `ICellRange.setHyperlink`
+     */
+    type Update = IHyperlink.Modifiers | IHyperlink | string | null;
+    /**
+     * Properties available to `IHyperlinks`.
+     */
+    interface Properties {
+        /** {@inheritDoc IHyperlink.getTextToDisplay} */
+        textToDisplay?: string;
+        /** {@inheritDoc IHyperlink.getAddress} */
+        address: string;
+        /** {@inheritDoc IHyperlink.getScreenTip} */
+        screenTip?: string;
+        /** {@inheritDoc IHyperlink.getTarget} */
+        target?: string;
+    }
+    /**
+     * A JSON representation useful for persistence.
+     */
+    type JSON = Partial<Omit<IHyperlink.Properties, 'textToDisplay'>> | string;
+}
+//# sourceMappingURL=IHyperlink.d.ts.map

package/types/src/hyperlink/IHyperlink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IHyperlink.d.ts","sourceRoot":"","sources":["../../../../src/hyperlink/IHyperlink.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvE;;;OAGG;IACH,gBAAgB,IAAI,MAAM,CAAC;IAC3B;;;;;;;;;;;;;;;;OAgBG;IACH,UAAU,IAAI,MAAM,CAAC;IACrB;;;;;;OAMG;IACH,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAC9B;;;;;;;OAOG;IACH,SAAS,IAAI,MAAM,CAAC;IAOpB;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,yBAAiB,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAY,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAEvD;;;;OAIG;IACH,KAAY,MAAM,GAAG,UAAU,CAAC,SAAS,GAAG,UAAU,GAAG,MAAM,GAAG,IAAI,CAAC;IAEvE;;OAEG;IACH,UAAiB,UAAU;QACzB,gDAAgD;QAChD,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,0CAA0C;QAC1C,OAAO,EAAE,MAAM,CAAC;QAChB,4CAA4C;QAC5C,SAAS,CAAC,EAAE,MAAM,CAAC;QAGnB,yCAAyC;QACzC,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IAEH,KAAY,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC;CACnF"}

package/types/src/hyperlink/_Hyperlink.d.ts

@@ -0,0 +1,21 @@
+import { ITypes } from '../type';
+import { IHyperlink } from './IHyperlink';
+export declare class Hyperlink implements IHyperlink {
+    protected _t: () => string;
+    protected _p: IHyperlink.Properties;
+    protected _r: (address: string, options: ITypes.SelectOptions | null, target: string, features?: string) => Promise<boolean>;
+    constructor(textToDisplay: () => string, resolver: (address: string, options: ITypes.SelectOptions | null, target: string, features?: string) => Promise<boolean>, json: IHyperlink.JSON);
+    /** {@inheritDoc IHyperlink.open} */
+    open(target?: '_self' | '_blank', features?: string): Promise<boolean>;
+    /** {@inheritDoc IHyperlink.getTarget} */
+    getTarget(): string;
+    /** {@inheritDoc IHyperlink.getTextToDisplay} */
+    getTextToDisplay(): string;
+    /** {@inheritDoc IHyperlink.getAddress} */
+    getAddress(): string;
+    /** {@inheritDoc IHyperlink.getScreenTip} */
+    getScreenTip(): string | null;
+    /** {@inheritDoc IHyperlink.isIHyperlink} */
+    get isIHyperlink(): true;
+}
+//# sourceMappingURL=_Hyperlink.d.ts.map

package/types/src/hyperlink/_Hyperlink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_Hyperlink.d.ts","sourceRoot":"","sources":["../../../../src/hyperlink/_Hyperlink.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAG/C,qBAAa,SAAU,YAAW,UAAU;IAC1C,SAAS,CAAC,EAAE,EAAE,MAAM,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,EAAE,UAAU,CAAC,UAAU,CAAC;IACpC,SAAS,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBAG3H,aAAa,EAAE,MAAM,MAAM,EAC3B,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,aAAa,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,EACxH,IAAI,EAAE,UAAU,CAAC,IAAI;IAcvB,oCAAoC;IACpC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOtE,yCAAyC;IACzC,SAAS,IAAI,MAAM;IAQnB,gDAAgD;IAChD,gBAAgB,IAAI,MAAM;IAK1B,0CAA0C;IAC1C,UAAU,IAAI,MAAM;IAGpB,4CAA4C;IAC5C,YAAY,IAAI,MAAM,GAAG,IAAI;IAO7B,4CAA4C;IAC5C,IAAI,YAAY,IAAI,IAAI,CAEvB;CACF"}

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

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

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

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