postext 1.14.0 → 1.15.0

package/dist/arabicMarks.js

@@ -0,0 +1,267 @@
+/**
+ * Arabic vowel marks (ḥarakāt, tashkīl) in a laid-out document (#376).
+ *
+ * The marks a vocalised text carries (fatḥa, ḍamma, kasra, tanwīn, sukūn,
+ * shadda, the dagger alef, the Qurʾānic annotation signs) stack over and
+ * under the letters, so the ink of a vocalised line reaches far past the
+ * letters' own ascenders and descenders: a shadda with a fatḥa over a lām
+ * stands about 1.3 em above the baseline in Amiri, a kasra under a final yāʾ
+ * hangs about 0.7 em under it. The line pitch never changes for them, as
+ * for the Chinese marks (`cjkMarks.ts`): they live in the leading. Two
+ * things follow from that.
+ *
+ * - The renderers clip each column to its box (`columnClipRect`). The
+ *   first line of a column may hold marks that rise above the column's top
+ *   and the last one marks that hang under its foot; the clip takes them
+ *   in. A line holding marks carries how far its ink reaches
+ *   (`VDTLine.markInk`), measured once here, so every renderer reads the
+ *   same extent without measuring (the PDF backend has no canvas).
+ * - Where the marks of one line meet the ink of the line above or below,
+ *   the paragraph is reported (`arabicMarksExceedLeading`). Two lines are
+ *   compared word by word: a mark over a word of the lower line only
+ *   collides with what hangs under the words of the upper line standing
+ *   above it, which keeps tall marks on an alif from being reported against
+ *   a descender at the other end of the line. Ink boxes are what the
+ *   measurer gives (`TextMetrics.actualBoundingBox*`); without them (no
+ *   canvas metrics) a word's box is estimated from its size and from the
+ *   marks it holds.
+ *
+ * A document without vowel marks is looked at once per line (one regular
+ * expression test) and left as it was.
+ */
+import { measureInkBox } from './measure/canvas';
+import { fontEm } from './measure/vertical';
+import { segmentFont, segmentPositions } from './cjkMarks';
+/** The combining marks of Arabic vocalisation and Qurʾānic annotation:
+ *  the honorific and Qurʾānic signs U+0610–U+061A, the ḥarakāt and their
+ *  extensions U+064B–U+065F, the superscript (dagger) alef U+0670, the
+ *  small high and low Qurʾānic marks U+06D6–U+06ED (the symbols and
+ *  letters among them left out: U+06DD end of āya, U+06DE rubʿ el-ḥizb,
+ *  U+06E5–U+06E6 small wāw and yāʾ, U+06E9 place of sajda), and the
+ *  extended Arabic marks U+08CA–U+08FF (U+08E2, a format character, left
+ *  out). */
+export const ARABIC_MARK_RE = /[ؐ-ًؚ-ٰٟۖ-ۜ۟-۪ۤۧۨ-ۭ࣊-ࣣ࣡-ࣿ]/;
+/** The marks among {@link ARABIC_MARK_RE} set under the letter: kasra,
+ *  kasratan, hamza below, subscript alef, the dots and small letters below
+ *  of other orthographies, the low Qurʾānic signs. */
+const ARABIC_MARK_BELOW_RE = /[ٍِٕٖٜٟۣ۪ۭ࣏࣍-࣒ࣣࣦࣩ࣭-࣯ࣶࣹࣺ]/;
+/** Arabic-script letters (and marks): what is estimated as Arabic. */
+const ARABIC_SCRIPT_RE = /[؀-ۿݐ-ݿࡰ-ࣿﭐ-﷿ﹰ-]/;
+/** Whether `text` holds an Arabic vowel or Qurʾānic mark. */
+export function hasArabicMarks(text) {
+    return ARABIC_MARK_RE.test(text);
+}
+/**
+ * Estimated ink of a word when the measurer gives no ink metrics, in em
+ * of its font, above and below the baseline. Arabic letters: the Naskh
+ * ascender of alif and lām and the descenders of rāʾ, nūn and yāʾ (about
+ * the typographic ascender and descender of Noto Naskh Arabic, 1.07 and
+ * 0.63 em, less the room those keep for marks); a mark over a letter adds
+ * about a third of an em above it, one under it a fifth below. With the
+ * marks of both sides the box is 1.75 em tall, Amiri's line spacing:
+ * fully vocalised text set solid at that leading touches. Any other text:
+ * a Latin face's ascender and descender.
+ */
+const ESTIMATE = {
+    arabicAscent: 0.8,
+    arabicDescent: 0.45,
+    markAbove: 0.3,
+    markBelow: 0.2,
+    latinAscent: 0.75,
+    latinDescent: 0.25,
+};
+/** Ink boxes measured, per font and text (cleared with each document's
+ *  annotation pass: fonts may have changed between builds). */
+let inkCache = new Map();
+const MAX_INK_ENTRIES = 50_000;
+/** The ink box of `text` set in `font`, px above and below the baseline:
+ *  measured, else estimated (see `ESTIMATE`). */
+export function inkBoxOf(text, font) {
+    const key = `${font}\u0000${text}`;
+    const cached = inkCache.get(key);
+    if (cached)
+        return cached;
+    if (inkCache.size >= MAX_INK_ENTRIES)
+        inkCache = new Map();
+    let ink = measureInkBox(text, font);
+    if (!ink) {
+        const em = fontEm(font);
+        const marks = hasArabicMarks(text);
+        if (ARABIC_SCRIPT_RE.test(text)) {
+            ink = {
+                ascent: em * (ESTIMATE.arabicAscent + (marks && aboveMark(text) ? ESTIMATE.markAbove : 0)),
+                descent: em * (ESTIMATE.arabicDescent + (marks && ARABIC_MARK_BELOW_RE.test(text) ? ESTIMATE.markBelow : 0)),
+            };
+        }
+        else {
+            ink = { ascent: em * ESTIMATE.latinAscent, descent: em * ESTIMATE.latinDescent };
+        }
+    }
+    inkCache.set(key, ink);
+    return ink;
+}
+/** Whether `text` holds a mark set over its letter. */
+function aboveMark(text) {
+    for (const ch of text)
+        if (ARABIC_MARK_RE.test(ch) && !ARABIC_MARK_BELOW_RE.test(ch))
+            return true;
+    return false;
+}
+/** The words of a line with their ink, at the x the renderers paint them
+ *  (the flow order `VDTLine.order` followed when the line has one). Spaces,
+ *  formulas, chips and swatches hold no Arabic and are left out. */
+export function lineWordInks(line, block) {
+    const segments = line.segments;
+    if (!segments || segments.length === 0) {
+        if (!line.text.trim())
+            return [];
+        const ink = inkBoxOf(line.text, block.fontString);
+        return [{ x0: line.bbox.x, x1: line.bbox.x + line.bbox.width, ...ink, marked: hasArabicMarks(line.text) }];
+    }
+    const { xs, widths } = segmentPositions(line, block);
+    const at = xs.slice();
+    if (line.order && line.order.length === segments.length) {
+        let x = xs[0] ?? line.bbox.x;
+        for (const i of line.order) {
+            at[i] = x;
+            x += widths[i];
+        }
+    }
+    const out = [];
+    segments.forEach((seg, i) => {
+        if (seg.kind !== 'text' || !seg.text.trim())
+            return;
+        const ink = inkBoxOf(seg.text, segmentFont(seg, block));
+        const shift = seg.baselineShift ?? 0;
+        out.push({
+            x0: at[i],
+            x1: at[i] + widths[i],
+            ascent: ink.ascent - shift,
+            descent: ink.descent + shift,
+            marked: hasArabicMarks(seg.text),
+        });
+    });
+    return out;
+}
+const round = (v) => Math.round(v * 1000) / 1000;
+/** Two lines' ink may touch by this much (px) before they are reported:
+ *  antialiasing, not a collision. */
+const TOUCH_PX = 0.5;
+/**
+ * Set `VDTLine.markInk` on every line of the document that holds an
+ * Arabic vowel mark, and report the paragraphs where those marks meet the
+ * ink of a neighbouring line of their column (`arabicMarksExceedLeading`,
+ * once per paragraph, on the lower line's paragraph). See the module
+ * comment.
+ */
+export function annotateArabicMarks(doc) {
+    // The document's vowel marks: none, and nothing is done.
+    let any = false;
+    for (const block of doc.blocks) {
+        if (block.type === 'resource' || !block.lines)
+            continue;
+        if (block.lines.some((l) => hasArabicMarks(l.text))) {
+            any = true;
+            break;
+        }
+    }
+    if (!any)
+        return [];
+    inkCache = new Map();
+    /** Lines of the columns that hold a marked line, with their words. */
+    const columns = new Map();
+    const marked = new Set();
+    for (const block of doc.blocks) {
+        if (block.type === 'resource' || block.designOverlay || block.hidden || !block.lines)
+            continue;
+        for (const line of block.lines) {
+            if (!hasArabicMarks(line.text))
+                continue;
+            const words = lineWordInks(line, block);
+            let above = 0;
+            let below = 0;
+            for (const w of words) {
+                if (!w.marked)
+                    continue;
+                above = Math.max(above, w.ascent);
+                below = Math.max(below, w.descent);
+            }
+            if (above > 0 || below > 0)
+                line.markInk = { above: round(above), below: round(below) };
+            if (block.pageIndex >= 0)
+                marked.add(`${block.pageIndex}:${block.columnIndex}`);
+        }
+    }
+    for (const block of doc.blocks) {
+        if (block.type === 'resource' || block.designOverlay || block.hidden || !block.lines || block.pageIndex < 0)
+            continue;
+        const key = `${block.pageIndex}:${block.columnIndex}`;
+        if (!marked.has(key))
+            continue;
+        let column = columns.get(key);
+        if (!column)
+            columns.set(key, (column = []));
+        const em = fontEm(block.fontString);
+        for (const line of block.lines)
+            column.push({ line, block, words: lineWordInks(line, block), em });
+    }
+    const warnings = [];
+    const reported = new Set();
+    for (const column of columns.values()) {
+        column.sort((a, b) => a.line.baseline - b.line.baseline);
+        for (let i = 1; i < column.length; i++) {
+            const a = column[i - 1];
+            const b = column[i];
+            if (reported.has(b.block))
+                continue;
+            const pitch = b.line.baseline - a.line.baseline;
+            if (pitch <= 0)
+                continue;
+            let need = 0;
+            for (const lower of b.words) {
+                for (const upper of a.words) {
+                    if (!lower.marked && !upper.marked)
+                        continue;
+                    if (Math.min(lower.x1, upper.x1) - Math.max(lower.x0, upper.x0) <= 0)
+                        continue;
+                    need = Math.max(need, lower.ascent + upper.descent);
+                }
+            }
+            if (need <= pitch + TOUCH_PX)
+                continue;
+            reported.add(b.block);
+            const block = b.block;
+            const sourceStart = block.sourceStart ?? block.lines[0]?.sourceStart;
+            warnings.push({
+                kind: 'arabicMarksExceedLeading',
+                text: b.line.text,
+                lineHeightEm: round(pitch / b.em),
+                neededEm: round(need / b.em),
+                ...(sourceStart !== undefined ? { sourceStart } : {}),
+                ...(block.sourceEnd !== undefined ? { sourceEnd: block.sourceEnd } : {}),
+                pageIndex: block.pageIndex,
+            });
+        }
+    }
+    return warnings;
+}
+/** How far the vowel marks of a column's lines reach above `y0` (its top)
+ *  and below `y1` (its foot), px (`VDTLine.markInk`; 0 when they stay
+ *  inside). */
+export function markInkOverhang(blocks, y0, y1) {
+    let above = 0;
+    let below = 0;
+    for (const block of blocks) {
+        if (block.hidden || !block.lines)
+            continue;
+        for (const line of block.lines) {
+            const ink = line.markInk;
+            if (!ink)
+                continue;
+            above = Math.max(above, y0 - (line.baseline - ink.above));
+            below = Math.max(below, line.baseline + ink.below - y1);
+        }
+    }
+    return [above, below];
+}
+//# sourceMappingURL=arabicMarks.js.map

package/dist/arabicMarks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabicMarks.js","sourceRoot":"","sources":["../src/arabicMarks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE3D;;;;;;;YAOY;AACZ,MAAM,CAAC,MAAM,cAAc,GAAG,4BAA4B,CAAC;AAE3D;;sDAEsD;AACtD,MAAM,oBAAoB,GAAG,0BAA0B,CAAC;AAExD,sEAAsE;AACtE,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAE7C,6DAA6D;AAC7D,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,GAAG;IACjB,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,GAAG;IACd,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;CACV,CAAC;AAQX;+DAC+D;AAC/D,IAAI,QAAQ,GAAG,IAAI,GAAG,EAAe,CAAC;AACtC,MAAM,eAAe,GAAG,MAAM,CAAC;AAE/B;iDACiD;AACjD,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,IAAY;IACjD,MAAM,GAAG,GAAG,GAAG,IAAI,SAAS,IAAI,EAAE,CAAC;IACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,IAAI,QAAQ,CAAC,IAAI,IAAI,eAAe;QAAE,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;IAC3D,IAAI,GAAG,GAAe,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAChD,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,GAAG,GAAG;gBACJ,MAAM,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,YAAY,GAAG,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1F,OAAO,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,aAAa,GAAG,CAAC,KAAK,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC7G,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,GAAG,QAAQ,CAAC,YAAY,EAAE,CAAC;QACnF,CAAC;IACH,CAAC;IACD,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACvB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,uDAAuD;AACvD,SAAS,SAAS,CAAC,IAAY;IAC7B,KAAK,MAAM,EAAE,IAAI,IAAI;QAAE,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;YAAE,OAAO,IAAI,CAAC;IAClG,OAAO,KAAK,CAAC;AACf,CAAC;AAcD;;oEAEoE;AACpE,MAAM,UAAU,YAAY,CAAC,IAAa,EAAE,KAAgB;IAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC/B,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAClD,OAAO,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7G,CAAC;IACD,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACrD,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC;IACtB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxD,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7B,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC3B,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YACV,CAAC,IAAI,MAAM,CAAC,CAAC,CAAE,CAAC;QAClB,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAc,EAAE,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QAC1B,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO;QACpD,MAAM,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACxD,MAAM,KAAK,GAAG,GAAG,CAAC,aAAa,IAAI,CAAC,CAAC;QACrC,GAAG,CAAC,IAAI,CAAC;YACP,EAAE,EAAE,EAAE,CAAC,CAAC,CAAE;YACV,EAAE,EAAE,EAAE,CAAC,CAAC,CAAE,GAAG,MAAM,CAAC,CAAC,CAAE;YACvB,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,KAAK;YAC1B,OAAO,EAAE,GAAG,CAAC,OAAO,GAAG,KAAK;YAC5B,MAAM,EAAE,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;SACjC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,KAAK,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;AAEjE;qCACqC;AACrC,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAgB;IAClD,yDAAyD;IACzD,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,SAAS;QACxD,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACpD,GAAG,GAAG,IAAI,CAAC;YACX,MAAM;QACR,CAAC;IACH,CAAC;IACD,IAAI,CAAC,GAAG;QAAE,OAAO,EAAE,CAAC;IACpB,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;IACrB,sEAAsE;IACtE,MAAM,OAAO,GAAG,IAAI,GAAG,EAA8E,CAAC;IACtG,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,SAAS;QAC/F,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC;gBAAE,SAAS;YACzC,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YACxC,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,IAAI,KAAK,GAAG,CAAC,CAAC;YACd,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;gBACtB,IAAI,CAAC,CAAC,CAAC,MAAM;oBAAE,SAAS;gBACxB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;gBAClC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;YACrC,CAAC;YACD,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC;gBAAE,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACxF,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC;gBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,SAAS,GAAG,CAAC;YAAE,SAAS;QACtH,MAAM,GAAG,GAAG,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,SAAS;QAC/B,IAAI,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC;QAC7C,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACpC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK;YAAE,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACrG,CAAC;IAED,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAY,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;QACtC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAE,CAAC;YACzB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;YACrB,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC;gBAAE,SAAS;YACpC,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YAChD,IAAI,KAAK,IAAI,CAAC;gBAAE,SAAS;YACzB,IAAI,IAAI,GAAG,CAAC,CAAC;YACb,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;gBAC5B,KAAK,MAAM,KAAK,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;oBAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM;wBAAE,SAAS;oBAC7C,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC;wBAAE,SAAS;oBAC/E,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;gBACtD,CAAC;YACH,CAAC;YACD,IAAI,IAAI,IAAI,KAAK,GAAG,QAAQ;gBAAE,SAAS;YACvC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACtB,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;YACtB,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC;YACrE,QAAQ,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,0BAA0B;gBAChC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI;gBACjB,YAAY,EAAE,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;gBACjC,QAAQ,EAAE,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC;gBAC5B,GAAG,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACrD,GAAG,CAAC,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxE,SAAS,EAAE,KAAK,CAAC,SAAS;aAC3B,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;eAEe;AACf,MAAM,UAAU,eAAe,CAAC,MAA2B,EAAE,EAAU,EAAE,EAAU;IACjF,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,SAAS;QAC3C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC;YACzB,IAAI,CAAC,GAAG;gBAAE,SAAS;YACnB,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YAC1D,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IACD,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACxB,CAAC"}

package/dist/arabicNumberWords.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Arabic numbers in words, for heading templates (`{1:ordinal}`,
+ * `{1:ordinal-feminine}`, `{1:words}`): the ordinal a chapter or a night is
+ * titled with — الفصل الأول, الباب الحادي عشر, الليلة الأولى, الليلة الحادية
+ * بعد الألف — and the cardinal (واحد وعشرون, إحدى عشرة). Both agree in gender
+ * with the noun they count: masculine for فصل, باب, جزء, كتاب; feminine for
+ * ليلة, مقالة, حكاية.
+ *
+ * The forms are those of Modern Standard Arabic as headings print them:
+ * nominative, and for ordinals definite (with ال). Numbers above a hundred
+ * that are not round take the "after" formula of the classical editions
+ * and their modern reprints: 145 الخامس والأربعون بعد المئة, 1001 الحادية
+ * بعد الألف. Hundreds are spelled مئة, as the language academies write
+ * them today, or مائة (`spelling: 'classical'`), as Bulaq and most
+ * Egyptian prints do (ثلاثمائة in one word either way).
+ */
+export type ArabicGender = 'masculine' | 'feminine';
+export type ArabicSpelling = 'modern' | 'classical';
+export interface ArabicWordsOptions {
+    /** The gender of the counted noun. Default `'masculine'`. */
+    gender?: ArabicGender;
+    /** `'classical'` spells the hundreds مائة. Default `'modern'` (مئة). */
+    spelling?: ArabicSpelling;
+}
+/**
+ * `n` as an Arabic cardinal, nominative, counting a noun of `gender`:
+ * واحد / واحدة, اثنان / اثنتان, ثلاثة / ثلاث, أحد عشر / إحدى عشرة, واحد
+ * وعشرون / واحدة وعشرون, مئة وخمسة, ألفان وثلاثمئة. Zero is صفر; past
+ * 99 999, and below zero, the number prints in digits.
+ */
+export declare function arabicCardinal(n: number, options?: ArabicWordsOptions): string;
+/**
+ * `n` as a definite Arabic ordinal, nominative, agreeing with a noun of
+ * `gender`, as a heading names a chapter or a night: الأول / الأولى, الحادي
+ * عشر / الحادية عشرة, الحادي والعشرون / الحادية والعشرون, المئة, الخامس
+ * والأربعون بعد المئة, الحادية بعد المئتين, الخامسة والأربعون بعد الثلاثمئة,
+ * الألف, الحادية بعد الألف. A round hundred or thousand is the definite
+ * number itself (المئتان, الألف والمئة); any other number above 100 is
+ * the ordinal of its last two digits "after" the round part. Past 9 999,
+ * and below 1, the number prints in digits.
+ */
+export declare function arabicOrdinal(n: number, options?: ArabicWordsOptions): string;
+//# sourceMappingURL=arabicNumberWords.d.ts.map

package/dist/arabicNumberWords.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabicNumberWords.d.ts","sourceRoot":"","sources":["../src/arabicNumberWords.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,UAAU,CAAC;AACpD,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEpD,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAkED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,MAAM,CAQlF;AA0CD;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,MAAM,CAajF"}

package/dist/arabicNumberWords.js

@@ -0,0 +1,163 @@
+/**
+ * Arabic numbers in words, for heading templates (`{1:ordinal}`,
+ * `{1:ordinal-feminine}`, `{1:words}`): the ordinal a chapter or a night is
+ * titled with — الفصل الأول, الباب الحادي عشر, الليلة الأولى, الليلة الحادية
+ * بعد الألف — and the cardinal (واحد وعشرون, إحدى عشرة). Both agree in gender
+ * with the noun they count: masculine for فصل, باب, جزء, كتاب; feminine for
+ * ليلة, مقالة, حكاية.
+ *
+ * The forms are those of Modern Standard Arabic as headings print them:
+ * nominative, and for ordinals definite (with ال). Numbers above a hundred
+ * that are not round take the "after" formula of the classical editions
+ * and their modern reprints: 145 الخامس والأربعون بعد المئة, 1001 الحادية
+ * بعد الألف. Hundreds are spelled مئة, as the language academies write
+ * them today, or مائة (`spelling: 'classical'`), as Bulaq and most
+ * Egyptian prints do (ثلاثمائة in one word either way).
+ */
+/** Largest cardinal spelled out; past it the number prints in digits. */
+const MAX_CARDINAL_AR = 99_999;
+/** Largest ordinal spelled out. */
+const MAX_ORDINAL_AR = 9_999;
+// --- Cardinals --------------------------------------------------------------
+/** 1–10 counting a masculine noun (3–10 take the feminine ending, by the
+ *  rule of polarity) and a feminine one. */
+const CARDINAL_UNITS = {
+    masculine: ['', 'واحد', 'اثنان', 'ثلاثة', 'أربعة', 'خمسة', 'ستة', 'سبعة', 'ثمانية', 'تسعة', 'عشرة'],
+    feminine: ['', 'واحدة', 'اثنتان', 'ثلاث', 'أربع', 'خمس', 'ست', 'سبع', 'ثماني', 'تسع', 'عشر'],
+};
+/** 11 and 12: their own forms; 13–19 take the unit of 3–9 above. */
+const CARDINAL_TEENS = {
+    masculine: { eleven: 'أحد عشر', twelve: 'اثنا عشر', ten: 'عشر' },
+    feminine: { eleven: 'إحدى عشرة', twelve: 'اثنتا عشرة', ten: 'عشرة' },
+};
+/** The tens, alike for both genders, nominative (genitive and accusative
+ *  end in ين). */
+const TENS = ['', '', 'عشرون', 'ثلاثون', 'أربعون', 'خمسون', 'ستون', 'سبعون', 'ثمانون', 'تسعون'];
+/** 100–900, nominative: مئتان is the dual (genitive مئتين); 300–900 are
+ *  written as one word. */
+const HUNDREDS = ['', 'مئة', 'مئتان', 'ثلاثمئة', 'أربعمئة', 'خمسمئة', 'ستمئة', 'سبعمئة', 'ثمانمئة', 'تسعمئة'];
+/** The classical spelling of the hundreds: مئة → مائة, مئتان → مائتان,
+ *  ثلاثمئة → ثلاثمائة. */
+function spelled(words, spelling) {
+    return spelling === 'classical' ? words.replace(/مئ/g, 'مائ') : words;
+}
+/** "a and b", the conjunction written onto the next word: ألف ومئة. */
+function joinAnd(parts) {
+    return parts.filter((p) => p.length > 0).join(' و');
+}
+function cardinalBelow100(n, gender) {
+    if (n <= 10)
+        return CARDINAL_UNITS[gender][n];
+    const teens = CARDINAL_TEENS[gender];
+    if (n === 11)
+        return teens.eleven;
+    if (n === 12)
+        return teens.twelve;
+    if (n < 20)
+        return `${CARDINAL_UNITS[gender][n - 10]} ${teens.ten}`;
+    const unit = n % 10;
+    // Units before tens: واحد وعشرون (21).
+    return joinAnd([unit ? CARDINAL_UNITS[gender][unit] : '', TENS[Math.floor(n / 10)]]);
+}
+function cardinalBelow1000(n, gender) {
+    return joinAnd([HUNDREDS[Math.floor(n / 100)], n % 100 ? cardinalBelow100(n % 100, gender) : '']);
+}
+/** The thousands of a cardinal: ألف, ألفان, ثلاثة آلاف … عشرة آلاف (the
+ *  plural, counted as a masculine noun), أحد عشر ألفًا … تسعة وتسعون ألفًا
+ *  (the singular in the accusative). */
+function thousandsWords(k) {
+    if (k === 1)
+        return 'ألف';
+    if (k === 2)
+        return 'ألفان';
+    if (k <= 10)
+        return `${CARDINAL_UNITS.masculine[k]} آلاف`;
+    return `${cardinalBelow100(k, 'masculine')} ألفًا`;
+}
+/**
+ * `n` as an Arabic cardinal, nominative, counting a noun of `gender`:
+ * واحد / واحدة, اثنان / اثنتان, ثلاثة / ثلاث, أحد عشر / إحدى عشرة, واحد
+ * وعشرون / واحدة وعشرون, مئة وخمسة, ألفان وثلاثمئة. Zero is صفر; past
+ * 99 999, and below zero, the number prints in digits.
+ */
+export function arabicCardinal(n, options = {}) {
+    if (!Number.isSafeInteger(n) || n < 0 || n > MAX_CARDINAL_AR)
+        return String(n);
+    if (n === 0)
+        return 'صفر';
+    const gender = options.gender ?? 'masculine';
+    const k = Math.floor(n / 1000);
+    const rest = n % 1000;
+    const words = joinAnd([k ? thousandsWords(k) : '', rest ? cardinalBelow1000(rest, gender) : '']);
+    return spelled(words, options.spelling);
+}
+// --- Ordinals ---------------------------------------------------------------
+const ORDINAL_UNITS = {
+    masculine: ['', 'الأول', 'الثاني', 'الثالث', 'الرابع', 'الخامس', 'السادس', 'السابع', 'الثامن', 'التاسع', 'العاشر'],
+    feminine: ['', 'الأولى', 'الثانية', 'الثالثة', 'الرابعة', 'الخامسة', 'السادسة', 'السابعة', 'الثامنة', 'التاسعة', 'العاشرة'],
+};
+/** The first unit inside a compound ordinal: الحادي عشر, الحادي والعشرون
+ *  (not الأول). */
+function compoundUnit(unit, gender) {
+    if (unit === 1)
+        return gender === 'feminine' ? 'الحادية' : 'الحادي';
+    return ORDINAL_UNITS[gender][unit];
+}
+/** The ordinal 1–99: الأول … العاشر, الحادي عشر … التاسع عشر (feminine:
+ *  الحادية عشرة), العشرون, الحادي والعشرون. 11–19 are indeclinable; the
+ *  tens are nominative. */
+function ordinalBelow100(n, gender) {
+    if (n <= 10)
+        return ORDINAL_UNITS[gender][n];
+    if (n < 20)
+        return `${compoundUnit(n - 10, gender)} ${gender === 'feminine' ? 'عشرة' : 'عشر'}`;
+    const tens = `ال${TENS[Math.floor(n / 10)]}`;
+    const unit = n % 10;
+    return unit === 0 ? tens : joinAnd([compoundUnit(unit, gender), tens]);
+}
+/** A round number (a multiple of 100 below 10 000) made definite, every
+ *  term with ال: المئة, الثلاثمئة, الألف, الألف والمئتان. The duals مئتان
+ *  and ألفان take the genitive (مئتين, ألفين) after بعد. */
+function definiteRound(n, genitive) {
+    const k = Math.floor(n / 1000);
+    const h = Math.floor((n % 1000) / 100);
+    const dual = (word) => (genitive ? word.replace(/ان$/, 'ين') : word);
+    let thousands = '';
+    if (k === 1)
+        thousands = 'الألف';
+    else if (k === 2)
+        thousands = dual('الألفان');
+    else if (k > 2)
+        thousands = `ال${CARDINAL_UNITS.masculine[k]} آلاف`;
+    const hundreds = h === 0 ? '' : h === 2 ? dual('المئتان') : `ال${HUNDREDS[h]}`;
+    return joinAnd([thousands, hundreds]);
+}
+/**
+ * `n` as a definite Arabic ordinal, nominative, agreeing with a noun of
+ * `gender`, as a heading names a chapter or a night: الأول / الأولى, الحادي
+ * عشر / الحادية عشرة, الحادي والعشرون / الحادية والعشرون, المئة, الخامس
+ * والأربعون بعد المئة, الحادية بعد المئتين, الخامسة والأربعون بعد الثلاثمئة,
+ * الألف, الحادية بعد الألف. A round hundred or thousand is the definite
+ * number itself (المئتان, الألف والمئة); any other number above 100 is
+ * the ordinal of its last two digits "after" the round part. Past 9 999,
+ * and below 1, the number prints in digits.
+ */
+export function arabicOrdinal(n, options = {}) {
+    if (!Number.isSafeInteger(n) || n < 1 || n > MAX_ORDINAL_AR)
+        return String(n);
+    const gender = options.gender ?? 'masculine';
+    const rest = n % 100;
+    const round = n - rest;
+    let words;
+    if (round === 0)
+        words = ordinalBelow100(rest, gender);
+    else if (rest === 0)
+        words = definiteRound(round, false);
+    // One after a round number is the compound form, as in 21: الحادي بعد
+    // المئة, الحادية بعد الألف (the alternatives الأولى / الواحدة بعد الألف
+    // are not generated).
+    else
+        words = `${rest === 1 ? compoundUnit(1, gender) : ordinalBelow100(rest, gender)} بعد ${definiteRound(round, true)}`;
+    return spelled(words, options.spelling);
+}
+//# sourceMappingURL=arabicNumberWords.js.map

package/dist/arabicNumberWords.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabicNumberWords.js","sourceRoot":"","sources":["../src/arabicNumberWords.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAYH,yEAAyE;AACzE,MAAM,eAAe,GAAG,MAAM,CAAC;AAC/B,mCAAmC;AACnC,MAAM,cAAc,GAAG,KAAK,CAAC;AAE7B,+EAA+E;AAE/E;4CAC4C;AAC5C,MAAM,cAAc,GAA4C;IAC9D,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;IACnG,QAAQ,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC;CAC7F,CAAC;AAEF,oEAAoE;AACpE,MAAM,cAAc,GAA0E;IAC5F,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE;IAChE,QAAQ,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,EAAE;CACrE,CAAC;AAEF;kBACkB;AAClB,MAAM,IAAI,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;AAEhG;2BAC2B;AAC3B,MAAM,QAAQ,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;AAE9G;0BAC0B;AAC1B,SAAS,OAAO,CAAC,KAAa,EAAE,QAAoC;IAClE,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AACxE,CAAC;AAED,uEAAuE;AACvE,SAAS,OAAO,CAAC,KAAwB;IACvC,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,gBAAgB,CAAC,CAAS,EAAE,MAAoB;IACvD,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,CAAC;IAC/C,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC;IAClC,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,KAAK,CAAC,MAAM,CAAC;IAClC,IAAI,CAAC,GAAG,EAAE;QAAE,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;IACpE,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;IACpB,uCAAuC;IACvC,OAAO,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,IAAI,CAAE,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAE,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,SAAS,iBAAiB,CAAC,CAAS,EAAE,MAAoB;IACxD,OAAO,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC,CAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AACrG,CAAC;AAED;;wCAEwC;AACxC,SAAS,cAAc,CAAC,CAAS;IAC/B,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1B,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAC5B,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;IAC1D,OAAO,GAAG,gBAAgB,CAAC,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,CAAS,EAAE,UAA8B,EAAE;IACxE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,eAAe;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IAC/E,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAC1B,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC;IAC7C,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC;IACtB,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACjG,OAAO,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC1C,CAAC;AAED,+EAA+E;AAE/E,MAAM,aAAa,GAA4C;IAC7D,SAAS,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;IAClH,QAAQ,EAAE,CAAC,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;CAC5H,CAAC;AAEF;mBACmB;AACnB,SAAS,YAAY,CAAC,IAAY,EAAE,MAAoB;IACtD,IAAI,IAAI,KAAK,CAAC;QAAE,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC;IACpE,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAE,CAAC;AACtC,CAAC;AAED;;2BAE2B;AAC3B,SAAS,eAAe,CAAC,CAAS,EAAE,MAAoB;IACtD,IAAI,CAAC,IAAI,EAAE;QAAE,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,CAAC;IAC9C,IAAI,CAAC,GAAG,EAAE;QAAE,OAAO,GAAG,YAAY,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;IAC/F,MAAM,IAAI,GAAG,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;IAC7C,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;IACpB,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;AACzE,CAAC;AAED;;4DAE4D;AAC5D,SAAS,aAAa,CAAC,CAAS,EAAE,QAAiB;IACjD,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC/B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACrF,IAAI,SAAS,GAAG,EAAE,CAAC;IACnB,IAAI,CAAC,KAAK,CAAC;QAAE,SAAS,GAAG,OAAO,CAAC;SAC5B,IAAI,CAAC,KAAK,CAAC;QAAE,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;SACzC,IAAI,CAAC,GAAG,CAAC;QAAE,SAAS,GAAG,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC;IACpE,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/E,OAAO,OAAO,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,CAAS,EAAE,UAA8B,EAAE;IACvE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,cAAc;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IAC9E,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC;IAC7C,MAAM,IAAI,GAAG,CAAC,GAAG,GAAG,CAAC;IACrB,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC;IACvB,IAAI,KAAa,CAAC;IAClB,IAAI,KAAK,KAAK,CAAC;QAAE,KAAK,GAAG,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SAClD,IAAI,IAAI,KAAK,CAAC;QAAE,KAAK,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACzD,sEAAsE;IACtE,wEAAwE;IACxE,sBAAsB;;QACjB,KAAK,GAAG,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,QAAQ,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;IACzH,OAAO,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC1C,CAAC"}

package/dist/arabicNumerals.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Arabic-script numerals, written and read: the Arabic-Indic digits of the
+ * Mashriq (٠١٢٣٤٥٦٧٨٩, U+0660–0669) and the Extended Arabic-Indic digits
+ * of Persian and Urdu (۰۱۲۳۴۵۶۷۸۹, U+06F0–06F9); the additive abjad
+ * numerals of Classical Arabic and manuscript foliation (يا = 11,
+ * غتمو = 1446) in the Mashriqi and the Maghrebi values; and the letter
+ * series that number list items and front matter, in abjad order
+ * (أ ب ج د هـ) and in the alphabetical, hijāʾī order (أ ب ت ث). Also
+ * the reverse for digits: an Arabic author types ٣ where a Latin one
+ * types 3.
+ */
+import type { DigitSystem } from './types';
+/** `n` in Arabic-Indic digits: 2026 → ٢٠٢٦. */
+export declare function arabicIndicDecimal(n: number): string;
+/** `n` in Extended Arabic-Indic (Persian) digits: 2026 → ۲۰۲۶. Urdu writes
+ *  the same code points; its glyph forms come from the font (`locl`). */
+export declare function persianDecimal(n: number): string;
+/**
+ * The ASCII digits of an engine-generated string in the document's digit
+ * system: `'arab'` writes ٠–٩, `'arabext'` ۰–۹, `'latn'` (or none) leaves
+ * the string as it is. Only strings the engine composed go through it — a
+ * page count, a chapter ordinal, the fallback of a list number — never
+ * the author's text.
+ */
+export declare function withDigits(text: string, digits: DigitSystem | undefined): string;
+/** Arabic-Indic (٠–٩) and Extended Arabic-Indic (۰–۹) digits turned into
+ *  ASCII ones, everything else kept: what a number an author typed on an
+ *  Arabic or Persian keyboard (`startAt=٣`, `:::part{number="١٢"}`) is
+ *  read through before `Number()`. */
+export declare function asciiDigits(text: string): string;
+/**
+ * `n` in additive abjad numerals, highest value first in logical order
+ * (the reader sees it right to left): 11 يا, 15 يه, 1446 غتمو, 1835 غضله.
+ * The thousands count is written before the thousand letter (2000 بغ, as
+ * against 1002 غب). `'maghrebi'` takes the Maghrebi values. A final heh
+ * that would stand alone takes a tatweel (5 هـ). Zero has no abjad numeral
+ * and prints nothing; past 999 999 the number prints in digits.
+ */
+export declare function abjadNumeral(n: number, variant?: 'mashriqi' | 'maghrebi'): string;
+/** The 28 letters in abjad order, as list items are lettered in Arabic
+ *  textbooks and outlines (أ، ب، ج، د، هـ…). The first is written with its
+ *  hamza, as a list marker always is: a bare alif reads as the digit ١. */
+export declare const ABJAD_LETTERS: readonly string[];
+/** The 28 letters in alphabetical (hijāʾī) order, the dictionary order of
+ *  today (أ، ب، ت، ث، ج…); the first with its hamza, as above. */
+export declare const HIJAI_LETTERS: readonly string[];
+/**
+ * The `n`th marker of a letter series, by the bijective rule of
+ * `lower-alpha` (z, aa, ab…): past the last letter the series goes on in
+ * two letters (أأ, أب…), then three. A final heh that would stand alone
+ * takes a tatweel (هـ). Zero and below print nothing.
+ */
+export declare function arabicLettering(n: number, letters: readonly string[]): string;
+//# sourceMappingURL=arabicNumerals.d.ts.map

package/dist/arabicNumerals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabicNumerals.d.ts","sourceRoot":"","sources":["../src/arabicNumerals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAK3C,+CAA+C;AAC/C,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;yEACyE;AACzE,wBAAgB,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,CAIhF;AAED;;;sCAGsC;AACtC,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKhD;AAsDD;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,UAAU,GAAG,UAAuB,GAAG,MAAM,CAQ7F;AAMD;;2EAE2E;AAC3E,eAAO,MAAM,aAAa,EAAE,SAAS,MAAM,EAGzC,CAAC;AAEH;kEACkE;AAClE,eAAO,MAAM,aAAa,EAAE,SAAS,MAAM,EAGzC,CAAC;AAEH;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAQ7E"}