@vantail/vite 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The Vite plugin.
+ *
+ * `vantail dev` and `vantail build` apply this automatically, so a project does
+ * not need a `vite.config.ts` at all. Add it by hand when you already have
+ * one and want the same defaults:
+ *
+ * ```ts
+ * import { defineConfig } from "vite";
+ * import vantail from "@vantail/vite";
+ *
+ * export default defineConfig({ plugins: [vantail()] });
+ * ```
+ *
+ * It does four small things: point the build output at the `distDir` from
+ * `vantail.config.ts`, target the engines a webview actually has, expose the
+ * app's identity to application code, and warn when the page is opened in a
+ * normal browser where the native APIs cannot work.
+ */
+import { type ParsedConfig } from "@vantail/shared/load";
+import type { Plugin } from "vite";
+export interface VantailPluginOptions {
+    /** Path to `vantail.config.ts`. Found automatically when omitted. */
+    config?: string;
+    /**
+     * A config that has already been loaded. `@vantail/cli` passes this so the
+     * config is not read and validated twice.
+     */
+    resolved?: {
+        config: ParsedConfig;
+        root: string;
+    };
+}
+/**
+ * Browser engines a Vantail app can actually run on: WKWebView on macOS,
+ * WebView2 on Windows, WebKitGTK on Linux. Pinned rather than left to Vite's
+ * default so a build cannot silently start emitting syntax that the oldest
+ * supported webview rejects.
+ */
+export declare const WEBVIEW_TARGETS: string[];
+export default function vantail(options?: VantailPluginOptions): Plugin;
+export { vantail };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAc,KAAK,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,MAAM,EAAc,MAAM,MAAM,CAAC;AAE/C,MAAM,WAAW,oBAAoB;IACnC,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,MAAM,EAAE,YAAY,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CACnD;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,UAAsC,CAAC;AAEnE,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,GAAE,oBAAyB,GAAG,MAAM,CA4D1E;AAaD,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,95 @@
+/**
+ * The Vite plugin.
+ *
+ * `vantail dev` and `vantail build` apply this automatically, so a project does
+ * not need a `vite.config.ts` at all. Add it by hand when you already have
+ * one and want the same defaults:
+ *
+ * ```ts
+ * import { defineConfig } from "vite";
+ * import vantail from "@vantail/vite";
+ *
+ * export default defineConfig({ plugins: [vantail()] });
+ * ```
+ *
+ * It does four small things: point the build output at the `distDir` from
+ * `vantail.config.ts`, target the engines a webview actually has, expose the
+ * app's identity to application code, and warn when the page is opened in a
+ * normal browser where the native APIs cannot work.
+ */
+import { loadConfig } from "@vantail/shared/load";
+/**
+ * Browser engines a Vantail app can actually run on: WKWebView on macOS,
+ * WebView2 on Windows, WebKitGTK on Linux. Pinned rather than left to Vite's
+ * default so a build cannot silently start emitting syntax that the oldest
+ * supported webview rejects.
+ */
+export const WEBVIEW_TARGETS = ["es2022", "safari16", "chrome110"];
+export default function vantail(options = {}) {
+    let resolved = options.resolved;
+    return {
+        name: "vantail",
+        async config(userConfig) {
+            if (!resolved) {
+                const loaded = await loadConfig({
+                    cwd: userConfig.root ?? process.cwd(),
+                    ...(options.config ? { path: options.config } : {}),
+                });
+                resolved = { config: loaded.config, root: loaded.root };
+            }
+            const { app, distDir } = resolved.config;
+            return {
+                // The custom protocol serves the resource directory as its root, so
+                // absolute asset URLs resolve exactly as they do on a web server.
+                base: "/",
+                clearScreen: false,
+                envPrefix: ["VITE_", "VANTAIL_"],
+                build: {
+                    outDir: distDir ?? "dist",
+                    target: WEBVIEW_TARGETS,
+                    emptyOutDir: true,
+                },
+                server: {
+                    // A moved port would leave the runtime pointing at nothing.
+                    strictPort: true,
+                    host: "127.0.0.1",
+                },
+                define: {
+                    "import.meta.env.VANTAIL_APP_NAME": JSON.stringify(app.name),
+                    "import.meta.env.VANTAIL_APP_VERSION": JSON.stringify(app.version ?? "0.0.0"),
+                    "import.meta.env.VANTAIL_APP_IDENTIFIER": JSON.stringify(app.identifier),
+                },
+            };
+        },
+        transformIndexHtml: {
+            order: "pre",
+            handler(html, ctx) {
+                // Dev only: opening http://localhost:5173 in Chrome is a normal thing
+                // to do by accident, and the failure is otherwise mystifying.
+                if (!ctx.server || html.includes(NOTICE_MARKER))
+                    return html;
+                return {
+                    html,
+                    tags: [
+                        {
+                            tag: "script",
+                            injectTo: "head-prepend",
+                            children: BROWSER_NOTICE,
+                        },
+                    ],
+                };
+            },
+        },
+    };
+}
+const NOTICE_MARKER = "[vantail] No native runtime detected";
+const BROWSER_NOTICE = `
+if (!window.__VANTAIL__) {
+  console.warn(
+    "[vantail] No native runtime detected. Native APIs will throw NO_RUNTIME.\\n" +
+    "This page is meant to be opened by \`vantail dev\`, not in a browser tab."
+  );
+}
+`.trim();
+export { vantail };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,UAAU,EAAqB,MAAM,sBAAsB,CAAC;AAarE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;AAEnE,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,GAAyB,EAAE;IAChE,IAAI,QAAQ,GAAuD,OAAO,CAAC,QAAQ,CAAC;IAEpF,OAAO;QACL,IAAI,EAAE,SAAS;QAEf,KAAK,CAAC,MAAM,CAAC,UAAsB;YACjC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;oBAC9B,GAAG,EAAE,UAAU,CAAC,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE;oBACrC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACpD,CAAC,CAAC;gBACH,QAAQ,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;YAC1D,CAAC;YAED,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC;YAEzC,OAAO;gBACL,oEAAoE;gBACpE,kEAAkE;gBAClE,IAAI,EAAE,GAAG;gBACT,WAAW,EAAE,KAAK;gBAClB,SAAS,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;gBAChC,KAAK,EAAE;oBACL,MAAM,EAAE,OAAO,IAAI,MAAM;oBACzB,MAAM,EAAE,eAAe;oBACvB,WAAW,EAAE,IAAI;iBAClB;gBACD,MAAM,EAAE;oBACN,4DAA4D;oBAC5D,UAAU,EAAE,IAAI;oBAChB,IAAI,EAAE,WAAW;iBAClB;gBACD,MAAM,EAAE;oBACN,kCAAkC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC;oBAC5D,qCAAqC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC;oBAC7E,wCAAwC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC;iBACzE;aACF,CAAC;QACJ,CAAC;QAED,kBAAkB,EAAE;YAClB,KAAK,EAAE,KAAK;YACZ,OAAO,CAAC,IAAY,EAAE,GAAyB;gBAC7C,sEAAsE;gBACtE,8DAA8D;gBAC9D,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;oBAAE,OAAO,IAAI,CAAC;gBAC7D,OAAO;oBACL,IAAI;oBACJ,IAAI,EAAE;wBACJ;4BACE,GAAG,EAAE,QAAQ;4BACb,QAAQ,EAAE,cAAuB;4BACjC,QAAQ,EAAE,cAAc;yBACzB;qBACF;iBACF,CAAC;YACJ,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,aAAa,GAAG,sCAAsC,CAAC;AAE7D,MAAM,cAAc,GAAG;;;;;;;CAOtB,CAAC,IAAI,EAAE,CAAC;AAET,OAAO,EAAE,OAAO,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@vantail/vite",
+  "version": "0.1.0",
+  "description": "Vite plugin for Vantail applications.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Vantail/vantail.git",
+    "directory": "packages/vite"
+  },
+  "homepage": "https://github.com/Vantail/vantail",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@vantail/shared": "^0.1.0"
+  },
+  "peerDependencies": {
+    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "devDependencies": {
+    "vite": "^8.0.0"
+  }
+}