@gravito/cosmos 1.0.0-alpha.6 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @gravito/cosmos
+
+## 1.0.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @gravito/core@1.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 > Lightweight Internationalization (i18n) Orbit for Gravito.
 
-Provides simple JSON-based localization support for your Gravito application, with seamless integration into Hono context.
+Provides simple JSON-based localization support for your Gravito application, with seamless integration into Photon context.
 
 ## 📦 Installation
 
@@ -14,7 +14,7 @@ bun add @gravito/cosmos
 
 1.  **Register the Orbit**:
     ```typescript
-    import { PlanetCore } from 'gravito-core';
+    import { PlanetCore } from '@gravito/core';
     import { OrbitI18n } from '@gravito/cosmos';
 
     const core = new PlanetCore();
@@ -50,7 +50,7 @@ bun add @gravito/cosmos
 
 ## ✨ Features
 
--   **Context Injection**: Automatically injects `t()` helper into Hono context.
+-   **Context Injection**: Automatically injects `t()` helper into Photon context.
 -   **Parameter Replacement**: Supports `{key}` style parameter replacement.
 -   **Locale Detection**: Automatically detects locale from `Accept-Language` header or query parameter `?lang=`.
 -   **Fallback**: gracefully falls back to default locale if key is missing.

package/README.zh-TW.md

@@ -11,7 +11,7 @@ bun add @gravito/cosmos
 ## 快速開始
 
 ```typescript
-import { PlanetCore } from 'gravito-core'
+import { PlanetCore } from '@gravito/core'
 import { OrbitI18n } from '@gravito/cosmos'
 
 const core = new PlanetCore()

package/dist/index.js

@@ -146,7 +146,7 @@ async function loadTranslations(directory) {
 }
 
 // src/index.ts
-class I18nOrbit {
+class OrbitCosmos {
   config;
   constructor(config) {
     this.config = config;
@@ -154,12 +154,14 @@ class I18nOrbit {
   install(core) {
     const i18nManager = new I18nManager(this.config);
     core.adapter.use("*", localeMiddleware(i18nManager));
-    core.logger.info(`I18n Orbit initialized with locale: ${this.config.defaultLocale}`);
+    core.logger.info(`[OrbitCosmos] I18n initialized with locale: ${this.config.defaultLocale}`);
   }
 }
+var I18nOrbit = OrbitCosmos;
 export {
   localeMiddleware,
   loadTranslations,
+  OrbitCosmos,
   I18nOrbit,
   I18nManager,
   I18nInstance

package/ion/src/index.js

@@ -2,7 +2,7 @@ import { createRequire } from "node:module";
 var __require = /* @__PURE__ */ createRequire(import.meta.url);
 // ../core/package.json
 var package_default = {
-  name: "gravito-core",
+  name: "@gravito/core",
   version: "1.0.0-beta.2",
   description: "",
   module: "./dist/index.mjs",
@@ -700,7 +700,7 @@ async function handleProcessError(kind, error) {
       }
     }));
   } catch (e) {
-    console.error("[gravito-core] Failed to handle process-level error:", e);
+    console.error("[@gravito/core] Failed to handle process-level error:", e);
   } finally {
     if (shouldExit) {
       clearTimeout(exitTimer);

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@gravito/cosmos",
-  "version": "1.0.0-alpha.6",
+  "version": "1.0.0",
   "description": "Internationalization orbit for Gravito framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "bun build ./src/index.ts --outdir ./dist --target node --external @gravito/core --external hono",
-    "test": "bun test"
+    "build": "bun build ./src/index.ts --outdir ./dist --target node --external @gravito/core --external @gravito/photon",
+    "test": "bun test",
+    "test:coverage": "bun test --coverage --coverage-threshold=80",
+    "test:ci": "bun test --coverage --coverage-threshold=80",
+    "typecheck": "bun tsc -p tsconfig.json --noEmit --skipLibCheck"
   },
   "keywords": [
     "gravito",
@@ -17,8 +20,8 @@
   "author": "Carl Lee <carllee0520@gmail.com>",
   "license": "MIT",
   "peerDependencies": {
-    "gravito-core": "1.0.0-beta.5",
-    "hono": "^4.0.0"
+    "@gravito/core": "workspace:*",
+    "@gravito/photon": "workspace:*"
   },
   "devDependencies": {
     "bun-types": "latest"

package/src/I18nService.ts

@@ -1,11 +1,15 @@
-import type { MiddlewareHandler } from 'hono'
+import type { MiddlewareHandler } from '@gravito/photon'
+
+export type TranslationMap = {
+  [key: string]: string | TranslationMap
+}
 
 export interface I18nConfig {
   defaultLocale: string
   supportedLocales: string[]
   // Path to translation files, or a Record of translations
   // If undefined, it will look into `resources/lang` by default (conceptually, handled by loader)
-  translations?: Record<string, Record<string, string>>
+  translations?: Record<string, TranslationMap>
 }
 
 export interface I18nService {
@@ -103,7 +107,7 @@ export class I18nInstance implements I18nService {
  * Holds shared configuration and translation resources
  */
 export class I18nManager implements I18nService {
-  private translations: Record<string, Record<string, string>> = {}
+  private translations: Record<string, TranslationMap> = {}
   // Default instance for global usage (e.g. CLI or background jobs)
   private globalInstance: I18nInstance
 
@@ -195,7 +199,7 @@ export class I18nManager implements I18nService {
    * @param locale - The locale string.
    * @param translations - The translations object.
    */
-  addResource(locale: string, translations: Record<string, string>) {
+  addResource(locale: string, translations: TranslationMap) {
     this.translations[locale] = {
       ...(this.translations[locale] || {}),
       ...translations,

package/src/index.ts

@@ -1,13 +1,18 @@
-import type { GravitoOrbit, PlanetCore } from 'gravito-core'
+import type { GravitoMiddleware, GravitoOrbit, PlanetCore } from '@gravito/core'
 import { type I18nConfig, I18nManager, type I18nService, localeMiddleware } from './I18nService'
 
-declare module 'gravito-core' {
+declare module '@gravito/core' {
   interface Variables {
     i18n: I18nService
   }
 }
 
-export class I18nOrbit implements GravitoOrbit {
+/**
+ * OrbitCosmos - Internationalization Orbit
+ *
+ * Provides i18n functionality for Gravito applications.
+ */
+export class OrbitCosmos implements GravitoOrbit {
   constructor(private config: I18nConfig) {}
 
   install(core: PlanetCore): void {
@@ -18,11 +23,14 @@ export class I18nOrbit implements GravitoOrbit {
 
     // Inject locale middleware into every request
     // This middleware handles cloning the i18n instance per request
-    core.adapter.use('*', localeMiddleware(i18nManager) as any)
+    core.adapter.use('*', localeMiddleware(i18nManager) as unknown as GravitoMiddleware)
 
-    core.logger.info(`I18n Orbit initialized with locale: ${this.config.defaultLocale}`)
+    core.logger.info(`[OrbitCosmos] I18n initialized with locale: ${this.config.defaultLocale}`)
   }
 }
 
+/** @deprecated Use OrbitCosmos instead */
+export const I18nOrbit = OrbitCosmos
+
 export * from './I18nService'
 export * from './loader'

package/tests/loader.test.ts

@@ -0,0 +1,44 @@
+import { describe, expect, it, jest } from 'bun:test'
+import { mkdtempSync, writeFileSync } from 'node:fs'
+import { rm } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { loadTranslations } from '../src/loader'
+
+describe('loadTranslations', () => {
+  it('loads json translation files from a directory', async () => {
+    const tmpDir = mkdtempSync(join(tmpdir(), 'gravito-i18n-'))
+
+    try {
+      writeFileSync(join(tmpDir, 'en.json'), JSON.stringify({ hello: 'Hello' }))
+      writeFileSync(join(tmpDir, 'zh.json'), JSON.stringify({ hello: '你好' }))
+
+      const translations = await loadTranslations(tmpDir)
+
+      expect(translations.en.hello).toBe('Hello')
+      expect(translations.zh.hello).toBe('你好')
+    } finally {
+      await rm(tmpDir, { force: true, recursive: true })
+    }
+  })
+
+  it('skips invalid json files and returns empty for missing dir', async () => {
+    const tmpDir = mkdtempSync(join(tmpdir(), 'gravito-i18n-invalid-'))
+
+    const errorSpy = jest.spyOn(console, 'error').mockImplementation(() => {})
+    const warnSpy = jest.spyOn(console, 'warn').mockImplementation(() => {})
+
+    try {
+      writeFileSync(join(tmpDir, 'en.json'), '{invalid json}')
+      const translations = await loadTranslations(tmpDir)
+      expect(translations.en).toBeUndefined()
+
+      const missing = await loadTranslations(join(tmpDir, 'missing'))
+      expect(missing).toEqual({})
+    } finally {
+      errorSpy.mockRestore()
+      warnSpy.mockRestore()
+      await rm(tmpDir, { force: true, recursive: true })
+    }
+  })
+})

package/tests/service.test.ts

@@ -0,0 +1,109 @@
+import { describe, expect, it, jest } from 'bun:test'
+import { I18nInstance, I18nManager, localeMiddleware } from '../src/I18nService'
+import { I18nOrbit, OrbitCosmos } from '../src/index'
+
+describe('I18nManager and I18nInstance', () => {
+  const baseConfig = {
+    defaultLocale: 'en',
+    supportedLocales: ['en', 'fr'],
+    translations: {
+      en: {
+        greet: 'Hi :name',
+        nested: {
+          title: 'Title',
+        },
+      },
+    },
+  }
+
+  it('adds resources and translates with replacements', () => {
+    const manager = new I18nManager(baseConfig as any)
+    manager.addResource('fr', { greet: 'Salut :name' })
+    manager.locale = 'fr'
+    expect(manager.t('greet', { name: 'Carl' })).toBe('Salut Carl')
+  })
+
+  it('clones instances with explicit locale', () => {
+    const manager = new I18nManager(baseConfig as any)
+    const instance = manager.clone('fr') as I18nInstance
+    expect(instance.getLocale()).toBe('fr')
+    expect(instance.has('missing.key')).toBe(false)
+  })
+
+  it('returns key when value is not a string', () => {
+    const manager = new I18nManager(baseConfig as any)
+    expect(manager.t('nested')).toBe('nested')
+  })
+})
+
+describe('localeMiddleware', () => {
+  it('prefers route param locale and injects i18n', async () => {
+    const manager = new I18nManager({
+      defaultLocale: 'en',
+      supportedLocales: ['en', 'zh'],
+      translations: {
+        en: { title: 'Hello' },
+        zh: { title: '你好' },
+      },
+    })
+    const middleware = localeMiddleware(manager)
+    const ctx = {
+      req: {
+        param: jest.fn(() => 'zh'),
+        query: jest.fn(() => undefined),
+        header: jest.fn(() => undefined),
+      },
+      set: jest.fn(),
+    }
+
+    await middleware(ctx as any, async () => {})
+
+    const injected = ctx.set.mock.calls[0][1]
+    expect(ctx.set).toHaveBeenCalledWith('i18n', expect.any(I18nInstance))
+    expect(injected.locale).toBe('zh')
+  })
+
+  it('uses default locale when none provided', async () => {
+    const manager = new I18nManager({
+      defaultLocale: 'en',
+      supportedLocales: ['en'],
+      translations: {
+        en: { title: 'Hello' },
+      },
+    })
+    const middleware = localeMiddleware(manager)
+    const ctx = {
+      req: {
+        param: jest.fn(() => undefined),
+        query: jest.fn(() => undefined),
+        header: jest.fn(() => undefined),
+      },
+      set: jest.fn(),
+    }
+
+    await middleware(ctx as any, async () => {})
+
+    const injected = ctx.set.mock.calls[0][1]
+    expect(injected.locale).toBe('en')
+  })
+})
+
+describe('OrbitCosmos', () => {
+  it('installs locale middleware and logs initialization', () => {
+    const core = {
+      adapter: { use: jest.fn() },
+      logger: { info: jest.fn() },
+    }
+    const orbit = new OrbitCosmos({
+      defaultLocale: 'en',
+      supportedLocales: ['en'],
+      translations: { en: { title: 'Hello' } },
+    })
+
+    orbit.install(core as any)
+
+    expect(core.adapter.use).toHaveBeenCalledWith('*', expect.any(Function))
+    expect(core.logger.info).toHaveBeenCalledWith('[OrbitCosmos] I18n initialized with locale: en')
+    expect(I18nOrbit).toBe(OrbitCosmos)
+  })
+})

package/tsconfig.json

@@ -4,9 +4,16 @@
         "outDir": "./dist",
         "baseUrl": ".",
         "paths": {
-            "gravito-core": ["../../packages/core/src/index.ts"],
-            "@gravito/*": ["../../packages/*/src/index.ts"]
-        }
+            "@gravito/core": [
+                "../../packages/core/src/index.ts"
+            ],
+            "@gravito/*": [
+                "../../packages/*/src/index.ts"
+            ]
+        },
+        "types": [
+            "bun-types"
+        ]
     },
     "include": [
         "src/**/*"
@@ -16,4 +23,4 @@
         "dist",
         "**/*.test.ts"
     ]
-}
+}