@hybridly/vite 0.0.1-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Anthony Fu <https://github.com/antfu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,186 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const path = require('node:path');
+const vite = require('vite');
+const makeDebugger = require('debug');
+const fs = require('node:fs');
+const throttleDebounce = require('throttle-debounce');
+const node_child_process = require('node:child_process');
+const node_util = require('node:util');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+
+const path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+const makeDebugger__default = /*#__PURE__*/_interopDefaultLegacy(makeDebugger);
+const fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+const ROUTER_PLUGIN_NAME = "vite:hybridly:router";
+const ROUTER_HMR_UPDATE_ROUTE = "hybridly:routes:update";
+const ROUTER_VIRTUAL_MODULE_ID = "virtual:hybridly/router";
+const RESOLVED_ROUTER_VIRTUAL_MODULE_ID = `\0${ROUTER_VIRTUAL_MODULE_ID}`;
+const LAYOUT_PLUGIN_NAME = "vite:hybridly:layout";
+
+const debug = {
+  router: makeDebugger__default(ROUTER_PLUGIN_NAME),
+  layout: makeDebugger__default(LAYOUT_PLUGIN_NAME)
+};
+
+const TEMPLATE_LAYOUT_REGEX = /<template +layout(?: *= *['"](?:(?:(\w+):)?(\w+))['"] *)?>/;
+const TYPESCRIPT_REGEX = /lang=['"]ts['"]/;
+const layout = (options = {}) => {
+  const base = options?.directory ? options?.directory : path__default.resolve(process.cwd(), "resources", "views", "layouts");
+  const layoutPath = options?.resolve ? options.resolve : (layoutName) => vite.normalizePath(path__default.resolve(base, `${layoutName ?? "default"}.vue`)).replaceAll("\\", "/");
+  debug.layout("Registered layout path:", base);
+  return {
+    name: LAYOUT_PLUGIN_NAME,
+    transform: (code, id) => {
+      if (!TEMPLATE_LAYOUT_REGEX.test(code)) {
+        return;
+      }
+      return code.replace(TEMPLATE_LAYOUT_REGEX, (_, __, layoutName) => {
+        const isTypeScript = TYPESCRIPT_REGEX.test(code);
+        const importPath = layoutPath(layoutName);
+        debug.layout(`Resolved layout "${layoutName}":`, {
+          sourceFile: id,
+          importPath
+        });
+        return `
+					<script${isTypeScript ? ' lang="ts"' : ""}>
+					import layout from '${importPath}'
+					export default { layout }
+					<\/script>
+					<template>
+				`;
+      });
+    }
+  };
+};
+
+function getClientCode(routes) {
+  return `
+		if (typeof window !== 'undefined') {
+			window.hybridly = {
+				routes: ${JSON.stringify(routes)}
+			}
+	
+			if (import.meta.hot) {
+				import.meta.hot.on('${ROUTER_HMR_UPDATE_ROUTE}', (routes) => {
+					window.dispatchEvent(
+						new CustomEvent('hybridly:routes', { detail: routes })
+					)
+				})
+			}
+		}
+ `;
+}
+
+const shell = node_util.promisify(node_child_process.exec);
+async function fetchRoutesFromArtisan(options) {
+  const php = options.php ?? "php";
+  const result = await shell(`${php} artisan hybridly:routes`);
+  const routes = JSON.parse(result.stdout);
+  write(options, routes);
+  return routes;
+}
+
+const write = throttleDebounce.debounce(1e3, writeDefinitions, { atBegin: true });
+async function writeDefinitions(options, collection) {
+  collection ?? (collection = await fetchRoutesFromArtisan(options));
+  if (options.dts === false) {
+    return;
+  }
+  debug.router("Writing types for route collection:", collection);
+  const target = path__default.resolve(options.dts ?? "resources/types/routes.d.ts");
+  const routes = Object.fromEntries(Object.entries(collection.routes).map(([key, route]) => {
+    const bindings = route.bindings ? Object.fromEntries(Object.entries(route.bindings).map(([key2]) => [key2, "__key_placeholder__"])) : void 0;
+    return [key, {
+      ...route.uri ? { uri: route.uri } : {},
+      ...route.domain ? { domain: route.domain } : {},
+      ...route.wheres ? { wheres: route.wheres } : {},
+      ...route.bindings ? { bindings } : {}
+    }];
+  }));
+  const definitions = generateDefinitions().replace("__URL__", collection?.url ?? "").replace("__ROUTES__", JSON.stringify(routes).replaceAll('"__key_placeholder__"', "any"));
+  fs__default.writeFileSync(target, definitions, { encoding: "utf-8" });
+}
+function generateDefinitions() {
+  return `
+// This file has been automatically generated by Hybridly
+// Modifications will be discarded
+// It is recommended to add it in your .gitignore
+
+declare module 'hybridly/vue' {
+	export interface GlobalRouteCollection {
+		url: '__URL__'
+		routes: __ROUTES__
+	}
+}
+
+export {}`;
+}
+
+const router = (options = {}) => {
+  const resolved = {
+    php: "php",
+    dts: "resources/types/routes.d.ts",
+    watch: [
+      /routes\/.*\.php/
+    ],
+    ...options
+  };
+  let previousRoutes;
+  return {
+    name: ROUTER_PLUGIN_NAME,
+    configureServer(server) {
+      write(resolved);
+      server.watcher.on("change", async (path) => {
+        if (!resolved.watch.some((regex) => regex.test(path))) {
+          return;
+        }
+        const routes = await fetchRoutesFromArtisan(resolved);
+        if (JSON.stringify(routes) !== JSON.stringify(previousRoutes)) {
+          debug.router("Updating routes via HMR:", routes);
+          server.ws.send({
+            type: "custom",
+            event: ROUTER_HMR_UPDATE_ROUTE,
+            data: routes
+          });
+          write(resolved);
+          previousRoutes = routes;
+        }
+      });
+    },
+    resolveId(id) {
+      if (id === ROUTER_VIRTUAL_MODULE_ID) {
+        return RESOLVED_ROUTER_VIRTUAL_MODULE_ID;
+      }
+    },
+    async load(id) {
+      if (id === RESOLVED_ROUTER_VIRTUAL_MODULE_ID) {
+        const routes = await fetchRoutesFromArtisan(resolved);
+        return getClientCode(routes);
+      }
+    },
+    async handleHotUpdate(ctx) {
+      if (typeof resolved.dts === "string" && ctx.file.endsWith(resolved.dts)) {
+        return [];
+      }
+    },
+    transform() {
+      write(resolved);
+    }
+  };
+};
+
+function plugin(options = {}) {
+  return [
+    options.layout !== false && layout(options.layout),
+    options.router !== false && router(options.router)
+  ];
+}
+
+exports["default"] = plugin;
+exports.layout = layout;
+exports.router = router;

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { Plugin, PluginOption } from 'vite';
+
+interface Options {
+    /** Options for the layout plugin. */
+    layout?: false | LayoutOptions;
+    /** Options for the router plugin. */
+    router?: false | RouterOptions;
+}
+interface LayoutOptions {
+    /** The directory in which layouts are stored. */
+    directory?: string;
+    /** Function that resolves the layout path given its name. */
+    resolve?: (layout: string) => string;
+}
+interface RouterOptions {
+    /** Path to the PHP executable. */
+    php?: string;
+    /** Path to definition file. */
+    dts?: false | string;
+    /** File patterns to watch. */
+    watch?: RegExp[];
+}
+
+/**
+ * A basic Vite plugin that adds a <template layout="name"> syntax to Vite SFCs.
+ * It must be used before the Vue plugin.
+ */
+declare const _default$1: (options?: LayoutOptions) => Plugin;
+
+/**
+ * A basic Vite plugin that adds a <template layout="name"> syntax to Vite SFCs.
+ * It must be used before the Vue plugin.
+ */
+declare const _default: (options?: RouterOptions) => Plugin;
+
+/** Registers `unplugin-vue-define-options`. */
+declare function plugin(options?: Options): PluginOption[];
+
+export { Options, plugin as default, _default$1 as layout, _default as router };

package/dist/index.mjs

@@ -0,0 +1,174 @@
+import path from 'node:path';
+import { normalizePath } from 'vite';
+import makeDebugger from 'debug';
+import fs from 'node:fs';
+import { debounce } from 'throttle-debounce';
+import { exec } from 'node:child_process';
+import { promisify } from 'node:util';
+
+const ROUTER_PLUGIN_NAME = "vite:hybridly:router";
+const ROUTER_HMR_UPDATE_ROUTE = "hybridly:routes:update";
+const ROUTER_VIRTUAL_MODULE_ID = "virtual:hybridly/router";
+const RESOLVED_ROUTER_VIRTUAL_MODULE_ID = `\0${ROUTER_VIRTUAL_MODULE_ID}`;
+const LAYOUT_PLUGIN_NAME = "vite:hybridly:layout";
+
+const debug = {
+  router: makeDebugger(ROUTER_PLUGIN_NAME),
+  layout: makeDebugger(LAYOUT_PLUGIN_NAME)
+};
+
+const TEMPLATE_LAYOUT_REGEX = /<template +layout(?: *= *['"](?:(?:(\w+):)?(\w+))['"] *)?>/;
+const TYPESCRIPT_REGEX = /lang=['"]ts['"]/;
+const layout = (options = {}) => {
+  const base = options?.directory ? options?.directory : path.resolve(process.cwd(), "resources", "views", "layouts");
+  const layoutPath = options?.resolve ? options.resolve : (layoutName) => normalizePath(path.resolve(base, `${layoutName ?? "default"}.vue`)).replaceAll("\\", "/");
+  debug.layout("Registered layout path:", base);
+  return {
+    name: LAYOUT_PLUGIN_NAME,
+    transform: (code, id) => {
+      if (!TEMPLATE_LAYOUT_REGEX.test(code)) {
+        return;
+      }
+      return code.replace(TEMPLATE_LAYOUT_REGEX, (_, __, layoutName) => {
+        const isTypeScript = TYPESCRIPT_REGEX.test(code);
+        const importPath = layoutPath(layoutName);
+        debug.layout(`Resolved layout "${layoutName}":`, {
+          sourceFile: id,
+          importPath
+        });
+        return `
+					<script${isTypeScript ? ' lang="ts"' : ""}>
+					import layout from '${importPath}'
+					export default { layout }
+					<\/script>
+					<template>
+				`;
+      });
+    }
+  };
+};
+
+function getClientCode(routes) {
+  return `
+		if (typeof window !== 'undefined') {
+			window.hybridly = {
+				routes: ${JSON.stringify(routes)}
+			}
+	
+			if (import.meta.hot) {
+				import.meta.hot.on('${ROUTER_HMR_UPDATE_ROUTE}', (routes) => {
+					window.dispatchEvent(
+						new CustomEvent('hybridly:routes', { detail: routes })
+					)
+				})
+			}
+		}
+ `;
+}
+
+const shell = promisify(exec);
+async function fetchRoutesFromArtisan(options) {
+  const php = options.php ?? "php";
+  const result = await shell(`${php} artisan hybridly:routes`);
+  const routes = JSON.parse(result.stdout);
+  write(options, routes);
+  return routes;
+}
+
+const write = debounce(1e3, writeDefinitions, { atBegin: true });
+async function writeDefinitions(options, collection) {
+  collection ?? (collection = await fetchRoutesFromArtisan(options));
+  if (options.dts === false) {
+    return;
+  }
+  debug.router("Writing types for route collection:", collection);
+  const target = path.resolve(options.dts ?? "resources/types/routes.d.ts");
+  const routes = Object.fromEntries(Object.entries(collection.routes).map(([key, route]) => {
+    const bindings = route.bindings ? Object.fromEntries(Object.entries(route.bindings).map(([key2]) => [key2, "__key_placeholder__"])) : void 0;
+    return [key, {
+      ...route.uri ? { uri: route.uri } : {},
+      ...route.domain ? { domain: route.domain } : {},
+      ...route.wheres ? { wheres: route.wheres } : {},
+      ...route.bindings ? { bindings } : {}
+    }];
+  }));
+  const definitions = generateDefinitions().replace("__URL__", collection?.url ?? "").replace("__ROUTES__", JSON.stringify(routes).replaceAll('"__key_placeholder__"', "any"));
+  fs.writeFileSync(target, definitions, { encoding: "utf-8" });
+}
+function generateDefinitions() {
+  return `
+// This file has been automatically generated by Hybridly
+// Modifications will be discarded
+// It is recommended to add it in your .gitignore
+
+declare module 'hybridly/vue' {
+	export interface GlobalRouteCollection {
+		url: '__URL__'
+		routes: __ROUTES__
+	}
+}
+
+export {}`;
+}
+
+const router = (options = {}) => {
+  const resolved = {
+    php: "php",
+    dts: "resources/types/routes.d.ts",
+    watch: [
+      /routes\/.*\.php/
+    ],
+    ...options
+  };
+  let previousRoutes;
+  return {
+    name: ROUTER_PLUGIN_NAME,
+    configureServer(server) {
+      write(resolved);
+      server.watcher.on("change", async (path) => {
+        if (!resolved.watch.some((regex) => regex.test(path))) {
+          return;
+        }
+        const routes = await fetchRoutesFromArtisan(resolved);
+        if (JSON.stringify(routes) !== JSON.stringify(previousRoutes)) {
+          debug.router("Updating routes via HMR:", routes);
+          server.ws.send({
+            type: "custom",
+            event: ROUTER_HMR_UPDATE_ROUTE,
+            data: routes
+          });
+          write(resolved);
+          previousRoutes = routes;
+        }
+      });
+    },
+    resolveId(id) {
+      if (id === ROUTER_VIRTUAL_MODULE_ID) {
+        return RESOLVED_ROUTER_VIRTUAL_MODULE_ID;
+      }
+    },
+    async load(id) {
+      if (id === RESOLVED_ROUTER_VIRTUAL_MODULE_ID) {
+        const routes = await fetchRoutesFromArtisan(resolved);
+        return getClientCode(routes);
+      }
+    },
+    async handleHotUpdate(ctx) {
+      if (typeof resolved.dts === "string" && ctx.file.endsWith(resolved.dts)) {
+        return [];
+      }
+    },
+    transform() {
+      write(resolved);
+    }
+  };
+};
+
+function plugin(options = {}) {
+  return [
+    options.layout !== false && layout(options.layout),
+    options.router !== false && router(options.router)
+  ];
+}
+
+export { plugin as default, layout, router };

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@hybridly/vite",
+  "version": "0.0.1-alpha.1",
+  "description": "A solution to develop server-driven, client-rendered applications",
+  "keywords": [
+    "hybridly",
+    "inertiajs",
+    "vite",
+    "vite-plugin"
+  ],
+  "homepage": "https://github.com/hybridly/hybridly/tree/main/packages/vite#readme",
+  "bugs": {
+    "url": "https://github.com/hybridly/hybridly/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hybridly/hybridly.git",
+    "directory": "packages/vite"
+  },
+  "funding": "https://github.com/sponsors/innocenzi",
+  "author": "Enzo Innocenzi <enzo@innocenzi.dev>",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "*.d.ts"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "peerDependencies": {
+    "vue": "^3.2.33"
+  },
+  "dependencies": {
+    "@hybridly/core": "0.0.1-alpha.1",
+    "throttle-debounce": "^5.0.0"
+  },
+  "devDependencies": {
+    "rollup": "^2.79.1",
+    "vite": "^3.1.7",
+    "vue": "^3.2.40"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "stub": "unbuild --stub"
+  }
+}