@adonisjs/inertia 1.0.0-0 → 1.0.0-10

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-CXICUKHN.js

@@ -0,0 +1,165 @@
+// src/inertia.ts
+var kLazySymbol = Symbol("lazy");
+var Inertia = class {
+  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
+   */
+  #isLazyProps(value) {
+    return typeof value === "object" && value && kLazySymbol in value;
+  }
+  /**
+   * Pick props to resolve based on x-inertia-partial-data header
+   *
+   * If header is not present, resolve all props except lazy props
+   * If header is present, resolve only the props that are listed in the header
+   */
+  #pickPropsToResolve(component, props) {
+    const partialData = this.ctx.request.header("x-inertia-partial-data")?.split(",").filter(Boolean);
+    const partialComponent = this.ctx.request.header("x-inertia-partial-component");
+    let entriesToResolve = Object.entries(props);
+    if (partialData && partialComponent === component) {
+      entriesToResolve = entriesToResolve.filter(([key]) => partialData.includes(key));
+    } else {
+      entriesToResolve = entriesToResolve.filter(([key]) => !this.#isLazyProps(props[key]));
+    }
+    return entriesToResolve;
+  }
+  /**
+   * Resolve the props that will be sent to the client
+   */
+  async #resolvePageProps(component, props) {
+    const entriesToResolve = this.#pickPropsToResolve(component, props);
+    const entries = entriesToResolve.map(async ([key, value]) => {
+      if (typeof value === "function") {
+        return [key, await value(this.ctx)];
+      }
+      if (this.#isLazyProps(value)) {
+        const lazyValue = value[kLazySymbol];
+        return [key, await lazyValue()];
+      }
+      return [key, value];
+    });
+    return Object.fromEntries(await Promise.all(entries));
+  }
+  /**
+   * Build the page object that will be returned to the client
+   *
+   * See https://inertiajs.com/the-protocol#the-page-object
+   */
+  async #buildPageObject(component, pageProps) {
+    return {
+      component,
+      version: this.config.versionCache.getVersion(),
+      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, viewProps) {
+    const pageObject = await this.#buildPageObject(component, pageProps);
+    const isInertiaRequest = !!this.ctx.request.header("x-inertia");
+    if (!isInertiaRequest) {
+      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;
+  }
+  /**
+   * Create a lazy prop
+   *
+   * Lazy props are never resolved on first visit, but only when the client
+   * request a partial reload explicitely with this value.
+   *
+   * See https://inertiajs.com/partial-reloads#lazy-data-evaluation
+   */
+  lazy(callback) {
+    return { [kLazySymbol]: callback };
+  }
+  /**
+   * This method can be used to redirect the user to an external website
+   * or even a non-inertia route of your application.
+   *
+   * See https://inertiajs.com/redirects#external-redirects
+   */
+  async location(url) {
+    this.ctx.response.header("X-Inertia-Location", url);
+    this.ctx.response.status(409);
+  }
+};
+
+// src/inertia_middleware.ts
+var InertiaMiddleware = class {
+  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, this.#runtime);
+    await next();
+    const isInertiaRequest = !!request.header("x-inertia");
+    if (!isInertiaRequest)
+      return;
+    response.header("Vary", "Accept");
+    const method = request.method();
+    if (response.getStatus() === 302 && ["PUT", "PATCH", "DELETE"].includes(method)) {
+      response.status(303);
+    }
+    const version = this.config.versionCache.getVersion().toString();
+    if (method === "GET" && request.header("x-inertia-version", "") !== version) {
+      response.header("x-inertia-location", request.url());
+      response.status(409);
+    }
+  }
+};
+
+export {
+  InertiaMiddleware
+};

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

@@ -1,3 +1,18 @@
-export { configure } from './configure.js';
-export { stubsRoot } from './stubs/main.js';
-export { defineConfig } from './src/define_config.js';
+import Configure from '@adonisjs/core/commands/configure';
+import { ConfigProvider } from '@adonisjs/core/types';
+import { InertiaConfig, ResolvedConfig } from './src/types.js';
+import '@adonisjs/core/http';
+
+/**
+ * Configures the package
+ */
+declare function configure(command: Configure): Promise<void>;
+
+/**
+ * Define the Inertia configuration
+ */
+declare function defineConfig(config: InertiaConfig): ConfigProvider<ResolvedConfig>;
+
+declare const stubsRoot: string;
+
+export { configure, defineConfig, stubsRoot };

package/build/index.js

@@ -1,11 +1,231 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export { configure } from './configure.js';
-export { stubsRoot } from './stubs/main.js';
-export { defineConfig } from './src/define_config.js';
+// stubs/main.ts
+import { getDirname } from "@poppinss/utils";
+var stubsRoot = getDirname(import.meta.url);
+
+// configure.ts
+var ADAPTERS = ["Vue 3", "React", "Svelte", "Solid"];
+var ADAPTERS_INFO = {
+  "Vue 3": {
+    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": {
+    stubFolder: "react",
+    appExtension: "tsx",
+    componentsExtension: "tsx",
+    dependencies: [
+      { 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": {
+    stubFolder: "svelte",
+    appExtension: "ts",
+    componentsExtension: "svelte",
+    dependencies: [
+      { 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 ssr = await command.prompt.confirm("Do you want to use server-side rendering?", {
+    name: "ssr"
+  });
+  const adapterInfo = ADAPTERS_INFO[adapter];
+  const codemods = await command.createCodemods();
+  await codemods.updateRcFile((rcFile) => {
+    rcFile.addProvider("@adonisjs/inertia/inertia_provider");
+  });
+  await codemods.registerMiddleware("router", [
+    { path: "@adonisjs/inertia/inertia_middleware", position: "after" }
+  ]);
+  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);
+  }
+  const shouldInstallPackages = await command.prompt.confirm(
+    `Do you want to install dependencies ${pkgToInstall.map((pkg) => pkg.name).join(", ")}?`,
+    { name: "install" }
+  );
+  if (shouldInstallPackages) {
+    await codemods.installPackages(pkgToInstall);
+  } else {
+    await codemods.listPackagesToInstall(pkgToInstall);
+  }
+  const colors = command.colors;
+  command.ui.instructions().heading("Inertia was successfully configured !").add(`We have added a dummy ${colors.cyan("/inertia")} route in your project.`).add(`Try visiting it in your browser after starting your server to see Inertia in action`).add("Happy coding !").render();
+}
+
+// src/define_config.ts
+import { configProvider } from "@adonisjs/core";
+
+// src/version_cache.ts
+import { readFile } from "node:fs/promises";
+var VersionCache = class {
+  constructor(appRoot, assetsVersion) {
+    this.appRoot = appRoot;
+    this.assetsVersion = assetsVersion;
+    this.#cachedVersion = assetsVersion;
+  }
+  #cachedVersion;
+  /**
+   * Compute the hash of the manifest file and cache it
+   */
+  async #getManifestHash() {
+    try {
+      const crc32 = await import("crc-32");
+      const manifestPath = new URL("public/assets/manifest.json", this.appRoot);
+      const manifestFile = await readFile(manifestPath, "utf-8");
+      this.#cachedVersion = crc32.default.str(manifestFile);
+      return this.#cachedVersion;
+    } catch {
+      this.#cachedVersion = "1";
+      return this.#cachedVersion;
+    }
+  }
+  /**
+   * Pre-compute the version
+   */
+  async computeVersion() {
+    if (!this.assetsVersion)
+      await this.#getManifestHash();
+    return this;
+  }
+  /**
+   * Returns the current assets version
+   */
+  getVersion() {
+    if (!this.#cachedVersion)
+      throw new Error("Version has not been computed yet");
+    return this.#cachedVersion;
+  }
+  /**
+   * Set the assets version
+   */
+  async setVersion(version) {
+    this.#cachedVersion = version;
+  }
+};
+
+// src/define_config.ts
+function defineConfig(config) {
+  return configProvider.create(async (app) => {
+    const versionCache = new VersionCache(app.appRoot, config.assetsVersion);
+    await versionCache.computeVersion();
+    return {
+      rootView: config.rootView ?? "root",
+      sharedData: config.sharedData || {},
+      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")
+      }
+    };
+  });
+}
+export {
+  configure,
+  defineConfig,
+  stubsRoot
+};

package/build/providers/inertia_provider.d.ts

@@ -1,26 +1,26 @@
-import type { ApplicationService } from '@adonisjs/core/types';
-import { Inertia } from '../src/inertia.js';
-/**
- * HttpContext augmentations
- */
+import { ApplicationService } from '@adonisjs/core/types';
+
 declare module '@adonisjs/core/http' {
-    interface HttpContext {
-        inertia: Inertia;
+    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
  */
-export default class InertiaProvider {
+declare class InertiaProvider {
     protected app: ApplicationService;
     constructor(app: ApplicationService);
     /**
      * Registers edge plugin when edge is installed
      */
     protected registerEdgePlugin(): Promise<void>;
-    /**
-     * Register Inertia middleware, edge plugin, and add
-     * `inertia` property to the HttpContext
-     */
+    register(): Promise<void>;
     boot(): Promise<void>;
 }
+
+export { InertiaProvider as default };

package/build/providers/inertia_provider.js

@@ -1,46 +1,47 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { HttpContext } from '@adonisjs/core/http';
-import { Inertia } from '../src/inertia.js';
-import { VersionCache } from '../src/version_cache.js';
-import InertiaMiddleware from '../src/inertia_middleware.js';
-/**
- * Inertia provider
- */
-export default class InertiaProvider {
-    app;
-    constructor(app) {
-        this.app = app;
-    }
-    /**
-     * 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 { }
-    }
-    /**
-     * Register Inertia middleware, edge plugin, and add
-     * `inertia` property to the HttpContext
-     */
-    async boot() {
-        const appRoot = this.app.appRoot;
-        const config = this.app.config.get('inertia', { view: 'app' });
-        const versionCache = await new VersionCache(appRoot, config.assetsVersion).computeVersion();
-        this.app.container.singleton(InertiaMiddleware, () => new InertiaMiddleware(versionCache));
-        HttpContext.getter('inertia', function inertia() {
-            return new Inertia(this, config, versionCache.getVersion());
-        }, false);
-        await this.registerEdgePlugin();
-    }
-}
+import {
+  InertiaMiddleware
+} 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;
+  }
+  /**
+   * Registers edge plugin when edge is installed
+   */
+  async registerEdgePlugin() {
+    if (!this.app.usingEdgeJS)
+      return;
+    const edgeExports = await import("edge.js");
+    const { edgePluginInertia } = await import("../src/plugins/edge/plugin.js");
+    edgeExports.default.use(edgePluginInertia());
+  }
+  async register() {
+    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 {
+  InertiaProvider as default
+};

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>
+    </>
+  )
+}