@d3plus/locales 3.0.15 → 3.1.0

package/package.json

@@ -1,18 +1,25 @@
 {
   "name": "@d3plus/locales",
-  "version": "3.0.15",
+  "version": "3.1.0",
   "description": "International localizations for number, date, and UI labels.",
   "license": "MIT",
   "type": "module",
-  "exports": "./es/index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./es/index.js"
+    }
+  },
   "browser": "./umd/d3plus-locales.full.js",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "sideEffects": false,
   "files": [
     "umd",
-    "es"
+    "es",
+    "types"
   ],
   "homepage": "https://d3plus.org",
   "repository": {
@@ -29,8 +36,9 @@
   ],
   "scripts": {
     "build:esm": "node ../../scripts/build-esm.js",
+    "build:types": "tsc",
     "build:umd": "node ../../scripts/build-umd.js",
     "dev": "node ../../scripts/dev.js",
-    "test": "eslint index.js src/**/*.js && eslint --global=it test && mocha 'test/**/*-test.js'"
+    "test": "eslint index.ts src/**/*.ts && eslint --global=it test && mocha 'test/**/*-test.js'"
   }
 }

package/types/index.d.ts

@@ -0,0 +1,7 @@
+export { default as translateLocale } from "./src/dictionaries/translateLocale.js";
+export { default as formatLocale } from "./src/dictionaries/formatLocale.js";
+export { default as locale } from "./src/dictionaries/timeLocale.js";
+export { default as findLocale } from "./src/findLocale.js";
+export type { TranslationStrings } from "./src/dictionaries/translateLocale.js";
+export type { FormatLocaleDefinition } from "./src/dictionaries/formatLocale.js";
+export type { TimeLocaleDefinition } from "./src/dictionaries/timeLocale.js";

package/types/src/dictionaries/formatLocale.d.ts

@@ -0,0 +1,16 @@
+/**
+    @namespace {Object} formatLocale
+    A set of default locale formatters used when assigning suffixes and currency in numbers.
+*/
+export interface FormatLocaleDefinition {
+    separator?: string;
+    suffixes: string[];
+    grouping: number[];
+    delimiters: {
+        thousands: string;
+        decimal: string;
+    };
+    currency: [string, string];
+}
+declare const formatLocale: Record<string, FormatLocaleDefinition>;
+export default formatLocale;

package/types/src/dictionaries/timeLocale.d.ts

@@ -0,0 +1,39 @@
+export interface TimeLocaleDefinition {
+    dateTime: string;
+    date: string;
+    time: string;
+    quarter: string;
+    periods: [string, string];
+    days: [string, string, string, string, string, string, string];
+    shortDays: [string, string, string, string, string, string, string];
+    months: [
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string
+    ];
+    shortMonths: [
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string,
+        string
+    ];
+}
+declare const locale: Record<string, TimeLocaleDefinition>;
+export default locale;

package/types/src/dictionaries/translateLocale.d.ts

@@ -0,0 +1,21 @@
+export interface TranslationStrings {
+    and: string;
+    Back: string;
+    "Click to Expand": string;
+    "Click to Hide": string;
+    "Click to Highlight": string;
+    "Click to Show": string;
+    "Click to Show All": string;
+    Download: string;
+    "Loading Visualization": string;
+    more: string;
+    "No Data Available": string;
+    "Powered by D3plus": string;
+    Share: string;
+    "Shift+Click to Hide": string;
+    "Shift+Click to Highlight": string;
+    Total: string;
+    Values: string;
+}
+declare const translateLocale: Record<string, TranslationStrings>;
+export default translateLocale;

package/types/src/findLocale.d.ts

@@ -0,0 +1,5 @@
+/**
+    Converts a 2-letter language code into a full language-region locale string (e.g., "en" to "en-US").
+    @param locale A 2-letter language code (e.g., "en", "fr").
+*/
+export default function findLocale(locale: string): string;

package/types/src/utils/iso-codes.d.ts

@@ -0,0 +1,8 @@
+export interface IsoCodeEntry {
+    name: string;
+    names: string[];
+    "iso639-2": string;
+    "iso639-1": string | null;
+}
+declare const isoCodes: Record<string, IsoCodeEntry>;
+export default isoCodes;

package/types/src/utils/lookup.d.ts

@@ -0,0 +1,9 @@
+export interface LookupEntry {
+    language: string;
+    location: string | null;
+    id: number;
+    tag: string;
+    version?: string;
+}
+declare const lookup: Record<string, LookupEntry>;
+export default lookup;