postext 1.14.1 → 1.15.1

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"}

package/dist/arabicNumerals.js

@@ -0,0 +1,143 @@
+/**
+ * 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.
+ */
+const ARABIC_INDIC_ZERO = 0x0660;
+const PERSIAN_ZERO = 0x06f0;
+/** `n` in Arabic-Indic digits: 2026 → ٢٠٢٦. */
+export function arabicIndicDecimal(n) {
+    return String(n).replace(/\d/g, (d) => String.fromCharCode(ARABIC_INDIC_ZERO + Number(d)));
+}
+/** `n` in Extended Arabic-Indic (Persian) digits: 2026 → ۲۰۲۶. Urdu writes
+ *  the same code points; its glyph forms come from the font (`locl`). */
+export function persianDecimal(n) {
+    return String(n).replace(/\d/g, (d) => String.fromCharCode(PERSIAN_ZERO + Number(d)));
+}
+/**
+ * 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 function withDigits(text, digits) {
+    if (!digits || digits === 'latn')
+        return text;
+    const zero = digits === 'arab' ? ARABIC_INDIC_ZERO : PERSIAN_ZERO;
+    return text.replace(/[0-9]/g, (d) => String.fromCharCode(zero + d.charCodeAt(0) - 48));
+}
+/** 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 function asciiDigits(text) {
+    return text.replace(/[٠-٩۰-۹]/g, (d) => {
+        const c = d.charCodeAt(0);
+        return String.fromCharCode(48 + c - (c >= PERSIAN_ZERO ? PERSIAN_ZERO : ARABIC_INDIC_ZERO));
+    });
+}
+// ---------------------------------------------------------------------------
+// Abjad numerals
+// ---------------------------------------------------------------------------
+/** Units, tens and hundreds (index 1–9) and the thousand of the Mashriqi
+ *  abjad (أبجد هوز حطي كلمن سعفص قرشت ثخذ ضظغ). */
+const MASHRIQI = {
+    units: ['', 'ا', 'ب', 'ج', 'د', 'ه', 'و', 'ز', 'ح', 'ط'],
+    tens: ['', 'ي', 'ك', 'ل', 'م', 'ن', 'س', 'ع', 'ف', 'ص'],
+    hundreds: ['', 'ق', 'ر', 'ش', 'ت', 'ث', 'خ', 'ذ', 'ض', 'ظ'],
+    thousand: 'غ',
+};
+/** The Maghrebi abjad (أبجد هوز حطي كلمن صعفض قرست ثخذ ظغش): the same up to
+ *  ن = 50, then ص 60, ض 90, س 300, ظ 800, غ 900 and ش 1000. The W3C
+ *  `maghrebi-abjad` counter lists ض before ع (60) and ص after ف (90); the
+ *  mnemonic صعفض and the reference tables put them the other way round,
+ *  which is what is followed here. */
+const MAGHREBI = {
+    units: MASHRIQI.units,
+    tens: ['', 'ي', 'ك', 'ل', 'م', 'ن', 'ص', 'ع', 'ف', 'ض'],
+    hundreds: ['', 'ق', 'ر', 'س', 'ت', 'ث', 'خ', 'ذ', 'ظ', 'غ'],
+    thousand: 'ش',
+};
+/** Largest abjad numeral written; past it the number prints in digits. */
+const MAX_ABJAD = 999_999;
+/** Letters that join only to the letter before them: a ه written after
+ *  one of them stands alone. */
+const RIGHT_JOINING = new Set(['ا', 'أ', 'إ', 'آ', 'د', 'ذ', 'ر', 'ز', 'و']);
+/**
+ * A heh that would stand alone at the end of a numeral or a list marker —
+ * the whole marker (the fifth item, هـ) or after a letter that does not
+ * join forward (ده) — takes a tatweel, هـ, as Arabic books write it, so it
+ * is not read as the digit ٥. A heh joined to the letter before it (يه,
+ * 15) is clear as it is. The W3C counter styles write ه followed by a
+ * zero-width joiner, which shapes the same in a font that honours the
+ * joiner; the tatweel shapes alike everywhere, and is the form printed
+ * books use.
+ */
+function settleFinalHeh(text) {
+    if (!text.endsWith('ه'))
+        return text;
+    const before = text.slice(-2, -1);
+    return before === '' || RIGHT_JOINING.has(before) ? `${text}ـ` : text;
+}
+function abjadBelow1000(n, table) {
+    return table.hundreds[Math.floor(n / 100)] + table.tens[Math.floor(n / 10) % 10] + table.units[n % 10];
+}
+/**
+ * `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 function abjadNumeral(n, variant = 'mashriqi') {
+    if (!Number.isSafeInteger(n) || n < 1)
+        return '';
+    if (n > MAX_ABJAD)
+        return String(n);
+    const table = variant === 'maghrebi' ? MAGHREBI : MASHRIQI;
+    const thousands = Math.floor(n / 1000);
+    const rest = n % 1000;
+    const head = thousands === 0 ? '' : (thousands === 1 ? '' : abjadBelow1000(thousands, table)) + table.thousand;
+    return settleFinalHeh(head + abjadBelow1000(rest, table));
+}
+// ---------------------------------------------------------------------------
+// Letter series
+// ---------------------------------------------------------------------------
+/** 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 const ABJAD_LETTERS = Object.freeze([
+    'أ', 'ب', 'ج', 'د', 'ه', 'و', 'ز', 'ح', 'ط', 'ي', 'ك', 'ل', 'م', 'ن',
+    'س', 'ع', 'ف', 'ص', 'ق', 'ر', 'ش', 'ت', 'ث', 'خ', 'ذ', 'ض', 'ظ', 'غ',
+]);
+/** The 28 letters in alphabetical (hijāʾī) order, the dictionary order of
+ *  today (أ، ب، ت، ث، ج…); the first with its hamza, as above. */
+export const HIJAI_LETTERS = Object.freeze([
+    'أ', 'ب', 'ت', 'ث', 'ج', 'ح', 'خ', 'د', 'ذ', 'ر', 'ز', 'س', 'ش', 'ص',
+    'ض', 'ط', 'ظ', 'ع', 'غ', 'ف', 'ق', 'ك', 'ل', 'م', 'ن', 'ه', 'و', 'ي',
+]);
+/**
+ * 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 function arabicLettering(n, letters) {
+    if (!Number.isSafeInteger(n) || n < 1)
+        return '';
+    let s = '';
+    for (let x = n; x > 0; x = Math.floor(x / letters.length)) {
+        x -= 1;
+        s = letters[x % letters.length] + s;
+    }
+    return settleFinalHeh(s);
+}
+//# sourceMappingURL=arabicNumerals.js.map

package/dist/arabicNumerals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"arabicNumerals.js","sourceRoot":"","sources":["../src/arabicNumerals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACjC,MAAM,YAAY,GAAG,MAAM,CAAC;AAE5B,+CAA+C;AAC/C,MAAM,UAAU,kBAAkB,CAAC,CAAS;IAC1C,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,iBAAiB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7F,CAAC;AAED;yEACyE;AACzE,MAAM,UAAU,cAAc,CAAC,CAAS;IACtC,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACxF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,MAA+B;IACtE,IAAI,CAAC,MAAM,IAAI,MAAM,KAAK,MAAM;QAAE,OAAO,IAAI,CAAC;IAC9C,MAAM,IAAI,GAAG,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,YAAY,CAAC;IAClE,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;AACzF,CAAC;AAED;;;sCAGsC;AACtC,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC1B,OAAO,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC9F,CAAC,CAAC,CAAC;AACL,CAAC;AAED,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAE9E;mDACmD;AACnD,MAAM,QAAQ,GAAG;IACf,KAAK,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACxD,IAAI,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACvD,QAAQ,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IAC3D,QAAQ,EAAE,GAAG;CACd,CAAC;AAEF;;;;sCAIsC;AACtC,MAAM,QAAQ,GAAG;IACf,KAAK,EAAE,QAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IACvD,QAAQ,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;IAC3D,QAAQ,EAAE,GAAG;CACd,CAAC;AAEF,0EAA0E;AAC1E,MAAM,SAAS,GAAG,OAAO,CAAC;AAE1B;gCACgC;AAChC,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAE7E;;;;;;;;;GASG;AACH,SAAS,cAAc,CAAC,IAAY;IAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACrC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAClC,OAAO,MAAM,KAAK,EAAE,IAAI,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;AACxE,CAAC;AAED,SAAS,cAAc,CAAC,CAAS,EAAE,KAAsB;IACvD,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC,CAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAE,CAAC;AAC5G,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,CAAS,EAAE,UAAmC,UAAU;IACnF,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IACjD,IAAI,CAAC,GAAG,SAAS;QAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC3D,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACvC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC;IACtB,MAAM,IAAI,GAAG,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC/G,OAAO,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,8EAA8E;AAC9E,gBAAgB;AAChB,8EAA8E;AAE9E;;2EAE2E;AAC3E,MAAM,CAAC,MAAM,aAAa,GAAsB,MAAM,CAAC,MAAM,CAAC;IAC5D,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IACpE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;CACrE,CAAC,CAAC;AAEH;kEACkE;AAClE,MAAM,CAAC,MAAM,aAAa,GAAsB,MAAM,CAAC,MAAM,CAAC;IAC5D,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;IACpE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG;CACrE,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,CAAS,EAAE,OAA0B;IACnE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,EAAE,CAAC;IACjD,IAAI,CAAC,GAAG,EAAE,CAAC;IACX,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,CAAC,IAAI,CAAC,CAAC;QACP,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAE,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;AAC3B,CAAC"}

package/dist/bidi.d.ts

@@ -0,0 +1,186 @@
+/**
+ * The Unicode Bidirectional Algorithm (UAX #9), shared by the measurer and
+ * every renderer the way `writingMode.ts` shares vertical orientation.
+ *
+ * Arabic and Hebrew run right to left, digits and Latin words inside them
+ * left to right, and the order in which a line's pieces are painted follows
+ * from the characters themselves: their `Bidi_Class`, the paragraph's base
+ * direction and any explicit isolates (`:rtl[…]`, `:ltr[…]`, or the Unicode
+ * controls U+2066–U+2069). {@link resolveParagraph} resolves a paragraph's
+ * embedding levels (rules P2–P3, X1–X10, W1–W7, N0–N2, I1–I2); the line
+ * functions apply L1 (trailing white space back to the paragraph level) and
+ * L2 (reversal) to one line of it once the line breaker has cut it, so the
+ * breaker works on the logical text and never needs to know about
+ * direction. L3 (combining marks) is the shaper's business and L4
+ * (mirroring) is {@link mirroredChar}.
+ *
+ * Text is UTF-16: levels are kept per code unit, a surrogate pair's two
+ * units always share one level, and the order functions return the index
+ * of each code point's first unit. Characters rule X9 removes (embedding
+ * and override controls, `BN`) get the level of the character before them,
+ * so they never split a run; they paint nothing.
+ *
+ * Conformance: the full `BidiCharacterTest.txt` and `BidiTest.txt` of
+ * Unicode 18 pass (see `__tests__/bidi.test.ts`). The data tables are in
+ * `bidiData.ts`, generated by `scripts/gen-bidi-data.mjs`.
+ */
+import type { InlineDirection } from './parse/types';
+/** A Unicode `Bidi_Class` (UAX #9 table 4). */
+export type BidiClass = 'L' | 'R' | 'AL' | 'EN' | 'ES' | 'ET' | 'AN' | 'CS' | 'NSM' | 'BN' | 'B' | 'S' | 'WS' | 'ON' | 'LRE' | 'LRO' | 'RLE' | 'RLO' | 'PDF' | 'LRI' | 'RLI' | 'FSI' | 'PDI';
+/** Every `Bidi_Class`, by its code in the data tables. */
+export declare const BIDI_CLASS_NAMES: readonly BidiClass[];
+/** A paragraph's base direction as configured: `auto` takes it from the
+ *  first strong letter (rules P2–P3), left to right when there is none. */
+export type BaseDirection = 'ltr' | 'rtl' | 'auto';
+/** A code point's Unicode `Bidi_Class`. */
+export declare function bidiClassOf(cp: number): BidiClass;
+/** Whether a code point is a right-to-left letter (`Bidi_Class` `R` or
+ *  `AL`): Hebrew, Arabic, Syriac, Thaana, N'Ko, Adlam and the other
+ *  scripts written from right to left. Digits, punctuation and marks are
+ *  not, whatever text they sit in. */
+export declare function isRtlScriptChar(cp: number): boolean;
+/**
+ * Whether a paragraph needs the bidi algorithm at all: it holds a
+ * right-to-left letter or a control that opens a right-to-left embedding,
+ * override or isolate. Text without one, in a left-to-right paragraph,
+ * resolves to even levels throughout and paints in logical order, so the
+ * layout can skip the algorithm (and stays exactly as it was). Arabic-Indic
+ * digits alone do not count: they run left to right.
+ */
+export declare function needsBidi(text: string): boolean;
+/**
+ * The mirrored form of a character (`Bidi_Mirroring_Glyph`, rule L4): `)`
+ * for `(`, `»` for `«`, `≥` for `≤`. A renderer paints it in place of the
+ * character when the character's resolved level is odd and the font does
+ * not mirror it itself (OpenType `rtlm`). A character without a mirror is
+ * returned unchanged, as is anything longer than one code point.
+ *
+ * The ornate parentheses of Quranic text, U+FD3E ﴾ and U+FD3F ﴿, have no
+ * mirror and are not paired brackets: Unicode 14 gave them their present
+ * general categories (FD3F opens, FD3E closes, as they are written in
+ * Arabic) and keeps them out of `BidiMirroring.txt` and `BidiBrackets.txt`
+ * on purpose, so they always paint as they are encoded.
+ */
+export declare function mirroredChar(ch: string): string;
+/** The mirrored form of a code point (see {@link mirroredChar}), or the
+ *  code point itself when it has none. */
+export declare function mirroredCodePoint(cp: number): number;
+/** A Unicode `Joining_Type` (ArabicShaping.txt): `D` dual-joining (most
+ *  Arabic letters), `R` right-joining (alef, dal, ra, waw…: joined only to
+ *  the letter before them), `L` left-joining, `C` join-causing (tatweel,
+ *  ZWJ), `T` transparent (harakat and other marks, skipped when deciding
+ *  what joins), `U` non-joining. */
+export type JoiningType = 'U' | 'C' | 'D' | 'R' | 'L' | 'T';
+/** A code point's Unicode `Joining_Type`. */
+export declare function joiningTypeOf(cp: number): JoiningType;
+/** Whether a text holds a letter of a joining script: a character that is
+ *  dual-, right- or left-joining (Arabic, Syriac, N'Ko, Mongolian, Adlam…).
+ *  Join-causing characters alone do not count: a ZWJ also sits inside emoji
+ *  sequences. */
+export declare function hasJoiningScript(text: string): boolean;
+/**
+ * Whether the character starting at `index` is joined to the next
+ * non-transparent character of `text` (cursive Arabic: the two letters
+ * connect, so a cut, a style change or a kashida between them must keep
+ * the connection). It joins when it joins forward (`D`, `L`, `C`) and the
+ * next one joins backward (`D`, `R`, `C`); transparent marks between them
+ * (harakat) are skipped. `false` at the end of the text, and when `index`
+ * itself is a transparent mark.
+ */
+export declare function joinsWithNext(text: string, index: number): boolean;
+/** Whether any two characters of a text join (see {@link joinsWithNext}):
+ *  a word that must be measured, cut and painted as one shaped run. */
+export declare function joinsLetters(text: string): boolean;
+/** The embedding levels of one paragraph, before any line is cut. */
+export interface BidiParagraph {
+    /** The paragraph's text, in logical order. */
+    readonly text: string;
+    /** The paragraph embedding level: 0 left to right, 1 right to left. */
+    readonly paragraphLevel: number;
+    /** Resolved embedding level of each UTF-16 unit (rules X1–I2; L1 is per
+     *  line, see {@link lineLevels}). Odd levels run right to left. */
+    readonly levels: Uint8Array;
+    /** Each unit's original `Bidi_Class` code: what L1 reads. */
+    readonly classes: Uint8Array;
+}
+/** A stretch of a paragraph set as an isolate of its own direction (an
+ *  inline `:rtl[…]` / `:ltr[…]`), as if it were wrapped in RLI/LRI … PDI:
+ *  `[start, end)` in UTF-16 units. Isolates nest or are disjoint. */
+export interface BidiIsolate {
+    start: number;
+    end: number;
+    direction: 'ltr' | 'rtl';
+}
+/**
+ * Resolve the embedding levels of one paragraph (UAX #9 up to I2). `base`
+ * is the paragraph direction: `ltr`, `rtl`, or `auto` for the direction of
+ * its first strong letter (left to right when it has none). `isolates`
+ * sets stretches of the text as directional isolates, as if their bounds
+ * held RLI/LRI and PDI controls (the inline `:rtl[…]` and `:ltr[…]`); the
+ * text itself may also hold the Unicode controls. A paragraph separator
+ * (`B`) ends the embeddings opened before it, as at the end of a paragraph;
+ * callers split the text at paragraph breaks first (rule P1).
+ */
+export declare function resolveParagraph(text: string, base?: BaseDirection, isolates?: readonly BidiIsolate[]): BidiParagraph;
+/** A span of a parsed paragraph as {@link resolveSpans} reads it. */
+interface DirectedSpan {
+    text: string;
+    direction?: InlineDirection;
+}
+/**
+ * The isolates of a paragraph's spans (`InlineSpan.direction`, set by
+ * `:rtl[…]` and `:ltr[…]`) as ranges of their joined text. Spans of one
+ * isolate share its `id`; an isolate nested in another names it as `outer`.
+ */
+export declare function spanIsolates(spans: readonly DirectedSpan[]): BidiIsolate[];
+/** {@link resolveParagraph} for a paragraph given as its spans: the text is
+ *  their texts joined, and their `direction` isolates apply. */
+export declare function resolveSpans(spans: readonly DirectedSpan[], base?: BaseDirection): BidiParagraph;
+/**
+ * The algorithm proper, on class codes. `text` (with `map` from class
+ * positions to text positions, `-1` for a virtual control) gives the code
+ * units the paired-bracket rule reads; without it no bracket pairs.
+ * @internal Exported for the conformance tests (`BidiTest.txt` lists
+ * classes, not characters).
+ */
+export declare function resolveClasses(cls: Uint8Array, baseLevel: number, text: string | null, map: Int32Array | null): {
+    levels: Uint8Array;
+    paragraphLevel: number;
+};
+/**
+ * The levels of one line of a paragraph, `[start, end)` in UTF-16 units,
+ * after rule L1: segment and paragraph separators, and the white space and
+ * isolate controls before them or at the end of the line, go back to the
+ * paragraph level (a space that ends an Arabic line inside an English
+ * paragraph sits at the line's right end, not inside the Arabic run).
+ * Index 0 of the result is the line's first unit.
+ */
+export declare function lineLevels(par: BidiParagraph, start?: number, end?: number): Uint8Array;
+/**
+ * Rule L2 on any sequence of items with levels (characters, or a line's
+ * segments with the level of each): the indices of `levels[start..end)`
+ * from left to right. Every run at or above each odd level is reversed,
+ * from the highest level down.
+ */
+export declare function visualOrder(levels: ArrayLike<number>, start?: number, end?: number): number[];
+/**
+ * The characters of one line of a paragraph in visual order, left to right
+ * (rules L1 and L2): the index, in the paragraph's text, of each code
+ * point's first unit.
+ */
+export declare function lineVisualOrder(par: BidiParagraph, start?: number, end?: number): number[];
+/** A run of one level within a line: `[start, end)` in the paragraph's
+ *  text, painted right to left when `level` is odd. */
+export interface BidiRun {
+    start: number;
+    end: number;
+    level: number;
+}
+/**
+ * One line of a paragraph as runs of one level each, in visual order (left
+ * to right): what a renderer paints, each run shaped in its own direction
+ * (an odd level is right to left). Rules L1 and L2.
+ */
+export declare function lineRuns(par: BidiParagraph, start?: number, end?: number): BidiRun[];
+export {};
+//# sourceMappingURL=bidi.d.ts.map

package/dist/bidi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bidi.d.ts","sourceRoot":"","sources":["../src/bidi.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD,+CAA+C;AAC/C,MAAM,MAAM,SAAS,GACjB,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAC5F,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAE1E,0DAA0D;AAC1D,eAAO,MAAM,gBAAgB,EAAE,SAAS,SAAS,EAGtC,CAAC;AAYZ;2EAC2E;AAC3E,MAAM,MAAM,aAAa,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAC;AAuCnD,2CAA2C;AAC3C,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,CAEjD;AAED;;;sCAGsC;AACtC,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAGnD;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAiB/C;AAID;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAK/C;AAED;0CAC0C;AAC1C,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAMpD;AAyBD;;;;oCAIoC;AACpC,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;AAY5D,6CAA6C;AAC7C,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW,CAErD;AAED;;;iBAGiB;AACjB,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAQtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAelE;AAED;uEACuE;AACvE,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAMlD;AAKD,qEAAqE;AACrE,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uEAAuE;IACvE,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC;uEACmE;IACnE,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;CAC9B;AAED;;qEAEqE;AACrE,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,KAAK,GAAG,KAAK,CAAC;CAC1B;AA0BD;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,aAAsB,EAAE,QAAQ,CAAC,EAAE,SAAS,WAAW,EAAE,GAAG,aAAa,CA2B7H;AAED,qEAAqE;AACrE,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AASD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,GAAG,WAAW,EAAE,CAoB1E;AAED;gEACgE;AAChE,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,YAAY,EAAE,EAAE,IAAI,GAAE,aAAsB,GAAG,aAAa,CAIxG;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,GAAG,EAAE,UAAU,EACf,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,GAAG,EAAE,UAAU,GAAG,IAAI,GACrB;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE,CAgKhD;AAiMD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,aAAa,EAAE,KAAK,SAAI,EAAE,GAAG,SAAoB,GAAG,UAAU,CAiB7F;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,KAAK,SAAI,EAAE,GAAG,SAAgB,GAAG,MAAM,EAAE,CAwB/F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,aAAa,EAAE,KAAK,SAAI,EAAE,GAAG,SAAoB,GAAG,MAAM,EAAE,CAMhG;AAED;uDACuD;AACvD,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,aAAa,EAAE,KAAK,SAAI,EAAE,GAAG,SAAoB,GAAG,OAAO,EAAE,CAW1F"}