@adonisjs/inertia 1.0.0-1 → 1.0.0-11

package/build/app.css.stub

@@ -0,0 +1,39 @@
+{{{
+  exports({ to: app.makePath('resources/css/app.css') })
+}}}
+@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@400;500&display=swap');
+
+* {
+  margin: 0;
+  padding: 0;
+}
+
+html,
+body,
+#app {
+  background-color: #F7F8FA;
+  font-family: 'Poppins', sans-serif;
+  color: #46444c;
+  height: 100%;
+  width: 100%;
+}
+
+.title {
+  font-size: 42px;
+  font-weight: 500;
+  color: #5a45ff;
+}
+
+.container {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  flex-direction: column;
+  height: 100%;
+  width: 100%;
+}
+
+a {
+  text-decoration: underline;
+  color: #5a45ff;
+}

package/build/{chunk-TO74VVAR.js → chunk-CXICUKHN.js}

@@ -1,10 +1,13 @@
 // src/inertia.ts
 var kLazySymbol = Symbol("lazy");
 var Inertia = class {
-  constructor(ctx, config) {
+  constructor(ctx, config, viteRuntime) {
     this.ctx = ctx;
     this.config = config;
+    this.viteRuntime = viteRuntime;
+    this.#sharedData = config.sharedData;
   }
+  #sharedData = {};
   /**
    * Check if a value is a lazy prop
    */
@@ -54,19 +57,57 @@ var Inertia = class {
     return {
       component,
       version: this.config.versionCache.getVersion(),
-      props: await this.#resolvePageProps(component, { ...this.config.sharedData, ...pageProps }),
+      props: await this.#resolvePageProps(component, { ...this.#sharedData, ...pageProps }),
       url: this.ctx.request.url(true)
     };
   }
+  /**
+   * If the page should be rendered on the server
+   */
+  #shouldRenderOnServer(component) {
+    const isSsrEnabled = this.config.ssr.enabled;
+    const isSsrEnabledForPage = this.config.ssr.pages ? this.config.ssr.pages.includes(component) : true;
+    return isSsrEnabled && isSsrEnabledForPage;
+  }
+  /**
+   * Render the page on the server
+   *
+   * On development, we use the Vite Runtime API
+   * On production, we just import and use the SSR bundle generated by Vite
+   */
+  async #renderOnServer(pageObject, viewProps) {
+    let render;
+    if (this.viteRuntime) {
+      render = await this.viteRuntime.executeEntrypoint(this.config.ssr.entrypoint);
+    } else {
+      render = await import(this.config.ssr.bundle);
+    }
+    const result = await render.default(pageObject);
+    return this.ctx.view.render(this.config.rootView, {
+      ...viewProps,
+      page: { ssrHead: result.head, ssrBody: result.body }
+    });
+  }
+  /**
+   * Share data for the current request.
+   * This data will override any shared data defined in the config.
+   */
+  share(data) {
+    this.#sharedData = { ...this.#sharedData, ...data };
+  }
   /**
    * Render a page using Inertia
    */
-  async render(component, pageProps) {
+  async render(component, pageProps, viewProps) {
     const pageObject = await this.#buildPageObject(component, pageProps);
     const isInertiaRequest = !!this.ctx.request.header("x-inertia");
     if (!isInertiaRequest) {
-      return this.ctx.view.render(this.config.rootView, { page: pageObject });
+      const shouldRenderOnServer = this.#shouldRenderOnServer(component);
+      if (shouldRenderOnServer)
+        return this.#renderOnServer(pageObject, viewProps);
+      return this.ctx.view.render(this.config.rootView, { ...viewProps, page: pageObject });
     }
+    this.ctx.response.header("x-inertia", "true");
     return pageObject;
   }
   /**
@@ -94,18 +135,19 @@ var Inertia = class {
 
 // src/inertia_middleware.ts
 var InertiaMiddleware = class {
-  constructor(config) {
+  constructor(config, vite) {
     this.config = config;
+    this.#runtime = vite?.getRuntime();
   }
+  #runtime;
   async handle(ctx, next) {
     const { response, request } = ctx;
-    ctx.inertia = new Inertia(ctx, this.config);
+    ctx.inertia = new Inertia(ctx, this.config, this.#runtime);
     await next();
     const isInertiaRequest = !!request.header("x-inertia");
     if (!isInertiaRequest)
       return;
     response.header("Vary", "Accept");
-    response.header("X-Inertia", "true");
     const method = request.method();
     if (response.getStatus() === 302 && ["PUT", "PATCH", "DELETE"].includes(method)) {
       response.status(303);

package/build/{stubs/config.stub → config.stub}

@@ -7,7 +7,7 @@ export default defineConfig({
   /**
    * Path to the Edge view that will be used as the root view for Inertia responses
    */
-  rootView: 'home',
+  rootView: 'root',
 
   /**
    * Data that should be shared with all rendered pages
@@ -15,4 +15,12 @@ export default defineConfig({
   sharedData: {
     errors: (ctx) => ctx.session.flashMessages.get('errors'),
   },
+
+  /**
+   * Options for the server-side rendering
+   */
+  ssr: {
+    enabled: {{ ssr }},
+    entrypoint: '{{ ssrEntrypoint }}'
+  }
 })

package/build/index.d.ts

@@ -8,11 +8,11 @@ import '@adonisjs/core/http';
  */
 declare function configure(command: Configure): Promise<void>;
 
-declare const stubsRoot: string;
-
 /**
  * Define the Inertia configuration
  */
 declare function defineConfig(config: InertiaConfig): ConfigProvider<ResolvedConfig>;
 
+declare const stubsRoot: string;
+
 export { configure, defineConfig, stubsRoot };

package/build/index.js

@@ -1,70 +1,179 @@
 // configure.ts
-var ADAPTERS = ["Vue 3", "React", "Svelte"];
+import string from "@poppinss/utils/string";
+
+// stubs/main.ts
+import { getDirname } from "@poppinss/utils";
+var stubsRoot = getDirname(import.meta.url);
+
+// configure.ts
+var ADAPTERS = ["vue", "react", "svelte", "solid"];
 var ADAPTERS_INFO = {
-  "Vue 3": {
+  vue: {
+    stubFolder: "vue",
+    appExtension: "ts",
+    componentsExtension: "vue",
     dependencies: [
       { name: "@inertiajs/vue3", isDevDependency: false },
       { name: "vue", isDevDependency: false },
       { name: "@vitejs/plugin-vue", isDevDependency: true }
-    ]
+    ],
+    ssrDependencies: [{ name: "@vue/server-renderer", isDevDependency: false }],
+    viteRegister: {
+      pluginCall: "vue()",
+      importDeclarations: [{ isNamed: false, module: "@vitejs/plugin-vue", identifier: "vue" }]
+    },
+    ssrEntrypoint: "resources/ssr.ts"
   },
-  "React": {
+  react: {
+    stubFolder: "react",
+    appExtension: "tsx",
+    componentsExtension: "tsx",
     dependencies: [
-      { name: "@inertiajs/inertia-react", isDevDependency: false },
+      { name: "@inertiajs/react", isDevDependency: false },
       { name: "react", isDevDependency: false },
       { name: "react-dom", isDevDependency: false },
       { name: "@vitejs/plugin-react", isDevDependency: true },
       { name: "@types/react", isDevDependency: true },
       { name: "@types/react-dom", isDevDependency: true }
-    ]
+    ],
+    viteRegister: {
+      pluginCall: "react()",
+      importDeclarations: [{ isNamed: false, module: "@vitejs/plugin-react", identifier: "react" }]
+    },
+    ssrEntrypoint: "resources/ssr.tsx"
   },
-  "Svelte": {
+  svelte: {
+    stubFolder: "svelte",
+    appExtension: "ts",
+    componentsExtension: "svelte",
     dependencies: [
-      { name: "@inertiajs/inertia-svelte", isDevDependency: false },
+      { name: "@inertiajs/svelte", isDevDependency: false },
       { name: "svelte", isDevDependency: false },
       { name: "@sveltejs/vite-plugin-svelte", isDevDependency: true }
-    ]
+    ],
+    viteRegister: {
+      pluginCall: "svelte()",
+      importDeclarations: [
+        { isNamed: false, module: "@sveltejs/vite-plugin-svelte", identifier: "svelte" }
+      ]
+    },
+    ssrEntrypoint: "resources/ssr.ts"
+  },
+  solid: {
+    stubFolder: "solid",
+    appExtension: "tsx",
+    componentsExtension: "tsx",
+    dependencies: [
+      { name: "solid-js", isDevDependency: false },
+      { name: "inertia-adapter-solid", isDevDependency: false },
+      { name: "vite-plugin-solid", isDevDependency: true },
+      { name: "@solidjs/meta", isDevDependency: false }
+    ],
+    viteRegister: {
+      pluginCall: "solid()",
+      ssrPluginCall: "solid({ ssr: true })",
+      importDeclarations: [{ isNamed: false, module: "vite-plugin-solid", identifier: "solid" }]
+    },
+    ssrEntrypoint: "resources/ssr.tsx"
   }
 };
+async function defineExampleRoute(command, codemods) {
+  const tsMorph = await codemods.getTsMorphProject();
+  const routesFile = tsMorph?.getSourceFile(command.app.makePath("./start/routes.ts"));
+  if (!routesFile) {
+    return command.logger.warning("Unable to find the routes file");
+  }
+  const isAlreadyDefined = routesFile.getText().includes("/inertia");
+  if (isAlreadyDefined) {
+    command.logger.warning("/inertia route is already defined. Skipping");
+    return;
+  }
+  const action = command.logger.action("update start/routes.ts file");
+  try {
+    routesFile?.addStatements((writer) => {
+      writer.writeLine(`router.on('/inertia').renderInertia('home', { version: 6 })`);
+    });
+    await tsMorph?.save();
+    action.succeeded();
+  } catch (error) {
+    codemods.emit("error", error);
+    action.failed(error.message);
+  }
+}
 async function configure(command) {
-  const adapter = await command.prompt.choice(
-    "Select the Inertia adapter you want to use",
-    ADAPTERS,
-    { name: "adapter" }
-  );
-  const pkgToInstall = ADAPTERS_INFO[adapter].dependencies;
-  const withSsr = await command.prompt.confirm("Do you want to enable server-side rendering?", {
-    name: "ssr"
-  });
-  if (withSsr) {
-    pkgToInstall.push(...ADAPTERS_INFO[adapter].ssrDependencies || []);
+  let adapter = command.parsedFlags.adapter;
+  let ssr = command.parsedFlags.ssr;
+  let shouldInstallPackages = command.parsedFlags.install;
+  if (adapter === void 0) {
+    adapter = await command.prompt.choice(
+      "Select the Inertia adapter you want to use",
+      ADAPTERS.map((adapterName) => string.capitalCase(adapterName)),
+      { name: "adapter", result: (value) => value.toLowerCase() }
+    );
+  }
+  if (ssr === void 0) {
+    ssr = await command.prompt.confirm("Do you want to use server-side rendering?", {
+      name: "ssr"
+    });
   }
+  if (adapter in ADAPTERS_INFO === false) {
+    command.logger.error(
+      `The selected adapter "${adapter}" is invalid. Select one from: ${string.sentence(
+        Object.keys(ADAPTERS_INFO)
+      )}`
+    );
+    command.exitCode = 1;
+    return;
+  }
+  const adapterInfo = ADAPTERS_INFO[adapter];
   const codemods = await command.createCodemods();
   await codemods.updateRcFile((rcFile) => {
     rcFile.addProvider("@adonisjs/inertia/inertia_provider");
   });
-  codemods.registerMiddleware("router", [
+  await codemods.registerMiddleware("router", [
     { path: "@adonisjs/inertia/inertia_middleware", position: "after" }
   ]);
-  await command.publishStub("config.stub");
-  const shouldInstallPackages = await command.prompt.confirm(
-    `Do you want to install dependencies ${pkgToInstall.map((pkg) => pkg.name).join(", ")}?`,
-    { name: "install" }
+  const appExt = adapterInfo.appExtension;
+  const stubFolder = adapterInfo.stubFolder;
+  const compExt = adapterInfo.componentsExtension;
+  await codemods.makeUsingStub(stubsRoot, "config.stub", {
+    ssr,
+    ssrEntrypoint: adapterInfo.ssrEntrypoint
+  });
+  await codemods.makeUsingStub(stubsRoot, `app.css.stub`, {});
+  await codemods.makeUsingStub(stubsRoot, `${stubFolder}/root.edge.stub`, {});
+  await codemods.makeUsingStub(stubsRoot, `${stubFolder}/tsconfig.json.stub`, {});
+  await codemods.makeUsingStub(stubsRoot, `${stubFolder}/app.${appExt}.stub`, {});
+  await codemods.makeUsingStub(stubsRoot, `${stubFolder}/home.${compExt}.stub`, {});
+  if (ssr) {
+    await codemods.makeUsingStub(stubsRoot, `${stubFolder}/ssr.${appExt}.stub`, {});
+  }
+  const inertiaPluginCall = ssr ? `inertia({ ssr: { enabled: true, entrypoint: 'resources/ssr.${appExt}' } })` : `inertia({ ssr: { enabled: false } })`;
+  await codemods.registerVitePlugin(inertiaPluginCall, [
+    { isNamed: false, module: "@adonisjs/inertia/client", identifier: "inertia" }
+  ]);
+  await codemods.registerVitePlugin(
+    ssr && adapterInfo.viteRegister.ssrPluginCall ? adapterInfo.viteRegister.ssrPluginCall : adapterInfo.viteRegister.pluginCall,
+    adapterInfo.viteRegister.importDeclarations
   );
+  await defineExampleRoute(command, codemods);
+  const pkgToInstall = adapterInfo.dependencies;
+  if (ssr && adapterInfo.ssrDependencies) {
+    pkgToInstall.push(...adapterInfo.ssrDependencies);
+  }
+  if (shouldInstallPackages === void 0) {
+    shouldInstallPackages = await command.prompt.confirm(
+      `Do you want to install dependencies ${pkgToInstall.map((pkg) => pkg.name).join(", ")}?`,
+      { name: "install" }
+    );
+  }
   if (shouldInstallPackages) {
-    command.installPackages(pkgToInstall);
+    await codemods.installPackages(pkgToInstall);
   } else {
-    command.listPackagesToInstall(pkgToInstall);
+    await codemods.listPackagesToInstall(pkgToInstall);
   }
-  command.logger.success(
-    "Inertia was configured successfully. Please note that you still need to update your vite config, setup your Edge root view and others things. Read the docs for more info."
-  );
 }
 
-// stubs/main.ts
-import { getDirname } from "@poppinss/utils";
-var stubsRoot = getDirname(import.meta.url);
-
 // src/define_config.ts
 import { configProvider } from "@adonisjs/core";
 
@@ -124,7 +233,13 @@ function defineConfig(config) {
     return {
       rootView: config.rootView ?? "root",
       sharedData: config.sharedData || {},
-      versionCache
+      versionCache,
+      ssr: {
+        enabled: config.ssr?.enabled ?? false,
+        pages: config.ssr?.pages,
+        entrypoint: config.ssr?.entrypoint ?? app.makePath("resources/ssr.ts"),
+        bundle: config.ssr?.bundle ?? app.makePath("ssr/ssr.js")
+      }
     };
   });
 }

package/build/providers/inertia_provider.d.ts

@@ -1,5 +1,14 @@
 import { ApplicationService } from '@adonisjs/core/types';
 
+declare module '@adonisjs/core/http' {
+    interface BriskRoute {
+        /**
+         * Render an inertia page without defining an
+         * explicit route handler
+         */
+        renderInertia(component: string, props?: Record<string, any>, viewProps?: Record<string, any>): void;
+    }
+}
 /**
  * Inertia provider
  */
@@ -10,10 +19,8 @@ declare class InertiaProvider {
      * Registers edge plugin when edge is installed
      */
     protected registerEdgePlugin(): Promise<void>;
-    /**
-     * Register Inertia bindings
-     */
     register(): Promise<void>;
+    boot(): Promise<void>;
 }
 
 export { InertiaProvider as default };

package/build/providers/inertia_provider.js

@@ -1,10 +1,11 @@
 import {
   InertiaMiddleware
-} from "../chunk-TO74VVAR.js";
+} from "../chunk-CXICUKHN.js";
 
 // providers/inertia_provider.ts
 import { configProvider } from "@adonisjs/core";
 import { RuntimeException } from "@poppinss/utils";
+import { BriskRoute } from "@adonisjs/core/http";
 var InertiaProvider = class {
   constructor(app) {
     this.app = app;
@@ -13,26 +14,32 @@ 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
-   */
   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);
+    });
+  }
+  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,25 @@
+{{{
+  exports({ to: app.makePath('resources/app.tsx') })
+}}}
+import './css/app.css';
+
+import { createRoot } from 'react-dom/client';
+import { createInertiaApp } from '@inertiajs/react';
+
+const appName = import.meta.env.VITE_APP_NAME || 'AdonisJS'
+
+createInertiaApp({
+  progress: { color: '#5468FF' },
+
+  title: (title) => {{ '`${title} - ${appName}`' }},
+
+  resolve: (name) => {
+    const pages = import.meta.glob('./pages/**/*.tsx', { eager: true })
+    {{ 'return pages[`./pages/${name}.tsx`]' }}
+  },
+
+  setup({ el, App, props }) {
+    const root = createRoot(el);
+    root.render(<App {...props} />);
+  },
+});

package/build/react/home.tsx.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.makePath('resources/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/inertia">AdonisJS documentation</a>.
+        </span>
+      </div>
+    </>
+  )
+}

package/build/react/root.edge.stub

@@ -0,0 +1,22 @@
+{{{
+  exports({ to: app.makePath('resources/views/root.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()
+  @vite(['resources/app.tsx'])
+  @inertiaHead()
+</head>
+
+<body>
+  @inertia()
+</body>
+
+</html>

package/build/react/ssr.tsx.stub

@@ -0,0 +1,17 @@
+{{{
+  exports({ to: app.makePath('resources/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,25 @@
+{{{
+  exports({ to: app.makePath('resources/tsconfig.json') })
+}}}
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "react-jsx",
+    "lib": ["DOM", "ESNext", "DOM.Iterable", "ES2020"],
+    "useDefineForClassFields": true,
+    "baseUrl": ".",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "paths": {
+      "@/*": ["./*"],
+      "~/*": ["../*"],
+    },
+    "resolveJsonModule": true,
+    "types": ["vite/client"],
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+    "skipLibCheck": true,
+  },
+  "include": ["./**/*.ts", "./**/*.tsx"],
+}

package/build/solid/app.tsx.stub

@@ -0,0 +1,24 @@
+{{{
+  exports({ to: app.makePath('resources/app.tsx') })
+}}}
+import './css/app.css'
+
+import { render } from 'solid-js/web'
+import { createInertiaApp } from 'inertia-adapter-solid'
+
+const appName = import.meta.env.VITE_APP_NAME || 'AdonisJS'
+
+createInertiaApp({
+  progress: { color: '#5468FF' },
+
+  title: (title) => {{ '`${title} - ${appName}`' }},
+
+  resolve(name) {
+    const pages = import.meta.glob('./pages/**/*.tsx', { eager: true })
+    {{ 'return pages[`./pages/${name}.tsx`]' }}
+  },
+
+  setup({ el, App, props }) {
+    render(() => <App {...props} />, el)
+  },
+})

package/build/solid/home.tsx.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.makePath('resources/pages/home.tsx') })
+}}}
+import { Title } from '@solidjs/meta'
+
+export default function Home(props: { version: number }) {
+  return (
+    <>
+      <Title>Homepage</Title>
+
+      <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/inertia">AdonisJS documentation</a>.
+        </span>
+      </div>
+    </>
+  )
+}

package/build/solid/root.edge.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.makePath('resources/views/root.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>
+
+  @vite(['resources/app.tsx'])
+  @inertiaHead()
+</head>
+
+<body>
+  @inertia()
+</body>
+
+</html>