@dws-std/i18n 1.1.0 → 1.2.1

package/README.md

@@ -56,7 +56,7 @@ const unauthorized = entry({
 	}
 });
 
-// This will produce a plain ResolvedMessage when used in a message catalog
+// This will produce a plain LocalizedMessage when used in a message catalog
 const welcome = entry<{ name: string }>({
 	translations: {
 		en: 'Welcome, {{name}}!',
@@ -124,7 +124,7 @@ const msg = DNS_MESSAGES.recordCreated();
 
 ### Resolving to a specific locale
 
-`resolveMessage` takes a `LocalizedHttpException` or a `ResolvedMessage` and returns the interpolated string for the locale you want.
+`resolveMessage` takes a `LocalizedHttpException` or a `LocalizedMessage` and returns the interpolated string for the locale you want.
 
 ```ts
 import { resolveMessage } from '@dws-std/i18n';

package/dist/exception/localized-http-exception.d.ts

@@ -16,8 +16,8 @@ export interface LocalizedHttpExceptionOptions<TCause = unknown> extends HttpExc
 /**
  * HTTP exception that carries translated messages.
  *
- * The `message` property is automatically resolved to the default locale.
- * Use {@link resolveMessage} to get a translation in a different locale.
+ * The `message` property contains the raw template for the default locale.
+ * Use {@link resolveMessage} to get the interpolated string for any locale.
  *
  * @template TCause - Type of the underlying cause.
  */

package/dist/index.d.ts

@@ -2,11 +2,11 @@ export { entry } from './entry';
 export { defineExceptionCatalog } from './exception/define-exception-catalog';
 export type { DefineExceptionCatalogOptions, ExceptionCatalog } from './exception/define-exception-catalog';
 export { LocalizedHttpException } from './exception/localized-http-exception';
-export type { LocalizedHttpExceptionOptions as LocalizedHttpExceptionInit } from './exception/localized-http-exception';
+export type { LocalizedHttpExceptionOptions } from './exception/localized-http-exception';
 export type { ExceptionEntry } from './exception/type/exception-entry';
 export { defineMessageCatalog } from './message/define-message-catalog';
 export type { DefineMessageCatalogOptions, MessageCatalog } from './message/define-message-catalog';
+export type { LocalizedMessage } from './message/type/localized-message';
 export type { MessageEntry } from './message/type/message-entry';
-export type { ResolvedMessage } from './message/type/resolved-message';
 export { resolveMessage } from './resolve-message';
 export type { Translations } from './type/translations';

package/dist/index.js

@@ -6,21 +6,12 @@ function entry(definition) {
 // src/exception/localized-http-exception.ts
 import { HttpException } from "@dws-std/error";
 
-// src/resolve-message.ts
-var _interpolate = (template, params) => template.replace(/\{\{(\w+)\}\}/g, (_, key) => params[key] ?? `{{${key}}}`);
-var resolveMessage = (target, locale) => target.params ? _interpolate(target.translations[locale ?? target.defaultLocale] ?? "", target.params) : target.translations[locale ?? target.defaultLocale] ?? "";
-
-// src/exception/localized-http-exception.ts
 class LocalizedHttpException extends HttpException {
   translations;
   params;
   defaultLocale;
   constructor(key, init) {
-    super(resolveMessage({
-      translations: init.translations,
-      params: init.params,
-      defaultLocale: init.defaultLocale
-    }), {
+    super(init.translations[init.defaultLocale] ?? "", {
       cause: init.cause,
       status: init.status,
       key
@@ -59,6 +50,9 @@ var defineMessageCatalog = (options) => {
   }
   return catalog;
 };
+// src/resolve-message.ts
+var _interpolate = (template, params) => template.replace(/\{\{(\w+)\}\}/g, (_, key) => params[key] ?? `{{${key}}}`);
+var resolveMessage = (target, locale) => target.params ? _interpolate(target.translations[locale ?? target.defaultLocale] ?? "", target.params) : target.translations[locale ?? target.defaultLocale] ?? "";
 export {
   resolveMessage,
   entry,

package/dist/message/define-message-catalog.d.ts

@@ -1,7 +1,7 @@
 import type { MessageEntry } from './type/message-entry';
-import type { ResolvedMessage } from './type/resolved-message';
+import type { LocalizedMessage } from './type/localized-message';
 export type MessageCatalog<TDefs extends Record<string, MessageEntry<any>>> = {
-    readonly [K in keyof TDefs]: TDefs[K] extends MessageEntry<infer P> ? [P] extends [Record<string, never>] ? () => ResolvedMessage : (params: P) => ResolvedMessage : never;
+    readonly [K in keyof TDefs]: TDefs[K] extends MessageEntry<infer P> ? [P] extends [Record<string, never>] ? () => LocalizedMessage : (params: P) => LocalizedMessage : never;
 };
 /**
  * Configuration for {@link defineMessageCatalog}.
@@ -18,7 +18,7 @@ export interface DefineMessageCatalogOptions<TDefs extends Record<string, Messag
  * Builds a typed message catalog from a set of {@link MessageEntry} definitions.
  *
  * Each key in `definitions` becomes a factory function that creates
- * a {@link ResolvedMessage} pre-filled with the right translations and default locale.
+ * a {@link LocalizedMessage} pre-filled with the right translations and default locale.
  *
  * @param options - Default locale and message definitions.
  *

package/dist/message/type/{resolved-message.d.ts → localized-message.d.ts}

@@ -1,11 +1,11 @@
 import type { Translations } from '../../type/translations';
 /**
- * Fully resolved message ready to be rendered.
+ * Localized message carrying translations and interpolation parameters.
  *
  * Returned by the factory functions generated by `defineMessageCatalog`.
  * Pass it to {@link resolveMessage} to get the final string for a given locale.
  */
-export interface ResolvedMessage {
+export interface LocalizedMessage {
     /** All available translations keyed by locale. */
     readonly translations: Translations;
     /** Parameter values to interpolate into `{{placeholder}}` tokens. */

package/dist/resolve-message.d.ts

@@ -1,7 +1,7 @@
 import type { LocalizedHttpException } from './exception/localized-http-exception';
-import type { ResolvedMessage } from './message/type/resolved-message';
+import type { LocalizedMessage } from './message/type/localized-message';
 /**
- * Turns a {@link ResolvedMessage} or {@link LocalizedHttpException} into
+ * Turns a {@link LocalizedMessage} or {@link LocalizedHttpException} into
  * a plain string for the requested locale.
  *
  * `{{placeholder}}` tokens are replaced with matching values from `target.params`.
@@ -13,4 +13,4 @@ import type { ResolvedMessage } from './message/type/resolved-message';
  *
  * @returns Translated string with placeholders interpolated.
  */
-export declare const resolveMessage: (target: LocalizedHttpException | ResolvedMessage, locale?: string) => string;
+export declare const resolveMessage: (target: LocalizedHttpException | LocalizedMessage, locale?: string) => string;

package/package.json

@@ -1,17 +1,16 @@
 {
   "name": "@dws-std/i18n",
-  "version": "1.1.0",
-  "description": "Type-safe i18n for TypeScript — define localized exception and message catalogs with compile-time validated parameters.",
+  "version": "1.2.1",
+  "description": "Type-safe i18n for TypeScript, define localized exception and message catalogs with compile-time validated parameters.",
   "keywords": [
     "bun",
     "dws",
-    "exception",
-    "http-error",
     "i18n",
     "internationalization",
-    "l10n",
     "localization",
-    "translation"
+    "open-source",
+    "translation",
+    "typescript"
   ],
   "license": "MIT",
   "author": "Dominus Web Services (DWS)",
@@ -41,16 +40,16 @@
     "test": "bun test --pass-with-no-tests --coverage"
   },
   "dependencies": {
-    "@dws-std/error": "^2.1.0"
+    "@dws-std/error": "^2.1.1"
   },
   "devDependencies": {
-    "@types/bun": "^1.3.10",
-    "oxfmt": "0.41.0",
-    "oxlint": "1.56.0",
-    "oxlint-tsgolint": "0.17.0",
-    "typescript": "^5.9.3"
+    "@types/bun": "^1.3.11",
+    "oxfmt": "0.44.0",
+    "oxlint": "1.59.0",
+    "oxlint-tsgolint": "0.20.0",
+    "typescript": "^6.0.2"
   },
   "peerDependencies": {
-    "@dws-std/error": "^2.1.0"
+    "@dws-std/error": "^2.1.1"
   }
 }