@rowsncolumns/utils 9.5.7 → 9.6.1

package/dist/esm/formatter.js

@@ -1,4 +1,5 @@
 import { addLocale, format, formatColor, getFormatDateInfo, getLocale, isDateFormat, isTextFormat, } from "numfmt";
+import { prepareCjkNumberFormat } from "./cjk-number-format";
 import { IndexedColors } from "./colors";
 import { excelNumberPrePass, splitFormatSections, } from "./excel-number-format";
 /**
@@ -498,6 +499,153 @@ const withWorkbookSeparatorsCached = (code, locale) => {
     return rewritten;
 };
 export const ssfFormat = (pattern, value, locale) => {
+    // East Asian tokens numfmt does not render (`[DBNumN]`, Japanese era `g`/`e`,
+    // `aaa` weekdays): rewrite the code to plain literals, then convert the
+    // rendered digits to the `[DBNumN]` numeral system (see cjk-number-format).
+    if (typeof value === "number") {
+        const cjk = prepareCjkNumberFormat(pattern, value, locale);
+        if (cjk)
+            return cjk.finish(ssfFormatBase(cjk.code, value, locale));
+    }
+    return ssfFormatBase(pattern, value, locale);
+};
+const LAYOUT_FILL_MARK = "\uE000";
+const LAYOUT_SKIP_MARK = "\uE001";
+const LAYOUT_LITERAL_SPACE = "\uE002";
+const LAYOUT_DIGIT_PAD = "\u00a0";
+/**
+ * Quote every literal space of `code` as a private-use sentinel so that,
+ * rendered with numfmt's `nbsp` option, the only non-breaking spaces left
+ * in the output are the `?` digit pads.
+ */
+const markLiteralSpaces = (code) => {
+    let out = "";
+    let inQuotes = false;
+    let inBrackets = false;
+    for (let i = 0; i < code.length; i++) {
+        const char = code[i];
+        if (inQuotes) {
+            if (char === '"')
+                inQuotes = false;
+            out += char === " " ? LAYOUT_LITERAL_SPACE : char;
+            continue;
+        }
+        if (inBrackets) {
+            if (char === "]")
+                inBrackets = false;
+            out += char;
+            continue;
+        }
+        if (char === '"') {
+            inQuotes = true;
+        }
+        else if (char === "[") {
+            inBrackets = true;
+        }
+        else if (char === "\\" && code[i + 1] === " ") {
+            out += `"${LAYOUT_LITERAL_SPACE}"`;
+            i++;
+            continue;
+        }
+        else if (char === "\\" || char === "_" || char === "*") {
+            out += char + (code[i + 1] ?? "");
+            i++;
+            continue;
+        }
+        else if (char === " ") {
+            out += `"${LAYOUT_LITERAL_SPACE}"`;
+            continue;
+        }
+        out += char;
+    }
+    return out;
+};
+/** Does the pattern carry a `*` fill, `_` skip or `?` placeholder at all? */
+const LAYOUT_TOKEN_REGEX = /[*_?]/;
+/**
+ * Excel's width-aware number-format output: `*x` repeats `x` to the cell's
+ * width, `_x` reserves the width of `x` and `?` reserves a digit's width
+ * ("Number format codes", support.microsoft.com). A plain formatted string
+ * cannot carry that — `ssfFormat` drops the fill and renders the reserves as
+ * single spaces — so the painter asks for the parts and expands them with
+ * measured glyph widths.
+ *
+ * Returns `undefined` when the pattern has none of those tokens (the plain
+ * string is already exact), and for East Asian numeral codes. The parts'
+ * plain text ({@link numberFormatLayoutText}) equals `ssfFormat`'s output;
+ * callers compare it against the string they paint and ignore the layout
+ * when the two disagree.
+ */
+export const ssfFormatLayout = (pattern, value, locale) => {
+    if (!pattern || !LAYOUT_TOKEN_REGEX.test(pattern))
+        return undefined;
+    if (typeof value === "number" && prepareCjkNumberFormat(pattern, value, locale)) {
+        return undefined;
+    }
+    const raw = ssfFormatBase(pattern, value, locale, {
+        nbsp: true,
+        fillChar: LAYOUT_FILL_MARK,
+        skipChar: LAYOUT_SKIP_MARK,
+        transform: markLiteralSpaces,
+    });
+    if (raw === undefined)
+        return undefined;
+    // A locale whose group separator is itself a non-breaking space makes the
+    // digit pads ambiguous: keep those as plain spaces.
+    const digitPads = separatorsFor(locale).group !== LAYOUT_DIGIT_PAD;
+    const parts = [];
+    let text = "";
+    const flush = () => {
+        if (text)
+            parts.push({ type: "text", text });
+        text = "";
+    };
+    for (let i = 0; i < raw.length; i++) {
+        const char = raw[i];
+        if (char === LAYOUT_FILL_MARK || char === LAYOUT_SKIP_MARK) {
+            const next = raw[i + 1] ?? " ";
+            flush();
+            parts.push({
+                type: char === LAYOUT_FILL_MARK ? "fill" : "skip",
+                char: next,
+            });
+            i++;
+        }
+        else if (char === LAYOUT_DIGIT_PAD) {
+            if (digitPads) {
+                flush();
+                parts.push({ type: "digit" });
+            }
+            else {
+                text += char;
+            }
+        }
+        else if (char === LAYOUT_LITERAL_SPACE) {
+            text += " ";
+        }
+        else {
+            text += char;
+        }
+    }
+    flush();
+    return parts.some((part) => part.type !== "text") ? parts : undefined;
+};
+/**
+ * The plain string a layout stands for — what `ssfFormat` returns for the
+ * same pattern and value: fills drop out, skips and digit pads are one
+ * space each.
+ */
+export const numberFormatLayoutText = (parts) => {
+    let out = "";
+    for (const part of parts) {
+        if (part.type === "text")
+            out += part.text;
+        else if (part.type !== "fill")
+            out += " ";
+    }
+    return out;
+};
+function ssfFormatBase(pattern, value, locale, layout) {
     try {
         if (locale)
             ensureNumfmtLocale(locale);
@@ -506,12 +654,22 @@ export const ssfFormat = (pattern, value, locale) => {
             shortAmPm = withShortAmPmMarker(pattern);
             shortAmPmPatternCache.set(pattern, shortAmPm);
         }
-        const code = withWorkbookSeparatorsCached(shortAmPm ?? pattern, locale);
+        const baseCode = withWorkbookSeparatorsCached(shortAmPm ?? pattern, locale);
+        const code = layout ? layout.transform(baseCode) : baseCode;
         let patternLocale = localeForPattern(pattern, locale);
         if (shortAmPm !== undefined && patternLocale) {
             patternLocale = getShortAmPmLocale(patternLocale);
         }
-        const options = { locale: patternLocale };
+        // numfmt types `fillChar` / `skipChar` as booleans; at runtime they are
+        // the marker strings it emits ahead of the fill / skip character.
+        const options = layout
+            ? {
+                locale: patternLocale,
+                nbsp: layout.nbsp,
+                fillChar: layout.fillChar,
+                skipChar: layout.skipChar,
+            }
+            : { locale: patternLocale };
         if (typeof value === "number") {
             // Excel decides rounding, `General`, huge magnitudes and conditional
             // sections from the 15-significant-digit decimal, not the binary
@@ -529,9 +687,9 @@ export const ssfFormat = (pattern, value, locale) => {
         return isNegativeElapsedTime ? `-${formatted}` : formatted;
     }
     catch (err) {
-        return String(value);
+        return layout ? undefined : String(value);
     }
-};
+}
 /**
  * Excel's legacy fixed 56-color palette used by `[ColorN]` directives
  * inside number format patterns (1-indexed). This palette is INDEPENDENT

package/dist/esm/tsconfig.esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../array.ts","../../cell-data-helpers.ts","../../clipboard-html-sanitize.ts","../../color.ts","../../colors.ts","../../condition-operand.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../excel-number-format.ts","../../formatter.ts","../../formula-locale.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../keyboard.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../rich-text-html.ts","../../rich-text-links.ts","../../selection.ts","../../shared-string-canonical.ts","../../sheet-names.ts","../../sheet-protection.ts","../../sheet-span.ts","../../sort.ts","../../sparkline-groups.ts","../../string.ts","../../table-names.ts","../../table-styles.ts","../../table-totals.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts","../../formula-locale/formula-locale-data.generated.ts"],"version":"5.8.3"}
+{"root":["../../array.ts","../../cell-data-helpers.ts","../../cjk-number-format.ts","../../clipboard-html-sanitize.ts","../../color.ts","../../colors.ts","../../condition-operand.ts","../../conditional-format.ts","../../content-hash.ts","../../data-validation.ts","../../date.ts","../../dom.ts","../../excel-number-format.ts","../../formatter.ts","../../formula-locale.ts","../../formula-refs.ts","../../formula.ts","../../index.ts","../../keyboard.ts","../../locale.ts","../../log.ts","../../memoize.ts","../../numbers.ts","../../rich-text-html.ts","../../rich-text-links.ts","../../selection.ts","../../shared-string-canonical.ts","../../sheet-names.ts","../../sheet-protection.ts","../../sheet-span.ts","../../sort.ts","../../sparkline-groups.ts","../../string.ts","../../table-names.ts","../../table-styles.ts","../../table-totals.ts","../../typeguards.ts","../../uuid.ts","../../vitest.config.ts","../../formula-locale/formula-locale-data.generated.ts"],"version":"5.8.3"}

package/package.json

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