Merge pull request #911 from objectstack-ai/copilot/fix-i18n-route-registration

Author: hotlong

CHANGELOG.md

@@ -7,19 +7,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- **i18n route self-registration** — Moved i18n REST endpoint registration from `RestServer` to
+  `I18nServicePlugin` (and kernel fallback). The i18n plugin now self-registers `/api/v1/i18n/*`
+  routes via the `kernel:ready` hook, following the same autonomous plugin pattern used by
+  `AuthPlugin`, `WorkflowPlugin`, and other service plugins. `RestServer` no longer registers or
+  manages any i18n endpoints, keeping it strictly a protocol-driven gateway.
+- Removed `enableI18n` flag from `RestApiConfig` schema (`rest-server.zod.ts`) — i18n endpoints
+  are now controlled by the i18n service plugin's own `registerRoutes` option (default: `true`).
+- Removed `registerI18nEndpoints()` method from `RestServer` class.
+- `I18nServicePlugin` now accepts `registerRoutes` and `basePath` options for HTTP route control.
+- i18n endpoints now work independently of `RestServer`, enabling MSW/mock test environments
+  to serve i18n routes without any REST API gateway dependency.
+- **Dispatcher i18n bridge routes** — `createDispatcherPlugin()` now registers i18n HTTP route
+  bridges (`GET /i18n/locales`, `GET /i18n/translations/:locale`, `GET /i18n/labels/:object/:locale`)
+  via `HttpDispatcher.handleI18n()`, ensuring i18n endpoints work even when only the kernel's
+  memory fallback i18n is active (no explicit `I18nServicePlugin` loaded). This is consistent with
+  how auth, analytics, packages, storage, and automation services are bridged.
+
 ### Added
 - **i18n as core built-in service** — The i18n service is now a `core` criticality service with
   automatic in-memory fallback. When no plugin (e.g. `I18nServicePlugin`) registers an i18n service,
   the kernel auto-injects `createMemoryI18n` (in-memory Map-backed II18nService implementation)
   during `validateSystemRequirements()`. This ensures `/api/v1/i18n/*` routes and discovery always
   report i18n as available, even without `plugin-i18n` installed.
-- **REST i18n route auto-registration** — `RestServer.registerRoutes()` now automatically registers
-  `/api/v1/i18n/locales` and `/api/v1/i18n/translations/:locale` endpoints, controlled by the new
-  `enableI18n` config flag (default: `true`).
 - `createMemoryI18n` fallback factory in `@objectstack/core` (packages/core/src/fallbacks/memory-i18n.ts)
   implementing `II18nService` contract with translation loading, dot-notation key resolution, parameter
   interpolation, and locale management.
-- `enableI18n` flag in `RestApiConfig` schema (`rest-server.zod.ts`) for toggling i18n API endpoints.
 
 ### Changed
 - `ServiceRequirementDef.i18n` upgraded from `'optional'` to `'core'` — kernel now warns (instead

ROADMAP.md

@@ -842,7 +842,7 @@ Final polish and advanced features.
 | 19 | Automation Service | `IAutomationService` | ✅ | `@objectstack/service-automation` | DAG engine + HTTP API CRUD + Client SDK + typed returns (67 tests) |
 | 20 | Workflow Service | `IWorkflowService` | ❌ | `@objectstack/service-workflow` (planned) | Spec only |
 | 21 | GraphQL Service | `IGraphQLService` | ❌ | `@objectstack/service-graphql` (planned) | Spec only |
-| 22 | i18n Service | `II18nService` | ✅ | `@objectstack/service-i18n` | File-based locale loading |
+| 22 | i18n Service | `II18nService` | ✅ | `@objectstack/service-i18n` | File-based locale loading, self-registered REST routes |
 | 23 | UI Service | `IUIService` | ⚠️ | — | **Deprecated** — merged into `IMetadataService` |
 | 24 | Schema Driver | `ISchemaDriver` | ❌ | — | Spec only |
 | 25 | Startup Orchestrator | `IStartupOrchestrator` | ❌ | — | Kernel handles basics |

packages/rest/src/rest-server.ts

@@ -19,7 +19,6 @@ type NormalizedRestServerConfig = {
         enableUi: boolean;
         enableBatch: boolean;
         enableDiscovery: boolean;
-        enableI18n: boolean;
         documentation: RestApiConfig['documentation'];
         responseFormat: RestApiConfig['responseFormat'];
     };
@@ -127,7 +126,6 @@ export class RestServer {
                 enableUi: api.enableUi ?? true,
                 enableBatch: api.enableBatch ?? true,
                 enableDiscovery: api.enableDiscovery ?? true,
-                enableI18n: api.enableI18n ?? true,
                 documentation: api.documentation,
                 responseFormat: api.responseFormat,
             },
@@ -212,11 +210,6 @@ export class RestServer {
         if (this.config.api.enableBatch) {
             this.registerBatchEndpoints(basePath);
         }
-
-        // i18n endpoints
-        if (this.config.api.enableI18n) {
-            this.registerI18nEndpoints(basePath);
-        }
     }
 
     /**
@@ -679,56 +672,6 @@ export class RestServer {
         }
     }
 
-    /**
-     * Register i18n endpoints for locale and translation operations
-     */
-    private registerI18nEndpoints(basePath: string): void {
-        const i18nPath = `${basePath}/i18n`;
-
-        // GET /i18n/locales - List available locales
-        this.routeManager.register({
-            method: 'GET',
-            path: `${i18nPath}/locales`,
-            handler: async (_req: any, res: any) => {
-                try {
-                    if (this.protocol.getLocales) {
-                        const locales = await this.protocol.getLocales({});
-                        res.json(locales);
-                    } else {
-                        res.status(501).json({ error: 'i18n service not available in protocol' });
-                    }
-                } catch (error: any) {
-                    res.status(500).json({ error: error.message });
-                }
-            },
-            metadata: {
-                summary: 'Get available locales',
-                tags: ['i18n'],
-            },
-        });
-
-        // GET /i18n/translations/:locale - Get translations for a locale
-        this.routeManager.register({
-            method: 'GET',
-            path: `${i18nPath}/translations/:locale`,
-            handler: async (req: any, res: any) => {
-                try {
-                    if (this.protocol.getTranslations) {
-                        const translations = await this.protocol.getTranslations({ locale: req.params.locale });
-                        res.json(translations);
-                    } else {
-                        res.status(501).json({ error: 'i18n service not available in protocol' });
-                    }
-                } catch (error: any) {
-                    res.status(500).json({ error: error.message });
-                }
-            },
-            metadata: {
-                summary: 'Get translations for a locale',
-                tags: ['i18n'],
-            },
-        });
-    }
 
     /**
      * Get the route manager

packages/rest/src/rest.test.ts

@@ -399,25 +399,10 @@ describe('RestServer', () => {
       expect(uiRoutes.length).toBeGreaterThan(0);
     });
 
-    it('should register i18n endpoints by default', () => {
+    it('should not register i18n endpoints (i18n routes are self-registered by service-i18n)', () => {
       const rest = new RestServer(server as any, protocol as any);
       rest.registerRoutes();
 
-      const i18nRoutes = rest.getRoutes().filter((r) =>
-        r.metadata?.tags?.includes('i18n'),
-      );
-      expect(i18nRoutes.length).toBeGreaterThan(0);
-      const paths = i18nRoutes.map((r) => r.path);
-      expect(paths).toContain('/api/v1/i18n/locales');
-      expect(paths).toContain('/api/v1/i18n/translations/:locale');
-    });
-
-    it('should skip i18n routes when enableI18n is false', () => {
-      const rest = new RestServer(server as any, protocol as any, {
-        api: { enableI18n: false },
-      } as any);
-      rest.registerRoutes();
-
       const i18nRoutes = rest.getRoutes().filter((r) =>
         r.metadata?.tags?.includes('i18n'),
       );

packages/runtime/src/dispatcher-plugin.ts

@@ -53,7 +53,7 @@ function errorResponse(err: any, res: any): void {
  *   - /graphql   (GraphQL)
  *   - /analytics (BI queries)
  *   - /packages  (package management)
-
+ *   - /i18n      (internationalization — locales, translations, field labels)
  *   - /storage   (file storage)
  *   - /automation (CRUD + triggers + runs)
  *
@@ -237,6 +237,36 @@ export function createDispatcherPlugin(config: DispatcherPluginConfig = {}): Plu
                 }
             });
 
+            // ── i18n ────────────────────────────────────────────────────
+            // Bridges to HttpDispatcher.handleI18n() which resolves the i18n
+            // service from the kernel (either I18nServicePlugin or memory fallback).
+            server.get(`${prefix}/i18n/locales`, async (req: any, res: any) => {
+                try {
+                    const result = await dispatcher.handleI18n('/locales', 'GET', req.query, { request: req });
+                    sendResult(result, res);
+                } catch (err: any) {
+                    errorResponse(err, res);
+                }
+            });
+
+            server.get(`${prefix}/i18n/translations/:locale`, async (req: any, res: any) => {
+                try {
+                    const result = await dispatcher.handleI18n(`/translations/${req.params.locale}`, 'GET', req.query, { request: req });
+                    sendResult(result, res);
+                } catch (err: any) {
+                    errorResponse(err, res);
+                }
+            });
+
+            server.get(`${prefix}/i18n/labels/:object/:locale`, async (req: any, res: any) => {
+                try {
+                    const result = await dispatcher.handleI18n(`/labels/${req.params.object}/${req.params.locale}`, 'GET', req.query, { request: req });
+                    sendResult(result, res);
+                } catch (err: any) {
+                    errorResponse(err, res);
+                }
+            });
+
             // ── Automation ──────────────────────────────────────────────
             server.get(`${prefix}/automation`, async (req: any, res: any) => {
                 try {