add support for plugin ui i18n

Author: justjam2013

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to `homebridge-config-ui-x` will be documented in this file.
 - add status to security system modal
 - move reset status layout button into row
 - expose unique id on accessory info modal + copy icon (@NorthernMan54)
+- add support for plugin ui i18n (from #2597) (@justjam2013)
 
 ### Other Changes
 

src/modules/plugins/plugins.interfaces.ts

@@ -39,6 +39,9 @@ export interface HomebridgePlugin {
     to: string
     switch: string
   }
+  directories?: {
+    schemas?: string
+  }
 }
 
 export interface HomebridgePluginUiMetadata {
@@ -157,6 +160,9 @@ export interface IPackageJson {
   private?: boolean
   publishConfig?: { registry?: string }
   deprecated?: string
+  directories?: {
+    schemas?: string
+  }
 }
 
 export type NpmFunding = { type: string, url: string } | string | Array<{ type: string, url: string } | string>

src/modules/plugins/plugins.service.ts

@@ -1088,7 +1088,21 @@ export class PluginsService {
       throw new NotFoundException()
     }
 
-    const schemaPath = resolve(plugin.installPath, pluginName, 'config.schema.json')
+    let schemaPath: string
+
+    const i18nPath = plugin.directories?.schemas
+    if (i18nPath) {
+      const lang = this.configService.ui.lang === 'auto' ? 'en' : this.configService.ui.lang
+
+      if (lang && lang !== 'en' && lang !== 'auto') {
+        const i18nSchemaPath = resolve(plugin.installPath, pluginName, i18nPath, `config.schema.${lang}.json`)
+        if (existsSync(i18nSchemaPath)) {
+          schemaPath = i18nSchemaPath
+        }
+      }
+    }
+
+    schemaPath ??= resolve(plugin.installPath, pluginName, 'config.schema.json')
 
     let configSchema = await readJson(schemaPath)
 
@@ -1652,6 +1666,9 @@ export class PluginsService {
     // Only verified plugins can show donation links
     plugin.funding = (plugin.verifiedPlugin || plugin.verifiedPlusPlugin) ? pkgJson.funding : undefined
 
+    // Add directories for i18n schema support
+    plugin.directories = pkgJson.directories
+
     // If the plugin is private, do not attempt to query npm
     if (pkgJson.private) {
       plugin.publicPackage = false

test/e2e/plugins.e2e-spec.ts

@@ -288,6 +288,102 @@ describe('PluginController (e2e)', () => {
     expect(res.json().pluginType).toBe('platform')
   })
 
+  it('GET /plugins/config-schema/:plugin-name (i18n - French)', async () => {
+    // Mock the language setting to French
+    const originalLang = (pluginsService as any).configService.ui.lang;
+    (pluginsService as any).configService.ui.lang = 'fr'
+
+    const res = await app.inject({
+      method: 'GET',
+      path: '/plugins/config-schema/homebridge-mock-plugin',
+      headers: {
+        authorization,
+      },
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.json().pluginAlias).toBe('ExampleHomebridgePlugin')
+    expect(res.json().pluginType).toBe('platform')
+    // Verify French translation is loaded
+    expect(res.json().schema.properties.name.title).toBe('Nom')
+    expect(res.json().schema.properties.name.default).toBe('Exemple de plateforme dynamique')
+
+    // Restore original language
+    ;(pluginsService as any).configService.ui.lang = originalLang
+  })
+
+  it('GET /plugins/config-schema/:plugin-name (i18n - German)', async () => {
+    // Mock the language setting to German
+    const originalLang = (pluginsService as any).configService.ui.lang;
+    (pluginsService as any).configService.ui.lang = 'de'
+
+    const res = await app.inject({
+      method: 'GET',
+      path: '/plugins/config-schema/homebridge-mock-plugin',
+      headers: {
+        authorization,
+      },
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.json().pluginAlias).toBe('ExampleHomebridgePlugin')
+    expect(res.json().pluginType).toBe('platform')
+    // Verify German translation is loaded
+    expect(res.json().schema.properties.name.title).toBe('Name')
+    expect(res.json().schema.properties.name.default).toBe('Beispiel Dynamische Plattform')
+
+    // Restore original language
+    ;(pluginsService as any).configService.ui.lang = originalLang
+  })
+
+  it('GET /plugins/config-schema/:plugin-name (i18n - fallback to base for unsupported language)', async () => {
+    // Mock the language setting to a language that doesn't have a translation
+    const originalLang = (pluginsService as any).configService.ui.lang;
+    (pluginsService as any).configService.ui.lang = 'es'
+
+    const res = await app.inject({
+      method: 'GET',
+      path: '/plugins/config-schema/homebridge-mock-plugin',
+      headers: {
+        authorization,
+      },
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.json().pluginAlias).toBe('ExampleHomebridgePlugin')
+    expect(res.json().pluginType).toBe('platform')
+    // Verify base English schema is loaded as fallback
+    expect(res.json().schema.properties.name.title).toBe('Name')
+    expect(res.json().schema.properties.name.default).toBe('Example Dynamic Platform')
+
+    // Restore original language
+    ;(pluginsService as any).configService.ui.lang = originalLang
+  })
+
+  it('GET /plugins/config-schema/:plugin-name (i18n - English explicitly)', async () => {
+    // Mock the language setting to English (should skip i18n directory)
+    const originalLang = (pluginsService as any).configService.ui.lang;
+    (pluginsService as any).configService.ui.lang = 'en'
+
+    const res = await app.inject({
+      method: 'GET',
+      path: '/plugins/config-schema/homebridge-mock-plugin',
+      headers: {
+        authorization,
+      },
+    })
+
+    expect(res.statusCode).toBe(200)
+    expect(res.json().pluginAlias).toBe('ExampleHomebridgePlugin')
+    expect(res.json().pluginType).toBe('platform')
+    // Verify base English schema is loaded (not from i18n directory)
+    expect(res.json().schema.properties.name.title).toBe('Name')
+    expect(res.json().schema.properties.name.default).toBe('Example Dynamic Platform')
+
+    // Restore original language
+    ;(pluginsService as any).configService.ui.lang = originalLang
+  })
+
   it('GET /plugins/changelog/:plugin-name', async () => {
     const res = await app.inject({
       method: 'GET',

test/mocks/plugins/homebridge-mock-plugin/i18n/config.schema.de.json

@@ -0,0 +1,16 @@
+{
+  "pluginAlias": "ExampleHomebridgePlugin",
+  "pluginType": "platform",
+  "singular": true,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "title": "Name",
+        "type": "string",
+        "required": true,
+        "default": "Beispiel Dynamische Plattform"
+      }
+    }
+  }
+}

test/mocks/plugins/homebridge-mock-plugin/i18n/config.schema.fr.json

@@ -0,0 +1,16 @@
+{
+  "pluginAlias": "ExampleHomebridgePlugin",
+  "pluginType": "platform",
+  "singular": true,
+  "schema": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "title": "Nom",
+        "type": "string",
+        "required": true,
+        "default": "Exemple de plateforme dynamique"
+      }
+    }
+  }
+}

test/mocks/plugins/homebridge-mock-plugin/package.json

@@ -11,6 +11,9 @@
   "engines": {
     "homebridge": ">0.4.53"
   },
+  "directories": {
+    "schemas": "i18n"
+  },
   "dependencies": {},
   "devDependencies": {}
 }