@gravito/impulse-bridge 1.0.1 → 1.0.2

package/dist/index.cjs

@@ -26,13 +26,19 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 var ImpulseBridge = {
   /**
-   * Share a FormRequest blueprint with the frontend (via Inertia).
+   * Serializes a FormRequest class and shares its blueprint with the frontend.
+   *
+   * @param ctx - The Gravito request context.
+   * @param key - The unique identifier for this form blueprint on the frontend.
+   * @param RequestClass - The FormRequest class (not instance) to share.
    *
    * @example
+   * ```typescript
    * async show(ctx: Context) {
-   *   ImpulseBridge.share(ctx, 'login', LoginFormRequest)
-   *   return ctx.inertia('Login')
+   *   ImpulseBridge.share(ctx, 'register', RegistrationRequest);
+   *   return ctx.inertia('Auth/Register');
    * }
+   * ```
    */
   share(ctx, key, RequestClass) {
     const request = new RequestClass();

package/dist/index.d.cts

@@ -2,24 +2,39 @@ import { GravitoContext } from '@gravito/core';
 import { FormRequest } from '@gravito/impulse';
 
 /**
- * Impulse Bridge
+ * ImpulseBridge facilitates the synchronization of backend validation rules
+ * and form blueprints with frontend frameworks (primarily via Inertia.js).
  *
- * Provides utilities to synchronize backend validation rules with the frontend.
+ * It allows you to "share" a FormRequest structure so that frontend
+ * components can automatically perform client-side validation using the
+ * same rules defined on the server.
+ *
+ * @public
  */
 declare const ImpulseBridge: {
     /**
-     * Share a FormRequest blueprint with the frontend (via Inertia).
+     * Serializes a FormRequest class and shares its blueprint with the frontend.
+     *
+     * @param ctx - The Gravito request context.
+     * @param key - The unique identifier for this form blueprint on the frontend.
+     * @param RequestClass - The FormRequest class (not instance) to share.
      *
      * @example
+     * ```typescript
      * async show(ctx: Context) {
-     *   ImpulseBridge.share(ctx, 'login', LoginFormRequest)
-     *   return ctx.inertia('Login')
+     *   ImpulseBridge.share(ctx, 'register', RegistrationRequest);
+     *   return ctx.inertia('Auth/Register');
      * }
+     * ```
      */
     share(ctx: GravitoContext, key: string, RequestClass: new () => FormRequest): void;
 };
 /**
- * Global middleware to automatically inject blueprints if requested.
+ * Middleware that automatically shares a set of FormRequest blueprints
+ * with every request matched by the router.
+ *
+ * @param blueprints - A map of key-to-FormRequestClass pairs.
+ * @public
  */
 declare function impulseBridgeMiddleware(blueprints: Record<string, new () => FormRequest>): (ctx: GravitoContext, next: () => Promise<Response | undefined>) => Promise<Response | undefined>;
 

package/dist/index.d.ts

@@ -2,24 +2,39 @@ import { GravitoContext } from '@gravito/core';
 import { FormRequest } from '@gravito/impulse';
 
 /**
- * Impulse Bridge
+ * ImpulseBridge facilitates the synchronization of backend validation rules
+ * and form blueprints with frontend frameworks (primarily via Inertia.js).
  *
- * Provides utilities to synchronize backend validation rules with the frontend.
+ * It allows you to "share" a FormRequest structure so that frontend
+ * components can automatically perform client-side validation using the
+ * same rules defined on the server.
+ *
+ * @public
  */
 declare const ImpulseBridge: {
     /**
-     * Share a FormRequest blueprint with the frontend (via Inertia).
+     * Serializes a FormRequest class and shares its blueprint with the frontend.
+     *
+     * @param ctx - The Gravito request context.
+     * @param key - The unique identifier for this form blueprint on the frontend.
+     * @param RequestClass - The FormRequest class (not instance) to share.
      *
      * @example
+     * ```typescript
      * async show(ctx: Context) {
-     *   ImpulseBridge.share(ctx, 'login', LoginFormRequest)
-     *   return ctx.inertia('Login')
+     *   ImpulseBridge.share(ctx, 'register', RegistrationRequest);
+     *   return ctx.inertia('Auth/Register');
      * }
+     * ```
      */
     share(ctx: GravitoContext, key: string, RequestClass: new () => FormRequest): void;
 };
 /**
- * Global middleware to automatically inject blueprints if requested.
+ * Middleware that automatically shares a set of FormRequest blueprints
+ * with every request matched by the router.
+ *
+ * @param blueprints - A map of key-to-FormRequestClass pairs.
+ * @public
  */
 declare function impulseBridgeMiddleware(blueprints: Record<string, new () => FormRequest>): (ctx: GravitoContext, next: () => Promise<Response | undefined>) => Promise<Response | undefined>;
 

package/dist/index.js

@@ -1,13 +1,19 @@
 // src/index.ts
 var ImpulseBridge = {
   /**
-   * Share a FormRequest blueprint with the frontend (via Inertia).
+   * Serializes a FormRequest class and shares its blueprint with the frontend.
+   *
+   * @param ctx - The Gravito request context.
+   * @param key - The unique identifier for this form blueprint on the frontend.
+   * @param RequestClass - The FormRequest class (not instance) to share.
    *
    * @example
+   * ```typescript
    * async show(ctx: Context) {
-   *   ImpulseBridge.share(ctx, 'login', LoginFormRequest)
-   *   return ctx.inertia('Login')
+   *   ImpulseBridge.share(ctx, 'register', RegistrationRequest);
+   *   return ctx.inertia('Auth/Register');
    * }
+   * ```
    */
   share(ctx, key, RequestClass) {
     const request = new RequestClass();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gravito/impulse-bridge",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "publishConfig": {
         "access": "public"
     },