@digitaldefiance/i18n-lib 1.1.0 → 1.1.1

package/README.md

@@ -231,6 +231,37 @@ const userNotFound = getUserTranslation(
 
 ### Advanced Plugin Usage
 
+#### Compile-Time Completeness Enforcement (Strict Mode)
+
+By default the plugin engine performs runtime validation and provides fallbacks. If you want **compile-time** enforcement that every language mapping contains every string key, use the helper in `strict-types`:
+
+```typescript
+import { createCompleteComponentStrings } from '@digitaldefiance/i18n-lib';
+
+enum MyStrings {
+  Welcome = 'welcome',
+  Farewell = 'farewell'
+}
+
+type AppLang = 'en' | 'fr';
+
+// This will only compile if BOTH languages contain BOTH keys.
+const myStrictStrings = createCompleteComponentStrings<MyStrings, AppLang>({
+  en: {
+    [MyStrings.Welcome]: 'Welcome',
+    [MyStrings.Farewell]: 'Goodbye'
+  },
+  fr: {
+    [MyStrings.Welcome]: 'Bienvenue',
+    [MyStrings.Farewell]: 'Au revoir'
+  }
+});
+
+// If any key is missing, TypeScript reports an error before runtime.
+```
+
+The core library itself uses this helper for the core component (`createCoreComponentStrings`) to guarantee internal completeness. For partial / iterative authoring you can still start with normal objects and later switch to the strict helper when translations stabilize.
+
 #### Adding New Languages
 
 ```typescript
@@ -859,6 +890,12 @@ Part of the DigitalBurnbag project - a secure file sharing and automated protoco
 
 ## ChangeLog
 
+### Version 1.1.1
+
+- Sat Oct 11 2025 17:47:00 GMT-0700 (Pacific Daylight Time)
+  - Improved type checking for completeness of component translations during registration
+  - Updated README/Migration guide for clarity.
+
 ### Version 1.1.0
 
 - Sat Oct 11 2025 16:49:00 GMT-0700 (Pacific Daylight Time)

package/dist/core-i18n.d.ts

@@ -18,296 +18,7 @@ export declare const CoreComponentDefinition: ComponentDefinition<CoreStringKey>
 /**
  * Core component strings for all default languages
  */
-export declare function createCoreComponentStrings(): {
-    "en-US": {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    "en-UK": {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    fr: {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    es: {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    de: {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    "zh-CN": {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    ja: {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-    uk: {
-        common_yes: string;
-        common_no: string;
-        common_cancel: string;
-        common_ok: string;
-        common_save: string;
-        common_delete: string;
-        common_edit: string;
-        common_create: string;
-        common_update: string;
-        common_loading: string;
-        common_error: string;
-        common_success: string;
-        common_warning: string;
-        common_info: string;
-        error_invalidInput: string;
-        error_networkError: string;
-        error_notFound: string;
-        error_accessDenied: string;
-        error_internalServer: string;
-        error_validationFailed: string;
-        error_requiredField: string;
-        error_componentNotFoundTemplate: string;
-        error_languageNotFoundTemplate: string;
-        error_stringKeyNotFoundTemplate: string;
-        error_incompleteRegistrationTemplate: string;
-        error_duplicateComponentTemplate: string;
-        error_duplicateLanguageTemplate: string;
-        error_validationFailedTemplate: string;
-        system_welcome: string;
-        system_goodbye: string;
-        system_pleaseWait: string;
-        system_processingRequest: string;
-        system_operationComplete: string;
-        system_noDataAvailable: string;
-    };
-};
+export declare function createCoreComponentStrings(): import("./strict-types").CompleteComponentLanguageStrings<CoreStringKey, CoreLanguage>;
 /**
  * Create core component registration
  */

package/dist/core-i18n.js

@@ -14,6 +14,7 @@ const core_language_1 = require("./core-language");
 const core_string_key_1 = require("./core-string-key");
 const language_registry_1 = require("./language-registry");
 const plugin_i18n_engine_1 = require("./plugin-i18n-engine");
+const strict_types_1 = require("./strict-types");
 /**
  * Create default language definitions
  */
@@ -74,7 +75,7 @@ exports.CoreComponentDefinition = {
  * Core component strings for all default languages
  */
 function createCoreComponentStrings() {
-    return {
+    return (0, strict_types_1.createCompleteComponentStrings)({
         [core_language_1.CoreLanguage.EnglishUS]: {
             // Common/General
             [core_string_key_1.CoreStringKey.Common_Yes]: 'Yes',
@@ -395,7 +396,7 @@ function createCoreComponentStrings() {
             [core_string_key_1.CoreStringKey.System_OperationComplete]: 'Операція успішно завершена',
             [core_string_key_1.CoreStringKey.System_NoDataAvailable]: 'Дані недоступні',
         },
-    };
+    });
 }
 /**
  * Create core component registration

package/dist/strict-types.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Enforces that for each language L, all string keys K are present.
+ */
+export type CompleteLanguageStrings<TStringKey extends string> = {
+    [K in TStringKey]: string;
+};
+export type CompleteComponentLanguageStrings<TStringKey extends string, TLanguages extends string> = {
+    [L in TLanguages]: CompleteLanguageStrings<TStringKey>;
+};
+/**
+ * Helper to assert at compile-time that an object is a complete component language map.
+ * Returns the object unchanged at runtime.
+ */
+export declare function createCompleteComponentStrings<TStringKey extends string, TLanguages extends string>(obj: CompleteComponentLanguageStrings<TStringKey, TLanguages>): CompleteComponentLanguageStrings<TStringKey, TLanguages>;
+/**
+ * Utility to extract missing keys at compile time (identity, purely for readability)
+ */
+export declare function defineLanguageStrings<TStringKey extends string>(strings: CompleteLanguageStrings<TStringKey>): CompleteLanguageStrings<TStringKey>;

package/dist/strict-types.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCompleteComponentStrings = createCompleteComponentStrings;
+exports.defineLanguageStrings = defineLanguageStrings;
+/**
+ * Helper to assert at compile-time that an object is a complete component language map.
+ * Returns the object unchanged at runtime.
+ */
+function createCompleteComponentStrings(obj) {
+    return obj;
+}
+/**
+ * Utility to extract missing keys at compile time (identity, purely for readability)
+ */
+function defineLanguageStrings(strings) {
+    return strings;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/i18n-lib",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Generic i18n library with enum translation support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",