@rowsncolumns/utils 9.2.38 → 9.2.40

package/dist/esm/formatter.js

@@ -1,5 +1,6 @@
 import { addLocale, format, formatColor, getFormatDateInfo, getLocale, isDateFormat, isTextFormat, } from "numfmt";
 import { IndexedColors } from "./colors";
+import { excelNumberPrePass } from "./excel-number-format";
 /**
  * Pattern-based type inference (Excel parity). xlsx files routinely carry
  * a `numberFormat.pattern` without an accompanying `type` field — these
@@ -177,12 +178,145 @@ const localeForPattern = (pattern, locale) => {
     }
     return standalone ? (getStandaloneMonthLocale(locale) ?? locale) : locale;
 };
+const shortAmPmLocales = new Map();
+/**
+ * Excel's `A/P` renders one letter (`6:00 P`) in every locale, but numfmt
+ * honours the short form only when no locale is passed — under a locale it
+ * emits that locale's full designator (`6:00 PM`). Patterns with `A/P` render
+ * under a companion locale whose AM/PM designators are `A`/`P`. `locale` is a
+ * BCP 47 tag or an Excel LCID (`409`), as numfmt accepts both.
+ */
+const getShortAmPmLocale = (locale) => {
+    const cached = shortAmPmLocales.get(locale);
+    if (cached !== undefined)
+        return cached;
+    let overlay = locale;
+    try {
+        overlay = `ampm_${locale.replace(/[^a-z\d]/gi, "")}`;
+        addLocale({ ...(getLocale(locale) ?? {}), ampm: ["A", "P"] }, overlay);
+    }
+    catch {
+        overlay = locale;
+    }
+    shortAmPmLocales.set(locale, overlay);
+    return overlay;
+};
+/**
+ * An Excel `[$-LCID]` / `[$symbol-LCID]` token pins the section's locale, and
+ * numfmt resolves it to that LCID's own table — ahead of the companion locale
+ * `ssfFormat` passes, so `[$-409]h:mm A/P` would still render `6:00 PM`.
+ * Re-point a known LCID or tag at its companion (`$-409` → `$-ampm_409`); an
+ * LCID numfmt does not know (`F400`) or one carrying calendar bits stays as
+ * written.
+ */
+const shortAmPmLocaleToken = (token) => {
+    const dash = token.indexOf("-");
+    if (dash < 0)
+        return token;
+    const code = token.slice(dash + 1);
+    const wincode = Number.parseInt(code, 16);
+    if (Number.isFinite(wincode) && wincode & 0xff0000)
+        return token;
+    if (!getLocale(code))
+        return token;
+    return `${token.slice(0, dash + 1)}${getShortAmPmLocale(code)}`;
+};
+/**
+ * Does the pattern carry Excel's short `A/P` marker outside quoted literals,
+ * bracket directives and escapes? Returns the pattern with the marker
+ * upper-cased (Excel accepts `a/p` and renders it `A`/`P`; numfmt only
+ * tokenizes `A/P`) and its `[$-LCID]` tokens re-pointed at the companion
+ * `A`/`P` locale, or `undefined` when there is none.
+ */
+export const withShortAmPmMarker = (pattern) => {
+    const chunks = [];
+    const localeChunks = [];
+    let found = false;
+    let inQuotes = false;
+    let inBrackets = false;
+    for (let i = 0; i < pattern.length; i++) {
+        const char = pattern[i];
+        if (inQuotes) {
+            inQuotes = char !== '"';
+        }
+        else if (inBrackets) {
+            inBrackets = char !== "]";
+        }
+        else if (char === '"') {
+            inQuotes = true;
+        }
+        else if (char === "[") {
+            const end = pattern[i + 1] === "$" ? pattern.indexOf("]", i) : -1;
+            if (end > 0) {
+                localeChunks.push(chunks.length);
+                chunks.push(pattern.slice(i + 1, end));
+                i = end;
+                continue;
+            }
+            inBrackets = true;
+        }
+        else if (char === "\\" || char === "_" || char === "*") {
+            chunks.push(char + (pattern[i + 1] ?? ""));
+            i++;
+            continue;
+        }
+        else if ((char === "A" || char === "a") &&
+            pattern[i + 1] === "/" &&
+            (pattern[i + 2] === "P" || pattern[i + 2] === "p")) {
+            chunks.push("A/P");
+            found = true;
+            i += 2;
+            continue;
+        }
+        chunks.push(char);
+    }
+    if (!found)
+        return undefined;
+    for (const index of localeChunks) {
+        chunks[index] = `[${shortAmPmLocaleToken(chunks[index])}]`;
+    }
+    return chunks.join("");
+};
+const shortAmPmPatternCache = new Map();
+const DEFAULT_SEPARATORS = { decimal: ".", group: "," };
+const separatorsFor = (locale) => {
+    if (!locale)
+        return DEFAULT_SEPARATORS;
+    const l10n = getLocale(locale);
+    if (!l10n)
+        return DEFAULT_SEPARATORS;
+    return {
+        decimal: l10n.decimal ?? ".",
+        group: l10n.group ?? ",",
+    };
+};
 export const ssfFormat = (pattern, value, locale) => {
     try {
+        let shortAmPm = shortAmPmPatternCache.get(pattern);
+        if (shortAmPm === undefined && !shortAmPmPatternCache.has(pattern)) {
+            shortAmPm = withShortAmPmMarker(pattern);
+            shortAmPmPatternCache.set(pattern, shortAmPm);
+        }
+        const code = shortAmPm ?? pattern;
+        let patternLocale = localeForPattern(pattern, locale);
+        if (shortAmPm !== undefined && patternLocale) {
+            patternLocale = getShortAmPmLocale(patternLocale);
+        }
+        const options = { locale: patternLocale };
+        if (typeof value === "number") {
+            // Excel decides rounding, `General`, huge magnitudes and conditional
+            // sections from the 15-significant-digit decimal, not the binary
+            // double (#546 U8 / U21).
+            const pre = excelNumberPrePass(code, value, separatorsFor(locale), (section, sectionValue) => format(section, sectionValue, options));
+            if (pre.text !== undefined) {
+                return pre.text;
+            }
+            value = pre.value;
+        }
         const isNegativeElapsedTime = typeof value === "number" &&
             value < 0 &&
             isSingleSectionElapsedTimePattern(pattern);
-        const formatted = format(pattern, isNegativeElapsedTime ? Math.abs(value) : value, { locale: localeForPattern(pattern, locale) });
+        const formatted = format(code, isNegativeElapsedTime ? Math.abs(value) : value, options);
         return isNegativeElapsedTime ? `-${formatted}` : formatted;
     }
     catch (err) {

package/dist/esm/index.d.ts

@@ -9,6 +9,7 @@ export * from "./locale";
 export * from "./date";
 export * from "./log";
 export * from "./array";
+export * from "./excel-number-format";
 export * from "./formatter";
 export * from "./memoize";
 export * from "./cell-data-helpers";
@@ -21,4 +22,6 @@ export * from "./conditional-format";
 export * from "./data-validation";
 export * from "./content-hash";
 export * from "./shared-string-canonical";
+export * from "./keyboard";
+export * from "./sheet-span";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,SAAS,CAAC;AACxB,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC;AACvB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,mBAAmB,CAAC;AAClC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,2BAA2B,CAAC;AAC1C,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}

package/dist/esm/index.js

@@ -9,6 +9,7 @@ export * from "./locale";
 export * from "./date";
 export * from "./log";
 export * from "./array";
+export * from "./excel-number-format";
 export * from "./formatter";
 export * from "./memoize";
 export * from "./cell-data-helpers";
@@ -21,3 +22,5 @@ export * from "./conditional-format";
 export * from "./data-validation";
 export * from "./content-hash";
 export * from "./shared-string-canonical";
+export * from "./keyboard";
+export * from "./sheet-span";

package/dist/esm/keyboard.d.ts

@@ -0,0 +1,28 @@
+type HotkeyEventLike = {
+    key: string;
+    code?: string;
+};
+/**
+ * Map a physical key code (`KeyboardEvent.code`) to the character that key
+ * produces on a US layout: `KeyB` → `b`, `Digit1` → `1`, `Semicolon` → `;`.
+ * Returns undefined for codes that are not a letter, digit or punctuation key.
+ * @param code
+ * @returns
+ */
+export declare const hotkeyKeyFromCode: (code: string | undefined) => string | undefined;
+/**
+ * Layout-independent key to match keyboard shortcuts against.
+ *
+ * - A printable ASCII `event.key` wins, lowercased, so Dvorak/AZERTY users
+ *   keep the shortcut printed on their keys (Excel / Google Sheets parity)
+ *   and Shift no longer changes the letter (`Ctrl+Shift+X` → `x`).
+ * - When the layout produces a non-ASCII character (Cyrillic `и`, Greek `β`,
+ *   Hebrew, or a macOS Option dead character such as `†`), the character is
+ *   derived from the physical key instead: `event.code` `KeyB` → `b`.
+ * - Named keys (`Enter`, `Escape`, `F4`, `ArrowUp`, …) are returned as-is.
+ * @param event
+ * @returns
+ */
+export declare const getHotkeyKey: (event: HotkeyEventLike) => string;
+export {};
+//# sourceMappingURL=keyboard.d.ts.map

package/dist/esm/keyboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyboard.d.ts","sourceRoot":"","sources":["../../keyboard.ts"],"names":[],"mappings":"AAAA,KAAK,eAAe,GAAG;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAqBF;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,GAAG,SAAS,uBAWzD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,eAAe,WAYlD,CAAC"}

package/dist/esm/keyboard.js

@@ -0,0 +1,62 @@
+const PUNCTUATION_BY_CODE = {
+    Backquote: "`",
+    Backslash: "\\",
+    BracketLeft: "[",
+    BracketRight: "]",
+    Comma: ",",
+    Equal: "=",
+    Minus: "-",
+    Period: ".",
+    Quote: "'",
+    Semicolon: ";",
+    Slash: "/",
+};
+const isPrintableAscii = (key) => {
+    const charCode = key.charCodeAt(0);
+    return charCode >= 0x20 && charCode <= 0x7e;
+};
+/**
+ * Map a physical key code (`KeyboardEvent.code`) to the character that key
+ * produces on a US layout: `KeyB` → `b`, `Digit1` → `1`, `Semicolon` → `;`.
+ * Returns undefined for codes that are not a letter, digit or punctuation key.
+ * @param code
+ * @returns
+ */
+export const hotkeyKeyFromCode = (code) => {
+    if (!code) {
+        return undefined;
+    }
+    if (/^Key[A-Z]$/.test(code)) {
+        return code.charAt(3).toLowerCase();
+    }
+    if (/^Digit[0-9]$/.test(code)) {
+        return code.charAt(5);
+    }
+    return PUNCTUATION_BY_CODE[code];
+};
+/**
+ * Layout-independent key to match keyboard shortcuts against.
+ *
+ * - A printable ASCII `event.key` wins, lowercased, so Dvorak/AZERTY users
+ *   keep the shortcut printed on their keys (Excel / Google Sheets parity)
+ *   and Shift no longer changes the letter (`Ctrl+Shift+X` → `x`).
+ * - When the layout produces a non-ASCII character (Cyrillic `и`, Greek `β`,
+ *   Hebrew, or a macOS Option dead character such as `†`), the character is
+ *   derived from the physical key instead: `event.code` `KeyB` → `b`.
+ * - Named keys (`Enter`, `Escape`, `F4`, `ArrowUp`, …) are returned as-is.
+ * @param event
+ * @returns
+ */
+export const getHotkeyKey = (event) => {
+    const { key, code } = event;
+    if (key.length === 1) {
+        if (isPrintableAscii(key)) {
+            return key.toLowerCase();
+        }
+        const keyFromCode = hotkeyKeyFromCode(code);
+        if (keyFromCode !== undefined) {
+            return keyFromCode;
+        }
+    }
+    return key;
+};

package/dist/esm/sheet-span.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Sheets covered by a 3-D reference span `first:last` (`Sheet1:Sheet3!A1`):
+ * every name between the two endpoints in tab order, inclusive. Excel spans
+ * the tabs between the endpoints whichever one is written first and matches
+ * sheet names case-insensitively. Returns undefined when an endpoint is not a
+ * sheet (the caller reports #REF!).
+ * @param sheetNames sheet names in tab order
+ * @param first
+ * @param last
+ * @returns
+ */
+export declare const resolveSheetSpan: (sheetNames: readonly string[], first: string, last: string) => string[] | undefined;
+//# sourceMappingURL=sheet-span.d.ts.map

package/dist/esm/sheet-span.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sheet-span.d.ts","sourceRoot":"","sources":["../../sheet-span.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,GAC3B,YAAY,SAAS,MAAM,EAAE,EAC7B,OAAO,MAAM,EACb,MAAM,MAAM,KACX,MAAM,EAAE,GAAG,SAQb,CAAC"}

package/dist/esm/sheet-span.js

@@ -0,0 +1,20 @@
+/**
+ * Sheets covered by a 3-D reference span `first:last` (`Sheet1:Sheet3!A1`):
+ * every name between the two endpoints in tab order, inclusive. Excel spans
+ * the tabs between the endpoints whichever one is written first and matches
+ * sheet names case-insensitively. Returns undefined when an endpoint is not a
+ * sheet (the caller reports #REF!).
+ * @param sheetNames sheet names in tab order
+ * @param first
+ * @param last
+ * @returns
+ */
+export const resolveSheetSpan = (sheetNames, first, last) => {
+    const lower = sheetNames.map((name) => name.toLowerCase());
+    const start = lower.indexOf(first.toLowerCase());
+    const end = lower.indexOf(last.toLowerCase());
+    if (start === -1 || end === -1) {
+        return undefined;
+    }
+    return sheetNames.slice(Math.min(start, end), Math.max(start, end) + 1);
+};

package/dist/esm/tsconfig.esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../array.ts","../../cell-data-helpers.ts","../../color.ts","../../colors.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../formatter.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../selection.ts","../../shared-string-canonical.ts","../../sort.ts","../../string.ts","../../table-styles.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts"],"version":"5.8.3"}
+{"root":["../../array.ts","../../cell-data-helpers.ts","../../color.ts","../../colors.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../excel-number-format.ts","../../formatter.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../keyboard.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../selection.ts","../../shared-string-canonical.ts","../../sheet-span.ts","../../sort.ts","../../string.ts","../../table-styles.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts"],"version":"5.8.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rowsncolumns/utils",
-  "version": "9.2.38",
+  "version": "9.2.40",
   "author": "Vinay M",
   "license": "SEE LICENSE IN LICENSE.md",
   "main": "./dist/cjs/index.js",
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "numfmt": "^3.2.2",
-    "@rowsncolumns/common-types": ">=5.2.30"
+    "@rowsncolumns/common-types": ">=5.2.31"
   },
   "devDependencies": {},
   "peerDependencies": {}