@ankhorage/orchestrator-module-expo-localization 0.1.4 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ankhorage/orchestrator-module-expo-localization
 
+## 0.2.0
+
+### Minor Changes
+
+- ef56e0d: Generate localization runtime files under the canonical `src/modules/localization` namespace and rename the generated provider to `LocalizationModuleProvider`. Add an optional package-owned host contribution with generic metadata, layout integration, config normalization, and a serializable admin schema while keeping the root Orchestrator module standalone.
+
+## 0.1.5
+
+### Patch Changes
+
+- 2b1866c: Generate localization runtime files with direct `@ankhorage/runtime` imports and reject the retired `@ankh/runtime` workspace alias in regression coverage.
+
 ## 0.1.4
 
 ### Patch Changes

package/README.md

@@ -8,12 +8,31 @@ Adds localization support to Expo apps.
 - No boilerplate
 - Fully reversible
 
-## 📦 Usage
+## Usage
 
 ```ts
-orchestrator.install('expo-localization');
+import { createOrchestrator } from '@ankhorage/orchestrator';
+import { expoLocalizationModule } from '@ankhorage/orchestrator-module-expo-localization';
+
+const orchestrator = createOrchestrator({
+  modules: [expoLocalizationModule],
+  projectRoot: '/path/to/project',
+});
+
+await orchestrator.installModule('expo-localization', { config: {} });
+```
+
+The Orchestrator ledger is the canonical lifecycle and configuration source. Updating an existing
+installation uses `reconfigureModule()`, which also removes outputs recorded by an earlier module
+version before generating the canonical `src/modules/localization` namespace.
+
+Generic authoring hosts can opt into the package-owned metadata, layout integration, config
+normalizer, and serializable admin schema without making the core module depend on Studio:
+
+```ts
+import { expoLocalizationHostContribution } from '@ankhorage/orchestrator-module-expo-localization/host';
 ```
 
-## 🧠 Why this exists
+## Why this exists
 
 Standardizes localization setup across apps.

package/dist/host.d.ts

@@ -0,0 +1,40 @@
+import { parseExpoLocalizationModuleConfig } from './config';
+/**
+ * Optional package-owned data consumed by generic authoring hosts.
+ * The core module remains independently usable from the package root.
+ */
+export declare const expoLocalizationHostContribution: {
+    readonly id: "expo-localization";
+    readonly name: "Localization (Expo)";
+    readonly description: "Multi-language support powered by expo-localization and i18next.";
+    readonly definition: import("@ankhorage/orchestrator").ModuleDefinition<import("./config").ExpoLocalizationModuleConfig>;
+    readonly normalizeConfig: typeof parseExpoLocalizationModuleConfig;
+    readonly layout: {
+        readonly imports: readonly ["import { LocalizationModuleProvider } from \"@/modules/localization\";"];
+        readonly hooks: readonly [];
+        readonly providerStart: readonly ["<LocalizationModuleProvider>"];
+        readonly providerEnd: readonly ["</LocalizationModuleProvider>"];
+    };
+    readonly admin: {
+        readonly kind: "config-schema";
+        readonly title: "Localization";
+        readonly description: "Configure supported locales, the default locale, and translation resources.";
+        readonly fields: readonly [{
+            readonly key: "defaultLocale";
+            readonly label: "Default locale";
+            readonly control: "text";
+            readonly required: true;
+        }, {
+            readonly key: "locales";
+            readonly label: "Locales";
+            readonly control: "string-list";
+            readonly required: true;
+        }, {
+            readonly key: "translations";
+            readonly label: "Translations";
+            readonly control: "locale-string-map";
+            readonly required: false;
+        }];
+    };
+};
+//# sourceMappingURL=host.d.ts.map

package/dist/host.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,MAAM,UAAU,CAAC;AAG7D;;;GAGG;AACH,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqCnC,CAAC"}

package/dist/host.js

@@ -0,0 +1,45 @@
+import { parseExpoLocalizationModuleConfig } from './config';
+import { EXPO_LOCALIZATION_MODULE_ID, expoLocalizationModule } from './module';
+/**
+ * Optional package-owned data consumed by generic authoring hosts.
+ * The core module remains independently usable from the package root.
+ */
+export const expoLocalizationHostContribution = {
+    id: EXPO_LOCALIZATION_MODULE_ID,
+    name: 'Localization (Expo)',
+    description: 'Multi-language support powered by expo-localization and i18next.',
+    definition: expoLocalizationModule,
+    normalizeConfig: parseExpoLocalizationModuleConfig,
+    layout: {
+        imports: ['import { LocalizationModuleProvider } from "@/modules/localization";'],
+        hooks: [],
+        providerStart: ['<LocalizationModuleProvider>'],
+        providerEnd: ['</LocalizationModuleProvider>'],
+    },
+    admin: {
+        kind: 'config-schema',
+        title: 'Localization',
+        description: 'Configure supported locales, the default locale, and translation resources.',
+        fields: [
+            {
+                key: 'defaultLocale',
+                label: 'Default locale',
+                control: 'text',
+                required: true,
+            },
+            {
+                key: 'locales',
+                label: 'Locales',
+                control: 'string-list',
+                required: true,
+            },
+            {
+                key: 'translations',
+                label: 'Translations',
+                control: 'locale-string-map',
+                required: false,
+            },
+        ],
+    },
+};
+//# sourceMappingURL=host.js.map

package/dist/host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.js","sourceRoot":"","sources":["../src/host.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iCAAiC,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAE/E;;;GAGG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,EAAE,EAAE,2BAA2B;IAC/B,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EAAE,kEAAkE;IAC/E,UAAU,EAAE,sBAAsB;IAClC,eAAe,EAAE,iCAAiC;IAClD,MAAM,EAAE;QACN,OAAO,EAAE,CAAC,sEAAsE,CAAC;QACjF,KAAK,EAAE,EAAE;QACT,aAAa,EAAE,CAAC,8BAA8B,CAAC;QAC/C,WAAW,EAAE,CAAC,+BAA+B,CAAC;KAC/C;IACD,KAAK,EAAE;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,6EAA6E;QAC1F,MAAM,EAAE;YACN;gBACE,GAAG,EAAE,eAAe;gBACpB,KAAK,EAAE,gBAAgB;gBACvB,OAAO,EAAE,MAAM;gBACf,QAAQ,EAAE,IAAI;aACf;YACD;gBACE,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE,SAAS;gBAChB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,IAAI;aACf;YACD;gBACE,GAAG,EAAE,cAAc;gBACnB,KAAK,EAAE,cAAc;gBACrB,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;KACF;CACO,CAAC"}

package/dist/module.js

@@ -27,7 +27,7 @@ export const expoLocalizationModule = defineModule({
                 type: 'patch-text-block',
                 path: 'src/app/_layout.tsx',
                 blockId: `${EXPO_LOCALIZATION_MODULE_ID}:root-layout-import`,
-                content: 'import { LocalizationPluginProvider } from "@/plugins/localization";',
+                content: 'import { LocalizationModuleProvider } from "@/modules/localization";',
                 anchor: {
                     find: "import ankhConfig from '@root/ankh.config.json';",
                     position: 'before',
@@ -37,7 +37,7 @@ export const expoLocalizationModule = defineModule({
                 type: 'patch-text-block',
                 path: 'src/app/_layout.tsx',
                 blockId: `${EXPO_LOCALIZATION_MODULE_ID}:root-layout-provider`,
-                content: '  output = <LocalizationPluginProvider>{output}</LocalizationPluginProvider>;',
+                content: '  output = <LocalizationModuleProvider>{output}</LocalizationModuleProvider>;',
                 anchor: {
                     find: '  return (',
                     position: 'before',

package/dist/templateFiles.js

@@ -11,24 +11,24 @@ export function buildLocalizationWriteFiles(args) {
     const { defaultLocale, locales, translations } = args;
     return [
         {
-            path: 'src/plugins/localization/i18n.ts',
+            path: 'src/modules/localization/i18n.ts',
             content: renderTemplate('i18n.ts.tpl', {
                 DEFAULT_LOCALE: JSON.stringify(defaultLocale),
             }),
             overwrite: true,
         },
         {
-            path: 'src/plugins/localization/useT.ts',
+            path: 'src/modules/localization/useT.ts',
             content: readTemplate('useT.ts.tpl'),
             overwrite: true,
         },
         {
-            path: 'src/plugins/localization/runtimeLocalization.ts',
+            path: 'src/modules/localization/runtimeLocalization.ts',
             content: readTemplate('runtimeLocalization.ts.tpl'),
             overwrite: true,
         },
         {
-            path: 'src/plugins/localization/LocalizationProvider.tsx',
+            path: 'src/modules/localization/LocalizationProvider.tsx',
             content: renderTemplate('LocalizationProvider.tsx.tpl', {
                 DEFAULT_LOCALE: JSON.stringify(defaultLocale),
                 RESOURCE_LINES: locales
@@ -38,7 +38,7 @@ export function buildLocalizationWriteFiles(args) {
             overwrite: true,
         },
         {
-            path: 'src/plugins/localization/index.ts',
+            path: 'src/modules/localization/index.ts',
             content: readTemplate('index.ts.tpl'),
             overwrite: true,
         },
@@ -50,7 +50,7 @@ function buildLocaleJsonFiles(locales, configTranslations) {
         const contentSource = configTranslations[locale] ??
             (locale.startsWith('de') ? defaultTranslations.de : defaultTranslations.en);
         return {
-            path: `src/plugins/localization/locales/${locale}.json`,
+            path: `src/modules/localization/locales/${locale}.json`,
             content: `${JSON.stringify(contentSource, null, 2)}\n`,
         };
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "license": "MIT",
   "name": "@ankhorage/orchestrator-module-expo-localization",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "Expo localization module for @ankhorage/orchestrator.",
   "type": "module",
   "main": "./dist/index.js",
@@ -34,6 +34,10 @@
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./host": {
+      "types": "./dist/host.d.ts",
+      "default": "./dist/host.js"
     }
   },
   "scripts": {
@@ -48,7 +52,7 @@
     "version-packages": "changeset version"
   },
   "dependencies": {
-    "@ankhorage/orchestrator": "^0.2.2"
+    "@ankhorage/orchestrator": "^0.3.0"
   },
   "devDependencies": {
     "@ankhorage/devtools": "^1.0.6",

package/templates/LocalizationProvider.tsx.tpl

@@ -1,5 +1,5 @@
 /* generated by @ankhorage/orchestrator-module-expo-localization */
-import { RuntimeRendererConfigProvider } from "@ankh/runtime";
+import { RuntimeRendererConfigProvider } from "@ankhorage/runtime";
 import React, { useEffect, useMemo, useState } from "react";
 import * as ExpoLocalization from "expo-localization";
 import { useTranslation } from "react-i18next";
@@ -10,13 +10,13 @@ import {
   createLocalizationNodePropsResolver,
 } from "./runtimeLocalization";
 
-export interface LocalizationPluginConfig {
+export interface LocalizationModuleConfig {
   defaultLocale?: string;
 }
 
-export function LocalizationPluginProvider(props: {
+export function LocalizationModuleProvider(props: {
   children: React.ReactNode;
-  config?: LocalizationPluginConfig;
+  config?: LocalizationModuleConfig;
 }) {
   const { children, config } = props;
 

package/templates/index.ts.tpl

@@ -1,4 +1,4 @@
 /* generated by @ankhorage/orchestrator-module-expo-localization */
-export { LocalizationPluginProvider } from "./LocalizationProvider";
+export { LocalizationModuleProvider } from "./LocalizationProvider";
 export { useT } from "./useT";
 export { i18n } from "./i18n";

package/templates/runtimeLocalization.ts.tpl

@@ -1,5 +1,5 @@
 /* generated by @ankhorage/orchestrator-module-expo-localization */
-import type { RuntimeActionHandlers, RuntimeNodePropsResolver } from "@ankh/runtime";
+import type { RuntimeActionHandlers, RuntimeNodePropsResolver } from "@ankhorage/runtime";
 import type { i18n as I18nInstance } from "i18next";
 
 const LOCALIZED_PROP_PAIRS = [