@digitaldefiance/express-suite-starter 2.4.2 → 2.4.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/express-suite-starter",
-  "version": "2.4.2",
+  "version": "2.4.4",
   "license": "MIT",
   "bin": {
     "create-express-suite": "./dist/src/cli.js"
@@ -31,7 +31,7 @@
     "publish:public": "npm publish --access public"
   },
   "dependencies": {
-    "@digitaldefiance/i18n-lib": "npm:@digitaldefiance/i18n-lib@4.0.3",
+    "@digitaldefiance/i18n-lib": "npm:@digitaldefiance/i18n-lib@4.0.4",
     "@inquirer/prompts": "^7.5.0",
     "chalk": "^4.1.2",
     "handlebars": "^4.7.8",

package/scaffolding/lib/src/lib/enumerations/{{workspaceName}}-string-key.ts.mustache

@@ -1,5 +1,29 @@
-export enum {{WorkspaceName}}StringKey {
-  SiteTitle = 'siteTitle',
-  SiteDescription = 'siteDescription',
-  SiteTagline = 'siteTagline',
-}
+import { createI18nStringKeys } from '@digitaldefiance/i18n-lib';
+
+/**
+ * Branded string keys for the {{WorkspaceName}} component.
+ *
+ * Created using `createI18nStringKeys` for type-safe i18n support.
+ * Use `typeof {{WorkspaceName}}StringKey` when referencing the type.
+ *
+ * @example
+ * ```typescript
+ * import { {{WorkspaceName}}StringKey } from './enumerations/{{workspaceName}}-string-key';
+ * import type { BrandedStringsCollection } from '@digitaldefiance/i18n-lib';
+ *
+ * const strings: BrandedStringsCollection<typeof {{WorkspaceName}}StringKey> = {
+ *   [{{WorkspaceName}}StringKey.SiteTitle]: 'My Site',
+ * };
+ * ```
+ */
+export const {{WorkspaceName}}StringKey = createI18nStringKeys('{{WorkspaceName}}', {
+  SiteTitle: 'siteTitle',
+  SiteDescription: 'siteDescription',
+  SiteTagline: 'siteTagline',
+} as const);
+
+/**
+ * Type alias for the branded string key values.
+ * Use this when you need to type a variable that holds a string key value.
+ */
+export type {{WorkspaceName}}StringKeyValue = typeof {{WorkspaceName}}StringKey[keyof typeof {{WorkspaceName}}StringKey];

package/scaffolding/lib/src/lib/i18n-setup.ts.mustache

@@ -8,6 +8,7 @@ import {
   I18nBuilder,
   I18nEngine,
 } from '@digitaldefiance/i18n-lib';
+import type { BrandedEnumValue } from '@digitaldefiance/branded-enum';
 import { AppConstants } from './constants';
 import { {{WorkspaceName}}StringKey } from './enumerations/{{workspaceName}}-string-key';
 import { Strings } from './strings-collection';
@@ -82,8 +83,17 @@ export const i18nContext: IActiveContext<CoreLanguageCode> = {
   },
 };
 
+/**
+ * Translate a string key to the current or specified language.
+ *
+ * @param name - The branded string key value to translate
+ * @param variables - Optional variables to interpolate into the translation
+ * @param language - Optional language override
+ * @param context - Optional context space override
+ * @returns The translated string
+ */
 export const translate = (
-  name: {{WorkspaceName}}StringKey,
+  name: BrandedEnumValue<typeof {{WorkspaceName}}StringKey>,
   variables?: Record<string, string | number>,
   language?: CoreLanguageCode,
   context?: LanguageContextSpace,

package/scaffolding/lib/src/lib/strings-collection.ts.mustache

@@ -1,7 +1,13 @@
-import { LanguageCodes } from '@digitaldefiance/i18n-lib';
+import { LanguageCodes, type BrandedMasterStringsCollection, type CoreLanguageCode } from '@digitaldefiance/i18n-lib';
 import { {{WorkspaceName}}StringKey } from './enumerations/{{workspaceName}}-string-key';
 
-export const Strings = {
+/**
+ * Master strings collection for the {{WorkspaceName}} component.
+ *
+ * This collection provides translations for all supported languages.
+ * Uses `BrandedMasterStringsCollection` for type-safe branded enum support.
+ */
+export const Strings: BrandedMasterStringsCollection<typeof {{WorkspaceName}}StringKey, CoreLanguageCode> = {
   [LanguageCodes.EN_US]: {
     [{{WorkspaceName}}StringKey.SiteTitle]: '{{#isEnUs}}{{siteTitle}}{{/isEnUs}}{{^isEnUs}}Your Site Title{{/isEnUs}}',
     [{{WorkspaceName}}StringKey.SiteDescription]: '{{#isEnUs}}{{siteDescription}}{{/isEnUs}}{{^isEnUs}}Your description here{{/isEnUs}}',