@arkstack/inertia 0.15.1 → 0.15.3

package/README.md

@@ -0,0 +1,65 @@
+# @arkstack/inertia
+
+[![@arkstack/inertia](https://img.shields.io/npm/dt/@arkstack/inertia?style=flat-square&label=@arkstack/inertia&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F@arkstack/inertia)](https://www.npmjs.com/package/@arkstack/inertia)
+
+A runtime-agnostic [InertiaJS](https://inertiajs.com) server-side adapter for Arkstack. Build a single-page app (Vue, React, or Svelte) without an API: controllers return page components and props, and Inertia handles client-side routing. Works with both the Express and H3 drivers.
+
+## Install
+
+```sh
+pnpm add @arkstack/inertia
+```
+
+Then register the middleware in `src/config/middleware.ts` under `before` (alongside `resora()`):
+
+```ts
+import { inertia, resora } from '@arkstack/driver-express/middlewares' // or @arkstack/driver-h3/middlewares
+
+export default (): MiddlewareConfig => ({
+  before: [resora(), inertia()],
+})
+```
+
+Publish the config and root template:
+
+```sh
+ark publish --package @arkstack/inertia
+```
+
+## Usage
+
+```ts
+import { inertia, Inertia } from '@arkstack/inertia'
+
+// Render a page — JSON page object on Inertia visits, full HTML on first load
+return inertia('Users/Index', { users: await User.all() })
+
+// Shared props (global at boot, or request-scoped inside a handler)
+inertia().share('appName', config('app.name'))
+
+// Partial-reload helpers
+inertia('Users/Index', {
+  users: await User.all(),
+  stats: Inertia.lazy(() => expensiveStats()),   // only on a partial reload that asks for it
+  chart: Inertia.defer(() => buildChart()),       // fetched by the client after load
+  auth: Inertia.always({ user: request.user }),   // always present, even on partials
+})
+
+// Redirects (302 -> 303 for PUT/PATCH/DELETE) and external/full-page visits
+Inertia.redirect('/users')
+Inertia.location('https://example.com')
+```
+
+## Server-side rendering
+
+Set `ssr.enabled` in `src/config/inertia.ts`, build an SSR bundle, and run it with the supervised command:
+
+```sh
+ark inertia:ssr   # runs dist-ssr/ssr.js, restarting it if it crashes
+```
+
+The initial visit is then server-rendered and the client hydrates it; if the SSR server is unreachable the adapter falls back to client-side rendering.
+
+## Documentation
+
+See the [Inertia guide](https://arkstack.toneflix.net/guide/inertia) for the full setup, partial reloads, asset versioning, configuration, and SSR.

package/dist/commands/InertiaSsrCommand.js

@@ -1,4 +1,4 @@
-import { n as resolveSsrBundle, o as inertiaConfig, r as superviseProcess } from "../ssr-process-DkRTrGvf.js";
+import { n as resolveSsrBundle, o as inertiaConfig, r as superviseProcess } from "../ssr-process-C6QRQAaQ.js";
 import { Arkstack } from "@arkstack/contract";
 import { Command } from "@h3ravel/musket";
 import { existsSync } from "node:fs";

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Response } from "@arkstack/http";
+import { ViewFactory } from "@arkstack/view";
 
 //#region src/types.d.ts
 /**
@@ -264,6 +265,23 @@ declare const builtInTemplate: (mount: string, head?: string) => string;
  */
 declare const renderRootHtml: (page: InertiaPage, config: InertiaConfig) => Promise<string>;
 //#endregion
+//#region src/tags.d.ts
+/**
+ * Register the `@inertia` and `@inertiaHead` Edge tags on a view factory.
+ *
+ * - `@inertia` renders the root mount element (`<div data-page="…">`), or the
+ *   server-rendered markup when SSR is enabled.
+ * - `@inertiaHead` renders the SSR head tags (empty without SSR).
+ *
+ * Both read the values the adapter passes to the root template, so they replace
+ * the equivalent `{{{ inertia }}}` / `{{{ inertiaHead }}}` interpolations.
+ * Idempotent per factory.
+ *
+ * @param factory
+ * @returns
+ */
+declare const registerInertiaTags: (factory: ViewFactory) => void;
+//#endregion
 //#region src/ssr.d.ts
 /** The default address the Inertia SSR server listens on. */
 declare const DEFAULT_SSR_URL = "http://127.0.0.1:13714/render";
@@ -374,4 +392,4 @@ declare const SEE_OTHER_METHODS: Set<string>;
  */
 declare const shouldUpgradeRedirect: (method: string, status: number) => boolean;
 //#endregion
-export { AlwaysProp, AlwaysPropContract, DEFAULT_SSR_BUNDLE, DEFAULT_SSR_URL, DeferProp, DeferPropContract, Inertia, InertiaConfig, InertiaPage, InertiaPropWrapper, InertiaRequest, type InertiaStore, LazyProp, LazyPropContract, PageProps, SEE_OTHER_METHODS, type SsrProcessController, type SsrResponse, type SuperviseOptions, builtInTemplate, configure, currentStore, defaultConfig, escapeHtmlAttribute, flushShared, inertia, inertiaConfig, isAlwaysProp, isDeferProp, isLazyProp, isPropWrapper, renderDataPage, renderRootHtml, renderViaSsr, resetConfig, resolveProps, resolveSsrBundle, resolveVersion, runInertia, setVersion, shareData, sharedData, shouldUpgradeRedirect, superviseProcess };
+export { AlwaysProp, AlwaysPropContract, DEFAULT_SSR_BUNDLE, DEFAULT_SSR_URL, DeferProp, DeferPropContract, Inertia, InertiaConfig, InertiaPage, InertiaPropWrapper, InertiaRequest, type InertiaStore, LazyProp, LazyPropContract, PageProps, SEE_OTHER_METHODS, type SsrProcessController, type SsrResponse, type SuperviseOptions, builtInTemplate, configure, currentStore, defaultConfig, escapeHtmlAttribute, flushShared, inertia, inertiaConfig, isAlwaysProp, isDeferProp, isLazyProp, isPropWrapper, registerInertiaTags, renderDataPage, renderRootHtml, renderViaSsr, resetConfig, resolveProps, resolveSsrBundle, resolveVersion, runInertia, setVersion, shareData, sharedData, shouldUpgradeRedirect, superviseProcess };

package/dist/index.js

@@ -1,4 +1,5 @@
-import { a as defaultConfig, c as resolveVersion, i as configure, l as setVersion, n as resolveSsrBundle, o as inertiaConfig, r as superviseProcess, s as resetConfig, t as DEFAULT_SSR_BUNDLE } from "./ssr-process-DkRTrGvf.js";
+import { t as registerInertiaTags } from "./tags-DpBq4bSL.js";
+import { a as defaultConfig, c as resolveVersion, i as configure, l as setVersion, n as resolveSsrBundle, o as inertiaConfig, r as superviseProcess, s as resetConfig, t as DEFAULT_SSR_BUNDLE } from "./ssr-process-C6QRQAaQ.js";
 import { AsyncLocalStorage } from "node:async_hooks";
 import { Response } from "@arkstack/http";
 //#region src/props.ts
@@ -191,7 +192,10 @@ const renderRootHtml = async (page, config) => {
 	}
 	try {
 		const { view } = await import("@arkstack/view");
-		if (view().exists(config.root_view)) return await view(config.root_view, {
+		const { registerInertiaTags } = await import("./tags-DpBq4bSL.js").then((n) => n.n);
+		const factory = view();
+		registerInertiaTags(factory);
+		if (factory.exists(config.root_view)) return await view(config.root_view, {
 			page,
 			inertia: mount,
 			inertiaHead: head
@@ -391,4 +395,4 @@ function inertia(component, props = {}) {
 	return Inertia.render(component, props);
 }
 //#endregion
-export { AlwaysProp, DEFAULT_SSR_BUNDLE, DEFAULT_SSR_URL, DeferProp, Inertia, LazyProp, SEE_OTHER_METHODS, builtInTemplate, configure, currentStore, defaultConfig, escapeHtmlAttribute, flushShared, inertia, inertiaConfig, isAlwaysProp, isDeferProp, isLazyProp, isPropWrapper, renderDataPage, renderRootHtml, renderViaSsr, resetConfig, resolveProps, resolveSsrBundle, resolveVersion, runInertia, setVersion, shareData, sharedData, shouldUpgradeRedirect, superviseProcess };
+export { AlwaysProp, DEFAULT_SSR_BUNDLE, DEFAULT_SSR_URL, DeferProp, Inertia, LazyProp, SEE_OTHER_METHODS, builtInTemplate, configure, currentStore, defaultConfig, escapeHtmlAttribute, flushShared, inertia, inertiaConfig, isAlwaysProp, isDeferProp, isLazyProp, isPropWrapper, registerInertiaTags, renderDataPage, renderRootHtml, renderViaSsr, resetConfig, resolveProps, resolveSsrBundle, resolveVersion, runInertia, setVersion, shareData, sharedData, shouldUpgradeRedirect, superviseProcess };

package/dist/tags-DpBq4bSL.js

@@ -0,0 +1,51 @@
+//#region \0rolldown/runtime.js
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+//#endregion
+//#region src/tags.ts
+var tags_exports = /* @__PURE__ */ __exportAll({ registerInertiaTags: () => registerInertiaTags });
+/** Factories that already have the Inertia tags registered. */
+const registered = /* @__PURE__ */ new WeakSet();
+/**
+* Build an Edge tag compiler that outputs a template data variable raw (falling
+* back to an empty string when it is absent).
+* 
+* @param name 
+* @returns 
+*/
+const outputVariable = (name) => {
+	return (parser, buffer, token) => {
+		const ast = parser.utils.transformAst(parser.utils.generateAST(`${name} || ""`, token.loc, token.filename), token.filename, parser);
+		buffer.outputExpression(parser.utils.stringify(ast), token.filename, token.loc.start.line, false);
+	};
+};
+/**
+* Register the `@inertia` and `@inertiaHead` Edge tags on a view factory.
+*
+* - `@inertia` renders the root mount element (`<div data-page="…">`), or the
+*   server-rendered markup when SSR is enabled.
+* - `@inertiaHead` renders the SSR head tags (empty without SSR).
+*
+* Both read the values the adapter passes to the root template, so they replace
+* the equivalent `{{{ inertia }}}` / `{{{ inertiaHead }}}` interpolations.
+* Idempotent per factory.
+* 
+* @param factory 
+* @returns 
+*/
+const registerInertiaTags = (factory) => {
+	if (registered.has(factory)) return;
+	registered.add(factory);
+	factory.tag("inertia", false, false, outputVariable("inertia"));
+	factory.tag("inertiaHead", false, false, outputVariable("inertiaHead"));
+};
+//#endregion
+export { tags_exports as n, registerInertiaTags as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/inertia",
-  "version": "0.15.1",
+  "version": "0.15.3",
   "type": "module",
   "description": "InertiaJS server-side adapter for Arkstack, building the modern monolith with server-driven SPAs.",
   "homepage": "https://arkstack.toneflix.net/guide/inertia",
@@ -33,13 +33,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/common": "^0.15.1"
+    "@arkstack/common": "^0.15.3"
   },
   "peerDependencies": {
     "@h3ravel/musket": "^2.2.1",
-    "@arkstack/contract": "^0.15.1",
-    "@arkstack/http": "^0.15.1",
-    "@arkstack/view": "^0.15.1"
+    "@arkstack/contract": "^0.15.3",
+    "@arkstack/http": "^0.15.3",
+    "@arkstack/view": "^0.15.3"
   },
   "peerDependenciesMeta": {
     "@arkstack/view": {

package/stubs/config/inertia.ts.stub

@@ -1,5 +1,5 @@
-import type { InertiaConfig } from '@arkstack/inertia';
-import { env } from '@arkstack/common';
+import type { InertiaConfig } from '@arkstack/inertia'
+import { env } from '@arkstack/common'
 
 /**
  * Inertia adapter configuration.
@@ -36,5 +36,5 @@ export default (): InertiaConfig => {
       url: env('INERTIA_SSR_URL', 'http://127.0.0.1:13714/render'),
       bundle: 'dist-ssr/ssr.js',
     },
-  };
-};
+  }
+}

package/stubs/views/app.edge.stub

@@ -3,12 +3,10 @@
 <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    {{{ inertiaHead }}}
-    {{-- Replace with your Vite client + entry tags, e.g.: --}}
-    {{-- <script type="module" src="http://localhost:5173/@@vite/client"></script> --}}
-    {{-- <script type="module" src="http://localhost:5173/src/main.ts"></script> --}}
+    @inertiaHead
+    @vite('resources/js/app.ts')
 </head>
 <body>
-    {{{ inertia }}}
+    @inertia
 </body>
 </html>