@adonisjs/inertia 1.0.0-0 → 1.0.0-10

package/build/src/types.d.ts

@@ -1,20 +1,47 @@
-import type { HttpContext } from '@adonisjs/core/http';
-export type MaybePromise<T> = T | Promise<T>;
+import { HttpContext } from '@adonisjs/core/http';
+
+/**
+ * VersionCache is used to cache the version of the assets.
+ *
+ * If the user has provided a version, it will be used.
+ * Otherwise, we will compute a hash from the manifest file
+ * and cache it.
+ */
+declare class VersionCache {
+    #private;
+    protected appRoot: URL;
+    protected assetsVersion?: AssetsVersion;
+    constructor(appRoot: URL, assetsVersion?: AssetsVersion);
+    /**
+     * Pre-compute the version
+     */
+    computeVersion(): Promise<this>;
+    /**
+     * Returns the current assets version
+     */
+    getVersion(): string | number;
+    /**
+     * Set the assets version
+     */
+    setVersion(version: AssetsVersion): Promise<void>;
+}
+
+type MaybePromise<T> = T | Promise<T>;
 /**
  * Props that will be passed to inertia render method
  */
-export type PageProps = Record<string, unknown>;
+type PageProps = Record<string, unknown>;
 /**
  * Shared data types
  */
-export type Data = string | number | object | boolean;
-export type SharedDatumFactory = (ctx: HttpContext) => MaybePromise<Data>;
-export type SharedData = Record<string, Data | SharedDatumFactory>;
+type Data = string | number | object | boolean;
+type SharedDatumFactory = (ctx: HttpContext) => MaybePromise<Data>;
+type SharedData = Record<string, Data | SharedDatumFactory>;
 /**
  * Allowed values for the assets version
  */
-export type AssetsVersion = string | number | undefined;
-export interface InertiaConfig {
+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)
@@ -29,4 +56,41 @@ export 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[];
+        /**
+         * 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
+ */
+interface ResolvedConfig {
+    rootView: string;
+    versionCache: VersionCache;
+    sharedData: SharedData;
+    ssr: {
+        enabled: boolean;
+        entrypoint: string;
+        pages?: string[];
+        bundle: string;
+    };
 }
+
+export type { AssetsVersion, Data, InertiaConfig, MaybePromise, PageProps, ResolvedConfig, SharedData, SharedDatumFactory };

package/build/src/types.js

@@ -1,9 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export {};

package/build/vue/app.ts.stub

@@ -0,0 +1,27 @@
+{{{
+  exports({ to: app.makePath('resources/app.ts') })
+}}}
+import './css/app.css';
+
+import { createApp, h } from 'vue'
+import type { DefineComponent } from 'vue'
+import { createInertiaApp } from '@inertiajs/vue3'
+
+const appName = import.meta.env.VITE_APP_NAME || 'AdonisJS'
+
+createInertiaApp({
+  progress: { color: '#5468FF' },
+
+  title: (title) => {{ '`${title} - ${appName}`' }},
+
+  resolve: (name) => {
+    const pages = import.meta.glob<DefineComponent>('./pages/**/*.vue', { eager: true })
+    {{ 'return pages[`./pages/${name}.vue`]' }}
+  },
+
+  setup({ el, App, props, plugin }) {
+    createApp({ render: () => h(App, props) })
+      .use(plugin)
+      .mount(el)
+  },
+})

package/build/vue/home.vue.stub

@@ -0,0 +1,21 @@
+{{{
+  exports({ to: app.makePath('resources/pages/home.vue') })
+}}}
+<script setup lang="ts">
+import { Head } from '@inertiajs/vue3'
+
+defineProps<{ version: number }>()
+</script>
+
+<template>
+  <Head title="Homepage" />
+
+  <div className="container">
+    <div className="title">AdonisJS \{\{ version \}\} x Inertia x Vue.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>
+</template>

package/build/vue/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 VueJS</title>
+
+  @vite(['resources/app.ts'])
+  @inertiaHead()
+</head>
+
+<body>
+  @inertia()
+</body>
+
+</html>

package/build/vue/ssr.ts.stub

@@ -0,0 +1,22 @@
+{{{
+  exports({ to: app.makePath('resources/ssr.ts') })
+}}}
+
+import { createInertiaApp } from '@inertiajs/vue3'
+import { renderToString } from '@vue/server-renderer'
+import { createSSRApp, h, type DefineComponent } from 'vue'
+
+export default function render(page: any) {
+  return createInertiaApp({
+    page,
+    render: renderToString,
+    resolve: (name) => {
+      const pages = import.meta.glob<DefineComponent>('./pages/**/*.vue', { eager: true })
+      {{ 'return pages[`./pages/${name}.vue`]' }}
+    },
+
+    setup({ App, props, plugin }) {
+      return createSSRApp({ render: () => h(App, props) }).use(plugin)
+    },
+  })
+}

package/build/vue/tsconfig.json.stub

@@ -0,0 +1,26 @@
+{{{
+  exports({ to: app.makePath('resources/tsconfig.json') })
+}}}
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+    "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", "./**/*.vue"],
+}

package/package.json

@@ -1,22 +1,14 @@
 {
   "name": "@adonisjs/inertia",
   "description": "Official Inertia.js adapter for AdonisJS",
-  "version": "1.0.0-0",
+  "version": "1.0.0-10",
   "engines": {
     "node": ">=18.16.0"
   },
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "src",
-    "providers",
-    "build/src",
-    "build/providers",
-    "build/stubs",
-    "build/services",
-    "build/index.js",
-    "build/index.d.ts",
-    "build/configure.js"
+    "build"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -24,12 +16,14 @@
     "./services/main": "./build/services/inertia.js",
     "./inertia_middleware": "./build/src/inertia_middleware.js",
     "./inertia_provider": "./build/providers/inertia_provider.js",
-    "./plugins/edge": "./build/src/plugins/edge.js",
-    "./plugins/api_client": "./build/src/plugins/japa/api_client.js"
+    "./plugins/edge": "./build/src/plugins/edge/plugin.js",
+    "./plugins/api_client": "./build/src/plugins/japa/api_client.js",
+    "./client": "./build/src/plugins/vite.js",
+    "./helpers": "./build/src/helpers.js"
   },
   "scripts": {
     "clean": "del-cli build",
-    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "copy:templates": "copyfiles --up 1 \"stubs/**/*.stub\" build",
     "typecheck": "tsc --noEmit",
     "lint": "eslint . --ext=.ts",
     "format": "prettier --write .",
@@ -37,60 +31,65 @@
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
-    "build": "tsc",
+    "build": "tsup-node",
     "postbuild": "npm run copy:templates",
     "release": "np",
     "version": "npm run build",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "6.1.3-25",
-    "@adonisjs/core": "6.1.5-31",
-    "@adonisjs/eslint-config": "^1.1.8",
-    "@adonisjs/prettier-config": "^1.1.8",
-    "@adonisjs/session": "7.0.0-13",
-    "@adonisjs/tsconfig": "^1.1.8",
-    "@japa/api-client": "^2.0.1",
-    "@japa/assert": "2.0.1",
-    "@japa/file-system": "^2.0.1",
-    "@japa/plugin-adonisjs": "^2.0.1",
-    "@japa/runner": "3.0.5",
-    "@swc/core": "^1.3.96",
-    "@types/node": "^20.9.0",
-    "@types/qs": "^6.9.10",
-    "@types/supertest": "^2.0.16",
-    "c8": "^8.0.1",
+    "@adonisjs/assembler": "^7.2.3",
+    "@adonisjs/core": "6.3.1",
+    "@adonisjs/eslint-config": "^1.2.2",
+    "@adonisjs/prettier-config": "^1.2.2",
+    "@adonisjs/session": "7.1.1",
+    "@adonisjs/tsconfig": "^1.2.2",
+    "@adonisjs/vite": "^3.0.0-2",
+    "@japa/api-client": "^2.0.2",
+    "@japa/assert": "2.1.0",
+    "@japa/expect-type": "^2.0.1",
+    "@japa/file-system": "^2.2.0",
+    "@japa/plugin-adonisjs": "^3.0.0",
+    "@japa/runner": "3.1.1",
+    "@japa/snapshot": "^2.0.4",
+    "@swc/core": "^1.4.2",
+    "@types/node": "^20.11.24",
+    "@types/qs": "^6.9.12",
+    "@types/supertest": "^6.0.2",
+    "@vavite/multibuild": "^4.1.1",
+    "c8": "^9.1.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.1.0",
-    "edge.js": "^6.0.0",
-    "eslint": "^8.53.0",
+    "edge-parser": "^9.0.1",
+    "edge.js": "^6.0.1",
+    "eslint": "^8.57.0",
     "get-port": "^7.0.0",
-    "np": "^8.0.4",
-    "prettier": "^3.0.3",
-    "supertest": "^6.3.3",
-    "tinybench": "^2.5.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "np": "^10.0.0",
+    "prettier": "^3.2.5",
+    "supertest": "^6.3.4",
+    "tinybench": "^2.6.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.2",
+    "typescript": "~5.3.3",
+    "vite": "^5.1.4"
   },
   "dependencies": {
-    "@poppinss/utils": "^6.5.1",
+    "@poppinss/utils": "^6.7.2",
     "crc-32": "^1.2.2",
+    "edge-error": "^4.0.1",
     "html-entities": "^2.4.0",
     "qs": "^6.11.2"
   },
   "peerDependencies": {
-    "@adonisjs/assembler": "6.1.3-25",
-    "@adonisjs/core": "6.1.5-31",
-    "@adonisjs/session": "7.0.0-13",
-    "@japa/api-client": "^2.0.1",
+    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/session": "^7.0.0",
+    "@adonisjs/vite": "^3.0.0-2",
+    "@japa/api-client": "^2.0.0",
     "edge.js": "^6.0.0"
   },
   "peerDependenciesMeta": {
-    "@adonisjs/assembler": {
-      "optional": false
-    },
     "@japa/api-client": {
-      "optional": false
+      "optional": true
     }
   },
   "author": "Julien Ripouteau <julien@ripouteau.com>,adonisjs",
@@ -122,5 +121,23 @@
       "tests/**",
       "tests_helpers/**"
     ]
+  },
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/types.ts",
+      "./src/helpers.ts",
+      "./src/plugins/vite.ts",
+      "./services/inertia.ts",
+      "./src/inertia_middleware.ts",
+      "./providers/inertia_provider.ts",
+      "./src/plugins/edge/plugin.ts",
+      "./src/plugins/japa/api_client.ts"
+    ],
+    "outDir": "./build",
+    "clean": true,
+    "format": "esm",
+    "dts": true,
+    "target": "esnext"
   }
 }

package/build/configure.js

@@ -1,82 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-const ADAPTERS = ['Vue 3', 'React', 'Svelte'];
-const ADAPTERS_INFO = {
-    'Vue 3': {
-        dependencies: [
-            { name: '@inertiajs/vue3', isDevDependency: false },
-            { name: 'vue', isDevDependency: false },
-            { name: '@vitejs/plugin-vue', isDevDependency: true },
-        ],
-    },
-    'React': {
-        dependencies: [
-            { name: '@inertiajs/inertia-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 },
-        ],
-    },
-    'Svelte': {
-        dependencies: [
-            { name: '@inertiajs/inertia-svelte', isDevDependency: false },
-            { name: 'svelte', isDevDependency: false },
-            { name: '@sveltejs/vite-plugin-svelte', isDevDependency: true },
-        ],
-    },
-};
-/**
- * Configures the package
- */
-export async function configure(command) {
-    /**
-     * Prompt for adapter
-     */
-    const adapter = await command.prompt.choice('Select the Inertia adapter you want to use', ADAPTERS, { name: 'adapter' });
-    const pkgToInstall = ADAPTERS_INFO[adapter].dependencies;
-    /**
-     * Prompt for SSR
-     */
-    const withSsr = await command.prompt.confirm('Do you want to enable server-side rendering?', {
-        name: 'ssr',
-    });
-    if (withSsr) {
-        pkgToInstall.push(...(ADAPTERS_INFO[adapter].ssrDependencies || []));
-    }
-    const codemods = await command.createCodemods();
-    /**
-     * Publish provider
-     */
-    await codemods.updateRcFile((rcFile) => {
-        rcFile.addProvider('@adonisjs/inertia/inertia_provider');
-    });
-    /**
-     * Add Inertia middleware
-     */
-    codemods.registerMiddleware('router', [
-        { path: '@adonisjs/inertia/inertia_middleware', position: 'after' },
-    ]);
-    /**
-     * Publish config
-     */
-    await command.publishStub('config.stub');
-    /**
-     * Install packages
-     */
-    const shouldInstallPackages = await command.prompt.confirm(`Do you want to install dependencies ${pkgToInstall.map((pkg) => pkg.name).join(', ')}?`, { name: 'install' });
-    if (shouldInstallPackages) {
-        command.installPackages(pkgToInstall);
-    }
-    else {
-        command.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.');
-}

package/build/src/debug.d.ts

@@ -1,3 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-declare const _default: import("util").DebugLogger;
-export default _default;

package/build/src/debug.js

@@ -1,10 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { debuglog } from 'node:util';
-export default debuglog('adonisjs:inertia');

package/build/src/define_config.d.ts

@@ -1,5 +0,0 @@
-import type { InertiaConfig } from './types.js';
-/**
- * Define the Inertia configuration
- */
-export declare function defineConfig(config: InertiaConfig): InertiaConfig;

package/build/src/define_config.js

@@ -1,14 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/**
- * Define the Inertia configuration
- */
-export function defineConfig(config) {
-    return config;
-}

package/build/src/inertia.d.ts

@@ -1,39 +0,0 @@
-import type { HttpContext } from '@adonisjs/core/http';
-import type { InertiaConfig, MaybePromise, PageProps, AssetsVersion } from './types.js';
-/**
- * Main class used to interact with Inertia
- */
-export declare class Inertia {
-    #private;
-    protected ctx: HttpContext;
-    protected config: InertiaConfig;
-    protected version: AssetsVersion;
-    constructor(ctx: HttpContext, config: InertiaConfig, version: AssetsVersion);
-    /**
-     * Render a page using Inertia
-     */
-    render(component: string, pageProps?: PageProps): Promise<string | {
-        component: string;
-        version: AssetsVersion;
-        props: any;
-        url: string;
-    }>;
-    /**
-     * 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: () => MaybePromise<any>): {
-        [x: symbol]: () => MaybePromise<any>;
-    };
-    /**
-     * 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
-     */
-    location(url: string): Promise<void>;
-}

package/build/src/inertia.js

@@ -1,119 +0,0 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/**
- * Main class used to interact with Inertia
- */
-export class Inertia {
-    ctx;
-    config;
-    version;
-    /**
-     * The name of the Edge view that will be used to render the page.
-     */
-    #edgeRootView;
-    /**
-     * Symbol used to identify lazy props
-     */
-    #kLazySymbol = Symbol('lazy');
-    constructor(ctx, config = {}, version) {
-        this.ctx = ctx;
-        this.config = config;
-        this.version = version;
-        this.#edgeRootView = config.rootView || 'root';
-    }
-    /**
-     * Check if a value is a lazy prop
-     */
-    #isLazyProps(value) {
-        return typeof value === 'object' && value && this.#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[this.#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.version,
-            props: await this.#resolvePageProps(component, { ...this.config.sharedData, ...pageProps }),
-            url: this.ctx.request.url(true),
-        };
-    }
-    /**
-     * Render a page using Inertia
-     */
-    async render(component, pageProps) {
-        const pageObject = await this.#buildPageObject(component, pageProps);
-        const isInertiaRequest = !!this.ctx.request.header('x-inertia');
-        if (!isInertiaRequest) {
-            return this.ctx.view.render(this.#edgeRootView, { page: pageObject });
-        }
-        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 { [this.#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);
-    }
-}