@sheetxl/sdk 0.7.21 → 0.7.23-beta.2

package/types/src/numFmt/IFormatEngine.d.ts

@@ -0,0 +1,149 @@
+import { NumberFormatRef } from './BuiltInFormats';
+/**
+ * The number-format engine boundary.
+ *
+ * Everything that renders an Excel format code — cell rendering, commands,
+ * `TEXT()`, IO, clipboard — goes through this one interface.
+ */
+/** Options for {@link IFormatEngine.format}. */
+export interface FormatEngineOptions {
+    /**
+     * Use the 1904 date system.
+     * @defaultValue false
+     */
+    date1904?: boolean;
+    /**
+     * BCP-47 locale tag used for locale-dependent presets
+     * (`Short Date`, `[$-F800]`, ...).
+     * @defaultValue 'en-US'
+     */
+    locale?: string;
+    /**
+     * Collect fill/skip placeholders for width-aware cell rendering.
+     *
+     * When `true`:
+     * - `_x` (skip) and `?` (digit align) emit NOTHING into `text`; each records
+     *   a placeholder whose `char` is the width-reference character
+     *   (`'0'` for digit placeholders).
+     * - `*x` (fill) emits nothing and records a placeholder.
+     * - The section/conditional color is computed.
+     *
+     * When `false`/omitted (plain text output — TEXT(), clipboard, tooltips):
+     * - `_x` and `?` emit a single space; `*x` emits nothing.
+     * - `fills`/`skips`/`color` are `null`.
+     *
+     * @defaultValue false
+     */
+    placeholders?: boolean;
+}
+/**
+ * Structural metadata about a format code, for dialogs/classification.
+ * Mirrors numfmt's `getFormatInfo` (see {@link IFormatEngine.getFormatInfo}).
+ */
+export interface FormatInfo {
+    /** Coarse category: `general|number|grouped|currency|percent|scientific|fraction|date|time|datetime|text`. */
+    readonly type: string;
+    /** True if the format renders a date/time. */
+    readonly isDate: boolean;
+    /** True if the format is text-only (`@`). */
+    readonly isText: boolean;
+    /** True if the format scales by 100 and appends `%`. */
+    readonly isPercent: boolean;
+    /** Maximum number of decimal places any section emits. */
+    readonly maxDecimals: number;
+    /** Value multiplier implied by the format (e.g. 100 for percent, 0.001 for `#,##0,`). */
+    readonly scale: number;
+    /** Section color index, or 0. */
+    readonly color: number;
+    /** Non-zero if negatives are parenthesized. */
+    readonly parentheses: number;
+    /** Non-zero if the integer part is thousands-grouped. */
+    readonly grouped: number;
+}
+/** Which date/time components a format renders (numfmt `getFormatDateInfo`). */
+export interface FormatDateInfo {
+    readonly year: boolean;
+    readonly month: boolean;
+    readonly day: boolean;
+    readonly hours: boolean;
+    readonly minutes: boolean;
+    readonly seconds: boolean;
+    /** 12 or 24. */
+    readonly clockType: number;
+}
+/** A fill/skip position within {@link FormatEngineResult.text}. */
+export interface FormatPlaceholder {
+    /** Character offset into the result text. */
+    readonly offset: number;
+    /** The width-reference (skip) or repeated (fill) character. */
+    readonly char: string;
+}
+/** Result of {@link IFormatEngine.format}. */
+export interface FormatEngineResult {
+    /**
+     * The formatted display text, or `null` to signal a display error
+     * (e.g. an out-of-bounds date serial) — the cell renderer shows the
+     * `#` overflow placeholder for `null`.
+     */
+    readonly text: string | null;
+    /**
+     * The section/conditional color as a resolvable color string
+     * (e.g. `'Index9'` for legacy palette colors), or `null`.
+     * Only computed when {@link FormatEngineOptions.placeholders} is set.
+     */
+    readonly color: string | null;
+    /** `*` fill placeholders, or `null`. See {@link FormatEngineOptions.placeholders}. */
+    readonly fills: readonly FormatPlaceholder[] | null;
+    /** `_`/`?` skip placeholders, or `null`. See {@link FormatEngineOptions.placeholders}. */
+    readonly skips: readonly FormatPlaceholder[] | null;
+}
+/**
+ * A number-format engine. Stateless, and safe to share.
+ *
+ * Formats are {@link NumberFormatRef}s: either a format-code string or an
+ * ECMA-376 built-in id (the stored form for built-ins — Excel's own model).
+ * Ids are resolved AFTER the locale-adaptive interception (ids 14/22 render
+ * per the viewer locale, not their canonical codes).
+ */
+export interface IFormatEngine {
+    /** Stable identifier for diagnostics and conformance reports. */
+    readonly key: string;
+    /**
+     * Format a value with an Excel format code or built-in id.
+     *
+     * @throws On malformed/unsupported format codes — callers own the fallback
+     * policy (cell rendering warns and shows empty; conformance records it).
+     */
+    format(format: NumberFormatRef, value: string | number, options?: FormatEngineOptions): FormatEngineResult;
+    /** True if the format contains date tokens. */
+    isDateFormat(format: NumberFormatRef): boolean;
+    /** True if the format contains time tokens. */
+    isTimeFormat(format: NumberFormatRef): boolean;
+    /** True if the format contains fraction formatting. */
+    isFractionFormat(format: NumberFormatRef): boolean;
+    /**
+     * Adjust the decimal places in a format by `amount` (toolbar
+     * increase/decrease decimal). Returns the rewritten format code.
+     */
+    adjustDecimalPlaces(format: NumberFormatRef, amount: number): string;
+    /**
+     * Structural metadata for a format code (category, decimals, grouping, ...),
+     * for format dialogs and classification. `null` if the format is invalid.
+     */
+    getFormatInfo(format: NumberFormatRef): FormatInfo | null;
+    /**
+     * Which date/time components a (date) format renders. `null` for non-date
+     * formats or invalid codes.
+     */
+    getFormatDateInfo(format: NumberFormatRef): FormatDateInfo | null;
+    /** True if the format code parses (usable for live custom-code validation). */
+    isValidFormat(format: NumberFormatRef): boolean;
+}
+/**
+ * The number-format engine.
+ *
+ * Created on first use — this module sits in an import cycle with the engine's
+ * own helpers, so construction must not happen at module-evaluation time.
+ */
+export declare function getFormatEngine(): IFormatEngine;
+//# sourceMappingURL=IFormatEngine.d.ts.map

package/types/src/numFmt/IFormatEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFormatEngine.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/IFormatEngine.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,gDAAgD;AAChD,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,8GAA8G;IAC9G,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,wDAAwD;IACxD,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,gBAAgB;IAChB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B;AAED,mEAAmE;AACnE,MAAM,WAAW,iBAAiB;IAChC,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,8CAA8C;AAC9C,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,sFAAsF;IACtF,QAAQ,CAAC,KAAK,EAAE,SAAS,iBAAiB,EAAE,GAAG,IAAI,CAAC;IACpD,0FAA0F;IAC1F,QAAQ,CAAC,KAAK,EAAE,SAAS,iBAAiB,EAAE,GAAG,IAAI,CAAC;CACrD;AAED,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,iEAAiE;IACjE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,kBAAkB,CAAC;IAC3G,+CAA+C;IAC/C,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC;IAC/C,+CAA+C;IAC/C,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC;IAC/C,uDAAuD;IACvD,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC;IACnD;;;OAGG;IACH,mBAAmB,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACrE;;;OAGG;IACH,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,UAAU,GAAG,IAAI,CAAC;IAC1D;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,cAAc,GAAG,IAAI,CAAC;IAClE,+EAA+E;IAC/E,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC;CACjD;AAMD;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,aAAa,CAE/C"}

package/types/src/numFmt/NumberFormatBuilder.d.ts

@@ -0,0 +1,46 @@
+/** Top-level dialog categories (Date/Time group the Short/Medium/Long variants). */
+export type NumberFormatCategory = 'General' | 'Number' | 'Currency' | 'Accounting' | 'Date' | 'Time' | 'Percentage' | 'Fraction' | 'Scientific' | 'Text' | 'Special' | 'Custom';
+export declare const CATEGORIES: readonly NumberFormatCategory[];
+export declare function isParametricCategory(category: NumberFormatCategory): boolean;
+/** Parameters describing a number format for the dialog. */
+export interface NumberFormatParams {
+    category: NumberFormatCategory;
+    /** Number, Currency, Accounting, Percentage, Scientific. */
+    decimalPlaces?: number;
+    /** Number: thousands separator. */
+    useSeparator?: boolean;
+    /** Currency, Accounting: symbol literal (e.g. `$`). */
+    currencySymbol?: string;
+    /** Number, Currency: negative-number style index (see {@link NEGATIVE_STYLES}). */
+    negativeStyle?: number;
+    /** Date, Time, Fraction, Special, Custom: the chosen/typed format code. */
+    code?: string;
+}
+/**
+ * Negative-number presentation options (Number/Currency), matching Excel's list.
+ * The dialog renders a live sample per entry by building + formatting a negative.
+ */
+export declare const NEGATIVE_STYLES: readonly {
+    key: string;
+    label: string;
+    red: boolean;
+    parens: boolean;
+}[];
+/** Common currency symbols for the Currency/Accounting symbol picker. */
+export declare const CURRENCY_SYMBOLS: readonly string[];
+/** Preset code lists for the list categories (locale-adaptive later — Plane 1). */
+export declare const DATE_PRESETS: readonly string[];
+export declare const TIME_PRESETS: readonly string[];
+export declare const FRACTION_PRESETS: readonly string[];
+export declare const SPECIAL_PRESETS: readonly string[];
+/** Default code seeded when switching to a category. */
+export declare function defaultCodeForCategory(category: NumberFormatCategory): string;
+/** Synthesize an Excel format code from dialog parameters. */
+export declare function build(params: NumberFormatParams): string;
+/**
+ * Best-effort reverse of {@link build}: classify a code and recover the dialog
+ * controls. Round-trips stably for builder-produced codes; for arbitrary codes
+ * it lands on the closest category (Custom as the fallback).
+ */
+export declare function parse(code: string): NumberFormatParams;
+//# sourceMappingURL=NumberFormatBuilder.d.ts.map

package/types/src/numFmt/NumberFormatBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberFormatBuilder.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/NumberFormatBuilder.ts"],"names":[],"mappings":"AAmBA,oFAAoF;AACpF,MAAM,MAAM,oBAAoB,GAC5B,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,GAClE,YAAY,GAAG,UAAU,GAAG,YAAY,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE7E,eAAO,MAAM,UAAU,EAAE,SAAS,oBAAoB,EAGpD,CAAC;AAMH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,OAAO,CAE5E;AAED,4DAA4D;AAC5D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,4DAA4D;IAC5D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mCAAmC;IACnC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,uDAAuD;IACvD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mFAAmF;IACnF,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,2EAA2E;IAC3E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;GAK1B,CAAC;AAEH,yEAAyE;AACzE,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAE5C,CAAC;AAEH,mFAAmF;AACnF,eAAO,MAAM,YAAY,EAAE,SAAS,MAAM,EAGxC,CAAC;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,MAAM,EAGxC,CAAC;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAG5C,CAAC;AACH,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAE3C,CAAC;AAEH,wDAAwD;AACxD,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,MAAM,CAe7E;AAsBD,8DAA8D;AAC9D,wBAAgB,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM,CA4BxD;AAyDD;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,kBAAkB,CAgCtD"}

package/types/src/numFmt/NumberFormatParser.d.ts

@@ -0,0 +1,168 @@
+import { IColor } from '../color';
+import { formatValue as _formatValue } from './_NumFmtUtils';
+import { FormatInfo, FormatDateInfo } from './IFormatEngine';
+/**
+ * Options for parsing a NumberFormat.
+ */
+export interface ParserOptions {
+    /**
+     * Call when a repeat char
+     */
+    onRepeatChar?: (offset: number, character: string) => void;
+    /**
+     * The character to add to the formatted string when a spacing character is
+     * introduced.
+     *
+     * @defaultValue ' '
+     */
+    spacingCharacter?: string;
+    /**
+     * When '_' is encountered this is called.
+     */
+    onSpacingChar?: (offset: number, character: string) => void;
+    /**
+     * When '?' this encountered this is called.
+     *
+     * @defaultValue ' '
+     */
+    digitCharacter?: string;
+    onDigitChar?: (offset: number) => void;
+}
+export interface ParsedCharPlaceHolder {
+    offset: number;
+    char: string;
+}
+export declare const ParseRunType: {
+    /**
+     * Contains text.
+     */
+    readonly Text: "text";
+    /**
+     * Indicates the text at this run should repeat.
+     */
+    readonly Repeat: "repeat";
+    /**
+     * Indicates the text at this run should not be displayed but used for measuring white-space.
+     */
+    readonly Spacing: "spacing";
+};
+export type ParseRunType = typeof ParseRunType[keyof typeof ParseRunType];
+export interface ParsedRun {
+    type: ParseRunType;
+    width: number;
+    text: string;
+}
+export interface ParsedRuns {
+    runs: readonly ParsedRun[];
+    readonly length: number;
+    readonly width: number;
+    readonly lastRepeatIndex: number;
+}
+/**
+ * This interface returns rendering information about the formatted text based on the numberFormat.
+ *
+ *  @see
+ *  * {@link https://customformats.com/}
+ *  * {@link https://exceljet.net/custom-number-formats}
+ *  * {@link https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.spreadsheet.numberingformats?view=openxml-2.8.1}
+ */
+export interface Parsed {
+    /**
+     * @remarks
+     * Never null
+     */
+    readonly displayText: string;
+    /**
+     * If provided then there was a formatting error.
+     *
+     * @remarks
+     * If this is not `null` then a character should be displayed.
+     *
+     * This is different then repeatChars in that it will only display the value
+     * and not any additional.
+     */
+    readonly errorPlaceholder: string | null;
+    /**
+     * If there is a conditional color then this is the color to use.
+     */
+    readonly conditionalColor: IColor | null;
+    /**
+     * From the '*' formatChar.
+     * A single character (usually a ' ' but can be anything)
+     *
+     * Repeats the next character in the format enough times to fill the column to its current width.
+     * There shall not be more than one asterisk in one section of the format. If more than one asterisk
+     * appears in one section of the format, all but the last asterisk shall be ignored.
+     * [Example: if the number format is 0*x, and the value 3 is in the cell, the value 3xxxxxx is displayed.
+     * The number of x characters that are displayed in the cell varies based on the width of the column. end example]
+     */
+    readonly repeatChars: ParsedCharPlaceHolder[];
+    /**
+     * From the '_' formatChar.
+     * An array of single characters.
+     *
+     * Skips the width of the next character.
+     * Useful for lining up negative and positive values in different cells of the same column.
+     * [Example: The number format _(0.0_);(0.0) aligns the numbers 2.3 and the column even though the
+     * negative number is enclosed by parentheses. end example]
+     */
+    readonly spacingChars: ParsedCharPlaceHolder[];
+    /**
+     * The displayText broken down into runs. Useful for more complex layouts.
+     */
+    readonly formattedRuns: ParsedRuns;
+    /**
+     * If true then the text could wrap if it doesn't fit.
+     */
+    readonly canWrap: boolean;
+    /**
+     * Returns the value as a javascript date if possible. Will
+     * return null if not possible.
+     */
+    readonly asDate: Date | null;
+    /**
+     * If the format is a date format then this is true.
+     */
+    readonly isDateFormat: boolean;
+    /**
+     * If the format is a time format then this is true.
+     */
+    readonly isTimeFormat: boolean;
+}
+export declare const Parser: Readonly<{
+    /**
+     * Language Code Identifier (LCIDs) are 'embedded' within numberFormat.
+     *
+     * There is the original (being deprecated) format and the new 'locale names' format.
+     * The original format (most widely used at time of writing but being deprecated). Is an 8 digit hex number (xxyyzzzz). If the number is less than this then it is assumed to have
+     * leading 0s. The hex is broken down into 3 parts.
+     * xx - appearance of the number (see)
+     *
+     * Also modern Excel 365 now allows this syntax: [$-lg-CN,xxyy] where lg-CN is the language and country of the locale (replacing zzzz), and xxyy are as defined in the prior answer. Leading zeros are not needed and the whole ,xxyy part is optional.
+     * In addition, a gannen suffix -x-gannen is allowed on Japanese locale codes, which replaces a 1 value (first year of emperor reign) for e formats with 元. For example:
+     */
+    formatValue: typeof _formatValue;
+    /**
+     * Returns true if the format contains fraction formatting.
+     */
+    isFractionFormat: (format: string) => boolean;
+    /**
+     * Adjust the decimal in a format by an amount.
+     *
+     * @param format The format string.
+     * @param amount The number of decimals to adjust by.
+     */
+    adjustDecimalPlaces: (format: string, amount: number) => string;
+    /**
+     * Structural metadata about a format code (category, decimals, grouping, ...),
+     * for format dialogs and classification. `null` if the code is invalid.
+     */
+    getFormatInfo: (format: string) => FormatInfo | null;
+    /**
+     * Which date/time components a date format renders. `null` for non-date codes.
+     */
+    getFormatDateInfo: (format: string) => FormatDateInfo | null;
+    /** True if a format code parses (for live custom-code validation). */
+    isValidFormat: (format: string) => boolean;
+}>;
+//# sourceMappingURL=NumberFormatParser.d.ts.map

package/types/src/numFmt/NumberFormatParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberFormatParser.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/NumberFormatParser.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAmB,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAExF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAE3D;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAE5D;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CACxC;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,eAAO,MAAM,YAAY;IACvB;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,MAAM,OAAO,YAAY,CAAC,CAAC;AAE1E,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,SAAS,SAAS,EAAE,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,MAAM;IAWrB;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B;;;;;;;;OAQG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,qBAAqB,EAAE,CAAC;IAC9C;;;;;;;;OAQG;IACH,QAAQ,CAAC,YAAY,EAAE,qBAAqB,EAAE,CAAC;IAC/C;;OAEG;IACH,QAAQ,CAAC,aAAa,EAAE,UAAU,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;CAChC;AAED,eAAO,MAAM,MAAM;IACjB;;;;;;;;;;OAUG;;IAGH;;OAEG;+BACwB,MAAM,KAAG,OAAO;IAI3C;;;;;OAKG;kCAC2B,MAAM,UAAU,MAAM,KAAG,MAAM;IAI7D;;;OAGG;4BACqB,MAAM,KAAG,UAAU,GAAG,IAAI;IAIlD;;OAEG;gCACyB,MAAM,KAAG,cAAc,GAAG,IAAI;IAI1D,sEAAsE;4BAC9C,MAAM,KAAG,OAAO;EAGxC,CAAC"}

package/types/src/numFmt/NumberFormatStyles.d.ts

@@ -0,0 +1,43 @@
+import { Type } from './NumberFormatType';
+/**
+ * These are only returned if all segments have the same values.
+ */
+export interface StyleConfig {
+    separator?: boolean;
+    decimalPlaces?: number;
+    currencySymbol?: string;
+}
+/**
+ * Returns meta data about the number format.
+ */
+export interface Style {
+    numberFormat: string;
+    /**
+     * Category of format/
+     */
+    formatType: Type;
+    /**
+     * If used in a menu it's the sort oder.
+     * TODO - enrich this since excel and drawMl (charts are slightly different. Union these?)
+     */
+    primary?: number;
+    args?: StyleConfig;
+    regMatch?: RegExp;
+}
+export declare class Styles {
+    /**
+     * Find the style for a numberFormat.
+     */
+    lookupStyle(numberFormat: string | number): Style;
+    /**
+     * Returns an ordered list of a select set of the builtIn FormatCodes.
+     */
+    lookupPrimary(): Style[];
+    /**
+     * Returns all catalog styles for a category (`formatType`), in catalog order.
+     * Used by the format dialog to list a category's preset variants.
+     */
+    lookupByType(formatType: string | Type): Style[];
+    lookupDefault(numberFormatKey: string | Type): string | undefined;
+}
+//# sourceMappingURL=NumberFormatStyles.d.ts.map

package/types/src/numFmt/NumberFormatStyles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberFormatStyles.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/NumberFormatStyles.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAI1C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAC;IACjB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,IAAI,CAAC,EAAE,WAAW,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAmKD,qBAAa,MAAM;IACjB;;OAEG;IACH,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK;IAyCjD;;OAEG;IAEH,aAAa,IAAI,KAAK,EAAE;IAIxB;;;OAGG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,EAAE;IAKhD,aAAa,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS;CAMlE"}

package/types/src/numFmt/NumberFormatType.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Represents the built-in categorization of a number format, or 'Custom' if the format is not recognized as a built-in type.
+ *
+ * Excel has the following:
+ * @see
+ * {@link https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.spreadsheet.numberingformats?view=openxml-2.8.1}
+ */
+export declare const Type: {
+    /**
+     * The default format, displays numbers as entered.
+     */
+    readonly General: "General";
+    /**
+     * Displays numbers with a thousands separator and two decimal places.
+     */
+    readonly Number: "Number";
+    /**
+     * Formats numbers as currency with a currency symbol and two decimal places.
+     */
+    readonly Currency: "Currency";
+    /**
+     * Formats numbers as currency, aligning currency symbols and decimal points in a column.
+     */
+    readonly Accounting: "Accounting";
+    /**
+     * Displays dates in a short format (e.g., "M/d/yyyy").
+     */
+    readonly ShortDate: "Short Date";
+    /**
+     * Displays dates in a long format (e.g., "dddd, MMMM d, yyyy").
+     */
+    readonly LongDate: "Long Date";
+    /**
+     * Displays dates in a medium format (e.g., "d-mmm-yy").
+     */
+    readonly MediumDate: "Medium Date";
+    /**
+     * Displays times in a short format (e.g., "h:mm AM/PM").
+     */
+    readonly ShortTime: "Short Time";
+    /**
+     * Displays times in a medium format (e.g., "h:mm:ss AM/PM").
+     */
+    readonly MediumTime: "Medium Time";
+    /**
+     * Displays times in a long format (e.g., "h:mm:ss.000 AM/PM").
+     */
+    readonly LongTime: "Long Time";
+    /**
+     * Displays numbers with a thousands separator.
+     */
+    readonly Comma: "Comma";
+    /**
+     * Displays numbers as percentages with a percent symbol.
+     */
+    readonly Percentage: "Percentage";
+    /**
+     * Displays numbers as fractions.
+     */
+    readonly Fraction: "Fraction";
+    /**
+     * Displays numbers in scientific notation.
+     */
+    readonly Scientific: "Scientific";
+    /**
+     * Treats the cell content as text, even if it appears to be a number.
+     */
+    readonly Text: "Text";
+    /**
+     * A placeholder for special or custom number formats.
+     */
+    readonly Special: "Special";
+    /**
+     * Indicates a user-defined or custom number format.
+     */
+    readonly Custom: "Custom";
+};
+export type Type = typeof Type[keyof typeof Type];
+//# sourceMappingURL=NumberFormatType.d.ts.map

package/types/src/numFmt/NumberFormatType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumberFormatType.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/NumberFormatType.ts"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,eAAO,MAAM,IAAI;IACf;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;CAEK,CAAC;AACX,MAAM,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC"}

package/types/src/numFmt/NumfmtFormatEngine.d.ts

@@ -0,0 +1,33 @@
+import { NumberFormatRef } from './BuiltInFormats';
+import { FormatEngineOptions, FormatEngineResult, FormatInfo, FormatDateInfo, IFormatEngine } from './IFormatEngine';
+/**
+ * The SheetXL number-format engine.
+ *
+ * Renders Excel format codes — and ECMA-376 built-in ids — to display text,
+ * section color, and the fill/skip placeholders the cell renderer uses for
+ * width-aware alignment.
+ *
+ * Locale-adaptive presets (`Short Date`, `[$-F800]`, ...) are resolved before
+ * the format code reaches the formatter, so built-ins such as `14`/`22` render
+ * per the viewer's locale rather than their canonical codes.
+ */
+export declare class NumfmtFormatEngine implements IFormatEngine {
+    readonly key: string;
+    /** @inheritdoc IFormatEngine.format */
+    format(format: NumberFormatRef, value: string | number, options?: FormatEngineOptions): FormatEngineResult;
+    /** @inheritdoc IFormatEngine.isDateFormat */
+    isDateFormat(format: NumberFormatRef): boolean;
+    /** @inheritdoc IFormatEngine.isTimeFormat */
+    isTimeFormat(format: NumberFormatRef): boolean;
+    /** @inheritdoc IFormatEngine.isFractionFormat */
+    isFractionFormat(format: NumberFormatRef): boolean;
+    /** @inheritdoc IFormatEngine.adjustDecimalPlaces */
+    adjustDecimalPlaces(format: NumberFormatRef, amount: number): string;
+    /** @inheritdoc IFormatEngine.getFormatInfo */
+    getFormatInfo(format: NumberFormatRef): FormatInfo | null;
+    /** @inheritdoc IFormatEngine.getFormatDateInfo */
+    getFormatDateInfo(format: NumberFormatRef): FormatDateInfo | null;
+    /** @inheritdoc IFormatEngine.isValidFormat */
+    isValidFormat(format: NumberFormatRef): boolean;
+}
+//# sourceMappingURL=NumfmtFormatEngine.d.ts.map

package/types/src/numFmt/NumfmtFormatEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NumfmtFormatEngine.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/NumfmtFormatEngine.ts"],"names":[],"mappings":"AAYA,OAAO,EAA6C,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEnG,OAAO,KAAK,EACV,mBAAmB,EAAE,kBAAkB,EAAqB,UAAU,EAAE,cAAc,EAAE,aAAa,EACtG,MAAM,iBAAiB,CAAC;AA8CzB;;;;;;;;;;GAUG;AAQH,qBAAa,kBAAmB,YAAW,aAAa;IACtD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAY;IAEhC,uCAAuC;IACvC,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,kBAAkB;IA0G1G,6CAA6C;IAC7C,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO;IAI9C,6CAA6C;IAC7C,YAAY,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO;IAI9C,iDAAiD;IACjD,gBAAgB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO;IAIlD,oDAAoD;IACpD,mBAAmB,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAIpE,8CAA8C;IAC9C,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,UAAU,GAAG,IAAI;IAQzD,kDAAkD;IAClD,iBAAiB,CAAC,MAAM,EAAE,eAAe,GAAG,cAAc,GAAG,IAAI;IAUjE,8CAA8C;IAC9C,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO;CAOhD"}

package/types/src/numFmt/_BuiltInNumberFormats.d.ts

@@ -0,0 +1,12 @@
+import { NumberFormatRef } from './BuiltInFormats';
+/**
+ * Find the default number format string for a format id as defined in OOXML.
+ */
+export declare function _BuiltInNumberFormats(fmtId: number): string;
+/**
+ * Returns the built-in numeric id for a format code, or the code itself if it
+ * is not a built-in. Numeric refs (already ids) pass through unchanged, which
+ * keeps stored ids lossless through the xlsx writer.
+ */
+export declare function _FindBuiltInNumberFormatId(fmtString: NumberFormatRef): string | number | undefined;
+//# sourceMappingURL=_BuiltInNumberFormats.d.ts.map

package/types/src/numFmt/_BuiltInNumberFormats.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_BuiltInNumberFormats.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/_BuiltInNumberFormats.ts"],"names":[],"mappings":"AACA,OAAO,EAA8C,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEpG;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAS3D;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAclG"}

package/types/src/numFmt/_FormatCell.d.ts

@@ -0,0 +1,52 @@
+import { ScalarType, Scalar, IRuntime } from '@sheetxl/primitives';
+import { IColor } from '../color';
+import { IStyle } from '../style';
+import { NumberFormatRef } from './BuiltInFormats';
+import { Parsed, ParserOptions } from './NumberFormatParser';
+export declare function parseNumberFormat(runtime: IRuntime, value: Scalar, style: IStyle, type: ScalarType, numberFormat: NumberFormatRef, parseColor: (val: any) => IColor): Parsed;
+/**
+ * The unformatted text for a number.
+ *
+ * Excel's binary→decimal conversion is 15 significant digits, rounded (`PI()` echoes in the
+ * formula bar as `3.14159265358979`, `2/3` as `0.666666666666667`); JavaScript's `String()`
+ * emits the shortest round-trip form — up to 17 digits. Round through `toPrecision(15)` to
+ * match (`Number()` strips the trailing zeros it pads with).
+ *
+ * JavaScript also switches to exponential notation outside `1e-7 .. 1e21` and writes the
+ * exponent marker in lowercase (`1e+30`). Excel spells it uppercase with a signed,
+ * at-least-two-digit exponent (`1E+30`, `1E-07`), so normalize to Excel's spelling.
+ *
+ * Exported for the SHOW FORMULAS text frame, which strips formatting down to the raw value
+ * (measured — see `unformattedNumberText`'s use in `SheetCell.csTextFrame`) and so needs this
+ * number spelling WITHOUT the date/percent conversions `unformattedTextFromCell` applies.
+ *
+ * @internal
+ */
+export declare function unformattedNumberText(value: Scalar): string;
+/**
+ * The text a value shows with formatting stripped ENTIRELY — SHOW FORMULAS' non-formula cell.
+ *
+ * @remarks
+ * A different rule from {@link unformattedTextFromCell} (the formula bar), and the difference is
+ * the point: measured over COM, Excel strips all formatting to the raw value here — a `m/d/yyyy`
+ * cell shows `45292`, `0.00%` shows `0.125` — while the formula bar keeps the date and the percent.
+ * Only the NUMBER SPELLING is shared ({@link unformattedNumberText}).
+ *
+ * The ONE definition of that text: the show-formulas text frame (`SheetCell.csTextFrame`'s
+ * `disabledFormatting` path, which both paint and autoFit measure go through) and
+ * `ICell.GetTextOptions.showFormulas` (what the clipboard writes) both resolve it here, so
+ * what is copied cannot drift from what is painted.
+ *
+ * "Stripped" is about the NUMBER FORMAT, not about localization: a boolean and an error are words,
+ * and Excel shows the spreadsheet language's word (`WAHR`, `#WERT!`) in formula view exactly as it
+ * does everywhere else. JavaScript's own spelling — `'' + value`, i.e. `true`, and an error's
+ * MESSAGE in preference to its label — is never what a cell paints.
+ *
+ * @internal
+ */
+export declare function rawTextFromValue(value: Scalar, type: ScalarType): string;
+/**
+ * Note - Even in the case of unformatted text we do a 'minimum' amount. For example we convert dates and percentages
+ */
+export declare function unformattedTextFromCell(runtime: IRuntime, value: Scalar, type: ScalarType, numberFormat: NumberFormatRef, options?: ParserOptions): string;
+//# sourceMappingURL=_FormatCell.d.ts.map

package/types/src/numFmt/_FormatCell.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_FormatCell.d.ts","sourceRoot":"","sources":["../../../../src/numFmt/_FormatCell.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAgB,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAG3F,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAGvC,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AAIvC,OAAO,EAAuB,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAG7E,OAAO,EAAE,KAAK,MAAM,EAA+C,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAoBpH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,UAAU,EAChB,YAAY,EAAE,eAAe,EAC7B,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,GAC/B,MAAM,CAkLR;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAO3D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,MAAM,CAiBxE;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,QAAQ,EACjB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,UAAU,EAChB,YAAY,EAAE,eAAe,EAC7B,OAAO,CAAC,EAAE,aAAa,GAEtB,MAAM,CAoER"}