@uxf/localize 11.2.1 → 11.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uxf/localize",
-  "version": "11.2.1",
+  "version": "11.10.0",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
     "react": ">=18.2.0"
   },
   "devDependencies": {
-    "@types/react": "18.2.27",
+    "@types/react": "18.2.57",
     "react": "18.2.0"
   }
 }

package/src/components/format-datetime.d.ts

@@ -1,2 +1,2 @@
-import { DateTimes, FormatDatetimeComponent, LocalizeConfigMap } from "../types";
-export declare function createFormatDatetimeComponent<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatDatetimeComponent<DT>;
+import { FormatDatetimeComponent, LocalizeConfigMap } from "../types";
+export declare function createFormatDatetimeComponent<DT extends string, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatDatetimeComponent<DT>;

package/src/components/format-money.d.ts

@@ -1,2 +1,2 @@
-import { DateTimes, FormatMoneyComponent, LocalizeConfigMap } from "../types";
-export declare function createFormatMoneyComponent<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatMoneyComponent;
+import { FormatMoneyComponent, LocalizeConfigMap } from "../types";
+export declare function createFormatMoneyComponent<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): FormatMoneyComponent;

package/src/components/format-number.d.ts

@@ -1,2 +1,2 @@
-import { DateTimes, FormatNumberComponent, LocalizeConfigMap } from "../types";
-export declare function createFormatNumberComponent<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatNumberComponent;
+import { FormatNumberComponent, LocalizeConfigMap } from "../types";
+export declare function createFormatNumberComponent<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): FormatNumberComponent;

package/src/components/format-percentage.d.ts

@@ -1,2 +1,2 @@
-import { DateTimes, FormatPercentageComponent, LocalizeConfigMap } from "../types";
-export declare function createFormatPercentageComponent<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatPercentageComponent;
+import { FormatPercentageComponent, LocalizeConfigMap } from "../types";
+export declare function createFormatPercentageComponent<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): FormatPercentageComponent;

package/src/context/context.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { DateTimes, LocalizeConfigMap } from "../types";
+import { LocalizeConfigMap } from "../types";
 export declare const _useLocalizeContext: () => string;
 export declare const _LocalizeProvider: import("react").Provider<string>;
-export declare const getLocaleConfigHook: <DT extends DateTimes, Locales extends string>(allConfigurations: LocalizeConfigMap<DT, Locales>) => () => LocalizeConfigMap<DT, Locales>[Locales];
+export declare const getLocaleConfigHook: <DateTimes extends string, Locales extends string>(allConfigurations: LocalizeConfigMap<DateTimes, Locales>) => () => LocalizeConfigMap<DateTimes, Locales>[Locales];

package/src/format-datetime/format-datetime.d.ts

@@ -1,3 +1,3 @@
-import { DateTimes, FormatDatetimeFunction, LocalizeConfigMap } from "../types";
-export declare function createFormatDatetime<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatDatetimeFunction<DT, Locales>;
-export declare function createUseFormatDatetime<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): () => (value: import("../types").DateValue, format: DT) => string;
+import { FormatDatetimeFunction, LocalizeConfigMap } from "../types";
+export declare function createFormatDatetime<DT extends string, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatDatetimeFunction<DT, Locales>;
+export declare function createUseFormatDatetime<DT extends string, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): () => (value: import("../types").DateValue, format: DT) => string;

package/src/format-money/format-money.d.ts

@@ -1,3 +1,3 @@
-import { DateTimes, FormatMoneyFunction, LocalizeConfigMap } from "../types";
-export declare function createFormatMoney<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatMoneyFunction<Locales>;
-export declare function createUseFormatMoney<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): () => (money: import("../types").Money, options?: import("../types").FormatMoneyOptions | undefined) => string;
+import { FormatMoneyFunction, LocalizeConfigMap } from "../types";
+export declare function createFormatMoney<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): FormatMoneyFunction<Locales>;
+export declare function createUseFormatMoney<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): () => (money: import("../types").Money, options?: import("../types").FormatMoneyOptions | undefined) => string;

package/src/format-number/format-number.d.ts

@@ -1,3 +1,3 @@
-import { DateTimes, FormatNumberFunction, LocalizeConfigMap } from "../types";
-export declare function createFormatNumber<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatNumberFunction<Locales>;
-export declare function createUseFormatNumber<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): () => (value: number, options?: import("../types").FormatNumberOptions | undefined) => string;
+import { FormatNumberFunction, LocalizeConfigMap } from "../types";
+export declare function createFormatNumber<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): FormatNumberFunction<Locales>;
+export declare function createUseFormatNumber<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): () => (value: number, options?: import("../types").FormatNumberOptions | undefined) => string;

package/src/format-percentage/format-percentage.d.ts

@@ -1,3 +1,3 @@
-import { DateTimes, FormatPercentageFunction, LocalizeConfigMap, RoundingType } from "../types";
-export declare function createFormatPercentage<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): FormatPercentageFunction<Locales>;
-export declare function createUseFormatPercentage<DT extends DateTimes, Locales extends string>(localizeConfigs: LocalizeConfigMap<DT, Locales>): () => (value: number, roundingType?: RoundingType | null | undefined, options?: import("../types").FormatPercentageOptions | undefined) => string;
+import { FormatPercentageFunction, LocalizeConfigMap, RoundingType } from "../types";
+export declare function createFormatPercentage<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): FormatPercentageFunction<Locales>;
+export declare function createUseFormatPercentage<Locales extends string>(localizeConfigs: LocalizeConfigMap<never, Locales>): () => (value: number, roundingType?: RoundingType | null | undefined, options?: import("../types").FormatPercentageOptions | undefined) => string;

package/src/index.d.ts

@@ -1,3 +1,3 @@
 import { CreateLocalizeReturn, DateTimes, LocalizeConfigMap } from "./types";
 export * from "./get-currency-symbol/get-currency-symbol";
-export declare function createLocalize<DT extends DateTimes, Locales extends string>(config: LocalizeConfigMap<DT, Locales>): CreateLocalizeReturn<DT, Locales>;
+export declare function createLocalize<DT extends string = DateTimes, Locales extends string = string>(config: LocalizeConfigMap<DT, Locales>): CreateLocalizeReturn<DT, Locales>;

package/src/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/src/index.test.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cs_1 = __importDefault(require("../locale/cs"));
+const en_1 = __importDefault(require("../locale/en"));
+const index_1 = require("./index");
+const date = new Date("2023-07-21T07:58:35");
+describe("basic createLocalize", function () {
+    it("basic usage", function () {
+        const { formatDateTime } = (0, index_1.createLocalize)({ cs: cs_1.default, en: en_1.default });
+        expect(formatDateTime("cs", date, "dateShort")).toBe("21. 7. 23");
+    });
+    it("use custom formats for dates", function () {
+        const { formatDateTime } = (0, index_1.createLocalize)({
+            cs: { ...cs_1.default, dateTime: { ...cs_1.default.dateTime, custom: "dd DD. MM." } },
+        });
+        expect(formatDateTime("cs", date, "custom")).toBe("Fr 21. 07.");
+    });
+});

package/src/types.d.ts

@@ -1,7 +1,7 @@
 import { FC, Provider } from "react";
 import { CURRENCIES } from "./utils/data";
 export type DateTimes = "timeShort" | "timeFull" | "dateShort" | "dateMedium" | "dateLong" | "dateShortNoYear" | "dateLongNoYear" | "dateTimeShort" | "dateTimeMedium" | "dateTimeLong";
-export type LocalizeConfig<DT extends DateTimes> = {
+export type LocalizeConfig<DT extends string> = {
     number: {
         thousandsSeparator: string;
         decimalSeparator: string;
@@ -14,9 +14,9 @@ export type LocalizeConfig<DT extends DateTimes> = {
     };
     dateTime: Record<DT, string>;
 };
-export type LocalizeConfigMap<DT extends DateTimes, Locales extends string> = Record<Locales, LocalizeConfig<DT>>;
+export type LocalizeConfigMap<DT extends string = DateTimes, Locales extends string = string> = Record<Locales, LocalizeConfig<DT>>;
 export type LocalizeProviderType = Provider<string>;
-export type UseLocaleConfigType<DT extends DateTimes> = () => LocalizeConfig<DT>;
+export type UseLocaleConfigType<DT extends string> = () => LocalizeConfig<DT>;
 export type Money = {
     amount: string;
     currency: Currency;
@@ -43,13 +43,13 @@ export type FormatPercentageComponent = FC<{
 export type DateString = `${number}-${number}-${number}`;
 export type DateTimeString = `${number}-${number}-${number}T${number}:${number}:${number}+${number}:${number}`;
 export type DateValue = Date | DateString | DateTimeString;
-export type FormatDatetimeFunction<DT extends DateTimes, Locales extends string> = (locale: Locales, value: DateValue, format: DT) => string;
-export type UseFormatDatetimeFunction<DT extends DateTimes> = () => (value: DateValue, format: DT) => string;
-export type FormatDatetimeComponent<DT extends DateTimes> = FC<{
+export type FormatDatetimeFunction<DT extends string, Locales extends string> = (locale: Locales, value: DateValue, format: DT) => string;
+export type UseFormatDatetimeFunction<DT extends string> = () => (value: DateValue, format: DT) => string;
+export type FormatDatetimeComponent<DT extends string> = FC<{
     value: DateValue;
     format: DT;
 }>;
-export type CreateLocalizeReturn<DT extends DateTimes, Locales extends string> = {
+export type CreateLocalizeReturn<DT extends string, Locales extends string> = {
     LocalizeProvider: LocalizeProviderType;
     useLocaleConfig: UseLocaleConfigType<DT>;
     formatNumber: FormatNumberFunction<Locales>;