@adonisjs/inertia 1.0.0-0 → 1.0.0-2

package/build/src/plugins/api_client.js

@@ -1,62 +1,70 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { ApiRequest, ApiResponse } from '@japa/api-client';
-/**
- * Ensure the response is an inertia response, otherwise throw an error
- */
+// src/plugins/api_client.ts
+import { configProvider } from "@adonisjs/core";
+import { RuntimeException } from "@poppinss/utils";
+import { ApiRequest, ApiResponse } from "@japa/api-client";
 function ensureIsInertiaResponse() {
-    if (!this.header('x-inertia')) {
-        throw new Error('Response is not an Inertia response. Make sure to call `withInertia()` on the request');
-    }
+  if (!this.header("x-inertia")) {
+    throw new Error(
+      "Response is not an Inertia response. Make sure to call `withInertia()` on the request"
+    );
+  }
 }
-export function inertiaApiClient() {
-    return () => {
-        ApiRequest.macro('withInertia', function () {
-            this.header('x-inertia', 'true');
-            return this;
-        });
-        ApiRequest.macro('withInertiaPartialReload', function (component, data) {
-            this.withInertia();
-            this.header('X-Inertia-Partial-Data', data.join(','));
-            this.header('X-Inertia-Partial-Component', component);
-            return this;
-        });
-        /**
-         * Response getters
-         */
-        ApiResponse.getter('inertiaComponent', function () {
-            ensureIsInertiaResponse.call(this);
-            return this.body().component;
-        });
-        ApiResponse.getter('inertiaProps', function () {
-            ensureIsInertiaResponse.call(this);
-            return this.body().props;
-        });
-        /**
-         * Response assertions
-         */
-        ApiResponse.macro('assertInertiaComponent', function (component) {
-            ensureIsInertiaResponse.call(this);
-            this.assert.deepEqual(this.body().component, component);
-            return this;
-        });
-        ApiResponse.macro('assertInertiaProps', function (props) {
-            this.ensureHasAssert();
-            ensureIsInertiaResponse.call(this);
-            this.assert.deepEqual(this.body().props, props);
-            return this;
-        });
-        ApiResponse.macro('assertInertiaPropsContains', function (props) {
-            this.ensureHasAssert();
-            ensureIsInertiaResponse.call(this);
-            this.assert.containsSubset(this.body().props, props);
-            return this;
-        });
-    };
+function inertiaApiClient(app) {
+  return async () => {
+    const inertiaConfigProvider = app.config.get("inertia");
+    const config = await configProvider.resolve(app, inertiaConfigProvider);
+    if (!config) {
+      throw new RuntimeException(
+        'Invalid "config/inertia.ts" file. Make sure you are using the "defineConfig" method'
+      );
+    }
+    ApiRequest.macro("withInertia", function() {
+      this.header("x-inertia", "true");
+      this.header("x-inertia-version", config.versionCache.getVersion().toString());
+      return this;
+    });
+    ApiRequest.macro(
+      "withInertiaPartialReload",
+      function(component, data) {
+        this.withInertia();
+        this.header("X-Inertia-Partial-Data", data.join(","));
+        this.header("X-Inertia-Partial-Component", component);
+        return this;
+      }
+    );
+    ApiResponse.getter("inertiaComponent", function() {
+      ensureIsInertiaResponse.call(this);
+      return this.body().component;
+    });
+    ApiResponse.getter("inertiaProps", function() {
+      ensureIsInertiaResponse.call(this);
+      return this.body().props;
+    });
+    ApiResponse.macro("assertInertiaComponent", function(component) {
+      ensureIsInertiaResponse.call(this);
+      this.assert.deepEqual(this.body().component, component);
+      return this;
+    });
+    ApiResponse.macro(
+      "assertInertiaProps",
+      function(props) {
+        this.ensureHasAssert();
+        ensureIsInertiaResponse.call(this);
+        this.assert.deepEqual(this.body().props, props);
+        return this;
+      }
+    );
+    ApiResponse.macro(
+      "assertInertiaPropsContains",
+      function(props) {
+        this.ensureHasAssert();
+        ensureIsInertiaResponse.call(this);
+        this.assert.containsSubset(this.body().props, props);
+        return this;
+      }
+    );
+  };
 }
+export {
+  inertiaApiClient
+};

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

@@ -1,5 +1,8 @@
-import type { PluginFn } from 'edge.js/types';
+import { PluginFn } from 'edge.js/types';
+
 /**
  * Register the Inertia tags and globals within Edge
  */
-export declare const edgePluginInertia: () => PluginFn<undefined>;
+declare const edgePluginInertia: () => PluginFn<undefined>;
+
+export { edgePluginInertia };

package/build/src/plugins/edge.js

@@ -1,43 +1,41 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { encode } from 'html-entities';
-import debug from '../debug.js';
-/**
- * Register the Inertia tags and globals within Edge
- */
-export const edgePluginInertia = () => {
-    return (edge) => {
-        debug('sharing globals and inertia tags with edge');
-        edge.global('inertia', (page = {}) => {
-            if (page.ssrBody)
-                return page.ssrBody;
-            return `<div id="app" data-page="${encode(JSON.stringify(page))}"></div>`;
-        });
-        edge.global('inertiaHead', (page) => {
-            const { ssrHead = [] } = page || {};
-            return ssrHead.join('\n');
-        });
-        edge.registerTag({
-            block: false,
-            tagName: 'inertia',
-            seekable: false,
-            compile(_, buffer, { filename, loc }) {
-                buffer.writeExpression(`out += state.inertia(state.page)`, filename, loc.start.line);
-            },
-        });
-        edge.registerTag({
-            block: false,
-            tagName: 'inertiaHead',
-            seekable: false,
-            compile(_, buffer, { filename, loc }) {
-                buffer.writeExpression(`out += state.inertiaHead(state.page)`, filename, loc.start.line);
-            },
-        });
-    };
+// src/plugins/edge.ts
+import { encode } from "html-entities";
+
+// src/debug.ts
+import { debuglog } from "node:util";
+var debug_default = debuglog("adonisjs:inertia");
+
+// src/plugins/edge.ts
+var edgePluginInertia = () => {
+  return (edge) => {
+    debug_default("sharing globals and inertia tags with edge");
+    edge.global("inertia", (page = {}) => {
+      if (page.ssrBody)
+        return page.ssrBody;
+      return `<div id="app" data-page="${encode(JSON.stringify(page))}"></div>`;
+    });
+    edge.global("inertiaHead", (page) => {
+      const { ssrHead = [] } = page || {};
+      return ssrHead.join("\n");
+    });
+    edge.registerTag({
+      block: false,
+      tagName: "inertia",
+      seekable: false,
+      compile(_, buffer, { filename, loc }) {
+        buffer.writeExpression(`out += state.inertia(state.page)`, filename, loc.start.line);
+      }
+    });
+    edge.registerTag({
+      block: false,
+      tagName: "inertiaHead",
+      seekable: false,
+      compile(_, buffer, { filename, loc }) {
+        buffer.writeExpression(`out += state.inertiaHead(state.page)`, filename, loc.start.line);
+      }
+    });
+  };
+};
+export {
+  edgePluginInertia
 };

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)
@@ -30,3 +57,13 @@ export interface InertiaConfig {
      */
     sharedData?: SharedData;
 }
+/**
+ * Resolved inertia configuration
+ */
+interface ResolvedConfig {
+    rootView: string;
+    versionCache: VersionCache;
+    sharedData: SharedData;
+}
+
+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/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-2",
   "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",
@@ -25,7 +17,7 @@
     "./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/api_client": "./build/src/plugins/api_client.js"
   },
   "scripts": {
     "clean": "del-cli build",
@@ -37,7 +29,7 @@
     "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",
@@ -52,6 +44,7 @@
     "@adonisjs/tsconfig": "^1.1.8",
     "@japa/api-client": "^2.0.1",
     "@japa/assert": "2.0.1",
+    "@japa/expect-type": "^2.0.0",
     "@japa/file-system": "^2.0.1",
     "@japa/plugin-adonisjs": "^2.0.1",
     "@japa/runner": "3.0.5",
@@ -70,7 +63,8 @@
     "supertest": "^6.3.3",
     "tinybench": "^2.5.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.2.2"
+    "tsup": "^7.3.0",
+    "typescript": "~5.2.2"
   },
   "dependencies": {
     "@poppinss/utils": "^6.5.1",
@@ -122,5 +116,21 @@
       "tests/**",
       "tests_helpers/**"
     ]
+  },
+  "tsup": {
+    "entry": [
+      "./index.ts",
+      "./src/types.ts",
+      "./services/inertia.ts",
+      "./src/inertia_middleware.ts",
+      "./providers/inertia_provider.ts",
+      "./src/plugins/edge.ts",
+      "./src/plugins/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);
-    }
-}