@gravito/ion 3.0.0 → 3.0.1

package/dist/index.cjs

@@ -159,21 +159,31 @@ var OrbitIon = class {
     this.options = options;
   }
   /**
-   * Install the Inertia orbit into PlanetCore
+   * Install the inertia orbit into PlanetCore
    */
   install(core) {
-    core.logger.info("\u{1F6F0}\uFE0F Orbit Inertia installed");
+    core.logger.info("\u{1F6F0}\uFE0F Orbit Inertia installed (Callable Interface)");
     const appVersion = this.options.version ?? core.config.get("APP_VERSION", "1.0.0");
     const rootView = this.options.rootView ?? "app";
     core.adapter.use("*", async (c, next) => {
-      const gravitoCtx = c;
-      const inertia = new InertiaService(gravitoCtx, {
+      const service = new InertiaService(c, {
         version: String(appVersion),
         rootView
       });
-      c.set("inertia", inertia);
-      await next();
-      return void 0;
+      const inertiaProxy = (component, props = {}, rootVars = {}) => {
+        return service.render(component, props, rootVars);
+      };
+      Object.assign(inertiaProxy, {
+        share: service.share.bind(service),
+        shareAll: service.shareAll.bind(service),
+        getSharedProps: service.getSharedProps.bind(service),
+        render: service.render.bind(service),
+        // Also allow .render()
+        service
+        // Access to the raw service instance
+      });
+      c.set("inertia", inertiaProxy);
+      return await next();
     });
   }
 };

package/dist/index.d.cts

@@ -122,39 +122,80 @@ declare class InertiaService {
  * @since 1.0.0
  */
 
-declare module '@gravito/core' {
-    interface GravitoVariables {
-        /** Inertia.js service for SPA rendering */
-        inertia?: InertiaService;
-    }
-}
 /**
- * OrbitIon - Inertia.js integration orbit
- *
- * This orbit provides seamless Inertia.js integration, enabling
- * SPA-like navigation with server-side routing.
+ * InertiaHelper is a callable function and service suite injected into the Gravito context.
+ * It allows you to render Inertia components directly or manage shared data.
  *
  * @example
  * ```typescript
- * import { PlanetCore, defineConfig } from '@gravito/core'
- * import { OrbitIon } from '@gravito/ion'
+ * // Direct call rendering
+ * return ctx.get('inertia')('Welcome', { user });
  *
- * const core = await PlanetCore.boot(defineConfig({
- *   orbits: [OrbitIon]
- * }))
+ * // Using shared data
+ * ctx.get('inertia').share('appName', 'Gravito App');
  * ```
+ * @public
+ */
+interface InertiaHelper {
+    /**
+     * Render an Inertia component.
+     * Shortcut for context.get('inertia').render()
+     *
+     * @param component - The name of the frontend component (e.g., 'Pages/Home')
+     * @param props - Data to pass to the component
+     * @param rootVars - Variables for the root HTML template (e.g., meta tags)
+     */
+    (component: string, props?: Record<string, unknown>, rootVars?: Record<string, unknown>): Response;
+    /** Share data with all Inertia responses for the remainder of the request */
+    share(key: string, value: unknown): void;
+    /** Share multiple props at once */
+    shareAll(props: Record<string, unknown>): void;
+    /** Get all currently shared props */
+    getSharedProps(): Record<string, unknown>;
+    /** Explicitly render an Inertia component */
+    render(component: string, props?: Record<string, unknown>, rootVars?: Record<string, unknown>): Response;
+    /** Direct access to the low-level Inertia service instance */
+    service: InertiaService;
+}
+/**
+ * Options for configuring OrbitIon.
+ * @public
  */
 interface OrbitIonOptions {
+    /** Current asset version to detect staleness (X-Inertia-Version) */
     version?: string;
+    /** The root HTML template view (default: 'app') */
     rootView?: string;
 }
+/**
+ * OrbitIon provides official Inertia.js integration for Gravito.
+ *
+ * It handles Inertia requests, partial reloads, asset versioning, and seamless
+ * data sharing between the server and your frontend application (React, Vue, etc.).
+ *
+ * It injects an `InertiaHelper` into the context, allowing you to render
+ * components with a simple function call: `c.get('inertia')('Page', { props })`.
+ *
+ * @example
+ * ```typescript
+ * import { OrbitIon } from '@gravito/ion';
+ *
+ * core.addOrbit(new OrbitIon({
+ *   version: '1.0.0',
+ *   rootView: 'app'
+ * }));
+ * ```
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class OrbitIon implements GravitoOrbit {
     private options;
     constructor(options?: OrbitIonOptions);
     /**
-     * Install the Inertia orbit into PlanetCore
+     * Install the inertia orbit into PlanetCore
      */
     install(core: PlanetCore): void;
 }
 
-export { type InertiaConfig, InertiaService, OrbitIon, type OrbitIonOptions, OrbitIon as default };
+export { type InertiaConfig, type InertiaHelper, InertiaService, OrbitIon, type OrbitIonOptions, OrbitIon as default };

package/dist/index.d.ts

@@ -122,39 +122,80 @@ declare class InertiaService {
  * @since 1.0.0
  */
 
-declare module '@gravito/core' {
-    interface GravitoVariables {
-        /** Inertia.js service for SPA rendering */
-        inertia?: InertiaService;
-    }
-}
 /**
- * OrbitIon - Inertia.js integration orbit
- *
- * This orbit provides seamless Inertia.js integration, enabling
- * SPA-like navigation with server-side routing.
+ * InertiaHelper is a callable function and service suite injected into the Gravito context.
+ * It allows you to render Inertia components directly or manage shared data.
  *
  * @example
  * ```typescript
- * import { PlanetCore, defineConfig } from '@gravito/core'
- * import { OrbitIon } from '@gravito/ion'
+ * // Direct call rendering
+ * return ctx.get('inertia')('Welcome', { user });
  *
- * const core = await PlanetCore.boot(defineConfig({
- *   orbits: [OrbitIon]
- * }))
+ * // Using shared data
+ * ctx.get('inertia').share('appName', 'Gravito App');
  * ```
+ * @public
+ */
+interface InertiaHelper {
+    /**
+     * Render an Inertia component.
+     * Shortcut for context.get('inertia').render()
+     *
+     * @param component - The name of the frontend component (e.g., 'Pages/Home')
+     * @param props - Data to pass to the component
+     * @param rootVars - Variables for the root HTML template (e.g., meta tags)
+     */
+    (component: string, props?: Record<string, unknown>, rootVars?: Record<string, unknown>): Response;
+    /** Share data with all Inertia responses for the remainder of the request */
+    share(key: string, value: unknown): void;
+    /** Share multiple props at once */
+    shareAll(props: Record<string, unknown>): void;
+    /** Get all currently shared props */
+    getSharedProps(): Record<string, unknown>;
+    /** Explicitly render an Inertia component */
+    render(component: string, props?: Record<string, unknown>, rootVars?: Record<string, unknown>): Response;
+    /** Direct access to the low-level Inertia service instance */
+    service: InertiaService;
+}
+/**
+ * Options for configuring OrbitIon.
+ * @public
  */
 interface OrbitIonOptions {
+    /** Current asset version to detect staleness (X-Inertia-Version) */
     version?: string;
+    /** The root HTML template view (default: 'app') */
     rootView?: string;
 }
+/**
+ * OrbitIon provides official Inertia.js integration for Gravito.
+ *
+ * It handles Inertia requests, partial reloads, asset versioning, and seamless
+ * data sharing between the server and your frontend application (React, Vue, etc.).
+ *
+ * It injects an `InertiaHelper` into the context, allowing you to render
+ * components with a simple function call: `c.get('inertia')('Page', { props })`.
+ *
+ * @example
+ * ```typescript
+ * import { OrbitIon } from '@gravito/ion';
+ *
+ * core.addOrbit(new OrbitIon({
+ *   version: '1.0.0',
+ *   rootView: 'app'
+ * }));
+ * ```
+ *
+ * @public
+ * @since 3.0.0
+ */
 declare class OrbitIon implements GravitoOrbit {
     private options;
     constructor(options?: OrbitIonOptions);
     /**
-     * Install the Inertia orbit into PlanetCore
+     * Install the inertia orbit into PlanetCore
      */
     install(core: PlanetCore): void;
 }
 
-export { type InertiaConfig, InertiaService, OrbitIon, type OrbitIonOptions, OrbitIon as default };
+export { type InertiaConfig, type InertiaHelper, InertiaService, OrbitIon, type OrbitIonOptions, OrbitIon as default };

package/dist/index.js

@@ -131,21 +131,31 @@ var OrbitIon = class {
     this.options = options;
   }
   /**
-   * Install the Inertia orbit into PlanetCore
+   * Install the inertia orbit into PlanetCore
    */
   install(core) {
-    core.logger.info("\u{1F6F0}\uFE0F Orbit Inertia installed");
+    core.logger.info("\u{1F6F0}\uFE0F Orbit Inertia installed (Callable Interface)");
     const appVersion = this.options.version ?? core.config.get("APP_VERSION", "1.0.0");
     const rootView = this.options.rootView ?? "app";
     core.adapter.use("*", async (c, next) => {
-      const gravitoCtx = c;
-      const inertia = new InertiaService(gravitoCtx, {
+      const service = new InertiaService(c, {
         version: String(appVersion),
         rootView
       });
-      c.set("inertia", inertia);
-      await next();
-      return void 0;
+      const inertiaProxy = (component, props = {}, rootVars = {}) => {
+        return service.render(component, props, rootVars);
+      };
+      Object.assign(inertiaProxy, {
+        share: service.share.bind(service),
+        shareAll: service.shareAll.bind(service),
+        getSharedProps: service.getSharedProps.bind(service),
+        render: service.render.bind(service),
+        // Also allow .render()
+        service
+        // Access to the raw service instance
+      });
+      c.set("inertia", inertiaProxy);
+      return await next();
     });
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravito/ion",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Inertia.js adapter for Gravito",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",