@judo/i18n 0.1.0

package/dist/system-messages.d.ts

@@ -0,0 +1,198 @@
+/**
+ * System messages used throughout the application.
+ * Keys are organized by category for easy management and translation.
+ */
+export declare const SYSTEM_MESSAGES: {
+    readonly action: {
+        readonly save: {
+            readonly success: "Saved successfully";
+            readonly error: "Failed to save";
+            readonly loading: "Saving...";
+        };
+        readonly delete: {
+            readonly success: "Deleted successfully";
+            readonly error: "Failed to delete";
+            readonly confirm: "Are you sure you want to delete this item?";
+            readonly confirmTitle: "Confirm Delete";
+        };
+        readonly create: {
+            readonly success: "Created successfully";
+            readonly error: "Failed to create";
+        };
+        readonly update: {
+            readonly success: "Updated successfully";
+            readonly error: "Failed to update";
+        };
+        readonly cancel: {
+            readonly label: "Cancel";
+        };
+        readonly confirm: {
+            readonly label: "Confirm";
+        };
+        readonly close: {
+            readonly label: "Close";
+        };
+        readonly back: {
+            readonly label: "Back";
+        };
+        readonly refresh: {
+            readonly label: "Refresh";
+            readonly success: "Refreshed successfully";
+            readonly error: "Failed to refresh";
+        };
+    };
+    readonly validation: {
+        readonly required: "{{field}} is required";
+        readonly minLength: "{{field}} must be at least {{min}} characters";
+        readonly maxLength: "{{field}} must be at most {{max}} characters";
+        readonly min: "{{field}} must be at least {{min}}";
+        readonly max: "{{field}} must be at most {{max}}";
+        readonly email: "Please enter a valid email address";
+        readonly url: "Please enter a valid URL";
+        readonly number: "Please enter a valid number";
+        readonly integer: "Please enter a whole number";
+        readonly pattern: "{{field}} format is invalid";
+        readonly unique: "{{field}} must be unique";
+        readonly date: "Please enter a valid date";
+        readonly dateRange: "End date must be after start date";
+    };
+    readonly nav: {
+        readonly unsavedChanges: {
+            readonly title: "Unsaved Changes";
+            readonly message: "You have unsaved changes. Are you sure you want to leave?";
+            readonly stay: "Stay";
+            readonly leave: "Leave";
+        };
+        readonly breadcrumb: {
+            readonly home: "Home";
+        };
+    };
+    readonly session: {
+        readonly timeout: {
+            readonly title: "Session Expiring";
+            readonly message: "Your session will expire in {{time}}. Would you like to stay logged in?";
+            readonly logout: "Logout";
+            readonly extend: "Stay Logged In";
+        };
+        readonly expired: {
+            readonly title: "Session Expired";
+            readonly message: "Your session has expired. Please log in again.";
+        };
+    };
+    readonly loading: {
+        readonly model: "Loading application...";
+        readonly data: "Loading data...";
+        readonly saving: "Saving...";
+        readonly deleting: "Deleting...";
+        readonly processing: "Processing...";
+    };
+    readonly error: {
+        readonly generic: "An error occurred";
+        readonly network: "Network error. Please check your connection.";
+        readonly notFound: "The requested resource was not found";
+        readonly unauthorized: "You are not authorized to perform this action";
+        readonly forbidden: "Access denied";
+        readonly serverError: "Server error. Please try again later.";
+        readonly timeout: "Request timed out. Please try again.";
+        readonly validation: "Please correct the errors and try again";
+    };
+    readonly empty: {
+        readonly noData: "No data available";
+        readonly noResults: "No results found";
+        readonly noItems: "No items to display";
+        readonly noSelection: "No item selected";
+    };
+    readonly pagination: {
+        readonly of: "of";
+        readonly rowsPerPage: "Rows per page";
+        readonly showing: "Showing {{from}}-{{to}} of {{total}}";
+        readonly firstPage: "First page";
+        readonly lastPage: "Last page";
+        readonly previousPage: "Previous page";
+        readonly nextPage: "Next page";
+    };
+    readonly table: {
+        readonly selectAll: "Select all";
+        readonly deselectAll: "Deselect all";
+        readonly selectedCount: "{{count}} selected";
+        readonly sortAscending: "Sort ascending";
+        readonly sortDescending: "Sort descending";
+        readonly filterBy: "Filter by {{column}}";
+        readonly clearFilter: "Clear filter";
+        readonly noRows: "No rows";
+        readonly actions: "Actions";
+    };
+    readonly dialog: {
+        readonly confirm: {
+            readonly title: "Confirm";
+            readonly yes: "Yes";
+            readonly no: "No";
+        };
+        readonly alert: {
+            readonly title: "Alert";
+            readonly ok: "OK";
+        };
+    };
+    readonly auth: {
+        readonly login: "Log In";
+        readonly logout: "Log Out";
+        readonly loggingIn: "Logging in...";
+        readonly loggingOut: "Logging out...";
+        readonly profile: "Profile";
+    };
+    readonly common: {
+        readonly search: "Search";
+        readonly filter: "Filter";
+        readonly clear: "Clear";
+        readonly reset: "Reset";
+        readonly apply: "Apply";
+        readonly select: "Select";
+        readonly selected: "Selected";
+        readonly all: "All";
+        readonly none: "None";
+        readonly yes: "Yes";
+        readonly no: "No";
+        readonly true: "True";
+        readonly false: "False";
+        readonly enabled: "Enabled";
+        readonly disabled: "Disabled";
+        readonly active: "Active";
+        readonly inactive: "Inactive";
+        readonly more: "More";
+        readonly less: "Less";
+        readonly details: "Details";
+        readonly options: "Options";
+        readonly settings: "Settings";
+        readonly help: "Help";
+        readonly about: "About";
+    };
+};
+/**
+ * Type for system message keys.
+ */
+export type SystemMessageCategory = keyof typeof SYSTEM_MESSAGES;
+/**
+ * Flatten nested object keys into dot-notation strings.
+ */
+type FlattenKeys<T, Prefix extends string = ""> = T extends object ? {
+    [K in keyof T]: K extends string ? T[K] extends object ? FlattenKeys<T[K], `${Prefix}${K}.`> : `${Prefix}${K}` : never;
+}[keyof T] : never;
+/**
+ * Type for all flattened system message keys.
+ */
+export type SystemMessageKey = FlattenKeys<typeof SYSTEM_MESSAGES>;
+/**
+ * Get a system message value by dot-notation path.
+ *
+ * @param path - Dot-notation path to the message (e.g., 'action.save.success')
+ * @returns The message string or undefined if not found
+ */
+export declare function getSystemMessage(path: string): string | undefined;
+/**
+ * Get all keys from system messages in flat dot-notation format.
+ *
+ * @returns Array of all message keys
+ */
+export declare function getAllSystemMessageKeys(): string[];
+export {};
+//# sourceMappingURL=system-messages.d.ts.map

package/dist/system-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system-messages.d.ts","sourceRoot":"","sources":["../src/system-messages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2LlB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,OAAO,eAAe,CAAC;AAEjE;;GAEG;AACH,KAAK,WAAW,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,EAAE,IAAI,CAAC,SAAS,MAAM,GAC/D;KACC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,GAC7B,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAClB,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,GACnC,GAAG,MAAM,GAAG,CAAC,EAAE,GAChB,KAAK;CACR,CAAC,MAAM,CAAC,CAAC,GACT,KAAK,CAAC;AAET;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,eAAe,CAAC,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAYjE;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,EAAE,CAkBlD"}

package/dist/translation-keys.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Generate translation key from model element.
+ * Format: {elementType}.{sourceId|name}.{property}
+ *
+ * @param element - Model element with sourceId, name, and @type
+ * @param property - Property to translate (label, placeholder, tooltip, etc.)
+ * @returns Translation key string
+ */
+export declare function getTranslationKey(element: {
+    sourceId?: string;
+    name: string;
+    "@type"?: string;
+}, property?: "label" | "placeholder" | "tooltip" | "confirmationMessage"): string;
+/**
+ * Generate translation key for system messages.
+ * Format: system.{category}.{key}
+ *
+ * @param category - Message category (e.g., 'action', 'validation', 'nav')
+ * @param key - Specific message key
+ * @returns Translation key string
+ */
+export declare function getSystemMessageKey(category: string, key: string): string;
+/**
+ * Generate translation key for a column in a table.
+ * Format: column.{sourceId|name}.label
+ *
+ * @param column - Column element with sourceId and name
+ * @returns Translation key string
+ */
+export declare function getColumnTranslationKey(column: {
+    sourceId?: string;
+    name: string;
+}): string;
+/**
+ * Generate translation key for an enum value.
+ * Format: enum.{enumName}.{value}
+ *
+ * @param enumName - Name of the enumeration
+ * @param value - Enum value
+ * @returns Translation key string
+ */
+export declare function getEnumTranslationKey(enumName: string, value: string): string;
+/**
+ * Generate translation key for navigation item.
+ * Format: nav.{sourceId|name}.label
+ *
+ * @param item - Navigation item with sourceId and name
+ * @returns Translation key string
+ */
+export declare function getNavItemTranslationKey(item: {
+    sourceId?: string;
+    name: string;
+}): string;
+//# sourceMappingURL=translation-keys.d.ts.map

package/dist/translation-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation-keys.d.ts","sourceRoot":"","sources":["../src/translation-keys.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAChC,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,EAC9D,QAAQ,GAAE,OAAO,GAAG,aAAa,GAAG,SAAS,GAAG,qBAA+B,GAC7E,MAAM,CAMR;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAG3F;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAG1F"}

package/dist/use-model-label.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Hook for translating model element labels.
+ *
+ * Uses react-i18next's `useTranslation()` to look up the translation key
+ * generated from the element, falling back to the model-defined label.
+ *
+ * When a `translationKeyMap` is provided via `I18nProvider`, the hook resolves
+ * the element's `xmi:id` to a human-readable tree-path key (e.g.,
+ * `"PageName.container.input"`). Without the map, it falls back to the legacy
+ * type-based key format (`"textinput.sourceId.label"`).
+ *
+ * When no locale loader is configured (no translations available), the
+ * `defaultValue` path is used, which returns `element.label ?? element.name`.
+ */
+/**
+ * Resolved label result from the useModelLabel hook.
+ */
+export interface ModelLabelResult {
+    /**
+     * The translated label string. Falls back to `element.label ?? element.name`
+     * when no translation is found.
+     */
+    label: string;
+    /**
+     * The translation key used for lookup.
+     * Useful for debugging or for providing in test IDs.
+     */
+    translationKey: string;
+}
+/**
+ * Hook to get a translated label for a model element.
+ *
+ * Resolves the translation key in two ways (in order of preference):
+ * 1. If a `translationKeyMap` is configured (via codegen), looks up the element's
+ *    `xmi:id` to get a human-readable path key (e.g., `"PageName.container.input"`)
+ * 2. Falls back to the legacy format: `{elementType}.{sourceId|name}.{property}`
+ *
+ * @param element - The model element (must have `name`; optionally `xmi:id`, `@type`, `sourceId`, `label`)
+ * @param property - The property to translate (defaults to "label")
+ * @returns The translated label and the translation key
+ *
+ * @example
+ * ```tsx
+ * function MyInput({ element }: { element: TextInput }) {
+ *   const { label } = useModelLabel(element);
+ *   return <TextField label={label} />;
+ * }
+ * ```
+ */
+export declare function useModelLabel(element: {
+    "xmi:id"?: string;
+    sourceId?: string;
+    name: string;
+    "@type"?: string;
+    label?: string;
+}, property?: "label" | "placeholder" | "tooltip" | "confirmationMessage"): ModelLabelResult;
+//# sourceMappingURL=use-model-label.d.ts.map

package/dist/use-model-label.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-model-label.d.ts","sourceRoot":"","sources":["../src/use-model-label.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAMH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAC5B,OAAO,EAAE;IACR,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CACf,EACD,QAAQ,GAAE,OAAO,GAAG,aAAa,GAAG,SAAS,GAAG,qBAA+B,GAC7E,gBAAgB,CAqBlB"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@judo/i18n",
+  "version": "0.1.0",
+  "description": "Internationalization and localization support for JUDO UI Runtime",
+  "license": "EPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BlackBeltTechnology/judo-frontend-runtime.git",
+    "directory": "packages/i18n"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@judo/model-api": "0.1.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.3.2",
+    "@types/node": "^25.2.3",
+    "@types/react": "^19.2.14",
+    "date-fns": "^4.1.0",
+    "i18next": "^25.8.10",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "react-i18next": "^16.5.4",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18",
+    "@judo/model-api": "0.1.0"
+  },
+  "peerDependencies": {
+    "date-fns": "^4.0.0",
+    "i18next": "^25.8.10",
+    "react": "^19.0.0",
+    "react-i18next": "^16.0.0",
+    "@judo/model-api": "0.1.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "clean": "rm -rf dist",
+    "type-check": "tsgo --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}