@adonisjs/inertia 1.0.0-8 → 1.0.0

package/build/types-fb05P61I.d.ts

@@ -0,0 +1,203 @@
+import { ConfigProvider } from '@adonisjs/core/types';
+import { HttpContext } from '@adonisjs/core/http';
+import { Simplify, Serialize } from '@tuyau/utils/types';
+import { Vite } from '@adonisjs/vite';
+
+/**
+ * Symbol used to identify lazy props
+ */
+declare const kLazySymbol: unique symbol;
+/**
+ * Main class used to interact with Inertia
+ */
+declare class Inertia {
+    #private;
+    protected ctx: HttpContext;
+    protected 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> = {}, TViewProps extends Record<string, any> = {}>(component: string, pageProps?: TPageProps, viewProps?: TViewProps): Promise<string | PageObject<TPageProps>>;
+    /**
+     * 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<T>(callback: () => MaybePromise<T>): {
+        [kLazySymbol]: () => MaybePromise<T>;
+    };
+    /**
+     * 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>;
+}
+
+/**
+ * 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
+ */
+type PageProps = Record<string, unknown>;
+/**
+ * Shared data types
+ */
+type Data = string | number | object | boolean;
+type SharedDatumFactory = (ctx: HttpContext) => MaybePromise<Data>;
+type SharedData = Record<string, Data | SharedDatumFactory>;
+/**
+ * Allowed values for the assets version
+ */
+type AssetsVersion = string | number | undefined;
+interface InertiaConfig<T extends SharedData = SharedData> {
+    /**
+     * Path to the Edge view that will be used as the root view for Inertia responses.
+     * @default root (resources/views/inertia_layout.edge)
+     */
+    rootView?: string | ((ctx: HttpContext) => 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.
+     */
+    assetsVersion?: AssetsVersion;
+    /**
+     * Data that should be shared with all rendered pages
+     */
+    sharedData?: T;
+    /**
+     * 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
+ */
+interface ResolvedConfig<T extends SharedData = SharedData> {
+    rootView: string | ((ctx: HttpContext) => string);
+    versionCache: VersionCache;
+    sharedData: T;
+    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;
+}
+type IsLazyProp<T> = T extends {
+    [kLazySymbol]: () => MaybePromise<any>;
+} ? true : false;
+type InferProps<T> = {
+    [K in keyof T as IsLazyProp<T[K]> extends true ? K : never]+?: T[K] extends {
+        [kLazySymbol]: () => MaybePromise<infer U>;
+    } ? U : T[K];
+} & {
+    [K in keyof T as IsLazyProp<T[K]> extends true ? never : K]: T[K];
+};
+type ReturnsTypesSharedData<T extends SharedData> = {} extends T ? {} : {
+    [K in keyof T]: T[K] extends (...args: any[]) => MaybePromise<infer U> ? U : T[K];
+};
+/**
+ * Infer shared data types from the config provider
+ */
+type InferSharedProps<T extends ConfigProvider<ResolvedConfig>> = ReturnsTypesSharedData<Awaited<ReturnType<T['resolver']>>['sharedData']>;
+/**
+ * The shared props inferred from the user config user-land.
+ * Should be module augmented by the user
+ */
+interface SharedProps {
+}
+/**
+ * Helper for infering the page props from a Controller method that returns
+ * inertia.render
+ *
+ * InferPageProps will also include the shared props
+ *
+ * ```ts
+ * // Your Adonis Controller
+ * class MyController {
+ *  index() {
+ *   return inertia.render('foo', { foo: 1 })
+ *  }
+ * }
+ *
+ * // Your React component
+ * export default MyReactComponent(props: InferPageProps<Controller, 'index'>) {
+ * }
+ * ```
+ */
+type InferPageProps<Controller, Method extends keyof Controller> = Controller[Method] extends (...args: any[]) => any ? Simplify<Serialize<InferProps<Exclude<Awaited<ReturnType<Controller[Method]>>, string>['props']> & SharedProps>> : never;
+/**
+ * Signature for the method in the SSR entrypoint file
+ */
+type RenderInertiaSsrApp = (page: PageObject) => Promise<{
+    head: string[];
+    body: string;
+}>;
+
+export { type AssetsVersion as A, type Data as D, type InertiaConfig as I, type MaybePromise as M, type PageProps as P, type ResolvedConfig as R, type SharedData as S, Inertia as a, type SharedDatumFactory as b, type PageObject as c, type InferSharedProps as d, type SharedProps as e, type InferPageProps as f, type RenderInertiaSsrApp as g };

package/build/vue/app.ts.stub

@@ -1,11 +1,19 @@
 {{{
-  exports({ to: app.makePath('resources/app.ts') })
+  exports({ to: app.makePath('inertia/app/app.ts') })
 }}}
-import './css/app.css';
+/// <reference path="../../adonisrc.ts" />
+/// <reference path="../../config/inertia.ts" />
 
+import '../css/app.css';
+
+{{#if ssr}}
+import { createSSRApp, h } from 'vue'
+{{#else}}
 import { createApp, h } from 'vue'
+{{/if}}
 import type { DefineComponent } from 'vue'
 import { createInertiaApp } from '@inertiajs/vue3'
+import { resolvePageComponent } from '@adonisjs/inertia/helpers'
 
 const appName = import.meta.env.VITE_APP_NAME || 'AdonisJS'
 
@@ -15,12 +23,18 @@ createInertiaApp({
   title: (title) => {{ '`${title} - ${appName}`' }},
 
   resolve: (name) => {
-    const pages = import.meta.glob<DefineComponent>('./pages/**/*.vue', { eager: true })
-    {{ 'return pages[`./pages/${name}.vue`]' }}
+    return resolvePageComponent(
+      {{ '`../pages/${name}.vue`' }},
+      import.meta.glob<DefineComponent>('../pages/**/*.vue'),
+    )
   },
 
   setup({ el, App, props, plugin }) {
+    {{#if ssr}}
+    createSSRApp({ render: () => h(App, props) })
+    {{#else}}
     createApp({ render: () => h(App, props) })
+    {{/if}}
       .use(plugin)
       .mount(el)
   },

package/build/vue/errors/not_found.vue.stub

@@ -0,0 +1,10 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/errors/not_found.vue') })
+}}}
+<template>
+  <div class="container">
+    <div class="title">Page not found</div>
+
+    <span>This page does not exist.</span>
+  </div>
+</template>

package/build/vue/errors/server_error.vue.stub

@@ -0,0 +1,14 @@
+{{{
+  exports({ to: app.makePath('inertia/pages/errors/server_error.vue') })
+}}}
+<script setup lang="ts">
+defineProps<{ error: any }>();
+</script>
+
+<template>
+  <div class="container">
+    <div class="title">Server Error</div>
+
+    <span>\{\{ error.message \}\}</span>
+  </div>
+</template>

package/build/vue/home.vue.stub

@@ -1,5 +1,5 @@
 {{{
-  exports({ to: app.makePath('resources/pages/home.vue') })
+  exports({ to: app.makePath('inertia/pages/home.vue') })
 }}}
 <script setup lang="ts">
 import { Head } from '@inertiajs/vue3'
@@ -10,12 +10,12 @@ defineProps<{ version: number }>()
 <template>
   <Head title="Homepage" />
 
-  <div className="container">
-    <div className="title">AdonisJS \{\{ version \}\} x Inertia x Vue.js</div>
+  <div class="container">
+    <div class="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>.
+      <a href="https://docs.adonisjs.com/guides/inertia">AdonisJS documentation</a>.
     </span>
   </div>
 </template>

package/build/vue/root.edge.stub

@@ -1,5 +1,5 @@
 {{{
-  exports({ to: app.makePath('resources/views/root.edge') })
+  exports({ to: app.makePath('resources/views/inertia_layout.edge') })
 }}}
 <!DOCTYPE html>
 <html>
@@ -10,7 +10,7 @@
 
   <title inertia>AdonisJS x Inertia x VueJS</title>
 
-  @vite(['resources/app.ts'])
+  {{ "@vite(['inertia/app/app.ts', `inertia/pages/${page.component}.vue`])" }}
   @inertiaHead()
 </head>
 

package/build/vue/ssr.ts.stub

@@ -0,0 +1,22 @@
+{{{
+  exports({ to: app.makePath('inertia/app/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

@@ -1,26 +1,16 @@
 {{{
-  exports({ to: app.makePath('resources/tsconfig.json') })
+  exports({ to: app.makePath('inertia/tsconfig.json') })
 }}}
 {
+  "extends": "@adonisjs/tsconfig/tsconfig.client.json",
   "compilerOptions": {
-    "target": "ESNext",
-    "jsx": "preserve",
-    "jsxImportSource": "vue",
-    "lib": ["DOM", "ESNext", "DOM.Iterable", "ES2020"],
-    "useDefineForClassFields": true,
     "baseUrl": ".",
+    "jsx": "preserve",
     "module": "ESNext",
-    "moduleResolution": "Bundler",
+    "jsxImportSource": "vue",
     "paths": {
-      "@/*": ["./*"],
-      "~/*": ["../*"],
+      "~/*": ["./*"],
     },
-    "resolveJsonModule": true,
-    "types": ["vite/client"],
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "verbatimModuleSyntax": true,
-    "skipLibCheck": true,
   },
   "include": ["./**/*.ts", "./**/*.vue"],
 }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@adonisjs/inertia",
   "description": "Official Inertia.js adapter for AdonisJS",
-  "version": "1.0.0-8",
+  "version": "1.0.0",
   "engines": {
-    "node": ">=18.16.0"
+    "node": ">=20.6.0"
   },
   "main": "build/index.js",
   "type": "module",
@@ -18,7 +18,8 @@
     "./inertia_provider": "./build/providers/inertia_provider.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"
+    "./client": "./build/src/plugins/vite.js",
+    "./helpers": "./build/src/helpers.js"
   },
   "scripts": {
     "clean": "del-cli build",
@@ -32,55 +33,57 @@
     "prebuild": "npm run lint && npm run clean",
     "build": "tsup-node",
     "postbuild": "npm run copy:templates",
-    "release": "np",
+    "release": "release-it",
     "version": "npm run build",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.2.1",
-    "@adonisjs/core": "6.3.0",
-    "@adonisjs/eslint-config": "^1.2.1",
-    "@adonisjs/prettier-config": "^1.2.1",
-    "@adonisjs/session": "7.1.1",
-    "@adonisjs/tsconfig": "^1.2.1",
-    "@adonisjs/vite": "^3.0.0-0",
-    "@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": "^2.0.3",
-    "@japa/runner": "3.1.1",
-    "@swc/core": "^1.4.2",
-    "@types/node": "^20.11.20",
-    "@types/qs": "^6.9.11",
+    "@adonisjs/assembler": "^7.7.0",
+    "@adonisjs/core": "6.9.1",
+    "@adonisjs/eslint-config": "^1.3.0",
+    "@adonisjs/prettier-config": "^1.3.0",
+    "@adonisjs/session": "7.4.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@adonisjs/vite": "^3.0.0",
+    "@japa/api-client": "^2.0.3",
+    "@japa/assert": "3.0.0",
+    "@japa/expect-type": "^2.0.2",
+    "@japa/file-system": "^2.3.0",
+    "@japa/plugin-adonisjs": "^3.0.1",
+    "@japa/runner": "3.1.4",
+    "@japa/snapshot": "^2.0.5",
+    "@swc/core": "^1.5.24",
+    "@types/node": "^20.13.0",
+    "@types/qs": "^6.9.15",
     "@types/supertest": "^6.0.2",
     "@vavite/multibuild": "^4.1.1",
     "c8": "^9.1.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.1.0",
-    "edge-parser": "^9.0.1",
-    "edge.js": "^6.0.1",
+    "edge-parser": "^9.0.2",
+    "edge.js": "^6.0.2",
     "eslint": "^8.57.0",
-    "get-port": "^7.0.0",
-    "np": "^9.2.0",
-    "prettier": "^3.2.5",
-    "supertest": "^6.3.4",
-    "tinybench": "^2.6.0",
+    "get-port": "^7.1.0",
+    "prettier": "^3.3.0",
+    "release-it": "^17.3.0",
+    "supertest": "^7.0.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.0.2",
-    "typescript": "~5.3.3",
-    "vite": "^5.1.4"
+    "typescript": "~5.4.5",
+    "vite": "^5.2.12"
   },
   "dependencies": {
-    "@poppinss/utils": "^6.7.2",
+    "@poppinss/utils": "^6.7.3",
+    "@tuyau/utils": "^0.0.4",
     "crc-32": "^1.2.2",
     "edge-error": "^4.0.1",
-    "html-entities": "^2.4.0",
-    "qs": "^6.11.2"
+    "html-entities": "^2.5.2",
+    "locate-path": "^7.2.0",
+    "qs": "^6.12.1"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.2.0",
-    "@adonisjs/session": "^7.0.0",
+    "@adonisjs/core": "^6.9.1",
+    "@adonisjs/session": "^7.4.0",
     "@adonisjs/vite": "^3.0.0",
     "@japa/api-client": "^2.0.0",
     "edge.js": "^6.0.0"
@@ -104,11 +107,17 @@
     "access": "public",
     "tag": "latest"
   },
-  "np": {
-    "message": "chore(release): %s",
-    "tag": "latest",
-    "branch": "main",
-    "anyBranch": false
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(release): ${version}",
+      "tagAnnotation": "v${version}",
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true,
+      "releaseName": "v${version}",
+      "web": true
+    }
   },
   "c8": {
     "reporter": [
@@ -124,12 +133,13 @@
     "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",
-      "./src/plugins/vite.ts"
+      "./src/plugins/japa/api_client.ts"
     ],
     "outDir": "./build",
     "clean": true,