@kyco-utils/number 0.1.3 → 0.2.0

package/README.md

@@ -1,7 +1,26 @@
 # @kyco-utils/number
 
-A set of utilities for TS projects.
+Locale-aware number utilities.
+
+## Install
+
+```sh
+pnpm add @kyco-utils/number zod
+```
+
+Requires `zod` v4 as a peer dependency (via `@kyco-utils/enums`). ESM only.
+
+## Usage
+
+```ts
+import { UserLocale } from '@kyco-utils/enums'
+import { getNumberSeparators } from '@kyco-utils/number'
+
+getNumberSeparators(UserLocale.DE_DE) // { thousandsSeparator: '.', decimalSeparator: ',' }
+```
+
+See the [API reference](https://kyco.github.io/kyco-utils/api/@kyco-utils/number) for all exports.
 
 ## License
 
-[MIT](LICENSE)
+[MIT](https://github.com/kyco/kyco-utils/blob/main/LICENSE)

package/dist/index.d.mts

@@ -1,11 +1,19 @@
 import { UserLocale } from "@kyco-utils/enums";
 import { NumberSeparators } from "@kyco-utils/types";
 /**
- * Gets the thousands and decimal separators for a given locale
+ * Returns the thousands and decimal separators for a locale, as used by `Intl.NumberFormat`.
+ * Falls back to `,` and `.` if the locale doesn't define one.
  *
- * @param locale - A supported {@link UserLocale} (BCP 47 language tag).
+ * @param locale - The {@link UserLocale} to get separators for.
  * @returns The {@link NumberSeparators} for the locale.
- * @see {@link UserLocale} for the list of supported locales.
+ * @example
+ * ```ts
+ * import { UserLocale } from '@kyco-utils/enums'
+ * import { getNumberSeparators } from '@kyco-utils/number'
+ *
+ * getNumberSeparators(UserLocale.EN_GB) // { thousandsSeparator: ',', decimalSeparator: '.' }
+ * getNumberSeparators(UserLocale.DE_DE) // { thousandsSeparator: '.', decimalSeparator: ',' }
+ * ```
  */
 export declare const getNumberSeparators: (locale: UserLocale) => NumberSeparators;
 //# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -1,15 +1,24 @@
 // src/index.ts
+const SAMPLE_NUMBER = 1234567.8;
 const DEFAULT_THOUSANDS_SEPARATOR = ",";
 const DEFAULT_DECIMAL_SEPARATOR = ".";
 /**
-* Gets the thousands and decimal separators for a given locale
+* Returns the thousands and decimal separators for a locale, as used by `Intl.NumberFormat`.
+* Falls back to `,` and `.` if the locale doesn't define one.
 *
-* @param locale - A supported {@link UserLocale} (BCP 47 language tag).
+* @param locale - The {@link UserLocale} to get separators for.
 * @returns The {@link NumberSeparators} for the locale.
-* @see {@link UserLocale} for the list of supported locales.
+* @example
+* ```ts
+* import { UserLocale } from '@kyco-utils/enums'
+* import { getNumberSeparators } from '@kyco-utils/number'
+*
+* getNumberSeparators(UserLocale.EN_GB) // { thousandsSeparator: ',', decimalSeparator: '.' }
+* getNumberSeparators(UserLocale.DE_DE) // { thousandsSeparator: '.', decimalSeparator: ',' }
+* ```
 */
 const getNumberSeparators = (locale) => {
-	const parts = new Intl.NumberFormat(locale).formatToParts(12345.6);
+	const parts = new Intl.NumberFormat(locale).formatToParts(SAMPLE_NUMBER);
 	return {
 		thousandsSeparator: parts.find((part) => part.type === "group")?.value ?? DEFAULT_THOUSANDS_SEPARATOR,
 		decimalSeparator: parts.find((part) => part.type === "decimal")?.value ?? DEFAULT_DECIMAL_SEPARATOR

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { UserLocale } from '@kyco-utils/enums'\nimport type { NumberSeparators } from '@kyco-utils/types'\n\nconst DEFAULT_THOUSANDS_SEPARATOR = ','\nconst DEFAULT_DECIMAL_SEPARATOR = '.'\n\n/**\n * Gets the thousands and decimal separators for a given locale\n *\n * @param locale - A supported {@link UserLocale} (BCP 47 language tag).\n * @returns The {@link NumberSeparators} for the locale.\n * @see {@link UserLocale} for the list of supported locales.\n */\nexport const getNumberSeparators = (locale: UserLocale): NumberSeparators => {\n  // @locale-updates\n  const parts = new Intl.NumberFormat(locale).formatToParts(12345.6)\n  const thousandsSeparator = parts.find((part) => part.type === 'group')?.value ?? DEFAULT_THOUSANDS_SEPARATOR\n  const decimalSeparator = parts.find((part) => part.type === 'decimal')?.value ?? DEFAULT_DECIMAL_SEPARATOR\n\n  return { thousandsSeparator, decimalSeparator }\n}\n"],"mappings":";AAGA,MAAM,8BAA8B;AACpC,MAAM,4BAA4B;;;;;;;;AASlC,MAAa,uBAAuB,WAAyC;CAE3E,MAAM,QAAQ,IAAI,KAAK,aAAa,MAAM,CAAC,CAAC,cAAc,OAAO;CAIjE,OAAO;EAAE,oBAHkB,MAAM,MAAM,SAAS,KAAK,SAAS,OAAO,CAAC,EAAE,SAAS;EAGpD,kBAFJ,MAAM,MAAM,SAAS,KAAK,SAAS,SAAS,CAAC,EAAE,SAAS;CAEnC;AAChD"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { UserLocale } from '@kyco-utils/enums'\nimport type { NumberSeparators } from '@kyco-utils/types'\n\nconst SAMPLE_NUMBER = 1234567.8\nconst DEFAULT_THOUSANDS_SEPARATOR = ','\nconst DEFAULT_DECIMAL_SEPARATOR = '.'\n\n/**\n * Returns the thousands and decimal separators for a locale, as used by `Intl.NumberFormat`.\n * Falls back to `,` and `.` if the locale doesn't define one.\n *\n * @param locale - The {@link UserLocale} to get separators for.\n * @returns The {@link NumberSeparators} for the locale.\n * @example\n * ```ts\n * import { UserLocale } from '@kyco-utils/enums'\n * import { getNumberSeparators } from '@kyco-utils/number'\n *\n * getNumberSeparators(UserLocale.EN_GB) // { thousandsSeparator: ',', decimalSeparator: '.' }\n * getNumberSeparators(UserLocale.DE_DE) // { thousandsSeparator: '.', decimalSeparator: ',' }\n * ```\n */\nexport const getNumberSeparators = (locale: UserLocale): NumberSeparators => {\n  // @locale-updates\n  const parts = new Intl.NumberFormat(locale).formatToParts(SAMPLE_NUMBER)\n  const thousandsSeparator = parts.find((part) => part.type === 'group')?.value ?? DEFAULT_THOUSANDS_SEPARATOR\n  const decimalSeparator = parts.find((part) => part.type === 'decimal')?.value ?? DEFAULT_DECIMAL_SEPARATOR\n\n  return { thousandsSeparator, decimalSeparator }\n}\n"],"mappings":";AAGA,MAAM,gBAAgB;AACtB,MAAM,8BAA8B;AACpC,MAAM,4BAA4B;;;;;;;;;;;;;;;;AAiBlC,MAAa,uBAAuB,WAAyC;CAE3E,MAAM,QAAQ,IAAI,KAAK,aAAa,MAAM,CAAC,CAAC,cAAc,aAAa;CAIvE,OAAO;EAAE,oBAHkB,MAAM,MAAM,SAAS,KAAK,SAAS,OAAO,CAAC,EAAE,SAAS;EAGpD,kBAFJ,MAAM,MAAM,SAAS,KAAK,SAAS,SAAS,CAAC,EAAE,SAAS;CAEnC;AAChD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kyco-utils/number",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Locale-aware number utilities for kyco-utils.",
   "type": "module",
   "sideEffects": false,
@@ -17,22 +17,19 @@
   "exports": {
     ".": {
       "@kyco-utils/source": "./src/index.ts",
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     }
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
   "dependencies": {
-    "@kyco-utils/enums": "^0.1.2",
-    "@kyco-utils/types": "^0.1.2"
+    "@kyco-utils/enums": "^0.2.0",
+    "@kyco-utils/types": "^0.2.0"
+  },
+  "peerDependencies": {
+    "zod": "^4.0.0"
+  },
+  "devDependencies": {
+    "zod": "^4.0.0"
   },
   "publishConfig": {
     "access": "public",
@@ -41,7 +38,6 @@
   "scripts": {
     "build": "vp pack",
     "dev": "vp pack --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "biome check ."
+    "typecheck": "tsc --noEmit"
   }
 }

package/dist/index.cjs

@@ -1,21 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-// src/index.ts
-const DEFAULT_THOUSANDS_SEPARATOR = ",";
-const DEFAULT_DECIMAL_SEPARATOR = ".";
-/**
-* Gets the thousands and decimal separators for a given locale
-*
-* @param locale - A supported {@link UserLocale} (BCP 47 language tag).
-* @returns The {@link NumberSeparators} for the locale.
-* @see {@link UserLocale} for the list of supported locales.
-*/
-const getNumberSeparators = (locale) => {
-	const parts = new Intl.NumberFormat(locale).formatToParts(12345.6);
-	return {
-		thousandsSeparator: parts.find((part) => part.type === "group")?.value ?? DEFAULT_THOUSANDS_SEPARATOR,
-		decimalSeparator: parts.find((part) => part.type === "decimal")?.value ?? DEFAULT_DECIMAL_SEPARATOR
-	};
-};
-exports.getNumberSeparators = getNumberSeparators;
-
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { UserLocale } from '@kyco-utils/enums'\nimport type { NumberSeparators } from '@kyco-utils/types'\n\nconst DEFAULT_THOUSANDS_SEPARATOR = ','\nconst DEFAULT_DECIMAL_SEPARATOR = '.'\n\n/**\n * Gets the thousands and decimal separators for a given locale\n *\n * @param locale - A supported {@link UserLocale} (BCP 47 language tag).\n * @returns The {@link NumberSeparators} for the locale.\n * @see {@link UserLocale} for the list of supported locales.\n */\nexport const getNumberSeparators = (locale: UserLocale): NumberSeparators => {\n  // @locale-updates\n  const parts = new Intl.NumberFormat(locale).formatToParts(12345.6)\n  const thousandsSeparator = parts.find((part) => part.type === 'group')?.value ?? DEFAULT_THOUSANDS_SEPARATOR\n  const decimalSeparator = parts.find((part) => part.type === 'decimal')?.value ?? DEFAULT_DECIMAL_SEPARATOR\n\n  return { thousandsSeparator, decimalSeparator }\n}\n"],"mappings":";;AAGA,MAAM,8BAA8B;AACpC,MAAM,4BAA4B;;;;;;;;AASlC,MAAa,uBAAuB,WAAyC;CAE3E,MAAM,QAAQ,IAAI,KAAK,aAAa,MAAM,CAAC,CAAC,cAAc,OAAO;CAIjE,OAAO;EAAE,oBAHkB,MAAM,MAAM,SAAS,KAAK,SAAS,OAAO,CAAC,EAAE,SAAS;EAGpD,kBAFJ,MAAM,MAAM,SAAS,KAAK,SAAS,SAAS,CAAC,EAAE,SAAS;CAEnC;AAChD"}

package/dist/index.d.cts

@@ -1,11 +0,0 @@
-import { UserLocale } from "@kyco-utils/enums";
-import { NumberSeparators } from "@kyco-utils/types";
-/**
- * Gets the thousands and decimal separators for a given locale
- *
- * @param locale - A supported {@link UserLocale} (BCP 47 language tag).
- * @returns The {@link NumberSeparators} for the locale.
- * @see {@link UserLocale} for the list of supported locales.
- */
-export declare const getNumberSeparators: (locale: UserLocale) => NumberSeparators;
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;qBAaa,sBAAmB,QAAY,eAAa"}

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;qBAaa,sBAAmB,QAAY,eAAa"}