@adonisjs/inertia 4.0.0-next.5 → 4.0.0-next.6

package/build/{chunk-XFUDVODO.js → chunk-GLGCE7D6.js}

@@ -341,6 +341,8 @@ var Inertia = class {
    * Resolve the root view template
    *
    * Handles both static strings and dynamic functions for the root view.
+   *
+   * @returns The resolved root view template name
    */
   #resolveRootView() {
     return typeof this.config.rootView === "function" ? this.config.rootView(this.ctx) : this.config.rootView;
@@ -353,6 +355,7 @@ var Inertia = class {
    * @param component - The component name being rendered
    * @param requestInfo - Information about the current request
    * @param pageProps - Raw page props to be processed
+   * @returns Promise resolving to processed props object with metadata
    */
   #buildPageProps(component, requestInfo, pageProps) {
     const finalProps = { ...this.#sharedState, ...pageProps };
@@ -376,6 +379,7 @@ var Inertia = class {
    * Handle Inertia request by setting headers and returning page object
    *
    * @param pageObject - The page object to return
+   * @returns The page object with appropriate headers set
    */
   #handleInertiaRequest(pageObject) {
     this.ctx.response.header(InertiaHeaders.Inertia, "true");
@@ -386,6 +390,7 @@ var Inertia = class {
    *
    * @param pageObject - The page object to render
    * @param viewProps - Additional props to pass to the root view template
+   * @returns Promise resolving to the rendered HTML string
    */
   async #renderWithSSR(pageObject, viewProps) {
     if (!this.#serverRenderer) {
@@ -403,6 +408,7 @@ var Inertia = class {
    *
    * @param pageObject - The page object to render
    * @param viewProps - Additional props to pass to the root view template
+   * @returns Promise resolving to the rendered HTML string
    */
   async #renderClientSide(pageObject, viewProps) {
     debug_default("rendering shell for SPA %O", pageObject);
@@ -413,6 +419,9 @@ var Inertia = class {
    *
    * Parses various Inertia headers to determine request type and props filtering.
    *
+   * @param reCompute - Whether to recompute the request info instead of using cached version
+   * @returns The request information object containing Inertia-specific data
+   *
    * @example
    * ```js
    * const info = inertia.requestInfo()
@@ -441,6 +450,8 @@ var Inertia = class {
    * Compute and cache the assets version
    *
    * Uses Vite manifest hash when available, otherwise defaults to '1'.
+   *
+   * @returns The computed version string for asset versioning
    */
   getVersion() {
     if (this.#cachedVersion) {
@@ -459,6 +470,7 @@ var Inertia = class {
    * Checks global SSR settings and component-specific configuration.
    *
    * @param component - The component name to check
+   * @returns Promise resolving to true if SSR is enabled for the component
    *
    * @example
    * ```js
@@ -488,6 +500,7 @@ var Inertia = class {
    * in every page render alongside page-specific props.
    *
    * @param sharedState - Props to share across all pages
+   * @returns The Inertia instance for method chaining
    *
    * @example
    * ```js
@@ -514,6 +527,7 @@ var Inertia = class {
    *
    * @param page - The page component name
    * @param pageProps - Props to pass to the page component
+   * @returns Promise resolving to the complete page object
    *
    * @example
    * ```js
@@ -553,8 +567,7 @@ var Inertia = class {
    * @param page - The page component name to render
    * @param pageProps - Props to pass to the page component
    * @param viewProps - Additional props to pass to the root view template
-   *
-   * @returns PageObject for Inertia requests, HTML string for initial page loads
+   * @returns Promise resolving to PageObject for Inertia requests, HTML string for initial page loads
    *
    * @example
    * ```js
@@ -678,7 +691,7 @@ var ServerRenderer = class {
    * @returns Promise resolving to an object with rendered head and body HTML
    *
    * @example
-   * ```typescript
+   * ```js
    * const pageObject = {
    *   component: 'Home',
    *   props: { user: { name: 'John' } },
@@ -741,6 +754,7 @@ var InertiaManager = class {
    * Creates a new Inertia instance for a specific HTTP request
    *
    * @param ctx - HTTP context for the current request
+   * @returns A new Inertia instance configured for the given request
    *
    * @example
    * ```js

package/build/factories/main.js

@@ -4,7 +4,7 @@ import {
 import {
   Inertia,
   ServerRenderer
-} from "../chunk-XFUDVODO.js";
+} from "../chunk-GLGCE7D6.js";
 import {
   InertiaHeaders
 } from "../chunk-DISC5OYC.js";

package/build/index.js

@@ -7,7 +7,7 @@ import {
   InertiaManager,
   ServerRenderer,
   symbols_exports
-} from "./chunk-XFUDVODO.js";
+} from "./chunk-GLGCE7D6.js";
 import {
   InertiaHeaders
 } from "./chunk-DISC5OYC.js";

package/build/providers/inertia_provider.js

@@ -1,6 +1,6 @@
 import {
   InertiaManager
-} from "../chunk-XFUDVODO.js";
+} from "../chunk-GLGCE7D6.js";
 import "../chunk-DISC5OYC.js";
 import "../chunk-4EZ2J6OA.js";
 import "../chunk-MLKGABMK.js";

package/build/src/client/helpers.d.ts

@@ -5,6 +5,8 @@
  *
  * @param path - The page path(s) to resolve. Can be a single string or array of strings
  * @param pages - Registry of page components where keys are paths and values are either promises or functions returning promises
+ * @param layout - Optional layout component to assign to the resolved page
+ * @returns Promise resolving to the page component
  *
  * @example
  * ```js
@@ -20,6 +22,6 @@
  * })
  * ```
  *
- * @throws {Error} When none of the provided paths can be resolved in the pages registry
+ * @throws Error When none of the provided paths can be resolved in the pages registry
  */
-export declare function resolvePageComponent<T>(path: string | string[], pages: Record<string, Promise<T> | (() => Promise<T>) | T>): Promise<T>;
+export declare function resolvePageComponent<T>(path: string | string[], pages: Record<string, Promise<T> | (() => Promise<T>) | T>, layout?: any): Promise<T>;

package/build/src/client/helpers.js

@@ -1,15 +1,29 @@
 import "../../chunk-MLKGABMK.js";
 
 // src/client/helpers.ts
-async function resolvePageComponent(path, pages) {
+async function resolvePageComponent(path, pages, layout) {
   for (const p of Array.isArray(path) ? path : [path]) {
     const page = pages[p];
     if (typeof page === "undefined") {
       continue;
     }
-    return typeof page === "function" ? page() : page;
+    const resolvedPage = await (typeof page === "function" ? page() : page);
+    if (!resolvedPage) {
+      throw new Error(
+        `Invalid page exported from "${path}". Make sure to default export a function`
+      );
+    }
+    if ("default" in resolvedPage === false) {
+      throw new Error(
+        `Invalid page exported from "${path}". Make sure to default export a function`
+      );
+    }
+    if (layout && !resolvedPage.default.layout) {
+      resolvedPage.default.layout = layout;
+    }
+    return resolvedPage;
   }
-  throw new Error(`Page not found: ${path}`);
+  throw new Error(`Page not found: "${path}"`);
 }
 export {
   resolvePageComponent

package/build/src/client/vite.d.ts

@@ -21,6 +21,8 @@ export type InertiaPluginOptions = {
         output?: string;
     } | {
         enabled: false;
+        entrypoint?: string;
+        output?: string;
     };
 };
 /**

package/build/src/define_config.d.ts

@@ -6,6 +6,7 @@ import type { InertiaConfig, InertiaConfigInput } from './types.js';
  * to create a complete Inertia configuration object.
  *
  * @param config - User configuration input to override defaults
+ * @returns Complete Inertia configuration object with defaults applied
  *
  * @example
  * ```js

package/build/src/index_pages.d.ts

@@ -7,14 +7,17 @@
  *
  * @param config - Configuration object specifying the frontend framework
  * @param config.framework - The frontend framework ('vue3' or 'react')
+ * @returns Assembler hook object with run method for generating page types
  *
  * @example
+ * ```js
  * // In your adonisrc.ts file
  * export default defineConfig({
  *   assembler: {
  *     onBuildStarting: [indexPages({ framework: 'vue3' })]
  *   }
  * })
+ * ```
  */
 export declare const indexPages: (config: {
     framework: "vue3" | "react";

package/build/src/inertia.d.ts

@@ -104,6 +104,9 @@ export declare class Inertia<Pages> {
      *
      * Parses various Inertia headers to determine request type and props filtering.
      *
+     * @param reCompute - Whether to recompute the request info instead of using cached version
+     * @returns The request information object containing Inertia-specific data
+     *
      * @example
      * ```js
      * const info = inertia.requestInfo()
@@ -117,6 +120,8 @@ export declare class Inertia<Pages> {
      * Compute and cache the assets version
      *
      * Uses Vite manifest hash when available, otherwise defaults to '1'.
+     *
+     * @returns The computed version string for asset versioning
      */
     getVersion(): string;
     /**
@@ -125,6 +130,7 @@ export declare class Inertia<Pages> {
      * Checks global SSR settings and component-specific configuration.
      *
      * @param component - The component name to check
+     * @returns Promise resolving to true if SSR is enabled for the component
      *
      * @example
      * ```js
@@ -143,6 +149,7 @@ export declare class Inertia<Pages> {
      * in every page render alongside page-specific props.
      *
      * @param sharedState - Props to share across all pages
+     * @returns The Inertia instance for method chaining
      *
      * @example
      * ```js
@@ -166,6 +173,7 @@ export declare class Inertia<Pages> {
      *
      * @param page - The page component name
      * @param pageProps - Props to pass to the page component
+     * @returns Promise resolving to the complete page object
      *
      * @example
      * ```js
@@ -187,8 +195,7 @@ export declare class Inertia<Pages> {
      * @param page - The page component name to render
      * @param pageProps - Props to pass to the page component
      * @param viewProps - Additional props to pass to the root view template
-     *
-     * @returns PageObject for Inertia requests, HTML string for initial page loads
+     * @returns Promise resolving to PageObject for Inertia requests, HTML string for initial page loads
      *
      * @example
      * ```js

package/build/src/inertia_manager.d.ts

@@ -35,6 +35,7 @@ export declare class InertiaManager {
      * Creates a new Inertia instance for a specific HTTP request
      *
      * @param ctx - HTTP context for the current request
+     * @returns A new Inertia instance configured for the given request
      *
      * @example
      * ```js

package/build/src/inertia_middleware.d.ts

@@ -51,8 +51,11 @@ export default abstract class BaseInertiaMiddleware {
      * This method should return an object containing data that will be
      * available to all Inertia pages as props.
      *
+     * @param ctx - The HTTP context object
+     * @returns Props to share across all pages
+     *
      * @example
-     * ```ts
+     * ```js
      * async share() {
      *   return {
      *     user: ctx.auth?.user,

package/build/src/inertia_middleware.js

@@ -1,6 +1,6 @@
 import {
   InertiaManager
-} from "../chunk-XFUDVODO.js";
+} from "../chunk-GLGCE7D6.js";
 import {
   InertiaHeaders
 } from "../chunk-DISC5OYC.js";

package/build/src/props.d.ts

@@ -139,9 +139,10 @@ export declare function deepMerge<T extends UnPackedPageProps | DeferProp<UnPack
  * This function is useful for runtime type checking and conditional prop handling.
  *
  * @param propValue - The object to check for deferred prop characteristics
+ * @returns True if the prop value is a deferred prop
  *
  * @example
- * ```javascript
+ * ```js
  * const prop = defer(() => ({ data: 'value' }))
  *
  * if (isDeferredProp(prop)) {
@@ -158,9 +159,10 @@ export declare function isDeferredProp<T extends UnPackedPageProps>(propValue: O
  * existing props rather than replaced during updates.
  *
  * @param propValue - The object to check for mergeable prop characteristics
+ * @returns True if the prop value is a mergeable prop
  *
  * @example
- * ```javascript
+ * ```js
  * const prop = merge({ items: [1, 2, 3] })
  *
  * if (isMergeableProp(prop)) {
@@ -177,9 +179,10 @@ export declare function isMergeableProp<T extends UnPackedPageProps | DeferProp<
  * responses, regardless of cherry-picking or selective prop requests.
  *
  * @param propValue - The object to check for always prop characteristics
+ * @returns True if the prop value is an always prop
  *
  * @example
- * ```javascript
+ * ```js
  * const prop = always({ userId: 123, permissions: ['read', 'write'] })
  *
  * if (isAlwaysProp(prop)) {
@@ -196,9 +199,10 @@ export declare function isAlwaysProp<T extends UnPackedPageProps>(propValue: Obj
  * when explicitly requested by the client, never in standard visits.
  *
  * @param propValue - The object to check for optional prop characteristics
+ * @returns True if the prop value is an optional prop
  *
  * @example
- * ```javascript
+ * ```js
  * const prop = optional(() => ({ detailedData: 'expensive computation' }))
  *
  * if (isOptionalProp(prop)) {
@@ -219,7 +223,8 @@ export declare function isOptionalProp<T extends UnPackedPageProps>(propValue: O
  * - Regular props: Included normally
  *
  * @param pageProps - The page props to process
- * @returns Object containing processed props, deferred props list, and merge props list
+ * @param containerResolver - Container resolver for dependency injection
+ * @returns Promise resolving to object containing processed props, deferred props list, and merge props list
  *
  * @example
  * ```js
@@ -251,7 +256,8 @@ export declare function buildStandardVisitProps(pageProps: PageProps, containerR
  *
  * @param pageProps - The page props to process
  * @param cherryPickProps - Array of prop names to include
- * @returns Object containing processed props and merge props list
+ * @param containerResolver - Container resolver for dependency injection
+ * @returns Promise resolving to object containing processed props and merge props list
  *
  * @example
  * ```js

package/build/src/server_renderer.d.ts

@@ -36,7 +36,7 @@ export declare class ServerRenderer {
      * @returns Promise resolving to an object with rendered head and body HTML
      *
      * @example
-     * ```typescript
+     * ```js
      * const pageObject = {
      *   component: 'Home',
      *   props: { user: { name: 'John' } },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/inertia",
   "description": "Official Inertia.js adapter for AdonisJS",
-  "version": "4.0.0-next.5",
+  "version": "4.0.0-next.6",
   "engines": {
     "node": ">=24.0.0"
   },