npm - @adonisjs/inertia - Versions diffs - 1.0.0-0 → 1.0.0-10 - Mend

@adonisjs/inertia 1.0.0-0 → 1.0.0-10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (58) hide show

package/build/app.css.stub +39 -0
package/build/chunk-CXICUKHN.js +165 -0
package/build/{stubs/config.stub → config.stub} +9 -1
package/build/index.d.ts +18 -3
package/build/index.js +231 -11
package/build/providers/inertia_provider.d.ts +12 -12
package/build/providers/inertia_provider.js +47 -46
package/build/react/app.tsx.stub +25 -0
package/build/react/home.tsx.stub +21 -0
package/build/react/root.edge.stub +22 -0
package/build/react/ssr.tsx.stub +17 -0
package/build/react/tsconfig.json.stub +25 -0
package/build/solid/app.tsx.stub +24 -0
package/build/solid/home.tsx.stub +21 -0
package/build/solid/root.edge.stub +21 -0
package/build/solid/ssr.tsx.stub +19 -0
package/build/solid/tsconfig.json.stub +26 -0
package/build/src/helpers.d.ts +12 -0
package/build/src/helpers.js +14 -0
package/build/src/inertia_middleware.d.ts +68 -7
package/build/src/inertia_middleware.js +6 -47
package/build/src/plugins/edge/plugin.d.ts +8 -0
package/build/src/plugins/edge/plugin.js +85 -0
package/build/src/plugins/{api_client.d.ts → japa/api_client.d.ts} +9 -4
package/build/src/plugins/japa/api_client.js +70 -0
package/build/src/plugins/vite.d.ts +26 -0
package/build/src/plugins/vite.js +33 -0
package/build/src/types.d.ts +72 -8
package/build/src/types.js +0 -9
package/build/vue/app.ts.stub +27 -0
package/build/vue/home.vue.stub +21 -0
package/build/vue/root.edge.stub +21 -0
package/build/vue/ssr.ts.stub +22 -0
package/build/vue/tsconfig.json.stub +26 -0
package/package.json +64 -47
package/build/configure.js +0 -82
package/build/src/debug.d.ts +0 -3
package/build/src/debug.js +0 -10
package/build/src/define_config.d.ts +0 -5
package/build/src/define_config.js +0 -14
package/build/src/inertia.d.ts +0 -39
package/build/src/inertia.js +0 -119
package/build/src/plugins/api_client.js +0 -62
package/build/src/plugins/edge.d.ts +0 -5
package/build/src/plugins/edge.js +0 -43
package/build/src/version_cache.d.ts +0 -27
package/build/src/version_cache.js +0 -68
package/build/stubs/main.d.ts +0 -1
package/build/stubs/main.js +0 -10
package/providers/inertia_provider.ts +0 -66
package/src/debug.ts +0 -12
package/src/define_config.ts +0 -17
package/src/inertia.ts +0 -140
package/src/inertia_middleware.ts +0 -54
package/src/plugins/api_client.ts +0 -127
package/src/plugins/edge.ts +0 -50
package/src/types.ts +0 -48
package/src/version_cache.ts +0 -74

package/build/react/root.edge.stub ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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>

package/build/solid/ssr.tsx.stub ADDED Viewed

@@ -0,0 +1,19 @@
+{{{
+  exports({ to: app.makePath('resources/ssr.tsx') })
+}}}
+import { hydrate } from 'solid-js/web'
+import { createInertiaApp } from 'inertia-adapter-solid'
+export default function render(page: any) {
+  return createInertiaApp({
+    page,
+    resolve: (name) => {
+      const pages = import.meta.glob('./pages/**/*.tsx', { eager: true })
+      {{ 'return pages[`./pages/${name}.tsx`]' }}
+    },
+    setup({ el, App, props }) {
+      hydrate(() => <App {...props} />, el)
+    },
+  })
+}

package/build/solid/tsconfig.json.stub ADDED Viewed

@@ -0,0 +1,26 @@
+{{{
+  exports({ to: app.makePath('resources/tsconfig.json') })
+}}}
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "jsx": "preserve",
+    "jsxImportSource": "solid-js",
+    "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/src/helpers.d.ts ADDED Viewed

@@ -0,0 +1,12 @@
+/**
+ * Utility function to resolve a page component
+ *
+ * @example
+ *    return resolvePageComponent(
+ *      `./pages/${name}.vue`,
+ *       import.meta.glob<DefineComponent>("./pages/**\/*.vue")
+ *    )
+ */
+declare function resolvePageComponent<T>(path: string | string[], pages: Record<string, Promise<T> | (() => Promise<T>)>): Promise<T>;
+export { resolvePageComponent };

package/build/src/helpers.js ADDED Viewed

@@ -0,0 +1,14 @@
+// src/helpers.ts
+async function resolvePageComponent(path, pages) {
+  for (const p of Array.isArray(path) ? path : [path]) {
+    const page = pages[p];
+    if (typeof page === "undefined") {
+      continue;
+    }
+    return typeof page === "function" ? page() : page;
+  }
+  throw new Error(`Page not found: ${path}`);
+}
+export {
+  resolvePageComponent
+};

package/build/src/inertia_middleware.d.ts CHANGED Viewed

@@ -1,12 +1,73 @@
-import type { HttpContext } from '@adonisjs/core/http';
-import type { NextFn } from '@adonisjs/core/types/http';
-import type { VersionCache } from './version_cache.js';
+import { Vite } from '@adonisjs/vite';
+import { HttpContext } from '@adonisjs/core/http';
+import { NextFn } from '@adonisjs/core/types/http';
+import { ViteRuntime } from 'vite/runtime';
+import { ResolvedConfig, Data, PageProps, MaybePromise } from './types.js';
+/**
+ * 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 viteRuntime?: ViteRuntime | undefined;
+    constructor(ctx: HttpContext, config: ResolvedConfig, viteRuntime?: ViteRuntime | 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> = PageProps, TViewProps extends Record<string, any> = PageProps>(component: string, pageProps?: TPageProps, viewProps?: TViewProps): Promise<string | {
+        component: string;
+        version: string | number;
+        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>): {
+        [kLazySymbol]: () => 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>;
+}
+/**
+ * HttpContext augmentations
+ */
+declare module '@adonisjs/core/http' {
+    interface HttpContext {
+        inertia: Inertia;
+    }
+}
 /**
  * Inertia middleware to handle the Inertia requests and
  * set appropriate headers/status
  */
-export default class InertiaMiddleware {
-    protected version: VersionCache;
-    constructor(version: VersionCache);
-    handle({ request, response }: HttpContext, next: NextFn): Promise<void>;
+declare class InertiaMiddleware {
+    #private;
+    protected config: ResolvedConfig;
+    constructor(config: ResolvedConfig, vite?: Vite);
+    handle(ctx: HttpContext, next: NextFn): Promise<void>;
 }
+export { InertiaMiddleware as default };

package/build/src/inertia_middleware.js CHANGED Viewed

@@ -1,47 +1,6 @@
-/*
- * @adonisjs/inertia
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/**
- * Inertia middleware to handle the Inertia requests and
- * set appropriate headers/status
- */
-export default class InertiaMiddleware {
-    version;
-    constructor(version) {
-        this.version = version;
-    }
-    async handle({ request, response }, next) {
-        await next();
-        const isInertiaRequest = !!request.header('x-inertia');
-        if (!isInertiaRequest)
-            return;
-        response.header('Vary', 'Accept');
-        response.header('X-Inertia', 'true');
-        /**
-         * When redirecting a PUT/PATCH/DELETE request, we need to change the
-         * we must use a 303 status code instead of a 302 to force
-         * the browser to use a GET request after redirecting.
-         *
-         * See https://inertiajs.com/redirects
-         */
-        const method = request.method();
-        if (response.getStatus() === 302 && ['PUT', 'PATCH', 'DELETE'].includes(method)) {
-            response.status(303);
-        }
-        /**
-         * Handle version change
-         *
-         * See https://inertiajs.com/the-protocol#asset-versioning
-         */
-        const version = this.version.getVersion();
-        if (method === 'GET' && request.header('x-inertia-version', '') !== version) {
-            response.header('x-inertia-location', request.url());
-            response.status(409);
-        }
-    }
-}
+import {
+  InertiaMiddleware
+} from "../chunk-CXICUKHN.js";
+export {
+  InertiaMiddleware as default
+};

package/build/src/plugins/edge/plugin.d.ts ADDED Viewed

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

package/build/src/plugins/edge/plugin.js ADDED Viewed

@@ -0,0 +1,85 @@
+// src/plugins/edge/plugin.ts
+import { encode } from "html-entities";
+// src/debug.ts
+import { debuglog } from "node:util";
+var debug_default = debuglog("adonisjs:inertia");
+// src/plugins/edge/tags.ts
+import { EdgeError } from "edge-error";
+// src/plugins/edge/utils.ts
+function isSubsetOf(expression, expressions, errorCallback) {
+  if (!expressions.includes(expression.type)) {
+    errorCallback();
+  }
+}
+// src/plugins/edge/tags.ts
+var inertiaTag = {
+  block: false,
+  tagName: "inertia",
+  seekable: true,
+  compile(parser, buffer, { filename, loc, properties }) {
+    if (properties.jsArg.trim() === "") {
+      buffer.writeExpression(`out += state.inertia(state.page)`, filename, loc.start.line);
+      return;
+    }
+    properties.jsArg = `(${properties.jsArg})`;
+    const parsed = parser.utils.transformAst(
+      parser.utils.generateAST(properties.jsArg, loc, filename),
+      filename,
+      parser
+    );
+    isSubsetOf(parsed, ["ObjectExpression"], () => {
+      const { line, col } = parser.utils.getExpressionLoc(parsed);
+      throw new EdgeError(
+        `"${properties.jsArg}" is not a valid argument for @inertia`,
+        "E_UNALLOWED_EXPRESSION",
+        { line, col, filename }
+      );
+    });
+    const attributes = parser.utils.stringify(parsed);
+    buffer.writeExpression(
+      `out += state.inertia(state.page, ${attributes})`,
+      filename,
+      loc.start.line
+    );
+  }
+};
+var inertiaHeadTag = {
+  block: false,
+  tagName: "inertiaHead",
+  seekable: false,
+  compile(_, buffer, { filename, loc }) {
+    buffer.writeExpression(`out += state.inertiaHead(state.page)`, filename, loc.start.line);
+  }
+};
+// src/plugins/edge/plugin.ts
+var edgePluginInertia = () => {
+  return (edge) => {
+    debug_default("sharing globals and inertia tags with edge");
+    edge.global(
+      "inertia",
+      (page = {}, attributes = {}) => {
+        if (page.ssrBody)
+          return page.ssrBody;
+        const className = attributes?.class ? ` class="${attributes.class}"` : "";
+        const id = attributes?.id ? ` id="${attributes.id}"` : ' id="app"';
+        const tag = attributes?.as || "div";
+        const dataPage = encode(JSON.stringify(page));
+        return `<${tag}${id}${className} data-page="${dataPage}"></${tag}>`;
+      }
+    );
+    edge.global("inertiaHead", (page) => {
+      const { ssrHead = [] } = page || {};
+      return ssrHead.join("\n");
+    });
+    edge.registerTag(inertiaHeadTag);
+    edge.registerTag(inertiaTag);
+  };
+};
+export {
+  edgePluginInertia
+};

package/build/src/plugins/{api_client.d.ts → japa/api_client.d.ts} RENAMED Viewed

@@ -1,5 +1,8 @@
-import type { PluginFn } from '@japa/runner/types';
-import type { PageProps } from '../types.js';
+import { PluginFn } from '@japa/runner/types';
+import { ApplicationService } from '@adonisjs/core/types';
+import { PageProps } from '../../types.js';
+import '@adonisjs/core/http';
 declare module '@japa/api-client' {
     interface ApiRequest {
         /**
@@ -19,7 +22,7 @@ declare module '@japa/api-client' {
         /**
          * The inertia response props
          */
-        inertiaProps: PageProps;
+        inertiaProps: Record<string, any>;
         /**
          * Assert component name of inertia response
          */
@@ -34,4 +37,6 @@ declare module '@japa/api-client' {
         assertInertiaPropsContains(props: PageProps): this;
     }
 }
-export declare function inertiaApiClient(): PluginFn;
+declare function inertiaApiClient(app: ApplicationService): PluginFn;
+export { inertiaApiClient };

package/build/src/plugins/japa/api_client.js ADDED Viewed

@@ -0,0 +1,70 @@
+// src/plugins/japa/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"
+    );
+  }
+}
+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/vite.d.ts ADDED Viewed

@@ -0,0 +1,26 @@
+import { PluginOption } from 'vite';
+type InertiaPluginOptions = {
+    ssr?: {
+        /**
+         * Whether or not to enable server-side rendering
+         */
+        enabled: true;
+        /**
+         * The entrypoint for the server-side rendering
+         */
+        entrypoint: string;
+        /**
+         * The output directory for the server-side rendering bundle
+         */
+        output?: string;
+    } | {
+        enabled: false;
+    };
+};
+/**
+ * Inertia plugin for Vite that is tailored for AdonisJS
+ */
+declare function inertia(options?: InertiaPluginOptions): PluginOption;
+export { type InertiaPluginOptions, inertia as default };

package/build/src/plugins/vite.js ADDED Viewed

@@ -0,0 +1,33 @@
+// src/plugins/vite.ts
+function inertia(options) {
+  return {
+    name: "vite-plugin-inertia",
+    config: () => {
+      if (!options?.ssr?.enabled)
+        return {};
+      return {
+        buildSteps: [
+          {
+            name: "build-client",
+            description: "build inertia client bundle",
+            config: { build: { outDir: "build/public/assets/" } }
+          },
+          {
+            name: "build-ssr",
+            description: "build inertia server bundle",
+            config: {
+              build: {
+                ssr: true,
+                outDir: options.ssr.output || "build/ssr",
+                rollupOptions: { input: options.ssr.entrypoint }
+              }
+            }
+          }
+        ]
+      };
+    }
+  };
+}
+export {
+  inertia as default
+};