@gravito/cosmos 1.0.0 → 3.0.0

package/dist/core/src/testing/TestResponse.d.ts

@@ -0,0 +1,78 @@
+/**
+ * TestResponse wraps a standard Fetch Response and provides fluent assertion methods
+ * inspired by Laravel's TestResponse.
+ */
+export declare class TestResponse {
+    readonly response: Response;
+    private _jsonData;
+    private _textData;
+    constructor(response: Response);
+    /**
+     * Assert the response status code
+     */
+    assertStatus(status: number): this;
+    /**
+     * Assert that the response has a 200 status code
+     */
+    assertOk(): this;
+    /**
+     * Assert that the response has a 201 status code
+     */
+    assertCreated(): this;
+    /**
+     * Assert that the response has a 404 status code
+     */
+    assertNotFound(): this;
+    /**
+     * Assert that the response has a 403 status code
+     */
+    assertForbidden(): this;
+    /**
+     * Assert that the response has a 401 status code
+     */
+    assertUnauthorized(): this;
+    /**
+     * Assert the response is a redirect
+     */
+    assertRedirect(uri?: string): this;
+    /**
+     * Assert that the response contains the given JSON data.
+     */
+    assertJson(data: any): Promise<this>;
+    /**
+     * Assert that the response contains exactly the given JSON data.
+     */
+    assertExactJson(data: any): Promise<this>;
+    /**
+     * Assert the structure of the JSON response.
+     */
+    assertJsonStructure(structure: any): Promise<this>;
+    /**
+     * Assert that the response contains the given string.
+     */
+    assertSee(value: string): Promise<this>;
+    /**
+     * Assert that the response does not contain the given string.
+     */
+    assertDontSee(value: string): Promise<this>;
+    /**
+     * Assert a header exists and matches value
+     */
+    assertHeader(header: string, value: string): this;
+    /**
+     * Assert a header does not exist
+     */
+    assertHeaderMissing(header: string): this;
+    /**
+     * Get the JSON content
+     */
+    getJson(): Promise<any>;
+    /**
+     * Get the text content
+     */
+    getText(): Promise<string>;
+    /**
+     * Alias for getText for standard expectations if needed
+     */
+    get body(): Promise<string>;
+}

package/dist/core/src/testing/index.d.ts

@@ -0,0 +1,2 @@
+export * from './HttpTester';
+export * from './TestResponse';

package/dist/core/src/types/events.d.ts

@@ -0,0 +1,94 @@
+/**
+ * Event system type definitions.
+ */
+/**
+ * Listener interface.
+ *
+ * All event listeners must implement this interface.
+ */
+export interface Listener<TEvent extends Event = Event> {
+    /**
+     * Handle an event.
+     * @param event - Event instance
+     */
+    handle(event: TEvent): Promise<void> | void;
+}
+/**
+ * Marker interface for listeners that should be queued.
+ *
+ * Listeners implementing this interface can be dispatched asynchronously via a queue.
+ */
+export interface ShouldQueue {
+    /**
+     * Queue name (optional).
+     */
+    queue?: string;
+    /**
+     * Connection name (optional).
+     */
+    connection?: string;
+    /**
+     * Delay before execution (seconds).
+     */
+    delay?: number;
+}
+/**
+ * Marker interface for events that should be broadcast.
+ *
+ * Events implementing this interface can be automatically broadcast to clients.
+ */
+export interface ShouldBroadcast {
+    /**
+     * Define the broadcast channel.
+     * @returns Channel name or channel object
+     */
+    broadcastOn(): string | Channel;
+    /**
+     * Define broadcast payload (optional).
+     * If omitted, public event properties will be used.
+     * @returns Broadcast payload
+     */
+    broadcastWith?(): Record<string, unknown>;
+    /**
+     * Define the broadcast event name (optional).
+     * If omitted, the event class name will be used.
+     * @returns Event name
+     */
+    broadcastAs?(): string;
+}
+/**
+ * Channel interface.
+ */
+export interface Channel {
+    /**
+     * Channel name.
+     */
+    name: string;
+    /**
+     * Channel type.
+     */
+    type: 'public' | 'private' | 'presence';
+}
+/**
+ * Base event class.
+ *
+ * All events should extend this class.
+ */
+export declare abstract class Event {
+    /**
+     * Whether this event should be broadcast.
+     */
+    shouldBroadcast(): boolean;
+    /**
+     * Get broadcast channel.
+     */
+    getBroadcastChannel(): string | Channel | null;
+    /**
+     * Get broadcast payload.
+     */
+    getBroadcastData(): Record<string, unknown>;
+    /**
+     * Get broadcast event name.
+     */
+    getBroadcastEventName(): string;
+}

package/dist/cosmos/src/I18nService.d.ts

@@ -0,0 +1,144 @@
+import type { MiddlewareHandler } from '@gravito/photon';
+export type TranslationMap = {
+    [key: string]: string | TranslationMap;
+};
+export interface I18nConfig {
+    defaultLocale: string;
+    supportedLocales: string[];
+    translations?: Record<string, TranslationMap>;
+}
+export interface I18nService {
+    locale: string;
+    setLocale(locale: string): void;
+    getLocale(): string;
+    t(key: string, replacements?: Record<string, string | number>): string;
+    has(key: string): boolean;
+    clone(locale?: string): I18nService;
+}
+/**
+ * Request-scoped I18n Instance
+ * Holds the state (locale) for a single request, but shares the heavy resources (translations)
+ */
+export declare class I18nInstance implements I18nService {
+    private manager;
+    private _locale;
+    /**
+     * Create a new I18nInstance.
+     *
+     * @param manager - The I18nManager instance.
+     * @param initialLocale - The initial locale for this instance.
+     */
+    constructor(manager: I18nManager, initialLocale: string);
+    get locale(): string;
+    set locale(value: string);
+    /**
+     * Set the current locale.
+     *
+     * @param locale - The locale to set.
+     */
+    setLocale(locale: string): void;
+    /**
+     * Get the current locale.
+     *
+     * @returns The current locale string.
+     */
+    getLocale(): string;
+    /**
+     * Translate a key.
+     *
+     * @param key - The translation key (e.g., 'messages.welcome').
+     * @param replacements - Optional replacements for parameters in the translation string.
+     * @returns The translated string, or the key if not found.
+     */
+    t(key: string, replacements?: Record<string, string | number>): string;
+    /**
+     * Check if a translation key exists.
+     *
+     * @param key - The translation key to check.
+     * @returns True if the key exists, false otherwise.
+     */
+    has(key: string): boolean;
+    /**
+     * Clone the current instance with a potentially new locale.
+     *
+     * @param locale - Optional new locale for the cloned instance.
+     * @returns A new I18nInstance.
+     */
+    clone(locale?: string): I18nService;
+}
+/**
+ * Global I18n Manager
+ * Holds shared configuration and translation resources
+ */
+export declare class I18nManager implements I18nService {
+    private config;
+    private translations;
+    private globalInstance;
+    /**
+     * Create a new I18nManager.
+     *
+     * @param config - The I18n configuration.
+     */
+    constructor(config: I18nConfig);
+    get locale(): string;
+    set locale(value: string);
+    /**
+     * Set the global locale.
+     *
+     * @param locale - The locale to set.
+     */
+    setLocale(locale: string): void;
+    /**
+     * Get the global locale.
+     *
+     * @returns The global locale string.
+     */
+    getLocale(): string;
+    /**
+     * Translate a key using the global locale.
+     *
+     * @param key - The translation key.
+     * @param replacements - Optional replacements.
+     * @returns The translated string.
+     */
+    t(key: string, replacements?: Record<string, string | number>): string;
+    /**
+     * Check if a translation key exists in the global locale.
+     *
+     * @param key - The translation key.
+     * @returns True if found.
+     */
+    has(key: string): boolean;
+    /**
+     * Clone the global instance.
+     *
+     * @param locale - Optional locale for the clone.
+     * @returns A new I18nInstance.
+     */
+    clone(locale?: string): I18nService;
+    /**
+     * Get the I18n configuration.
+     *
+     * @returns The configuration object.
+     */
+    getConfig(): I18nConfig;
+    /**
+     * Add a resource bundle for a specific locale.
+     *
+     * @param locale - The locale string.
+     * @param translations - The translations object.
+     */
+    addResource(locale: string, translations: TranslationMap): void;
+    /**
+     * Internal translation logic used by instances
+     */
+    translate(locale: string, key: string, replacements?: Record<string, string | number>): string;
+}
+/**
+ * Locale Middleware
+ *
+ * Detects locale from:
+ * 1. Route Parameter (e.g. /:locale/foo) - Recommended for SEO
+ * 2. Header (Accept-Language) - Recommended for APIs
+ */
+export declare const localeMiddleware: (i18nManager: I18nService) => MiddlewareHandler;

package/dist/cosmos/src/index.d.ts

@@ -0,0 +1,21 @@
+import type { GravitoOrbit, PlanetCore } from '@gravito/core';
+import { type I18nConfig, type I18nService } from './I18nService';
+declare module '@gravito/core' {
+    interface Variables {
+        i18n: I18nService;
+    }
+}
+/**
+ * OrbitCosmos - Internationalization Orbit
+ *
+ * Provides i18n functionality for Gravito applications.
+ */
+export declare class OrbitCosmos implements GravitoOrbit {
+    private config;
+    constructor(config: I18nConfig);
+    install(core: PlanetCore): void;
+}
+/** @deprecated Use OrbitCosmos instead */
+export declare const I18nOrbit: typeof OrbitCosmos;
+export * from './I18nService';
+export * from './loader';

package/dist/cosmos/src/loader.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Load translations from a directory
+ * Structure:
+ * /lang
+ *   /en.json -> { "welcome": "Hello" }
+ *   /zh.json -> { "welcome": "Hello" }
+ *   /en/auth.json -> { "failed": "Login failed" } (Optional deep structure, maybe later)
+ *
+ * For now, we support flat JSON files per locale: en.json, zh.json
+ */
+export declare function loadTranslations(directory: string): Promise<Record<string, Record<string, string>>>;

package/dist/index.js

@@ -117,7 +117,7 @@ var localeMiddleware = (i18nManager) => {
     }
     const i18n = i18nManager.clone(locale);
     c.set("i18n", i18n);
-    await next();
+    return await next();
   };
 };
 // src/loader.ts

package/dist/photon/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from 'hono';
+export { Hono as Photon } from 'hono';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/cosmos",
-  "version": "1.0.0",
+  "version": "3.0.0",
   "description": "Internationalization orbit for Gravito framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/I18nService.ts

@@ -279,6 +279,6 @@ export const localeMiddleware = (i18nManager: I18nService): MiddlewareHandler =>
     // Inject into context
     c.set('i18n', i18n)
 
-    await next()
+    return await next()
   }
 }