@rootreeweb/js-lib 4.0.10

package/dist/esm/general/localization.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Returns localized day names of the week based on the specified format.
+ *
+ * @param format The format of the day names to return.
+ * @returns An array of localized day names.
+ */
+export declare function getDayNames(format: "long" | "narrow" | "short"): string[];
+/**
+ * Provides a way to retrieve the locale from the HTML document or fallback to a
+ * default locale if it is unable to determine the locale. It is useful for
+ * obtaining the language and region settings of the user's environment.
+ *
+ * @returns The locale of the HTML document or a default locale.
+ */
+export declare function getLocale(): string;
+/**
+ * Provides a way to obtain a localized string representation of a currency
+ * value based on the specified value, utilizing a separate currencyFormatter
+ * object for the formatting process. It removes the currency code substring and
+ * trims any surrounding whitespace from the resulting string.
+ *
+ * @param value The currency value to be formatted.
+ * @returns A localized string representation of the currency value.
+ */
+export declare function getLocalizedCurrency(value: number): string;
+/**
+ * Provides a way to obtain a localized string representation of a date,
+ * including the month, day, and year, based on the specified format and
+ * locale.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the date. Defaults to the
+ *   HTM language attribute.
+ * @returns A localized string representation of the date.
+ */
+export declare function getLocalizedDate(date: Date | string, forceLocale?: string): string;
+/**
+ * Provides a way to obtain a localized string representation of a day based on
+ * the specified date and locale.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the day. Defaults to the
+ *   HTML language attribute.
+ * @returns A localized string representation of the day.
+ */
+export declare function getLocalizedDay(date: string, forceLocale?: string): string;
+/**
+ * Provides a way to obtain a localized string representation of a month based
+ * on the specified date and locale.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the month. Defaults to
+ *   the HTML language attribute.
+ * @returns A localized string representation of the month.
+ */
+export declare function getLocalizedMonth(date: string, forceLocale?: string): string;
+/**
+ * In summary, the getLocalizedQuantity function provides a way to obtain a
+ * localized string representation of a quantity based on the specified value,
+ * utilizing a separate quantityFormatter object for the formatting process.
+ *
+ * @param value The quantity value to be formatted.
+ * @returns A localized string representation of the quantity value.
+ */
+export declare function getLocalizedQuantity(value: number): string;
+/**
+ * Provides a way to obtain an array of localized month names based on the
+ * specified format.
+ *
+ * @param format The format of the month names to return.
+ * @returns An array of localized month names.
+ */
+export declare function getMonthNames(format?: "2-digit" | "long" | "narrow" | "numeric" | "short"): string[];
+/**
+ * Provides a way to obtain a localized string representation of an ordinal.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the ordinal. Defaults to
+ *   the HTML language attribute.
+ * @returns A localized string representation of the ordinal.
+ */
+export declare function getLocalizedOrdinal(date: string, forceLocale?: string): string;
+//# sourceMappingURL=localization.d.ts.map

package/dist/esm/general/localization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localization.d.ts","sourceRoot":"","sources":["../../../src/general/localization.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,EAAE,CAUzE;AACD;;;;;;GAMG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAQlC;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC/B,IAAI,EAAE,IAAI,GAAG,MAAM,EACnB,WAAW,CAAC,EAAE,MAAM,GAClB,MAAM,CAQR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAM1E;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAM5E;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC5B,MAAM,GAAE,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAgB,GAClE,MAAM,EAAE,CAUV;AA2CD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAClC,IAAI,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,MAAM,GAClB,MAAM,CAgBR"}

package/dist/esm/general/localization.js

@@ -0,0 +1,188 @@
+import { safeishGetProperty } from "./objects.js";
+/**
+ * Returns localized day names of the week based on the specified format.
+ *
+ * @param format The format of the day names to return.
+ * @returns An array of localized day names.
+ */
+export function getDayNames(format) {
+    const formatter = new Intl.DateTimeFormat(getLocale(), {
+        timeZone: "UTC",
+        weekday: format,
+    });
+    const days = [1, 2, 3, 4, 5, 6, 7].map((day) => {
+        const dd = `0${String(day)}`;
+        return new Date(`2017-01-${dd}T00:00:00+00:00`);
+    });
+    return days.map((date) => formatter.format(date));
+}
+/**
+ * Provides a way to retrieve the locale from the HTML document or fallback to a
+ * default locale if it is unable to determine the locale. It is useful for
+ * obtaining the language and region settings of the user's environment.
+ *
+ * @returns The locale of the HTML document or a default locale.
+ */
+export function getLocale() {
+    if (typeof document === "undefined") {
+        return "en-US";
+    }
+    return (
+    // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+    document.getElementsByTagName("html")[0]?.getAttribute("lang") || "en-US");
+}
+/**
+ * Provides a way to obtain a localized string representation of a currency
+ * value based on the specified value, utilizing a separate currencyFormatter
+ * object for the formatting process. It removes the currency code substring and
+ * trims any surrounding whitespace from the resulting string.
+ *
+ * @param value The currency value to be formatted.
+ * @returns A localized string representation of the currency value.
+ */
+export function getLocalizedCurrency(value) {
+    return getCurrancyFormatter().format(value).replace("US", "").trim();
+}
+/**
+ * Provides a way to obtain a localized string representation of a date,
+ * including the month, day, and year, based on the specified format and
+ * locale.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the date. Defaults to the
+ *   HTM language attribute.
+ * @returns A localized string representation of the date.
+ */
+export function getLocalizedDate(date, forceLocale) {
+    const formatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {
+        day: "numeric",
+        month: "long",
+        timeZone: "UTC",
+        year: "numeric",
+    });
+    return formatter.format(new Date(date));
+}
+/**
+ * Provides a way to obtain a localized string representation of a day based on
+ * the specified date and locale.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the day. Defaults to the
+ *   HTML language attribute.
+ * @returns A localized string representation of the day.
+ */
+export function getLocalizedDay(date, forceLocale) {
+    const formatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {
+        timeZone: "UTC",
+        weekday: "long",
+    });
+    return formatter.format(new Date(date));
+}
+/**
+ * Provides a way to obtain a localized string representation of a month based
+ * on the specified date and locale.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the month. Defaults to
+ *   the HTML language attribute.
+ * @returns A localized string representation of the month.
+ */
+export function getLocalizedMonth(date, forceLocale) {
+    const formatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {
+        month: "long",
+        timeZone: "UTC",
+    });
+    return formatter.format(new Date(date));
+}
+/**
+ * In summary, the getLocalizedQuantity function provides a way to obtain a
+ * localized string representation of a quantity based on the specified value,
+ * utilizing a separate quantityFormatter object for the formatting process.
+ *
+ * @param value The quantity value to be formatted.
+ * @returns A localized string representation of the quantity value.
+ */
+export function getLocalizedQuantity(value) {
+    return getQuantityFormatter().format(value);
+}
+/**
+ * Provides a way to obtain an array of localized month names based on the
+ * specified format.
+ *
+ * @param format The format of the month names to return.
+ * @returns An array of localized month names.
+ */
+export function getMonthNames(format = "long") {
+    const formatter = new Intl.DateTimeFormat(getLocale(), {
+        month: format,
+        timeZone: "UTC",
+    });
+    const months = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12].map((month) => {
+        const mm = month < 10 ? `0${String(month)}` : month;
+        return new Date(`2017-${String(mm)}-01T00:00:00+00:00`);
+    });
+    return months.map((date) => formatter.format(date));
+}
+/**
+ * Returns a currency formatter object that can be used to format currency
+ * values.
+ *
+ * @returns A currency formatter object.
+ */
+function getCurrancyFormatter() {
+    return new Intl.NumberFormat(getLocale(), {
+        currency: "USD",
+        currencyDisplay: "symbol",
+        style: "currency",
+    });
+}
+/**
+ * Returns a quantity formatter object that can be used to format quantity
+ * values.
+ *
+ * @returns A quantity formatter object.
+ */
+function getQuantityFormatter() {
+    return new Intl.NumberFormat(getLocale());
+}
+const suffixes_en = {
+    few: "rd",
+    many: "th",
+    one: "st",
+    other: "th",
+    two: "nd",
+    zero: "",
+};
+const suffixes_fr = {
+    few: "e",
+    many: "e",
+    one: "er",
+    other: "e",
+    two: "e",
+    zero: "",
+};
+/**
+ * Provides a way to obtain a localized string representation of an ordinal.
+ *
+ * @param date The date to be formatted.
+ * @param forceLocale The locale to use for formatting the ordinal. Defaults to
+ *   the HTML language attribute.
+ * @returns A localized string representation of the ordinal.
+ */
+export function getLocalizedOrdinal(date, forceLocale) {
+    const locale = forceLocale ?? getLocale();
+    const ordinalFormatter = new Intl.PluralRules(locale, {
+        type: "ordinal",
+    });
+    const dateFormatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {
+        day: "numeric",
+        timeZone: "UTC",
+    });
+    const number = parseInt(dateFormatter.format(new Date(date)));
+    const category = ordinalFormatter.select(number);
+    const suffix = locale === "fr-CA"
+        ? safeishGetProperty(suffixes_fr, category)
+        : safeishGetProperty(suffixes_en, category);
+    return String(number) + suffix;
+}
+//# sourceMappingURL=localization.js.map

package/dist/esm/general/localization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"localization.js","sourceRoot":"","sources":["../../../src/general/localization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,MAAmC;IAC9D,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE;QACtD,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,MAAM;KACf,CAAC,CAAC;IACH,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC9C,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACnD,CAAC;AACD;;;;;;GAMG;AACH,MAAM,UAAU,SAAS;IACxB,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;QACrC,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,OAAO;IACN,wEAAwE;IACxE,QAAQ,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,OAAO,CACzE,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa;IACjD,OAAO,oBAAoB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AACtE,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAC/B,IAAmB,EACnB,WAAoB;IAEpB,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,WAAW,IAAI,SAAS,EAAE,EAAE;QACrE,GAAG,EAAE,SAAS;QACd,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,SAAS;KACf,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,WAAoB;IACjE,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,WAAW,IAAI,SAAS,EAAE,EAAE;QACrE,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,MAAM;KACf,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAY,EAAE,WAAoB;IACnE,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,WAAW,IAAI,SAAS,EAAE,EAAE;QACrE,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa;IACjD,OAAO,oBAAoB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC5B,SAA8D,MAAM;IAEpE,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,EAAE;QACtD,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACpE,MAAM,EAAE,GAAG,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QACpD,OAAO,IAAI,IAAI,CAAC,QAAQ,MAAM,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB;IAC5B,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE;QACzC,QAAQ,EAAE,KAAK;QACf,eAAe,EAAE,QAAQ;QACzB,KAAK,EAAE,UAAU;KACjB,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB;IAC5B,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,WAAW,GAAG;IACnB,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,IAAI;IACT,KAAK,EAAE,IAAI;IACX,GAAG,EAAE,IAAI;IACT,IAAI,EAAE,EAAE;CACR,CAAC;AACF,MAAM,WAAW,GAAG;IACnB,GAAG,EAAE,GAAG;IACR,IAAI,EAAE,GAAG;IACT,GAAG,EAAE,IAAI;IACT,KAAK,EAAE,GAAG;IACV,GAAG,EAAE,GAAG;IACR,IAAI,EAAE,EAAE;CACR,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,mBAAmB,CAClC,IAAY,EACZ,WAAoB;IAEpB,MAAM,MAAM,GAAG,WAAW,IAAI,SAAS,EAAE,CAAC;IAC1C,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE;QACrD,IAAI,EAAE,SAAS;KACf,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,WAAW,IAAI,SAAS,EAAE,EAAE;QACzE,GAAG,EAAE,SAAS;QACd,QAAQ,EAAE,KAAK;KACf,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9D,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,MAAM,GACX,MAAM,KAAK,OAAO;QACjB,CAAC,CAAC,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC;QAC3C,CAAC,CAAC,kBAAkB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC9C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAChC,CAAC","sourcesContent":["import { safeishGetProperty } from \"./objects.js\";\n\n/**\n * Returns localized day names of the week based on the specified format.\n *\n * @param format The format of the day names to return.\n * @returns An array of localized day names.\n */\nexport function getDayNames(format: \"long\" | \"narrow\" | \"short\"): string[] {\n\tconst formatter = new Intl.DateTimeFormat(getLocale(), {\n\t\ttimeZone: \"UTC\",\n\t\tweekday: format,\n\t});\n\tconst days = [1, 2, 3, 4, 5, 6, 7].map((day) => {\n\t\tconst dd = `0${String(day)}`;\n\t\treturn new Date(`2017-01-${dd}T00:00:00+00:00`);\n\t});\n\treturn days.map((date) => formatter.format(date));\n}\n/**\n * Provides a way to retrieve the locale from the HTML document or fallback to a\n * default locale if it is unable to determine the locale. It is useful for\n * obtaining the language and region settings of the user's environment.\n *\n * @returns The locale of the HTML document or a default locale.\n */\nexport function getLocale(): string {\n\tif (typeof document === \"undefined\") {\n\t\treturn \"en-US\";\n\t}\n\treturn (\n\t\t// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing\n\t\tdocument.getElementsByTagName(\"html\")[0]?.getAttribute(\"lang\") || \"en-US\"\n\t);\n}\n\n/**\n * Provides a way to obtain a localized string representation of a currency\n * value based on the specified value, utilizing a separate currencyFormatter\n * object for the formatting process. It removes the currency code substring and\n * trims any surrounding whitespace from the resulting string.\n *\n * @param value The currency value to be formatted.\n * @returns A localized string representation of the currency value.\n */\nexport function getLocalizedCurrency(value: number): string {\n\treturn getCurrancyFormatter().format(value).replace(\"US\", \"\").trim();\n}\n\n/**\n * Provides a way to obtain a localized string representation of a date,\n * including the month, day, and year, based on the specified format and\n * locale.\n *\n * @param date The date to be formatted.\n * @param forceLocale The locale to use for formatting the date. Defaults to the\n *   HTM language attribute.\n * @returns A localized string representation of the date.\n */\nexport function getLocalizedDate(\n\tdate: Date | string,\n\tforceLocale?: string,\n): string {\n\tconst formatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {\n\t\tday: \"numeric\",\n\t\tmonth: \"long\",\n\t\ttimeZone: \"UTC\",\n\t\tyear: \"numeric\",\n\t});\n\treturn formatter.format(new Date(date));\n}\n\n/**\n * Provides a way to obtain a localized string representation of a day based on\n * the specified date and locale.\n *\n * @param date The date to be formatted.\n * @param forceLocale The locale to use for formatting the day. Defaults to the\n *   HTML language attribute.\n * @returns A localized string representation of the day.\n */\nexport function getLocalizedDay(date: string, forceLocale?: string): string {\n\tconst formatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {\n\t\ttimeZone: \"UTC\",\n\t\tweekday: \"long\",\n\t});\n\treturn formatter.format(new Date(date));\n}\n\n/**\n * Provides a way to obtain a localized string representation of a month based\n * on the specified date and locale.\n *\n * @param date The date to be formatted.\n * @param forceLocale The locale to use for formatting the month. Defaults to\n *   the HTML language attribute.\n * @returns A localized string representation of the month.\n */\nexport function getLocalizedMonth(date: string, forceLocale?: string): string {\n\tconst formatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {\n\t\tmonth: \"long\",\n\t\ttimeZone: \"UTC\",\n\t});\n\treturn formatter.format(new Date(date));\n}\n\n/**\n * In summary, the getLocalizedQuantity function provides a way to obtain a\n * localized string representation of a quantity based on the specified value,\n * utilizing a separate quantityFormatter object for the formatting process.\n *\n * @param value The quantity value to be formatted.\n * @returns A localized string representation of the quantity value.\n */\nexport function getLocalizedQuantity(value: number): string {\n\treturn getQuantityFormatter().format(value);\n}\n\n/**\n * Provides a way to obtain an array of localized month names based on the\n * specified format.\n *\n * @param format The format of the month names to return.\n * @returns An array of localized month names.\n */\nexport function getMonthNames(\n\tformat: \"2-digit\" | \"long\" | \"narrow\" | \"numeric\" | \"short\" = \"long\",\n): string[] {\n\tconst formatter = new Intl.DateTimeFormat(getLocale(), {\n\t\tmonth: format,\n\t\ttimeZone: \"UTC\",\n\t});\n\tconst months = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12].map((month) => {\n\t\tconst mm = month < 10 ? `0${String(month)}` : month;\n\t\treturn new Date(`2017-${String(mm)}-01T00:00:00+00:00`);\n\t});\n\treturn months.map((date) => formatter.format(date));\n}\n\n/**\n * Returns a currency formatter object that can be used to format currency\n * values.\n *\n * @returns A currency formatter object.\n */\nfunction getCurrancyFormatter(): Intl.NumberFormat {\n\treturn new Intl.NumberFormat(getLocale(), {\n\t\tcurrency: \"USD\",\n\t\tcurrencyDisplay: \"symbol\",\n\t\tstyle: \"currency\",\n\t});\n}\n\n/**\n * Returns a quantity formatter object that can be used to format quantity\n * values.\n *\n * @returns A quantity formatter object.\n */\nfunction getQuantityFormatter(): Intl.NumberFormat {\n\treturn new Intl.NumberFormat(getLocale());\n}\n\nconst suffixes_en = {\n\tfew: \"rd\",\n\tmany: \"th\",\n\tone: \"st\",\n\tother: \"th\",\n\ttwo: \"nd\",\n\tzero: \"\",\n};\nconst suffixes_fr = {\n\tfew: \"e\",\n\tmany: \"e\",\n\tone: \"er\",\n\tother: \"e\",\n\ttwo: \"e\",\n\tzero: \"\",\n};\n\n/**\n * Provides a way to obtain a localized string representation of an ordinal.\n *\n * @param date The date to be formatted.\n * @param forceLocale The locale to use for formatting the ordinal. Defaults to\n *   the HTML language attribute.\n * @returns A localized string representation of the ordinal.\n */\nexport function getLocalizedOrdinal(\n\tdate: string,\n\tforceLocale?: string,\n): string {\n\tconst locale = forceLocale ?? getLocale();\n\tconst ordinalFormatter = new Intl.PluralRules(locale, {\n\t\ttype: \"ordinal\",\n\t});\n\tconst dateFormatter = new Intl.DateTimeFormat(forceLocale ?? getLocale(), {\n\t\tday: \"numeric\",\n\t\ttimeZone: \"UTC\",\n\t});\n\tconst number = parseInt(dateFormatter.format(new Date(date)));\n\tconst category = ordinalFormatter.select(number);\n\tconst suffix =\n\t\tlocale === \"fr-CA\"\n\t\t\t? safeishGetProperty(suffixes_fr, category)\n\t\t\t: safeishGetProperty(suffixes_en, category);\n\treturn String(number) + suffix;\n}\n"]}

package/dist/esm/general/maps.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Creates an array in the map at the given key if it doesn't exist, or appends
+ * to the existing one if it does.
+ *
+ * @template TData The type of the data items.
+ * @template TKey The type of the key in the map.
+ * @param map The map to modify.
+ * @param id The key at which to append or create the array.
+ * @param item The data item to append.
+ */
+export declare function appendOrCreate<TData, TKey>(map: Map<TKey, TData[]>, id: TKey, item: TData): void;
+/**
+ * Groups an input item into a map, transforming a property from the input into
+ * a child array on the map item.
+ *
+ * @template TKey The type of the key in the map.
+ * @template TChildItem The type of the child item (e.g., `number`).
+ * @template TInputChildKey The key on the input item (e.g., `"item"`).
+ * @template TMapChildKey The key on the map item (e.g., `"items"`).
+ * @template TBase The base object type (e.g., `{ name: string }`).
+ * @template TInputItem The full input item type (e.g., `{ name: string; item:
+ *   number }`).
+ * @template TMapItem The full map item type (e.g., `{ name: string; items:
+ *   number[] }`).
+ * @param map The map to modify.
+ * @param id The key at which to find or create the parent entry.
+ * @param item The raw input item to process.
+ * @param childKey The property key on `item` to get the child value from.
+ * @param childrenFieldName The property key on the _map's_ item to push the
+ *   child value into.
+ * @throws {Error} Will throw an error if `childrenFieldName` does not point to
+ *   an array on an existing map item.
+ */
+export declare function appendOrCreateWithChildren<TKey, TChildItem, TInputChildKey extends PropertyKey, TMapChildKey extends PropertyKey, TBase extends object, TInputItem extends Record<TInputChildKey, TChildItem> & TBase, TMapItem extends Record<TMapChildKey, TChildItem[]> & TBase>(map: Map<TKey, TMapItem>, id: TKey, item: TInputItem, childKey: TInputChildKey, childrenFieldName: TMapChildKey): void;
+//# sourceMappingURL=maps.d.ts.map

package/dist/esm/general/maps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maps.d.ts","sourceRoot":"","sources":["../../../src/general/maps.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,IAAI,EACzC,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EACvB,EAAE,EAAE,IAAI,EACR,IAAI,EAAE,KAAK,GACT,IAAI,CAON;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,0BAA0B,CACzC,IAAI,EACJ,UAAU,EACV,cAAc,SAAS,WAAW,EAClC,YAAY,SAAS,WAAW,EAChC,KAAK,SAAS,MAAM,EACpB,UAAU,SAAS,MAAM,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG,KAAK,EAC7D,QAAQ,SAAS,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC,GAAG,KAAK,EAE3D,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,EACxB,EAAE,EAAE,IAAI,EACR,IAAI,EAAE,UAAU,EAChB,QAAQ,EAAE,cAAc,EACxB,iBAAiB,EAAE,YAAY,GAC7B,IAAI,CAgBN"}

package/dist/esm/general/maps.js

@@ -0,0 +1,59 @@
+import { safeishGetProperty } from "./objects.js";
+/**
+ * Creates an array in the map at the given key if it doesn't exist, or appends
+ * to the existing one if it does.
+ *
+ * @template TData The type of the data items.
+ * @template TKey The type of the key in the map.
+ * @param map The map to modify.
+ * @param id The key at which to append or create the array.
+ * @param item The data item to append.
+ */
+export function appendOrCreate(map, id, item) {
+    const existing = map.get(id);
+    if (!existing) {
+        map.set(id, [item]);
+    }
+    else {
+        existing.push(item);
+    }
+}
+/**
+ * Groups an input item into a map, transforming a property from the input into
+ * a child array on the map item.
+ *
+ * @template TKey The type of the key in the map.
+ * @template TChildItem The type of the child item (e.g., `number`).
+ * @template TInputChildKey The key on the input item (e.g., `"item"`).
+ * @template TMapChildKey The key on the map item (e.g., `"items"`).
+ * @template TBase The base object type (e.g., `{ name: string }`).
+ * @template TInputItem The full input item type (e.g., `{ name: string; item:
+ *   number }`).
+ * @template TMapItem The full map item type (e.g., `{ name: string; items:
+ *   number[] }`).
+ * @param map The map to modify.
+ * @param id The key at which to find or create the parent entry.
+ * @param item The raw input item to process.
+ * @param childKey The property key on `item` to get the child value from.
+ * @param childrenFieldName The property key on the _map's_ item to push the
+ *   child value into.
+ * @throws {Error} Will throw an error if `childrenFieldName` does not point to
+ *   an array on an existing map item.
+ */
+export function appendOrCreateWithChildren(map, id, item, childKey, childrenFieldName) {
+    const existing = map.get(id);
+    const childItem = safeishGetProperty(item, childKey);
+    if (!existing) {
+        const { [childKey]: _discard, ...base } = item;
+        const newMapItem = {
+            ...base,
+            [childrenFieldName]: [childItem],
+        };
+        map.set(id, newMapItem);
+    }
+    else {
+        const childArray = safeishGetProperty(existing, childrenFieldName);
+        childArray.push(childItem);
+    }
+}
+//# sourceMappingURL=maps.js.map

package/dist/esm/general/maps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maps.js","sourceRoot":"","sources":["../../../src/general/maps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAC7B,GAAuB,EACvB,EAAQ,EACR,IAAW;IAEX,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;IACrB,CAAC;SAAM,CAAC;QACP,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,0BAA0B,CASzC,GAAwB,EACxB,EAAQ,EACR,IAAgB,EAChB,QAAwB,EACxB,iBAA+B;IAE/B,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC7B,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAErD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACf,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QAE/C,MAAM,UAAU,GAAG;YAClB,GAAI,IAAc;YAClB,CAAC,iBAAiB,CAAC,EAAE,CAAC,SAAS,CAAC;SACpB,CAAC;QACd,GAAG,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACzB,CAAC;SAAM,CAAC;QACP,MAAM,UAAU,GAAG,kBAAkB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;QACnE,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC5B,CAAC;AACF,CAAC","sourcesContent":["import { safeishGetProperty } from \"./objects.js\";\n\n/**\n * Creates an array in the map at the given key if it doesn't exist, or appends\n * to the existing one if it does.\n *\n * @template TData The type of the data items.\n * @template TKey The type of the key in the map.\n * @param map The map to modify.\n * @param id The key at which to append or create the array.\n * @param item The data item to append.\n */\nexport function appendOrCreate<TData, TKey>(\n\tmap: Map<TKey, TData[]>,\n\tid: TKey,\n\titem: TData,\n): void {\n\tconst existing = map.get(id);\n\tif (!existing) {\n\t\tmap.set(id, [item]);\n\t} else {\n\t\texisting.push(item);\n\t}\n}\n\n/**\n * Groups an input item into a map, transforming a property from the input into\n * a child array on the map item.\n *\n * @template TKey The type of the key in the map.\n * @template TChildItem The type of the child item (e.g., `number`).\n * @template TInputChildKey The key on the input item (e.g., `\"item\"`).\n * @template TMapChildKey The key on the map item (e.g., `\"items\"`).\n * @template TBase The base object type (e.g., `{ name: string }`).\n * @template TInputItem The full input item type (e.g., `{ name: string; item:\n *   number }`).\n * @template TMapItem The full map item type (e.g., `{ name: string; items:\n *   number[] }`).\n * @param map The map to modify.\n * @param id The key at which to find or create the parent entry.\n * @param item The raw input item to process.\n * @param childKey The property key on `item` to get the child value from.\n * @param childrenFieldName The property key on the _map's_ item to push the\n *   child value into.\n * @throws {Error} Will throw an error if `childrenFieldName` does not point to\n *   an array on an existing map item.\n */\nexport function appendOrCreateWithChildren<\n\tTKey,\n\tTChildItem,\n\tTInputChildKey extends PropertyKey,\n\tTMapChildKey extends PropertyKey,\n\tTBase extends object,\n\tTInputItem extends Record<TInputChildKey, TChildItem> & TBase,\n\tTMapItem extends Record<TMapChildKey, TChildItem[]> & TBase,\n>(\n\tmap: Map<TKey, TMapItem>,\n\tid: TKey,\n\titem: TInputItem,\n\tchildKey: TInputChildKey,\n\tchildrenFieldName: TMapChildKey,\n): void {\n\tconst existing = map.get(id);\n\tconst childItem = safeishGetProperty(item, childKey);\n\n\tif (!existing) {\n\t\tconst { [childKey]: _discard, ...base } = item;\n\n\t\tconst newMapItem = {\n\t\t\t...(base as TBase),\n\t\t\t[childrenFieldName]: [childItem],\n\t\t} as TMapItem;\n\t\tmap.set(id, newMapItem);\n\t} else {\n\t\tconst childArray = safeishGetProperty(existing, childrenFieldName);\n\t\tchildArray.push(childItem);\n\t}\n}\n"]}

package/dist/esm/general/messenger/createMessenger.d.ts

@@ -0,0 +1,10 @@
+import type { MessengerFactory } from "./types.js";
+/**
+ * Factory for creating a de-bounced/throttled message function.
+ *
+ * @template T The successful result data type.
+ * @param params See MessengerFactory for parameters.
+ * @returns The update status function.
+ */
+export declare function createMessenger<T>(...params: Parameters<MessengerFactory<T>>): ReturnType<MessengerFactory<T>>;
+//# sourceMappingURL=createMessenger.d.ts.map

package/dist/esm/general/messenger/createMessenger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMessenger.d.ts","sourceRoot":"","sources":["../../../../src/general/messenger/createMessenger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAiB,MAAM,YAAY,CAAC;AAElE;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAChC,GAAG,MAAM,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACxC,UAAU,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAgEjC"}

package/dist/esm/general/messenger/createMessenger.js

@@ -0,0 +1,65 @@
+/**
+ * Factory for creating a de-bounced/throttled message function.
+ *
+ * @template T The successful result data type.
+ * @param params See MessengerFactory for parameters.
+ * @returns The update status function.
+ */
+export function createMessenger(...params) {
+    const [postMessage, options = {}] = params;
+    const { statusTimeout = 100 } = options;
+    let timeout;
+    let lastMessage = null;
+    let lastSent = 0;
+    const post = (message) => {
+        lastSent = Date.now();
+        postMessage(message);
+    };
+    const clearPending = () => {
+        lastMessage = null;
+        if (timeout) {
+            clearTimeout(timeout);
+            timeout = null;
+        }
+    };
+    const updateStatus = (status, force = false) => {
+        const now = Date.now();
+        lastMessage = status;
+        // Immediately send if enough time has passed since last send
+        if (force || now - lastSent >= statusTimeout) {
+            clearPending();
+            post({ status });
+            return;
+        }
+        // Schedule next possible send if not already scheduled
+        if (!timeout) {
+            const timeSinceLast = now - lastSent;
+            const delay = Math.max(statusTimeout - timeSinceLast, 0);
+            timeout = setTimeout(() => {
+                if (lastMessage) {
+                    post({ status: lastMessage });
+                    lastMessage = null;
+                }
+                timeout = null;
+            }, delay);
+        }
+    };
+    const sendError = (e) => {
+        // Make sure the last thing to happen is communicated to the client.
+        if (lastMessage)
+            updateStatus(lastMessage, true);
+        clearPending();
+        if (e instanceof Error) {
+            post({ error: e.message });
+        }
+        else {
+            post({ error: String(e) });
+        }
+    };
+    const sendSuccess = (data) => {
+        clearPending();
+        post({ data });
+    };
+    return { sendError, sendSuccess, updateStatus };
+}
+//# sourceMappingURL=createMessenger.js.map

package/dist/esm/general/messenger/createMessenger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMessenger.js","sourceRoot":"","sources":["../../../../src/general/messenger/createMessenger.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC9B,GAAG,MAAuC;IAE1C,MAAM,CAAC,WAAW,EAAE,OAAO,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC;IAC3C,MAAM,EAAE,aAAa,GAAG,GAAG,EAAE,GAAG,OAAO,CAAC;IACxC,IAAI,OAA6C,CAAC;IAClD,IAAI,WAAW,GAAkB,IAAI,CAAC;IACtC,IAAI,QAAQ,GAAG,CAAC,CAAC;IACjB,MAAM,IAAI,GAAG,CAAC,OAAyB,EAAE,EAAE;QAC1C,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACtB,WAAW,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,GAAG,EAAE;QACzB,WAAW,GAAG,IAAI,CAAC;QACnB,IAAI,OAAO,EAAE,CAAC;YACb,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,OAAO,GAAG,IAAI,CAAC;QAChB,CAAC;IACF,CAAC,CAAC;IAEF,MAAM,YAAY,GAAoD,CACrE,MAAM,EACN,KAAK,GAAG,KAAK,EACZ,EAAE;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,WAAW,GAAG,MAAM,CAAC;QAErB,6DAA6D;QAC7D,IAAI,KAAK,IAAI,GAAG,GAAG,QAAQ,IAAI,aAAa,EAAE,CAAC;YAC9C,YAAY,EAAE,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YACjB,OAAO;QACR,CAAC;QAED,uDAAuD;QACvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACd,MAAM,aAAa,GAAG,GAAG,GAAG,QAAQ,CAAC;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;YAEzD,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;gBACzB,IAAI,WAAW,EAAE,CAAC;oBACjB,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;oBAC9B,WAAW,GAAG,IAAI,CAAC;gBACpB,CAAC;gBACD,OAAO,GAAG,IAAI,CAAC;YAChB,CAAC,EAAE,KAAK,CAAC,CAAC;QACX,CAAC;IACF,CAAC,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,CAAU,EAAE,EAAE;QAChC,oEAAoE;QACpE,IAAI,WAAW;YAAE,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjD,YAAY,EAAE,CAAC;QACf,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC;YACxB,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC5B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC5B,CAAC;IACF,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,IAAO,EAAE,EAAE;QAC/B,YAAY,EAAE,CAAC;QACf,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAChB,CAAC,CAAC;IACF,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;AACjD,CAAC","sourcesContent":["import type { MessengerFactory, WorkerMessage } from \"./types.js\";\n\n/**\n * Factory for creating a de-bounced/throttled message function.\n *\n * @template T The successful result data type.\n * @param params See MessengerFactory for parameters.\n * @returns The update status function.\n */\nexport function createMessenger<T>(\n\t...params: Parameters<MessengerFactory<T>>\n): ReturnType<MessengerFactory<T>> {\n\tconst [postMessage, options = {}] = params;\n\tconst { statusTimeout = 100 } = options;\n\tlet timeout: null | ReturnType<typeof setTimeout>;\n\tlet lastMessage: null | string = null;\n\tlet lastSent = 0;\n\tconst post = (message: WorkerMessage<T>) => {\n\t\tlastSent = Date.now();\n\t\tpostMessage(message);\n\t};\n\n\tconst clearPending = () => {\n\t\tlastMessage = null;\n\t\tif (timeout) {\n\t\t\tclearTimeout(timeout);\n\t\t\ttimeout = null;\n\t\t}\n\t};\n\n\tconst updateStatus: ReturnType<MessengerFactory<T>>[\"updateStatus\"] = (\n\t\tstatus,\n\t\tforce = false,\n\t) => {\n\t\tconst now = Date.now();\n\t\tlastMessage = status;\n\n\t\t// Immediately send if enough time has passed since last send\n\t\tif (force || now - lastSent >= statusTimeout) {\n\t\t\tclearPending();\n\t\t\tpost({ status });\n\t\t\treturn;\n\t\t}\n\n\t\t// Schedule next possible send if not already scheduled\n\t\tif (!timeout) {\n\t\t\tconst timeSinceLast = now - lastSent;\n\t\t\tconst delay = Math.max(statusTimeout - timeSinceLast, 0);\n\n\t\t\ttimeout = setTimeout(() => {\n\t\t\t\tif (lastMessage) {\n\t\t\t\t\tpost({ status: lastMessage });\n\t\t\t\t\tlastMessage = null;\n\t\t\t\t}\n\t\t\t\ttimeout = null;\n\t\t\t}, delay);\n\t\t}\n\t};\n\n\tconst sendError = (e: unknown) => {\n\t\t// Make sure the last thing to happen is communicated to the client.\n\t\tif (lastMessage) updateStatus(lastMessage, true);\n\t\tclearPending();\n\t\tif (e instanceof Error) {\n\t\t\tpost({ error: e.message });\n\t\t} else {\n\t\t\tpost({ error: String(e) });\n\t\t}\n\t};\n\n\tconst sendSuccess = (data: T) => {\n\t\tclearPending();\n\t\tpost({ data });\n\t};\n\treturn { sendError, sendSuccess, updateStatus };\n}\n"]}

package/dist/esm/general/messenger/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./createMessenger.js";
+export * from "./types.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/general/messenger/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC"}

package/dist/esm/general/messenger/index.js

@@ -0,0 +1,3 @@
+export * from "./createMessenger.js";
+export * from "./types.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/general/messenger/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/general/messenger/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC","sourcesContent":["export * from \"./createMessenger.js\";\nexport * from \"./types.js\";\n"]}

package/dist/esm/general/messenger/types.d.ts

@@ -0,0 +1,26 @@
+/**
+ * A function for creating a messenger that uses the self.postMessage function
+ * for sending messages between workers.
+ *
+ * @template T The type of a successful result.
+ * @param postMessage The self.postMessage function.
+ * @param options The options for the messenger.
+ * @returns UpdateStatus, sendSuccess, and sendError functions.
+ */
+export type MessengerFactory<T> = (postMessage: PostMessageFunction, options?: MessengerOptions) => {
+    sendError: (error: unknown) => void;
+    sendSuccess: (data: T) => void;
+    updateStatus: (status: string, force?: boolean) => void;
+};
+export type MessengerOptions = {
+    statusTimeout?: number;
+};
+export type PostMessageFunction = (typeof self)["postMessage"];
+export type WorkerMessage<T> = {
+    data: T;
+} | {
+    error: string;
+} | {
+    status: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/general/messenger/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/general/messenger/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CACjC,WAAW,EAAE,mBAAmB,EAChC,OAAO,CAAC,EAAE,gBAAgB,KACtB;IACJ,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACpC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAC/B,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1D,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,aAAa,CAAC,CAAC;AAE/D,MAAM,MAAM,aAAa,CAAC,CAAC,IACxB;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,GACX;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GACjB;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dist/esm/general/messenger/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/general/messenger/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/general/messenger/types.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A function for creating a messenger that uses the self.postMessage function\n * for sending messages between workers.\n *\n * @template T The type of a successful result.\n * @param postMessage The self.postMessage function.\n * @param options The options for the messenger.\n * @returns UpdateStatus, sendSuccess, and sendError functions.\n */\nexport type MessengerFactory<T> = (\n\tpostMessage: PostMessageFunction,\n\toptions?: MessengerOptions,\n) => {\n\tsendError: (error: unknown) => void;\n\tsendSuccess: (data: T) => void;\n\tupdateStatus: (status: string, force?: boolean) => void;\n};\n\nexport type MessengerOptions = { statusTimeout?: number };\n\nexport type PostMessageFunction = (typeof self)[\"postMessage\"];\n\nexport type WorkerMessage<T> =\n\t| { data: T }\n\t| { error: string }\n\t| { status: string };\n"]}