@adonisjs/inertia 4.0.0-next.9 → 4.0.0

package/build/commands/commands.json

@@ -0,0 +1 @@
+{"commands":[{"commandName":"make:page","description":"Create a new Inertia page component","help":"","namespace":"make","aliases":[],"flags":[{"name":"vue","flagName":"vue","required":false,"type":"boolean","description":"Create a Vue page component"},{"name":"react","flagName":"react","required":false,"type":"boolean","description":"Create a React page component"}],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the page component","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make_page.js"}],"version":1}

package/build/commands/main.d.ts

@@ -0,0 +1,4 @@
+import { CommandMetaData, Command } from '@adonisjs/ace/types';
+
+export function getMetaData(): Promise<CommandMetaData[]>
+export function getCommand(metaData: CommandMetaData): Promise<Command | null>

package/build/commands/main.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises'
+
+/**
+ * In-memory cache of commands after they have been loaded
+ */
+let commandsMetaData
+
+/**
+ * Reads the commands from the "./commands.json" file. Since, the commands.json
+ * file is generated automatically, we do not have to validate its contents
+ */
+export async function getMetaData() {
+  if (commandsMetaData) {
+    return commandsMetaData
+  }
+
+  const commandsIndex = await readFile(new URL('./commands.json', import.meta.url), 'utf-8')
+  commandsMetaData = JSON.parse(commandsIndex).commands
+
+  return commandsMetaData
+}
+
+/**
+ * Imports the command by lookingup its path from the commands
+ * metadata
+ */
+export async function getCommand(metaData) {
+  const commands = await getMetaData()
+  const command = commands.find(({ commandName }) => metaData.commandName === commandName)
+  if (!command) {
+    return null
+  }
+
+  const { default: commandConstructor } = await import(new URL(command.filePath, import.meta.url).href)
+  return commandConstructor
+}

package/build/commands/make_page.d.ts

@@ -0,0 +1,16 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+export default class MakePage extends BaseCommand {
+    #private;
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    name: string;
+    vue: boolean;
+    react: boolean;
+    /**
+     * Directory under which the inertia pages are stored
+     */
+    protected pagesDir: string;
+    run(): Promise<void>;
+}

package/build/commands/make_page.js

@@ -0,0 +1,47 @@
+import { readdir } from "node:fs/promises";
+import { BaseCommand, args, flags } from "@adonisjs/core/ace";
+import { join } from "node:path";
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+const stubsRoot = join(import.meta.dirname, "../stubs");
+var MakePage = class extends BaseCommand {
+	static commandName = "make:page";
+	static description = "Create a new Inertia page component";
+	static options = { allowUnknownFlags: true };
+	pagesDir = "inertia/pages";
+	async #detectFramework() {
+		try {
+			const files = await readdir(this.app.makePath(this.pagesDir), { recursive: true });
+			const hasVue = files.some((file) => file.endsWith(".vue"));
+			const hasReact = files.some((file) => file.endsWith(".tsx") || file.endsWith(".jsx"));
+			if (hasVue && !hasReact) return "vue";
+			if (hasReact && !hasVue) return "react";
+			return null;
+		} catch {
+			return null;
+		}
+	}
+	async #resolveFramework() {
+		if (this.vue) return "vue";
+		if (this.react) return "react";
+		const detected = await this.#detectFramework();
+		if (detected) return detected;
+		return this.prompt.choice("Select the frontend framework", ["vue", "react"]);
+	}
+	async run() {
+		const framework = await this.#resolveFramework();
+		await (await this.createCodemods()).makeUsingStub(stubsRoot, `make/page/${framework}.stub`, {
+			flags: this.parsed.flags,
+			pagesDir: this.pagesDir,
+			entity: this.app.generators.createEntity(this.name)
+		});
+	}
+};
+__decorate([args.string({ description: "Name of the page component" })], MakePage.prototype, "name", void 0);
+__decorate([flags.boolean({ description: "Create a Vue page component" })], MakePage.prototype, "vue", void 0);
+__decorate([flags.boolean({ description: "Create a React page component" })], MakePage.prototype, "react", void 0);
+export { MakePage as default };

package/build/debug-CBMTuPUm.js

@@ -0,0 +1,3 @@
+import { debuglog } from "node:util";
+var debug_default = debuglog("adonisjs:inertia");
+export { debug_default as t };

package/build/define_config-O1Y9QfzM.js

@@ -0,0 +1,57 @@
+import lodash from "@poppinss/utils/lodash";
+const GLOB = {
+	vue3: ["**/*.vue"],
+	react: ["**/*.ts", "**/*.tsx"]
+};
+const SUPPORTED_FRAMEWORKS = Object.keys(GLOB);
+const TYPES_EXTRACTION_HELPER = {
+	vue3: `import type { VNodeProps, AllowedComponentProps, ComponentInstance } from 'vue'
+
+type ExtractProps<T> = Omit<
+  ComponentInstance<T>['$props'],
+  keyof VNodeProps | keyof AllowedComponentProps
+>`,
+	react: `import type React from 'react'
+import type { Prettify } from '@adonisjs/core/types/common'
+
+type ExtractProps<T> =
+  T extends React.FC<infer Props>
+    ? Prettify<Omit<Props, 'children'>>
+    : T extends React.Component<infer Props>
+      ? Prettify<Omit<Props, 'children'>>
+      : never`
+};
+const indexPages = function(config) {
+	if (!SUPPORTED_FRAMEWORKS.includes(config.framework)) throw new Error(`Unsupported framework "${config.framework}". Types generation is available only for ${SUPPORTED_FRAMEWORKS.join(",")}`);
+	return { run(_, __, indexGenerator) {
+		indexGenerator.add("inertiaPages", {
+			source: "inertia/pages",
+			glob: GLOB[config.framework],
+			output: ".adonisjs/server/pages.d.ts",
+			as(vfs, buffer, ___, helpers) {
+				const filesList = vfs.asList();
+				buffer.writeLine(`import '@adonisjs/inertia/types'`);
+				buffer.writeLine(TYPES_EXTRACTION_HELPER[config.framework]);
+				buffer.write(`declare module '@adonisjs/inertia/types' {`).indent();
+				buffer.write(`export interface InertiaPages {`).indent();
+				Object.keys(filesList).forEach((key) => {
+					buffer.write(`'${key}': ExtractProps<(typeof import('${helpers.toImportPath(filesList[key])}'))['default']>`);
+				});
+				buffer.dedent().write(`}`);
+				buffer.dedent().write(`}`);
+			}
+		});
+	} };
+};
+function defineConfig(config) {
+	return lodash.merge({
+		rootView: "inertia_layout",
+		history: { encrypt: false },
+		ssr: {
+			enabled: false,
+			bundle: "ssr/ssr.js",
+			entrypoint: "inertia/ssr.tsx"
+		}
+	}, config);
+}
+export { indexPages as n, defineConfig as t };

package/build/factories/main.js

@@ -1,175 +1,63 @@
-import {
-  defineConfig
-} from "../chunk-5QRJHXXQ.js";
-import {
-  Inertia,
-  ServerRenderer
-} from "../chunk-XXMTGYB5.js";
-import {
-  InertiaHeaders
-} from "../chunk-DISC5OYC.js";
-import "../chunk-4EZ2J6OA.js";
-import "../chunk-MLKGABMK.js";
-
-// factories/inertia_factory.ts
+import { n as ServerRenderer, r as Inertia } from "../inertia_manager-Ra2dhBKa.js";
+import { t as InertiaHeaders } from "../headers-DafWEpBh.js";
+import "../debug-CBMTuPUm.js";
+import { t as defineConfig } from "../define_config-O1Y9QfzM.js";
+import "../index.js";
 import { HttpContextFactory } from "@adonisjs/core/factories/http";
 var InertiaFactory = class {
-  /** Optional Vite instance for asset handling */
-  #vite;
-  /** Internal parameters for factory configuration */
-  #parameters = {
-    ctx: new HttpContextFactory().create(),
-    config: defineConfig({})
-  };
-  /**
-   * Creates a new InertiaFactory instance with default Inertia headers
-   *
-   * @example
-   * ```typescript
-   * const factory = new InertiaFactory()
-   * ```
-   */
-  constructor() {
-    this.#parameters.ctx.request.request.headers[InertiaHeaders.Inertia] = "true";
-  }
-  /**
-   * Merges additional parameters into the factory configuration
-   *
-   * @param parameters - Partial factory parameters to merge
-   *
-   * @example
-   * ```typescript
-   * factory.merge({
-   *   config: { ssr: { enabled: true } },
-   *   ctx: customContext
-   * })
-   * ```
-   */
-  merge(parameters) {
-    if (parameters.ctx) {
-      this.#parameters.ctx = parameters.ctx;
-    }
-    if (parameters.config) {
-      this.#parameters.config = defineConfig(parameters.config);
-    }
-    this.#parameters.ctx.request.request.headers[InertiaHeaders.Inertia] = "true";
-    return this;
-  }
-  /**
-   * Removes the X-Inertia header from the request headers
-   *
-   * @example
-   * ```typescript
-   * const inertia = factory.withoutInertia().create()
-   * ```
-   */
-  withoutInertia() {
-    delete this.#parameters.ctx.request.request.headers[InertiaHeaders.Inertia];
-    return this;
-  }
-  /**
-   * Configures the factory for partial reloads of a specific component
-   *
-   * @param component - Name of the component to partially reload
-   *
-   * @example
-   * ```typescript
-   * const inertia = factory
-   *   .partialReload('UserProfile')
-   *   .only(['name', 'email'])
-   *   .create()
-   * ```
-   */
-  partialReload(component) {
-    const self = this;
-    const request = this.#parameters.ctx.request;
-    request.request.headers[InertiaHeaders.PartialComponent] = component;
-    return {
-      /**
-       * Specifies which props to include in the partial reload
-       *
-       * @param props - Array of property names to include
-       */
-      only(props) {
-        request.request.headers[InertiaHeaders.PartialOnly] = props.join(",");
-        return this;
-      },
-      /**
-       * Specifies which props to exclude from the partial reload
-       *
-       * @param props - Array of property names to exclude
-       */
-      except(props) {
-        request.request.headers[InertiaHeaders.PartialExcept] = props.join(",");
-        return this;
-      },
-      /**
-       * Specifies which props should be reset during the partial reload
-       *
-       * @param props - Array of property names to reset
-       */
-      reset(props) {
-        request.request.headers[InertiaHeaders.Reset] = props.join(",");
-        return this;
-      },
-      /**
-       * Creates the Inertia instance with partial reload configuration
-       */
-      create() {
-        return self.create();
-      }
-    };
-  }
-  /**
-   * Sets the assets version for cache busting
-   *
-   * @param version - Version string or function for asset versioning
-   *
-   * @example
-   * ```typescript
-   * factory.withVersion('1.0.0')
-   * // or
-   * factory.withVersion(() => Date.now().toString())
-   * ```
-   */
-  withVersion(version) {
-    this.#parameters.config = { ...this.#parameters.config, assetsVersion: version };
-    return this;
-  }
-  /**
-   * Sets the Vite instance for asset handling
-   *
-   * @param options - Vite configuration object
-   *
-   * @example
-   * ```typescript
-   * factory.withVite(viteInstance)
-   * ```
-   */
-  withVite(options) {
-    this.#vite = options;
-    return this;
-  }
-  /**
-   * Creates a new Inertia instance with the configured parameters
-   *
-   * @example
-   * ```typescript
-   * const inertia = factory
-   *   .merge({ config: customConfig })
-   *   .withVersion('1.0.0')
-   *   .create()
-   * ```
-   */
-  create() {
-    return new Inertia(
-      this.#parameters.ctx,
-      this.#parameters.config,
-      this.#vite,
-      this.#vite ? new ServerRenderer(this.#parameters.config, this.#vite) : void 0
-    );
-  }
-};
-export {
-  InertiaFactory
+	#vite;
+	#parameters = {
+		ctx: new HttpContextFactory().create(),
+		config: defineConfig({})
+	};
+	constructor() {
+		this.#parameters.ctx.request.request.headers[InertiaHeaders.Inertia] = "true";
+	}
+	merge(parameters) {
+		if (parameters.ctx) this.#parameters.ctx = parameters.ctx;
+		if (parameters.config) this.#parameters.config = defineConfig(parameters.config);
+		this.#parameters.ctx.request.request.headers[InertiaHeaders.Inertia] = "true";
+		return this;
+	}
+	withoutInertia() {
+		delete this.#parameters.ctx.request.request.headers[InertiaHeaders.Inertia];
+		return this;
+	}
+	partialReload(component) {
+		const self = this;
+		const request = this.#parameters.ctx.request;
+		request.request.headers[InertiaHeaders.PartialComponent] = component;
+		return {
+			only(props) {
+				request.request.headers[InertiaHeaders.PartialOnly] = props.join(",");
+				return this;
+			},
+			except(props) {
+				request.request.headers[InertiaHeaders.PartialExcept] = props.join(",");
+				return this;
+			},
+			reset(props) {
+				request.request.headers[InertiaHeaders.Reset] = props.join(",");
+				return this;
+			},
+			create() {
+				return self.create();
+			}
+		};
+	}
+	withVersion(version) {
+		this.#parameters.config = {
+			...this.#parameters.config,
+			assetsVersion: version
+		};
+		return this;
+	}
+	withVite(options) {
+		this.#vite = options;
+		return this;
+	}
+	create() {
+		return new Inertia(this.#parameters.ctx, this.#parameters.config, this.#vite, this.#vite ? new ServerRenderer(this.#parameters.config, this.#vite) : void 0);
+	}
 };
+export { InertiaFactory };

package/build/headers-DafWEpBh.js

@@ -0,0 +1,11 @@
+const InertiaHeaders = {
+	Inertia: "x-inertia",
+	Reset: "x-inertia-reset",
+	Version: "x-inertia-version",
+	Location: "x-inertia-location",
+	ErrorBag: "x-inertia-error-bag",
+	PartialOnly: "x-inertia-partial-data",
+	PartialExcept: "x-inertia-partial-except",
+	PartialComponent: "x-inertia-partial-component"
+};
+export { InertiaHeaders as t };

package/build/index.js

@@ -1,24 +1,5 @@
-import {
-  defineConfig,
-  indexPages
-} from "./chunk-5QRJHXXQ.js";
-import {
-  Inertia,
-  InertiaManager,
-  ServerRenderer,
-  symbols_exports
-} from "./chunk-XXMTGYB5.js";
-import {
-  InertiaHeaders
-} from "./chunk-DISC5OYC.js";
-import "./chunk-4EZ2J6OA.js";
-import "./chunk-MLKGABMK.js";
-export {
-  Inertia,
-  InertiaHeaders,
-  InertiaManager,
-  ServerRenderer,
-  defineConfig,
-  indexPages,
-  symbols_exports as symbols
-};
+import { i as symbols_exports, n as ServerRenderer, r as Inertia, t as InertiaManager } from "./inertia_manager-Ra2dhBKa.js";
+import { t as InertiaHeaders } from "./headers-DafWEpBh.js";
+import "./debug-CBMTuPUm.js";
+import { n as indexPages, t as defineConfig } from "./define_config-O1Y9QfzM.js";
+export { Inertia, InertiaHeaders, InertiaManager, ServerRenderer, defineConfig, indexPages, symbols_exports as symbols };