npm - @ethisyscore/vite-plugin - Versions diffs - 1.0.0-alpha.12 - Mend

@ethisyscore/vite-plugin 1.0.0-alpha.12

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 (5) hide show

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,237 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ethisysManifestPlugin: () => ethisysManifestPlugin
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_fs = require("fs");
+var import_node_path = require("path");
+function slash(p) {
+  return import_node_path.sep === "\\" ? p.replace(/\\/g, "/") : p;
+}
+function escapeHtml(str) {
+  return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+}
+function ethisysManifestPlugin(options = {}) {
+  const manifestRelPath = options.manifestPath ?? "../extension.manifest.json";
+  const mountId = options.mountId ?? "root";
+  let entries = [];
+  let rootDir;
+  let manifestAbsPath;
+  function generateHtml(entry) {
+    if (entry.template) {
+      const templatePath = (0, import_node_path.resolve)(rootDir, entry.template);
+      if ((0, import_node_fs.existsSync)(templatePath)) {
+        let html = (0, import_node_fs.readFileSync)(templatePath, "utf-8");
+        const mountPattern = new RegExp(`id=["']${mountId}["']`);
+        if (!mountPattern.test(html)) {
+          throw new Error(
+            `[ethisys-manifest] Custom template "${entry.template}" must contain an element with id="${mountId}".`
+          );
+        }
+        html = html.replace("{{SOURCE}}", entry.source);
+        return html;
+      }
+    }
+    const safeTitle = escapeHtml(entry.title ?? "Plugin");
+    const safeSource = escapeHtml(entry.source);
+    return `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>${safeTitle}</title>
+  </head>
+  <body>
+    <div id="${mountId}"></div>
+    <script type="module" src="${safeSource}"></script>
+  </body>
+</html>`;
+  }
+  function readManifest() {
+    if (!(0, import_node_fs.existsSync)(manifestAbsPath)) {
+      return [];
+    }
+    const raw = (0, import_node_fs.readFileSync)(manifestAbsPath, "utf-8");
+    let manifest;
+    try {
+      manifest = JSON.parse(raw);
+    } catch {
+      throw new Error(
+        `[ethisys-manifest] Failed to parse manifest at "${manifestAbsPath}".`
+      );
+    }
+    const result = [];
+    for (const page of manifest.ui?.pages ?? []) {
+      if (page.source) {
+        result.push(page);
+      }
+    }
+    for (const surface of manifest.ui?.surfaces ?? []) {
+      if (surface.source) {
+        result.push(surface);
+      }
+    }
+    return result;
+  }
+  function validateEntries() {
+    const entrypointSources = /* @__PURE__ */ new Map();
+    for (const entry of entries) {
+      const source = entry.source;
+      if (source.includes("..") || source.startsWith("/")) {
+        throw new Error(
+          `[ethisys-manifest] Source path "${source}" must be relative with no traversal.`
+        );
+      }
+      const sourcePath = (0, import_node_path.resolve)(rootDir, source);
+      if (!(0, import_node_fs.existsSync)(sourcePath)) {
+        throw new Error(
+          `[ethisys-manifest] Source file "${source}" for entry "${entry.entrypoint}" does not exist.`
+        );
+      }
+      const existingSource = entrypointSources.get(entry.entrypoint);
+      if (existingSource && existingSource !== source) {
+        throw new Error(
+          `[ethisys-manifest] Conflicting sources for entrypoint "${entry.entrypoint}": "${existingSource}" and "${source}". Only one source file can be mapped to a single entrypoint.`
+        );
+      }
+      entrypointSources.set(entry.entrypoint, source);
+    }
+  }
+  return {
+    name: "ethisys-manifest",
+    enforce: "pre",
+    config(config, { command }) {
+      rootDir = config.root ?? process.cwd();
+      manifestAbsPath = (0, import_node_path.resolve)(rootDir, manifestRelPath);
+      entries = readManifest();
+      if (entries.length === 0) {
+        return;
+      }
+      validateEntries();
+      if (command === "build") {
+        const input = {};
+        const seen = /* @__PURE__ */ new Set();
+        for (const entry of entries) {
+          if (seen.has(entry.entrypoint)) {
+            continue;
+          }
+          seen.add(entry.entrypoint);
+          const name = entry.entrypoint.replace(/\.html$/, "");
+          input[name] = slash((0, import_node_path.resolve)(rootDir, entry.entrypoint));
+        }
+        return {
+          build: {
+            rollupOptions: {
+              input
+            }
+          }
+        };
+      }
+    },
+    // Dev server: intercept HTML requests and serve virtual HTML.
+    // Pre-middleware — runs before Vite's built-in handlers.
+    // Safe because we only respond to .html requests and SPA navigation;
+    // module requests (/@vite/client, /@react-refresh, .ts/.tsx/.css files)
+    // don't match our conditions and pass through to Vite's transform middleware.
+    configureServer(server) {
+      server.watcher.add(manifestAbsPath);
+      server.middlewares.use(async (req, res, next) => {
+        try {
+          const url = req.url?.split("?")[0] ?? "";
+          const acceptsHtml = req.headers.accept?.includes("text/html");
+          if (url.endsWith(".html") || url === "/" || url === "/index.html") {
+            const filename = url === "/" || url === "/index.html" ? "index.html" : url.slice(1);
+            const entry = entries.find((e) => e.entrypoint === filename);
+            if (entry) {
+              let html = generateHtml(entry);
+              html = await server.transformIndexHtml(url, html);
+              res.setHeader("Content-Type", "text/html");
+              res.statusCode = 200;
+              res.end(html);
+              return;
+            }
+          }
+          if (acceptsHtml && !url.includes(".")) {
+            const mainEntry = entries.find(
+              (e) => e.entrypoint === "index.html"
+            );
+            if (mainEntry) {
+              let html = generateHtml(mainEntry);
+              html = await server.transformIndexHtml(url, html);
+              res.setHeader("Content-Type", "text/html");
+              res.statusCode = 200;
+              res.end(html);
+              return;
+            }
+          }
+          next();
+        } catch (err) {
+          next(err);
+        }
+      });
+    },
+    // Watch manifest for changes during dev — reload entries on edit.
+    // Entire handler is wrapped in try/catch so JSON syntax errors in the
+    // manifest don't crash the dev server (common during active editing).
+    handleHotUpdate({ file, server }) {
+      if (slash(file) === slash(manifestAbsPath)) {
+        try {
+          entries = readManifest();
+          validateEntries();
+        } catch (e) {
+          server.config.logger.error(String(e));
+          return [];
+        }
+        server.config.logger.info(
+          "[ethisys-manifest] Manifest changed \u2014 reloading entries"
+        );
+        server.hot.send({ type: "full-reload" });
+        return [];
+      }
+    },
+    // Build: resolve virtual HTML module IDs (no physical files exist on disk)
+    resolveId(id) {
+      const normalizedId = slash(id);
+      const match = entries.find(
+        (e) => slash((0, import_node_path.resolve)(rootDir, e.entrypoint)) === normalizedId
+      );
+      if (match) {
+        return id;
+      }
+    },
+    // Build: provide virtual HTML content for Rollup
+    load(id) {
+      const normalizedId = slash(id);
+      const match = entries.find(
+        (e) => slash((0, import_node_path.resolve)(rootDir, e.entrypoint)) === normalizedId
+      );
+      if (match) {
+        return generateHtml(match);
+      }
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ethisysManifestPlugin
+});

package/dist/index.d.cts ADDED Viewed

@@ -0,0 +1,26 @@
+import { Plugin } from 'vite';
+interface EthisysPluginOptions {
+    /**
+     * Path to the manifest file, relative to Vite's root directory.
+     * @default "../extension.manifest.json"
+     */
+    manifestPath?: string;
+    /**
+     * ID of the mount element in the generated HTML.
+     * React plugins use "root", Vue plugins use "app".
+     * @default "root"
+     */
+    mountId?: string;
+}
+/**
+ * Vite plugin that reads `extension.manifest.json` (or a custom manifest path)
+ * and auto-generates HTML entry points for all pages and surfaces that declare
+ * a `source` field. No physical HTML files are required.
+ *
+ * Pages without a `source` field share the main entry point (SPA mode).
+ * Surfaces (dialogs, panels) each get their own HTML shell.
+ */
+declare function ethisysManifestPlugin(options?: EthisysPluginOptions): Plugin;
+export { type EthisysPluginOptions, ethisysManifestPlugin };

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,26 @@
+import { Plugin } from 'vite';
+interface EthisysPluginOptions {
+    /**
+     * Path to the manifest file, relative to Vite's root directory.
+     * @default "../extension.manifest.json"
+     */
+    manifestPath?: string;
+    /**
+     * ID of the mount element in the generated HTML.
+     * React plugins use "root", Vue plugins use "app".
+     * @default "root"
+     */
+    mountId?: string;
+}
+/**
+ * Vite plugin that reads `extension.manifest.json` (or a custom manifest path)
+ * and auto-generates HTML entry points for all pages and surfaces that declare
+ * a `source` field. No physical HTML files are required.
+ *
+ * Pages without a `source` field share the main entry point (SPA mode).
+ * Surfaces (dialogs, panels) each get their own HTML shell.
+ */
+declare function ethisysManifestPlugin(options?: EthisysPluginOptions): Plugin;
+export { type EthisysPluginOptions, ethisysManifestPlugin };

package/dist/index.js ADDED Viewed

@@ -0,0 +1,212 @@
+// src/index.ts
+import { readFileSync, existsSync } from "fs";
+import { resolve, sep } from "path";
+function slash(p) {
+  return sep === "\\" ? p.replace(/\\/g, "/") : p;
+}
+function escapeHtml(str) {
+  return str.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+}
+function ethisysManifestPlugin(options = {}) {
+  const manifestRelPath = options.manifestPath ?? "../extension.manifest.json";
+  const mountId = options.mountId ?? "root";
+  let entries = [];
+  let rootDir;
+  let manifestAbsPath;
+  function generateHtml(entry) {
+    if (entry.template) {
+      const templatePath = resolve(rootDir, entry.template);
+      if (existsSync(templatePath)) {
+        let html = readFileSync(templatePath, "utf-8");
+        const mountPattern = new RegExp(`id=["']${mountId}["']`);
+        if (!mountPattern.test(html)) {
+          throw new Error(
+            `[ethisys-manifest] Custom template "${entry.template}" must contain an element with id="${mountId}".`
+          );
+        }
+        html = html.replace("{{SOURCE}}", entry.source);
+        return html;
+      }
+    }
+    const safeTitle = escapeHtml(entry.title ?? "Plugin");
+    const safeSource = escapeHtml(entry.source);
+    return `<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>${safeTitle}</title>
+  </head>
+  <body>
+    <div id="${mountId}"></div>
+    <script type="module" src="${safeSource}"></script>
+  </body>
+</html>`;
+  }
+  function readManifest() {
+    if (!existsSync(manifestAbsPath)) {
+      return [];
+    }
+    const raw = readFileSync(manifestAbsPath, "utf-8");
+    let manifest;
+    try {
+      manifest = JSON.parse(raw);
+    } catch {
+      throw new Error(
+        `[ethisys-manifest] Failed to parse manifest at "${manifestAbsPath}".`
+      );
+    }
+    const result = [];
+    for (const page of manifest.ui?.pages ?? []) {
+      if (page.source) {
+        result.push(page);
+      }
+    }
+    for (const surface of manifest.ui?.surfaces ?? []) {
+      if (surface.source) {
+        result.push(surface);
+      }
+    }
+    return result;
+  }
+  function validateEntries() {
+    const entrypointSources = /* @__PURE__ */ new Map();
+    for (const entry of entries) {
+      const source = entry.source;
+      if (source.includes("..") || source.startsWith("/")) {
+        throw new Error(
+          `[ethisys-manifest] Source path "${source}" must be relative with no traversal.`
+        );
+      }
+      const sourcePath = resolve(rootDir, source);
+      if (!existsSync(sourcePath)) {
+        throw new Error(
+          `[ethisys-manifest] Source file "${source}" for entry "${entry.entrypoint}" does not exist.`
+        );
+      }
+      const existingSource = entrypointSources.get(entry.entrypoint);
+      if (existingSource && existingSource !== source) {
+        throw new Error(
+          `[ethisys-manifest] Conflicting sources for entrypoint "${entry.entrypoint}": "${existingSource}" and "${source}". Only one source file can be mapped to a single entrypoint.`
+        );
+      }
+      entrypointSources.set(entry.entrypoint, source);
+    }
+  }
+  return {
+    name: "ethisys-manifest",
+    enforce: "pre",
+    config(config, { command }) {
+      rootDir = config.root ?? process.cwd();
+      manifestAbsPath = resolve(rootDir, manifestRelPath);
+      entries = readManifest();
+      if (entries.length === 0) {
+        return;
+      }
+      validateEntries();
+      if (command === "build") {
+        const input = {};
+        const seen = /* @__PURE__ */ new Set();
+        for (const entry of entries) {
+          if (seen.has(entry.entrypoint)) {
+            continue;
+          }
+          seen.add(entry.entrypoint);
+          const name = entry.entrypoint.replace(/\.html$/, "");
+          input[name] = slash(resolve(rootDir, entry.entrypoint));
+        }
+        return {
+          build: {
+            rollupOptions: {
+              input
+            }
+          }
+        };
+      }
+    },
+    // Dev server: intercept HTML requests and serve virtual HTML.
+    // Pre-middleware — runs before Vite's built-in handlers.
+    // Safe because we only respond to .html requests and SPA navigation;
+    // module requests (/@vite/client, /@react-refresh, .ts/.tsx/.css files)
+    // don't match our conditions and pass through to Vite's transform middleware.
+    configureServer(server) {
+      server.watcher.add(manifestAbsPath);
+      server.middlewares.use(async (req, res, next) => {
+        try {
+          const url = req.url?.split("?")[0] ?? "";
+          const acceptsHtml = req.headers.accept?.includes("text/html");
+          if (url.endsWith(".html") || url === "/" || url === "/index.html") {
+            const filename = url === "/" || url === "/index.html" ? "index.html" : url.slice(1);
+            const entry = entries.find((e) => e.entrypoint === filename);
+            if (entry) {
+              let html = generateHtml(entry);
+              html = await server.transformIndexHtml(url, html);
+              res.setHeader("Content-Type", "text/html");
+              res.statusCode = 200;
+              res.end(html);
+              return;
+            }
+          }
+          if (acceptsHtml && !url.includes(".")) {
+            const mainEntry = entries.find(
+              (e) => e.entrypoint === "index.html"
+            );
+            if (mainEntry) {
+              let html = generateHtml(mainEntry);
+              html = await server.transformIndexHtml(url, html);
+              res.setHeader("Content-Type", "text/html");
+              res.statusCode = 200;
+              res.end(html);
+              return;
+            }
+          }
+          next();
+        } catch (err) {
+          next(err);
+        }
+      });
+    },
+    // Watch manifest for changes during dev — reload entries on edit.
+    // Entire handler is wrapped in try/catch so JSON syntax errors in the
+    // manifest don't crash the dev server (common during active editing).
+    handleHotUpdate({ file, server }) {
+      if (slash(file) === slash(manifestAbsPath)) {
+        try {
+          entries = readManifest();
+          validateEntries();
+        } catch (e) {
+          server.config.logger.error(String(e));
+          return [];
+        }
+        server.config.logger.info(
+          "[ethisys-manifest] Manifest changed \u2014 reloading entries"
+        );
+        server.hot.send({ type: "full-reload" });
+        return [];
+      }
+    },
+    // Build: resolve virtual HTML module IDs (no physical files exist on disk)
+    resolveId(id) {
+      const normalizedId = slash(id);
+      const match = entries.find(
+        (e) => slash(resolve(rootDir, e.entrypoint)) === normalizedId
+      );
+      if (match) {
+        return id;
+      }
+    },
+    // Build: provide virtual HTML content for Rollup
+    load(id) {
+      const normalizedId = slash(id);
+      const match = entries.find(
+        (e) => slash(resolve(rootDir, e.entrypoint)) === normalizedId
+      );
+      if (match) {
+        return generateHtml(match);
+      }
+    }
+  };
+}
+export {
+  ethisysManifestPlugin
+};

package/package.json ADDED Viewed

@@ -0,0 +1,48 @@
+{
+  "name": "@ethisyscore/vite-plugin",
+  "version": "1.0.0-alpha.12",
+  "description": "Vite plugin for manifest-driven HTML entry points in EthisysCore plugins. Reads feature.manifest.json and generates HTML shells in-memory — zero boilerplate HTML files needed.",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "vite": ">=5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vite": "^8.0.1",
+    "vitest": "^4.1.0"
+  },
+  "keywords": [
+    "ethisyscore",
+    "vite",
+    "vite-plugin",
+    "plugin",
+    "manifest",
+    "mpa",
+    "multi-page"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ethisysltd/ethisyscore-plugin-sdk"
+  }
+}