@adonisjs/inertia 1.0.0-2 → 1.0.0-20

package/build/providers/inertia_provider.js

@@ -1,9 +1,10 @@
 import {
   InertiaMiddleware
-} from "../chunk-GDULL3NT.js";
+} from "../chunk-PJEYAPJB.js";
 
 // providers/inertia_provider.ts
 import { configProvider } from "@adonisjs/core";
+import { BriskRoute } from "@adonisjs/core/http";
 import { RuntimeException } from "@poppinss/utils";
 var InertiaProvider = class {
   constructor(app) {
@@ -13,26 +14,38 @@ var InertiaProvider = class {
    * Registers edge plugin when edge is installed
    */
   async registerEdgePlugin() {
-    try {
-      const edgeExports = await import("edge.js");
-      const { edgePluginInertia } = await import("../src/plugins/edge.js");
-      edgeExports.default.use(edgePluginInertia());
-    } catch {
-    }
+    if (!this.app.usingEdgeJS)
+      return;
+    const edgeExports = await import("edge.js");
+    const { edgePluginInertia } = await import("../src/plugins/edge/plugin.js");
+    edgeExports.default.use(edgePluginInertia());
   }
   /**
-   * Register Inertia bindings
+   * Register inertia middleware
    */
   async register() {
-    const inertiaConfigProvider = this.app.config.get("inertia");
-    const config = await configProvider.resolve(this.app, inertiaConfigProvider);
-    if (!config) {
-      throw new RuntimeException(
-        'Invalid "config/inertia.ts" file. Make sure you are using the "defineConfig" method'
-      );
-    }
-    this.app.container.singleton(InertiaMiddleware, () => new InertiaMiddleware(config));
+    this.app.container.singleton(InertiaMiddleware, async () => {
+      const inertiaConfigProvider = this.app.config.get("inertia");
+      const config = await configProvider.resolve(this.app, inertiaConfigProvider);
+      const vite = await this.app.container.make("vite");
+      if (!config) {
+        throw new RuntimeException(
+          'Invalid "config/inertia.ts" file. Make sure you are using the "defineConfig" method'
+        );
+      }
+      return new InertiaMiddleware(config, vite);
+    });
+  }
+  /**
+   * Register edge plugin and brisk route macro
+   */
+  async boot() {
     await this.registerEdgePlugin();
+    BriskRoute.macro("renderInertia", function(template, props, viewProps) {
+      return this.setHandler(({ inertia }) => {
+        return inertia.render(template, props, viewProps);
+      });
+    });
   }
 };
 export {

package/build/react/app.tsx.stub

@@ -0,0 +1,35 @@
+{{{
+  exports({ to: app.makePath('inertia/app/app.tsx') })
+}}}
+import '../css/app.css';
+
+{{#if ssr}}
+import { hydrateRoot } from 'react-dom/client'
+{{#else}}
+import { createRoot } from 'react-dom/client';
+{{/if}}
+import { createInertiaApp } from '@inertiajs/react';
+import { resolvePageComponent } from '@adonisjs/inertia/helpers'
+
+const appName = import.meta.env.VITE_APP_NAME || 'AdonisJS'
+
+createInertiaApp({
+  progress: { color: '#5468FF' },
+
+  title: (title) => {{ '`${title} - ${appName}`' }},
+
+  resolve: (name) => {
+    return resolvePageComponent(
+      {{ '`../pages/${name}.tsx`' }},
+      import.meta.glob('../pages/**/*.tsx'),
+    )
+  },
+
+  setup({ el, App, props }) {
+    {{#if ssr}}
+    hydrateRoot(el, <App {...props} />)
+    {{#else}}
+    createRoot(el).render(<App {...props} />);
+    {{/if}}
+  },
+});

package/build/react/errors/not_found.tsx.stub

@@ -0,0 +1,14 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/errors/not_found.tsx') })
+}}}
+export default function NotFound() {
+  return (
+    <>
+      <div className="container">
+        <div className="title">Page not found</div>
+
+        <span>This page does not exist.</span>
+      </div>
+    </>
+  )
+}

package/build/react/errors/server_error.tsx.stub

@@ -0,0 +1,14 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/errors/server_error.tsx') })
+}}}
+export default function ServerError(props: { error: any }) {
+  return (
+    <>
+      <div className="container">
+        <div className="title">Server Error</div>
+
+        <span>{props.error.message}</span>
+      </div>
+    </>
+  )
+}

package/build/react/home.tsx.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/home.tsx') })
+}}}
+import { Head } from '@inertiajs/react'
+
+export default function Home(props: { version: number }) {
+  return (
+    <>
+      <Head title="Homepage" />
+
+      <div className="container">
+        <div className="title">AdonisJS {props.version} x Inertia x React</div>
+
+        <span>
+          Learn more about AdonisJS and Inertia.js by visiting the{' '}
+          <a href="https://docs.adonisjs.com/guides/inertia">AdonisJS documentation</a>.
+        </span>
+      </div>
+    </>
+  )
+}

package/build/react/root.edge.stub

@@ -0,0 +1,22 @@
+{{{
+  exports({ to: app.makePath('resources/views/inertia_layout.edge') })
+}}}
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title inertia>AdonisJS x Inertia x React</title>
+
+  @viteReactRefresh()
+  @inertiaHead()
+  {{ "@vite(['inertia/app/app.tsx', `inertia/pages/${page.component}.tsx`])" }}
+</head>
+
+<body>
+  @inertia()
+</body>
+
+</html>

package/build/react/ssr.tsx.stub

@@ -0,0 +1,17 @@
+{{{
+  exports({ to: app.makePath('inertia/app/ssr.tsx') })
+}}}
+import ReactDOMServer from 'react-dom/server'
+import { createInertiaApp } from '@inertiajs/react'
+
+export default function render(page: any) {
+  return createInertiaApp({
+    page,
+    render: ReactDOMServer.renderToString,
+    resolve: (name) => {
+      const pages = import.meta.glob('../pages/**/*.tsx', { eager: true })
+      {{ 'return pages[`../pages/${name}.tsx`]' }}
+    },
+    setup: ({ App, props }) => <App {...props} />,
+  })
+}

package/build/react/tsconfig.json.stub

@@ -0,0 +1,15 @@
+{{{
+  exports({ to: app.makePath('inertia/tsconfig.json') })
+}}}
+{
+  "extends": "@adonisjs/tsconfig/tsconfig.client.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ESNext",
+    "jsx": "react-jsx",
+    "paths": {
+      "~/*": ["./*"],
+    },
+  },
+  "include": ["./**/*.ts", "./**/*.tsx"],
+}

package/build/solid/app.tsx.stub

@@ -0,0 +1,35 @@
+{{{
+  exports({ to: app.makePath('inertia/app/app.tsx') })
+}}}
+import '../css/app.css'
+
+{{#if ssr}}
+import { hydrate } from 'solid-js/web';
+{{#else}}
+import { render } from 'solid-js/web'
+{{/if}}
+import { createInertiaApp } from 'inertia-adapter-solid'
+import { resolvePageComponent } from '@adonisjs/inertia/helpers'
+
+const appName = import.meta.env.VITE_APP_NAME || 'AdonisJS'
+
+createInertiaApp({
+  progress: { color: '#5468FF' },
+
+  title: (title) => {{ '`${title} - ${appName}`' }},
+
+  resolve: (name) => {
+    return resolvePageComponent(
+      {{ '`../pages/${name}.tsx`' }},
+      import.meta.glob('../pages/**/*.tsx'),
+    )
+  },
+
+  setup({ el, App, props }) {
+    {{#if ssr}}
+    hydrate(() => <App {...props} />, el)
+    {{#else}}
+    render(() => <App {...props} />, el)
+    {{/if}}
+  },
+})

package/build/solid/errors/not_found.tsx.stub

@@ -0,0 +1,14 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/errors/not_found.tsx') })
+}}}
+export default function NotFound() {
+  return (
+    <>
+      <div class="container">
+        <div class="title">Page not found</div>
+
+        <span>This page does not exist.</span>
+      </div>
+    </>
+  )
+}

package/build/solid/errors/server_error.tsx.stub

@@ -0,0 +1,14 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/errors/server_error.tsx') })
+}}}
+export default function ServerError(props: { error: any }) {
+  return (
+    <>
+      <div class="container">
+        <div class="title">Server Error</div>
+
+        <span>{props.error.message}</span>
+      </div>
+    </>
+  )
+}

package/build/solid/home.tsx.stub

@@ -0,0 +1,18 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/home.tsx') })
+}}}
+
+export default function Home(props: { version: number }) {
+  return (
+    <>
+      <div class="container">
+        <div class="title">AdonisJS {props.version} x Inertia x Solid.js</div>
+
+        <span>
+          Learn more about AdonisJS and Inertia.js by visiting the{' '}
+          <a href="https://docs.adonisjs.com/guides/inertia">AdonisJS documentation</a>.
+        </span>
+      </div>
+    </>
+  )
+}

package/build/solid/root.edge.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.makePath('resources/views/inertia_layout.edge') })
+}}}
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title inertia>AdonisJS x Inertia x SolidJS</title>
+
+  @inertiaHead()
+  {{ "@vite(['inertia/app/app.tsx', `inertia/pages/${page.component}.tsx`])" }}
+</head>
+
+<body>
+  @inertia()
+</body>
+
+</html>

package/build/solid/ssr.tsx.stub

@@ -0,0 +1,19 @@
+{{{
+  exports({ to: app.makePath('inertia/app/ssr.tsx') })
+}}}
+
+import { hydrate } from 'solid-js/web'
+import { createInertiaApp } from 'inertia-adapter-solid'
+
+export default function render(page: any) {
+  return createInertiaApp({
+    page,
+    resolve: (name) => {
+      const pages = import.meta.glob('../pages/**/*.tsx', { eager: true })
+      {{ 'return pages[`../pages/${name}.tsx`]' }}
+    },
+    setup({ el, App, props }) {
+      hydrate(() => <App {...props} />, el)
+    },
+  })
+}

package/build/solid/tsconfig.json.stub

@@ -0,0 +1,16 @@
+{{{
+  exports({ to: app.makePath('inertia/tsconfig.json') })
+}}}
+{
+  "extends": "@adonisjs/tsconfig/tsconfig.client.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "jsx": "preserve",
+    "module": "ESNext",
+    "jsxImportSource": "solid-js",
+    "paths": {
+      "~/*": ["./*"],
+    },
+  },
+  "include": ["./**/*.ts", "./**/*.tsx"],
+}

package/build/src/helpers.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Utility function to resolve a page component
+ *
+ * @example
+ *    return resolvePageComponent(
+ *      `./pages/${name}.vue`,
+ *       import.meta.glob<DefineComponent>("./pages/**\/*.vue")
+ *    )
+ */
+declare function resolvePageComponent<T>(path: string | string[], pages: Record<string, Promise<T> | (() => Promise<T>)>): Promise<T>;
+
+export { resolvePageComponent };

package/build/src/helpers.js

@@ -0,0 +1,14 @@
+// src/helpers.ts
+async function resolvePageComponent(path, pages) {
+  for (const p of Array.isArray(path) ? path : [path]) {
+    const page = pages[p];
+    if (typeof page === "undefined") {
+      continue;
+    }
+    return typeof page === "function" ? page() : page;
+  }
+  throw new Error(`Page not found: ${path}`);
+}
+export {
+  resolvePageComponent
+};

package/build/src/inertia_middleware.d.ts

@@ -1,6 +1,7 @@
+import { Vite } from '@adonisjs/vite';
 import { HttpContext } from '@adonisjs/core/http';
 import { NextFn } from '@adonisjs/core/types/http';
-import { ResolvedConfig, PageProps, MaybePromise } from './types.js';
+import { ResolvedConfig, Data, PageProps, PageObject, MaybePromise } from './types.js';
 
 /**
  * Symbol used to identify lazy props
@@ -13,16 +14,17 @@ declare class Inertia {
     #private;
     protected ctx: HttpContext;
     protected config: ResolvedConfig;
-    constructor(ctx: HttpContext, config: ResolvedConfig);
+    protected vite?: Vite | undefined;
+    constructor(ctx: HttpContext, config: ResolvedConfig, vite?: Vite | undefined);
+    /**
+     * Share data for the current request.
+     * This data will override any shared data defined in the config.
+     */
+    share(data: Record<string, Data>): void;
     /**
      * Render a page using Inertia
      */
-    render<TPageProps extends Record<string, any> = PageProps, TViewProps extends Record<string, any> = PageProps>(component: string, pageProps?: TPageProps, viewProps?: TViewProps): Promise<string | {
-        component: string;
-        version: string | number;
-        props: any;
-        url: string;
-    }>;
+    render<TPageProps extends Record<string, any> = PageProps, TViewProps extends Record<string, any> = PageProps>(component: string, pageProps?: TPageProps, viewProps?: TViewProps): Promise<string | PageObject<TPageProps>>;
     /**
      * Create a lazy prop
      *
@@ -57,7 +59,8 @@ declare module '@adonisjs/core/http' {
  */
 declare class InertiaMiddleware {
     protected config: ResolvedConfig;
-    constructor(config: ResolvedConfig);
+    protected vite?: Vite | undefined;
+    constructor(config: ResolvedConfig, vite?: Vite | undefined);
     handle(ctx: HttpContext, next: NextFn): Promise<void>;
 }
 

package/build/src/inertia_middleware.js

@@ -1,6 +1,6 @@
 import {
   InertiaMiddleware
-} from "../chunk-GDULL3NT.js";
+} from "../chunk-PJEYAPJB.js";
 export {
   InertiaMiddleware as default
 };

package/build/src/plugins/edge/plugin.js

@@ -0,0 +1,85 @@
+// src/plugins/edge/plugin.ts
+import { encode } from "html-entities";
+
+// src/debug.ts
+import { debuglog } from "node:util";
+var debug_default = debuglog("adonisjs:inertia");
+
+// src/plugins/edge/tags.ts
+import { EdgeError } from "edge-error";
+
+// src/plugins/edge/utils.ts
+function isSubsetOf(expression, expressions, errorCallback) {
+  if (!expressions.includes(expression.type)) {
+    errorCallback();
+  }
+}
+
+// src/plugins/edge/tags.ts
+var inertiaTag = {
+  block: false,
+  tagName: "inertia",
+  seekable: true,
+  compile(parser, buffer, { filename, loc, properties }) {
+    if (properties.jsArg.trim() === "") {
+      buffer.writeExpression(`out += state.inertia(state.page)`, filename, loc.start.line);
+      return;
+    }
+    properties.jsArg = `(${properties.jsArg})`;
+    const parsed = parser.utils.transformAst(
+      parser.utils.generateAST(properties.jsArg, loc, filename),
+      filename,
+      parser
+    );
+    isSubsetOf(parsed, ["ObjectExpression"], () => {
+      const { line, col } = parser.utils.getExpressionLoc(parsed);
+      throw new EdgeError(
+        `"${properties.jsArg}" is not a valid argument for @inertia`,
+        "E_UNALLOWED_EXPRESSION",
+        { line, col, filename }
+      );
+    });
+    const attributes = parser.utils.stringify(parsed);
+    buffer.writeExpression(
+      `out += state.inertia(state.page, ${attributes})`,
+      filename,
+      loc.start.line
+    );
+  }
+};
+var inertiaHeadTag = {
+  block: false,
+  tagName: "inertiaHead",
+  seekable: false,
+  compile(_, buffer, { filename, loc }) {
+    buffer.writeExpression(`out += state.inertiaHead(state.page)`, filename, loc.start.line);
+  }
+};
+
+// src/plugins/edge/plugin.ts
+var edgePluginInertia = () => {
+  return (edge) => {
+    debug_default("sharing globals and inertia tags with edge");
+    edge.global(
+      "inertia",
+      (page = {}, attributes = {}) => {
+        if (page.ssrBody)
+          return page.ssrBody;
+        const className = attributes?.class ? ` class="${attributes.class}"` : "";
+        const id = attributes?.id ? ` id="${attributes.id}"` : ' id="app"';
+        const tag = attributes?.as || "div";
+        const dataPage = encode(JSON.stringify(page));
+        return `<${tag}${id}${className} data-page="${dataPage}"></${tag}>`;
+      }
+    );
+    edge.global("inertiaHead", (page) => {
+      const { ssrHead = [] } = page || {};
+      return ssrHead.join("\n");
+    });
+    edge.registerTag(inertiaHeadTag);
+    edge.registerTag(inertiaTag);
+  };
+};
+export {
+  edgePluginInertia
+};

package/build/src/plugins/{api_client.d.ts → japa/api_client.d.ts}

@@ -1,6 +1,6 @@
 import { PluginFn } from '@japa/runner/types';
-import { PageProps } from '../types.js';
 import { ApplicationService } from '@adonisjs/core/types';
+import { PageProps } from '../../types.js';
 import '@adonisjs/core/http';
 
 declare module '@japa/api-client' {

package/build/src/plugins/{api_client.js → japa/api_client.js}

@@ -1,4 +1,4 @@
-// src/plugins/api_client.ts
+// src/plugins/japa/api_client.ts
 import { configProvider } from "@adonisjs/core";
 import { RuntimeException } from "@poppinss/utils";
 import { ApiRequest, ApiResponse } from "@japa/api-client";

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

@@ -0,0 +1,26 @@
+import { PluginOption } from 'vite';
+
+type InertiaPluginOptions = {
+    ssr?: {
+        /**
+         * Whether or not to enable server-side rendering
+         */
+        enabled: true;
+        /**
+         * The entrypoint for the server-side rendering
+         */
+        entrypoint: string;
+        /**
+         * The output directory for the server-side rendering bundle
+         */
+        output?: string;
+    } | {
+        enabled: false;
+    };
+};
+/**
+ * Inertia plugin for Vite that is tailored for AdonisJS
+ */
+declare function inertia(options?: InertiaPluginOptions): PluginOption;
+
+export { type InertiaPluginOptions, inertia as default };

package/build/src/plugins/vite.js

@@ -0,0 +1,36 @@
+// src/plugins/vite.ts
+function inertia(options) {
+  return {
+    name: "vite-plugin-inertia",
+    config: (_, { command }) => {
+      if (!options?.ssr?.enabled)
+        return {};
+      if (command === "build") {
+        process.env.NODE_ENV = "production";
+      }
+      return {
+        buildSteps: [
+          {
+            name: "build-client",
+            description: "build inertia client bundle",
+            config: { build: { outDir: "build/public/assets/" } }
+          },
+          {
+            name: "build-ssr",
+            description: "build inertia server bundle",
+            config: {
+              build: {
+                ssr: true,
+                outDir: options.ssr.output || "build/ssr",
+                rollupOptions: { input: options.ssr.entrypoint }
+              }
+            }
+          }
+        ]
+      };
+    }
+  };
+}
+export {
+  inertia as default
+};

package/build/src/types.d.ts

@@ -44,9 +44,13 @@ type AssetsVersion = string | number | undefined;
 interface InertiaConfig {
     /**
      * Path to the Edge view that will be used as the root view for Inertia responses.
-     * @default root (resources/views/root.edge)
+     * @default root (resources/views/inertia_layout.edge)
      */
     rootView?: string;
+    /**
+     * Path to your client-side entrypoint file.
+     */
+    entrypoint?: string;
     /**
      * The version of your assets. Every client request will be checked against this version.
      * If the version is not the same, the client will do a full reload.
@@ -56,6 +60,27 @@ interface InertiaConfig {
      * Data that should be shared with all rendered pages
      */
     sharedData?: SharedData;
+    /**
+     * Options to configure SSR
+     */
+    ssr?: {
+        /**
+         * Enable or disable SSR
+         */
+        enabled: boolean;
+        /**
+         * List of components that should be rendered on the server
+         */
+        pages?: string[] | ((ctx: HttpContext, page: string) => MaybePromise<boolean>);
+        /**
+         * Path to the SSR entrypoint file
+         */
+        entrypoint?: string;
+        /**
+         * Path to the SSR bundled file that will be used in production
+         */
+        bundle?: string;
+    };
 }
 /**
  * Resolved inertia configuration
@@ -64,6 +89,21 @@ interface ResolvedConfig {
     rootView: string;
     versionCache: VersionCache;
     sharedData: SharedData;
+    entrypoint: string;
+    ssr: {
+        enabled: boolean;
+        entrypoint: string;
+        pages?: string[] | ((ctx: HttpContext, page: string) => MaybePromise<boolean>);
+        bundle: string;
+    };
+}
+interface PageObject<TPageProps extends PageProps = PageProps> {
+    component: string;
+    version: string | number;
+    props: TPageProps;
+    url: string;
+    ssrHead?: string;
+    ssrBody?: string;
 }
 
-export type { AssetsVersion, Data, InertiaConfig, MaybePromise, PageProps, ResolvedConfig, SharedData, SharedDatumFactory };
+export type { AssetsVersion, Data, InertiaConfig, MaybePromise, PageObject, PageProps, ResolvedConfig, SharedData, SharedDatumFactory };