@fieldia/core 0.20.0 → 0.21.0

package/src/lib/record/input-rules.d.mts

@@ -0,0 +1,277 @@
+/**
+ * How Fieldia reads what a person types or pastes into a box: one set of
+ * readers for every box — a form's fields, a table's cells, a list's filters,
+ * the designer's settings — so a number, a duration, a date or a word is read
+ * the same way wherever it is typed. Pure: no DOM, no form.
+ *
+ * People in Egypt and the Gulf type in Arabic too: Arabic-Indic digits
+ * (٠١٢…), Persian ones (۰۱۲…), the Arabic decimal separator (٫) and its
+ * thousands separator (٬), and a French or German decimal comma are read,
+ * never refused. Invisible direction marks, which Arabic text carries and
+ * copying brings along, are never part of what is read.
+ */
+/** Invisible direction marks taken out: everywhere (what is structured), or only at the ends (any one line of text). */
+export declare function stripMarks(text: string, where?: 'all' | 'ends'): string;
+/** Arabic-Indic (٠-٩), Persian (۰-۹) and fullwidth (０-９) digits as 0-9; every other character as it is. */
+export declare function foldDigits(text: string): string;
+/** Line breaks as spaces, as one line of text keeps them; a password drops them instead. */
+export declare function oneLine(text: string, options?: {
+    password?: boolean;
+}): string;
+/** How many characters a text has, as a server counts them: by code point, so an emoji is one. */
+export declare function charCount(text: string): number;
+/**
+ * Words folded for finding: case, Arabic letter forms (أ إ آ ٱ as ا, ة as ه,
+ * ى as ي, the tatweel and short vowels dropped), digits in any script as 0-9,
+ * and no direction marks — so "أحمد" finds "احمد" and "١٢" finds "12".
+ */
+export declare function foldForSearch(text: string): string;
+/** A page's own marks for numbers: its decimal mark and its grouping mark. */
+export interface NumberMarks {
+    decimal: string;
+    group: string;
+}
+/** The marks a language writes numbers with, in Latin digits: en "." and ",", de "," and ".", fr "," and a narrow space. */
+export declare function numberMarks(locale: string): NumberMarks;
+/** Why a text is not a number, or not yet one. */
+export type NumberProblem = 
+/** A letter, an emoji or another symbol: never part of a number. */
+'numbersOnly'
+/** A minus that is not first. */
+ | 'minusFirst'
+/** Two decimal marks. */
+ | 'oneDecimalMark'
+/** Grouping marks where groups of three cannot be: "12 34". */
+ | 'groupsOfThree'
+/** A tab or a line break: several values, as spreadsheets copy them. */
+ | 'severalValues'
+/** Not a whole number yet: "-", ".", "1,". */
+ | 'unfinished';
+/** A number read: its value (null for nothing typed), as written plain in the page's way, and how many places and digits it has. */
+export interface NumberReading {
+    ok: true;
+    value: number | null;
+    /** The number with no grouping, in Latin digits and the page's decimal mark: "-1234,5" on a German page. Empty for nothing. */
+    plain: string;
+    /** Its decimal places as typed: "1.50" has 2. */
+    places: number;
+    /** Its digits, leading zeros of the whole part left out: what a field's `digits[0]` counts. */
+    digits: number;
+    /** Its significant digits: past 15, a number is no longer kept exactly. */
+    significant: number;
+}
+export type NumberRead = NumberReading | {
+    ok: false;
+    problem: NumberProblem;
+};
+/** What a box reads besides plain numbers: a trailing per cent sign (% or ٪); and whether its numbers are never grouped. */
+export interface NumberReadOptions {
+    percent?: boolean;
+    /**
+     * Never grouped, as a coordinate (30.0444) is: its one mark — . , ، or ٫ — is the decimal mark whatever the
+     * page's language, so "31,235" is 31.235 and never 31235; a space or a second mark does not read.
+     */
+    ungrouped?: boolean;
+}
+/**
+ * Typed or pasted text as a number, in the page's language (`locale`).
+ *
+ * Digits in Latin, Arabic-Indic, Persian and fullwidth script; one leading
+ * minus (also \u2212 U+2212) or plus; spaces, and the marks . , ، ٫ ٬. Which mark
+ * is the decimal one:
+ *   - both . and , : the last; the other groups;
+ *   - one kind repeated: it groups;
+ *   - one mark once: the page's decimal mark, ٫ or ، is decimal; the page's
+ *     grouping mark groups only with exactly three digits after it and one to
+ *     three before; a mark the page does not use is decimal;
+ *   - spaces and ٬ only group.
+ * Groups run one to three digits, then threes, and never come after the
+ * decimal mark, and the first group is never led by a 0. So on en and ar
+ * pages 1,500 is 1500 and 1,5 is 1.5; on a de page 1.500 is 1500 and 1.5 is
+ * 1.5; anywhere 0,500 and 0.500 are a half, 1 234,56 is 1234.56, and 12 34
+ * does not read. Nothing reads letters, a tab or a line break.
+ */
+export declare function readNumber(text: string, locale: string, options?: NumberReadOptions): NumberRead;
+/** What a field takes, for judging a keystroke or a paste. */
+export interface NumberLimits {
+    /** A whole number: no decimal mark. */
+    integer?: boolean;
+    /** At most these decimal places. */
+    places?: number;
+    /** At most these digits in all (a field's `digits[0]`); never more than 15 are kept exactly. */
+    digits?: number;
+    /** The least: a minus is refused when it is 0 or more. */
+    min?: number;
+    /** A per cent box: a trailing % or ٪ may be typed. */
+    percent?: boolean;
+    /** An hours box: `:` and `h` may be typed too ("6:30", "6h30"). */
+    duration?: boolean;
+    /** Never grouped, as a coordinate: its one mark is the decimal mark (see NumberReadOptions). */
+    ungrouped?: boolean;
+}
+/** Why a keystroke or a paste is refused, with what the words name. */
+export type NumberRefusal = {
+    problem: 'numbersOnly' | 'minusFirst' | 'oneDecimalMark' | 'groupsOfThree' | 'severalValues' | 'integer';
+} | {
+    problem: 'min';
+    min: number;
+} | {
+    problem: 'decimals';
+    places: number;
+} | {
+    problem: 'digits';
+    n: number;
+};
+/** The most significant digits a number keeps exactly. */
+export declare const MOST_DIGITS = 15;
+/**
+ * Whether the text a box would hold after a keystroke may stand: null when it
+ * may, or why not. Only what no more typing can make right is refused, so
+ * every way of writing a number the field takes can be typed key by key:
+ * letters, emoji and other symbols; a minus that is not first, or any minus
+ * where the least is 0 or more; a decimal mark that can only be one followed
+ * by a digit other than 0 in a whole number, or by more places than the
+ * field's (trailing zeros are no places: 12.50 has one, 12.0 none); a second
+ * decimal mark; a digit past `digits` or past 15 significant ones; and
+ * grouping that can never be right ("1.2." on a German page). Text on its way
+ * to a number ("-", "1,", "12 3", "1.234" on its way to "1.234,56") may stand;
+ * what it turns out to be, and min and max, are said as the box is left.
+ */
+export declare function couldBeNumber(text: string, locale: string, limits?: NumberLimits): NumberRefusal | null;
+/**
+ * Why a number read cannot be held by a field of these limits, or null: a
+ * decimal in a whole number, places past the field's, digits past its own or
+ * past 15. Not its least and most, which check says. For text a box is left
+ * with: as it was typed, "12.345" in a box of two places could not be told
+ * from "12.345,67" on its way.
+ */
+export declare function numberMisfit(value: number, limits: NumberLimits): NumberRefusal | null;
+/** A pasted or dropped amount, cleaned: the plain number for the box, or why nothing is pasted. */
+export type PastedNumber = {
+    ok: true;
+    text: string;
+    value: number;
+} | {
+    ok: false;
+    problem: 'notANumber' | 'severalValues';
+} | {
+    ok: false;
+    problem: 'otherCurrency';
+    currency: string;
+};
+/**
+ * Pasted (or dropped) text as the plain number a box takes, in the page's
+ * way: direction marks, the box's own currency (its symbol, narrow symbol,
+ * code or Arabic symbol), grouping, % and spaces taken out, and an
+ * accounting negative read — (1,200.00) and 1,200- are -1200. Another
+ * currency is named; a tab or a line break inside is several values; a
+ * single line break at the end, as a copied cell brings, is let go.
+ */
+export declare function cleanPastedNumber(text: string, locale: string, options?: {
+    currency?: string | null;
+    percent?: boolean;
+    ungrouped?: boolean;
+}): PastedNumber;
+/** Why typed hours do not read. */
+export type DurationProblem = 'unfinished' | 'minutes' | 'duration' | 'numbersOnly' | 'minusFirst' | 'severalValues';
+export type DurationRead = {
+    ok: true;
+    value: number | null;
+} | {
+    ok: false;
+    problem: DurationProblem;
+}
+/** Minutes of one digit that could be more than one time ("6:3", 6:03 or 6:30): never one of them in silence. */
+ | {
+    ok: false;
+    problem: 'minuteDigits';
+    times: string[];
+};
+/**
+ * Typed hours: "6:30", "06:30", "6.5" (or "6,5"), "6h30", "6h", "6:30:00"
+ * (seconds only when :00), Arabic digits too; a leading minus. Minutes past 59
+ * do not read ('minutes'), nor do "6 30" or other shapes ('duration'); "6:"
+ * and "-" are on their way ('unfinished'). Minutes of one digit that could be
+ * more than one ("6:3": 6:03 or 6:30) are never read as one ('minuteDigits',
+ * naming each); "6:7" can only be 6:07.
+ */
+export declare function readDuration(text: string, locale: string): DurationRead;
+/** The order a page types a date's day, month and year in. */
+export type DateOrder = 'dmy' | 'mdy' | 'ymd';
+export type DateProblem = 'unfinished' | 'noSuchMonth' | 'yearDigits' | 'time';
+export type DateRead = 
+/** Read; `timeLeftOut`, the time (HH:MM, here) an instant had, where a day alone is kept: said, never dropped in silence. */
+{
+    ok: true;
+    value: string | null;
+    timeLeftOut?: string;
+} | {
+    ok: false;
+    problem: DateProblem;
+}
+/** A time whose minutes have one digit that could be more than one time ("14:3"): each named. */
+ | {
+    ok: false;
+    problem: 'minuteDigits';
+    times: string[];
+} | {
+    ok: false;
+    problem: 'noSuchDay';
+    year: number;
+    month: number;
+    days: number;
+}
+/** A year of two digits ("85"): never given a century in silence; the two it could be are named. */
+ | {
+    ok: false;
+    problem: 'shortYear';
+    short: string;
+    early: number;
+    late: number;
+};
+/** Whether `word` is how a month's name begins, in any of the languages its names are read in: typing it is on its way. */
+export declare function couldBeMonth(word: string, locale?: string): boolean;
+/**
+ * A typed date, in the page's order (`order`, day/month/year unless told):
+ * separators / . - or a space; ISO yyyy-mm-dd always; Arabic and Persian
+ * digits; a year of four digits, from 1000 — one of two digits could be either
+ * century, so it is never read as one ('shortYear', naming both). Its month
+ * may be a word, as Fieldia writes a date at rest — "15 Oct 2026", "15
+ * أكتوبر 2026", "15 oct. 2026", "15. Okt. 2026", "Oct 15, 2026" — in
+ * English, Arabic, French, German or the page's language (`locale`); the
+ * numbers beside a month in words are its day and its year of four digits,
+ * in either order. With `time`, a time may follow ("13/10/2026 14:30", "…,
+ * 2:30 pm", "… ٢:٣٠ م"), and the value is yyyy-mm-ddTHH:MM. An instant with
+ * its zone (2026-10-15T14:30:00Z) is the local day and time it is — with
+ * `time`, its seconds :00, never dropped. Unfinished or impossible dates say
+ * why (31/02 → 'noSuchDay' with the days that month has).
+ */
+export declare function readDate(text: string, options?: {
+    order?: DateOrder;
+    time?: boolean;
+    locale?: string;
+}): DateRead;
+export type TimeRead = {
+    ok: true;
+    value: string | null;
+} | {
+    ok: false;
+    problem: 'unfinished' | 'time';
+} | {
+    ok: false;
+    problem: 'minuteDigits';
+    times: string[];
+};
+/**
+ * A typed time of day: 24-hour "14:30" (or "14.30", "14h30", "1430"), or
+ * twelve-hour with am/pm or ص/م; Arabic digits; seconds only when :00.
+ * The value is HH:MM. Minutes of one digit are read as written only when they
+ * can be one time alone ("14:7" is 14:07, "14:0" 14:00); "14:3" could be
+ * 14:03 or 14:30, and "14.5" 14:05, half past two or 14:50: those are never
+ * read, and each time it could be is named ('minuteDigits').
+ */
+export declare function readTime(text: string): TimeRead;
+/** The places a currency's amounts are written with: 3 for the Kuwaiti, Bahraini, Omani and Jordanian dinars and rials, 2 for most. */
+export declare function placesOfCurrency(currency: string | null | undefined): number;
+/** The decimal places a number has as JavaScript writes it: 12.345 has 3, 1e-7 has 7. */
+export declare function placesOf(value: number): number;

package/src/lib/record/input-rules.d.ts

@@ -0,0 +1,277 @@
+/**
+ * How Fieldia reads what a person types or pastes into a box: one set of
+ * readers for every box — a form's fields, a table's cells, a list's filters,
+ * the designer's settings — so a number, a duration, a date or a word is read
+ * the same way wherever it is typed. Pure: no DOM, no form.
+ *
+ * People in Egypt and the Gulf type in Arabic too: Arabic-Indic digits
+ * (٠١٢…), Persian ones (۰۱۲…), the Arabic decimal separator (٫) and its
+ * thousands separator (٬), and a French or German decimal comma are read,
+ * never refused. Invisible direction marks, which Arabic text carries and
+ * copying brings along, are never part of what is read.
+ */
+/** Invisible direction marks taken out: everywhere (what is structured), or only at the ends (any one line of text). */
+export declare function stripMarks(text: string, where?: 'all' | 'ends'): string;
+/** Arabic-Indic (٠-٩), Persian (۰-۹) and fullwidth (０-９) digits as 0-9; every other character as it is. */
+export declare function foldDigits(text: string): string;
+/** Line breaks as spaces, as one line of text keeps them; a password drops them instead. */
+export declare function oneLine(text: string, options?: {
+    password?: boolean;
+}): string;
+/** How many characters a text has, as a server counts them: by code point, so an emoji is one. */
+export declare function charCount(text: string): number;
+/**
+ * Words folded for finding: case, Arabic letter forms (أ إ آ ٱ as ا, ة as ه,
+ * ى as ي, the tatweel and short vowels dropped), digits in any script as 0-9,
+ * and no direction marks — so "أحمد" finds "احمد" and "١٢" finds "12".
+ */
+export declare function foldForSearch(text: string): string;
+/** A page's own marks for numbers: its decimal mark and its grouping mark. */
+export interface NumberMarks {
+    decimal: string;
+    group: string;
+}
+/** The marks a language writes numbers with, in Latin digits: en "." and ",", de "," and ".", fr "," and a narrow space. */
+export declare function numberMarks(locale: string): NumberMarks;
+/** Why a text is not a number, or not yet one. */
+export type NumberProblem = 
+/** A letter, an emoji or another symbol: never part of a number. */
+'numbersOnly'
+/** A minus that is not first. */
+ | 'minusFirst'
+/** Two decimal marks. */
+ | 'oneDecimalMark'
+/** Grouping marks where groups of three cannot be: "12 34". */
+ | 'groupsOfThree'
+/** A tab or a line break: several values, as spreadsheets copy them. */
+ | 'severalValues'
+/** Not a whole number yet: "-", ".", "1,". */
+ | 'unfinished';
+/** A number read: its value (null for nothing typed), as written plain in the page's way, and how many places and digits it has. */
+export interface NumberReading {
+    ok: true;
+    value: number | null;
+    /** The number with no grouping, in Latin digits and the page's decimal mark: "-1234,5" on a German page. Empty for nothing. */
+    plain: string;
+    /** Its decimal places as typed: "1.50" has 2. */
+    places: number;
+    /** Its digits, leading zeros of the whole part left out: what a field's `digits[0]` counts. */
+    digits: number;
+    /** Its significant digits: past 15, a number is no longer kept exactly. */
+    significant: number;
+}
+export type NumberRead = NumberReading | {
+    ok: false;
+    problem: NumberProblem;
+};
+/** What a box reads besides plain numbers: a trailing per cent sign (% or ٪); and whether its numbers are never grouped. */
+export interface NumberReadOptions {
+    percent?: boolean;
+    /**
+     * Never grouped, as a coordinate (30.0444) is: its one mark — . , ، or ٫ — is the decimal mark whatever the
+     * page's language, so "31,235" is 31.235 and never 31235; a space or a second mark does not read.
+     */
+    ungrouped?: boolean;
+}
+/**
+ * Typed or pasted text as a number, in the page's language (`locale`).
+ *
+ * Digits in Latin, Arabic-Indic, Persian and fullwidth script; one leading
+ * minus (also \u2212 U+2212) or plus; spaces, and the marks . , ، ٫ ٬. Which mark
+ * is the decimal one:
+ *   - both . and , : the last; the other groups;
+ *   - one kind repeated: it groups;
+ *   - one mark once: the page's decimal mark, ٫ or ، is decimal; the page's
+ *     grouping mark groups only with exactly three digits after it and one to
+ *     three before; a mark the page does not use is decimal;
+ *   - spaces and ٬ only group.
+ * Groups run one to three digits, then threes, and never come after the
+ * decimal mark, and the first group is never led by a 0. So on en and ar
+ * pages 1,500 is 1500 and 1,5 is 1.5; on a de page 1.500 is 1500 and 1.5 is
+ * 1.5; anywhere 0,500 and 0.500 are a half, 1 234,56 is 1234.56, and 12 34
+ * does not read. Nothing reads letters, a tab or a line break.
+ */
+export declare function readNumber(text: string, locale: string, options?: NumberReadOptions): NumberRead;
+/** What a field takes, for judging a keystroke or a paste. */
+export interface NumberLimits {
+    /** A whole number: no decimal mark. */
+    integer?: boolean;
+    /** At most these decimal places. */
+    places?: number;
+    /** At most these digits in all (a field's `digits[0]`); never more than 15 are kept exactly. */
+    digits?: number;
+    /** The least: a minus is refused when it is 0 or more. */
+    min?: number;
+    /** A per cent box: a trailing % or ٪ may be typed. */
+    percent?: boolean;
+    /** An hours box: `:` and `h` may be typed too ("6:30", "6h30"). */
+    duration?: boolean;
+    /** Never grouped, as a coordinate: its one mark is the decimal mark (see NumberReadOptions). */
+    ungrouped?: boolean;
+}
+/** Why a keystroke or a paste is refused, with what the words name. */
+export type NumberRefusal = {
+    problem: 'numbersOnly' | 'minusFirst' | 'oneDecimalMark' | 'groupsOfThree' | 'severalValues' | 'integer';
+} | {
+    problem: 'min';
+    min: number;
+} | {
+    problem: 'decimals';
+    places: number;
+} | {
+    problem: 'digits';
+    n: number;
+};
+/** The most significant digits a number keeps exactly. */
+export declare const MOST_DIGITS = 15;
+/**
+ * Whether the text a box would hold after a keystroke may stand: null when it
+ * may, or why not. Only what no more typing can make right is refused, so
+ * every way of writing a number the field takes can be typed key by key:
+ * letters, emoji and other symbols; a minus that is not first, or any minus
+ * where the least is 0 or more; a decimal mark that can only be one followed
+ * by a digit other than 0 in a whole number, or by more places than the
+ * field's (trailing zeros are no places: 12.50 has one, 12.0 none); a second
+ * decimal mark; a digit past `digits` or past 15 significant ones; and
+ * grouping that can never be right ("1.2." on a German page). Text on its way
+ * to a number ("-", "1,", "12 3", "1.234" on its way to "1.234,56") may stand;
+ * what it turns out to be, and min and max, are said as the box is left.
+ */
+export declare function couldBeNumber(text: string, locale: string, limits?: NumberLimits): NumberRefusal | null;
+/**
+ * Why a number read cannot be held by a field of these limits, or null: a
+ * decimal in a whole number, places past the field's, digits past its own or
+ * past 15. Not its least and most, which check says. For text a box is left
+ * with: as it was typed, "12.345" in a box of two places could not be told
+ * from "12.345,67" on its way.
+ */
+export declare function numberMisfit(value: number, limits: NumberLimits): NumberRefusal | null;
+/** A pasted or dropped amount, cleaned: the plain number for the box, or why nothing is pasted. */
+export type PastedNumber = {
+    ok: true;
+    text: string;
+    value: number;
+} | {
+    ok: false;
+    problem: 'notANumber' | 'severalValues';
+} | {
+    ok: false;
+    problem: 'otherCurrency';
+    currency: string;
+};
+/**
+ * Pasted (or dropped) text as the plain number a box takes, in the page's
+ * way: direction marks, the box's own currency (its symbol, narrow symbol,
+ * code or Arabic symbol), grouping, % and spaces taken out, and an
+ * accounting negative read — (1,200.00) and 1,200- are -1200. Another
+ * currency is named; a tab or a line break inside is several values; a
+ * single line break at the end, as a copied cell brings, is let go.
+ */
+export declare function cleanPastedNumber(text: string, locale: string, options?: {
+    currency?: string | null;
+    percent?: boolean;
+    ungrouped?: boolean;
+}): PastedNumber;
+/** Why typed hours do not read. */
+export type DurationProblem = 'unfinished' | 'minutes' | 'duration' | 'numbersOnly' | 'minusFirst' | 'severalValues';
+export type DurationRead = {
+    ok: true;
+    value: number | null;
+} | {
+    ok: false;
+    problem: DurationProblem;
+}
+/** Minutes of one digit that could be more than one time ("6:3", 6:03 or 6:30): never one of them in silence. */
+ | {
+    ok: false;
+    problem: 'minuteDigits';
+    times: string[];
+};
+/**
+ * Typed hours: "6:30", "06:30", "6.5" (or "6,5"), "6h30", "6h", "6:30:00"
+ * (seconds only when :00), Arabic digits too; a leading minus. Minutes past 59
+ * do not read ('minutes'), nor do "6 30" or other shapes ('duration'); "6:"
+ * and "-" are on their way ('unfinished'). Minutes of one digit that could be
+ * more than one ("6:3": 6:03 or 6:30) are never read as one ('minuteDigits',
+ * naming each); "6:7" can only be 6:07.
+ */
+export declare function readDuration(text: string, locale: string): DurationRead;
+/** The order a page types a date's day, month and year in. */
+export type DateOrder = 'dmy' | 'mdy' | 'ymd';
+export type DateProblem = 'unfinished' | 'noSuchMonth' | 'yearDigits' | 'time';
+export type DateRead = 
+/** Read; `timeLeftOut`, the time (HH:MM, here) an instant had, where a day alone is kept: said, never dropped in silence. */
+{
+    ok: true;
+    value: string | null;
+    timeLeftOut?: string;
+} | {
+    ok: false;
+    problem: DateProblem;
+}
+/** A time whose minutes have one digit that could be more than one time ("14:3"): each named. */
+ | {
+    ok: false;
+    problem: 'minuteDigits';
+    times: string[];
+} | {
+    ok: false;
+    problem: 'noSuchDay';
+    year: number;
+    month: number;
+    days: number;
+}
+/** A year of two digits ("85"): never given a century in silence; the two it could be are named. */
+ | {
+    ok: false;
+    problem: 'shortYear';
+    short: string;
+    early: number;
+    late: number;
+};
+/** Whether `word` is how a month's name begins, in any of the languages its names are read in: typing it is on its way. */
+export declare function couldBeMonth(word: string, locale?: string): boolean;
+/**
+ * A typed date, in the page's order (`order`, day/month/year unless told):
+ * separators / . - or a space; ISO yyyy-mm-dd always; Arabic and Persian
+ * digits; a year of four digits, from 1000 — one of two digits could be either
+ * century, so it is never read as one ('shortYear', naming both). Its month
+ * may be a word, as Fieldia writes a date at rest — "15 Oct 2026", "15
+ * أكتوبر 2026", "15 oct. 2026", "15. Okt. 2026", "Oct 15, 2026" — in
+ * English, Arabic, French, German or the page's language (`locale`); the
+ * numbers beside a month in words are its day and its year of four digits,
+ * in either order. With `time`, a time may follow ("13/10/2026 14:30", "…,
+ * 2:30 pm", "… ٢:٣٠ م"), and the value is yyyy-mm-ddTHH:MM. An instant with
+ * its zone (2026-10-15T14:30:00Z) is the local day and time it is — with
+ * `time`, its seconds :00, never dropped. Unfinished or impossible dates say
+ * why (31/02 → 'noSuchDay' with the days that month has).
+ */
+export declare function readDate(text: string, options?: {
+    order?: DateOrder;
+    time?: boolean;
+    locale?: string;
+}): DateRead;
+export type TimeRead = {
+    ok: true;
+    value: string | null;
+} | {
+    ok: false;
+    problem: 'unfinished' | 'time';
+} | {
+    ok: false;
+    problem: 'minuteDigits';
+    times: string[];
+};
+/**
+ * A typed time of day: 24-hour "14:30" (or "14.30", "14h30", "1430"), or
+ * twelve-hour with am/pm or ص/م; Arabic digits; seconds only when :00.
+ * The value is HH:MM. Minutes of one digit are read as written only when they
+ * can be one time alone ("14:7" is 14:07, "14:0" 14:00); "14:3" could be
+ * 14:03 or 14:30, and "14.5" 14:05, half past two or 14:50: those are never
+ * read, and each time it could be is named ('minuteDigits').
+ */
+export declare function readTime(text: string): TimeRead;
+/** The places a currency's amounts are written with: 3 for the Kuwaiti, Bahraini, Omani and Jordanian dinars and rials, 2 for most. */
+export declare function placesOfCurrency(currency: string | null | undefined): number;
+/** The decimal places a number has as JavaScript writes it: 12.345 has 3, 1e-7 has 7. */
+export declare function placesOf(value: number): number;