@realmorg/vite-plugin 0.0.0-stage → 2.0.0-alpha.3

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2023 RealmOrg
+
+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/README.md

@@ -1,3 +1,28 @@
-# Temporary Holding Version
+# @realmorg/vite-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Pre-assembles REALM components at build time so they run under a strict Content Security Policy, and writes a `custom-elements.json` manifest for editors and documentation tools.
+
+The plugin is optional. REALM runs without a build step, so you only need it if your project already uses Vite.
+
+```bash
+npm install -D @realmorg/vite-plugin
+```
+
+```js
+// vite.config.js
+import realm from "@realmorg/vite-plugin";
+
+export default {
+  plugins: [realm()],
+};
+```
+
+After the build, the script of every `<custom-element>` in the output HTML is assembled into a module next to the file. The inline script becomes `<script src="./file.name.js">`. Nothing is evaluated at runtime, so a policy of `script-src 'self'` is enough.
+
+| Option | Default | |
+| --- | --- | --- |
+| `manifest` | `"custom-elements.json"` | File name for the manifest, or `false` to skip it |
+
+Outside Vite, call `precompile(dir)` on any folder of built HTML files.
+
+Inline `on…` attributes on plain page elements are still inline handlers, so a strict policy blocks them, as it would without REALM.

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import type { Plugin } from "vite";
+import { describe } from "./manifest.js";
+export { createManifest, describe } from "./manifest.js";
+export interface PrecompileResult {
+    modules: string[];
+    definitions: ReturnType<typeof describe>[];
+}
+export declare const precompileFile: (path: string, root?: string) => PrecompileResult;
+export declare const precompile: (dir: string) => PrecompileResult;
+export interface RealmPluginOptions {
+    manifest?: string | false;
+}
+export default function realm(options?: RealmPluginOptions): Plugin;

package/dist/index.js

@@ -0,0 +1,92 @@
+import { existsSync, readdirSync, readFileSync, statSync, writeFileSync } from "node:fs";
+import { basename, dirname, join, relative } from "node:path";
+import { compileDefinition } from "@realmorg/realm/compiler";
+import { parseHTML } from "linkedom";
+import { createManifest, describe } from "./manifest.js";
+export { createManifest, describe } from "./manifest.js";
+const htmlFiles = (dir) => readdirSync(dir).flatMap((entry) => {
+    const path = join(dir, entry);
+    if (statSync(path).isDirectory())
+        return entry === "node_modules" ? [] : htmlFiles(path);
+    return entry.endsWith(".html") ? [path] : [];
+});
+const scriptTag = (script, src) => {
+    const type = script.getAttribute("type");
+    return `<script${type && type !== "module" ? ` type="${type}"` : ""} src="./${src}"></script>`;
+};
+const TAG = /<[a-z][^\s/>]*(?:\s+[^\s=/>]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s>]+))?)*\s*\/?>/gi;
+const HANDLER = /(\s)on([a-z][\w-]*)(?=\s*=)/g;
+const DEFINITION = /<custom-element[\s>][\s\S]*?<\/custom-element>/g;
+const inertHandlers = (html) => html.replace(DEFINITION, (definition) => definition.replace(TAG, (tag) => tag.replace(HANDLER, "$1realm:on$2")));
+export const precompileFile = (path, root = dirname(path)) => {
+    let html = readFileSync(path, "utf8");
+    const { document } = parseHTML(/<html[\s>]/i.test(html) ? html : `<!doctype html><html><body>${html}</body></html>`);
+    const result = { modules: [], definitions: [] };
+    let cursor = 0;
+    for (const definition of document.querySelectorAll("custom-element")) {
+        const open = html.indexOf("<custom-element", cursor);
+        const openEnd = html.indexOf(">", open) + 1;
+        cursor = openEnd;
+        result.definitions.push(describe(definition, relative(root, path)));
+        const compiled = compileDefinition(definition);
+        if (!compiled)
+            continue;
+        const module = `${basename(path, ".html")}.${compiled.name}.js`;
+        writeFileSync(join(dirname(path), module), compiled.module);
+        result.modules.push(join(dirname(path), module));
+        if (!compiled.script) {
+            const tag = `<script type="realm" src="./${module}"></script>`;
+            html = html.slice(0, openEnd) + tag + html.slice(openEnd);
+            cursor = openEnd + tag.length;
+            continue;
+        }
+        const text = compiled.script.textContent;
+        const end = html.indexOf(`${text}</script>`, openEnd) + text.length + "</script>".length;
+        const start = html.lastIndexOf("<script", end - text.length);
+        const tag = scriptTag(compiled.script, module);
+        html = html.slice(0, start) + tag + html.slice(end);
+        cursor = start + tag.length;
+    }
+    const inert = inertHandlers(html);
+    if (inert !== readFileSync(path, "utf8"))
+        writeFileSync(path, inert);
+    return result;
+};
+export const precompile = (dir) => {
+    const results = htmlFiles(dir).map((file) => precompileFile(file, dir));
+    return {
+        modules: results.flatMap((result) => result.modules),
+        definitions: results.flatMap((result) => result.definitions),
+    };
+};
+export default function realm(options = {}) {
+    let outDir = "dist";
+    let build = false;
+    return {
+        name: "realm",
+        configResolved(config) {
+            outDir = join(config.root, config.build.outDir);
+            build = config.command === "build";
+        },
+        configureServer(server) {
+            server.middlewares.use((request, response, next) => {
+                const url = request.url;
+                const path = decodeURIComponent(url);
+                const file = join(server.config.root, path);
+                const fetched = !request.headers.accept?.includes("text/html");
+                if (!fetched || url.includes("?") || !path.endsWith(".html") || !existsSync(file))
+                    return next();
+                response.setHeader("content-type", "text/html");
+                response.end(readFileSync(file));
+            });
+        },
+        closeBundle() {
+            if (!build)
+                return;
+            const { definitions } = precompile(outDir);
+            const manifest = options.manifest ?? "custom-elements.json";
+            if (manifest)
+                writeFileSync(join(outDir, manifest), `${JSON.stringify(createManifest(definitions), null, 2)}\n`);
+        },
+    };
+}

package/dist/manifest.d.ts

@@ -0,0 +1,67 @@
+export interface Source {
+    path: string;
+    html: string;
+}
+interface Attribute {
+    name: string;
+    fieldName: string;
+    type?: {
+        text: string;
+    };
+    default?: string;
+}
+export declare const describe: (definition: Element, path: string) => {
+    kind: string;
+    name: string;
+    tagName: string;
+    customElement: boolean;
+    attributes: Attribute[];
+    events: {
+        name: string;
+    }[];
+    slots: {
+        name: string;
+    }[];
+    cssParts: {
+        name: string;
+    }[];
+    cssStates: {
+        name: string;
+    }[];
+    path: string;
+};
+export declare const createManifest: (definitions: ReturnType<typeof describe>[]) => {
+    schemaVersion: string;
+    modules: {
+        kind: string;
+        path: string;
+        declarations: {
+            kind: string;
+            name: string;
+            tagName: string;
+            customElement: boolean;
+            attributes: Attribute[];
+            events: {
+                name: string;
+            }[];
+            slots: {
+                name: string;
+            }[];
+            cssParts: {
+                name: string;
+            }[];
+            cssStates: {
+                name: string;
+            }[];
+        }[];
+        exports: {
+            kind: string;
+            name: string;
+            declaration: {
+                name: string;
+                module: string;
+            };
+        }[];
+    }[];
+};
+export {};

package/dist/manifest.js

@@ -0,0 +1,103 @@
+import { tokenize } from "@realmorg/realm/compiler";
+const named = (names) => [...new Set(names)].sort().map((name) => ({ name }));
+const pascal = (tag) => tag.replace(/(^|-)([a-z0-9])/g, (_match, _dash, letter) => letter.toUpperCase());
+const kebab = (key) => key.replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`);
+const TYPES = {
+    string: () => "string",
+    number: () => "number",
+    boolean: () => "boolean",
+    date: () => "Date",
+    array: () => "array",
+    object: () => "object",
+    enum: (args) => args
+        .replace(/^\[|\]$/g, "")
+        .trim()
+        .replace(/\s*,\s*/g, " | "),
+};
+const propsObject = (script) => {
+    const start = script.indexOf("defineProps(");
+    if (start === -1)
+        return "";
+    const open = script.indexOf("{", start);
+    let depth = 0;
+    for (let index = open; index < script.length; index++) {
+        depth += { "{": 1, "}": -1 }[script[index]] ?? 0;
+        if (depth === 0)
+            return script.slice(open + 1, index);
+    }
+    return "";
+};
+const splitTopLevel = (source) => {
+    const parts = [];
+    let depth = 0;
+    let current = "";
+    for (const token of tokenize(source)) {
+        if (token.type === "punct" && "([{".includes(token.value))
+            depth++;
+        if (token.type === "punct" && ")]}".includes(token.value))
+            depth--;
+        if (depth === 0 && token.value === ",") {
+            parts.push(current);
+            current = "";
+        }
+        else
+            current += `${token.value} `;
+    }
+    return [...parts, current].map((part) => part.trim()).filter(Boolean);
+};
+const CALL = /\.\s*(\w+)\s*\(\s*((?:[^()]|\([^()]*\))*?)\s*\)/g;
+const attributesOf = (script) => splitTopLevel(propsObject(script)).flatMap((entry) => {
+    const [key = "", definition = ""] = entry.split(/\s*:\s*(.*)/s);
+    const calls = new Map([...definition.matchAll(CALL)].map((call) => [call[1], call[2]]));
+    const type = [...calls.keys()].find((name) => name && name in TYPES);
+    if (!type)
+        return [];
+    const attribute = {
+        name: calls.get("attribute")?.replace(/^["'`]|["'`]$/g, "") ?? kebab(key),
+        fieldName: key,
+        type: { text: TYPES[type](calls.get(type)) },
+    };
+    if (calls.has("default"))
+        attribute.default = calls.get("default");
+    return [attribute];
+});
+const EVENTS = /(?:dispatch\s*\(|new\s+(?:Custom)?Event\s*\()\s*["'`]([a-z][\w-]*)["'`]/g;
+const STATES = /:state\(([\w-]+)\)/g;
+export const describe = (definition, path) => {
+    const tagName = definition.getAttribute("name");
+    const script = definition.querySelector(":scope > script")?.textContent ?? "";
+    const css = [...definition.querySelectorAll(":scope > style")]
+        .map((style) => style.textContent)
+        .join("\n");
+    const slots = [...definition.querySelectorAll("slot")]
+        .map((slot) => slot.getAttribute("name") ?? "")
+        .filter((name) => !/^[#@]/.test(name));
+    const parts = [...definition.querySelectorAll("[part]")].flatMap((el) => el.getAttribute("part").split(/\s+/));
+    return {
+        kind: "class",
+        name: pascal(tagName),
+        tagName,
+        customElement: true,
+        attributes: attributesOf(script),
+        events: named([...script.matchAll(EVENTS)].map((match) => match[1])),
+        slots: named(slots),
+        cssParts: named(parts),
+        cssStates: named([...css.matchAll(STATES)].map((match) => match[1])),
+        path,
+    };
+};
+export const createManifest = (definitions) => ({
+    schemaVersion: "2.1.0",
+    modules: definitions.map(({ path, ...declaration }) => ({
+        kind: "javascript-module",
+        path,
+        declarations: [declaration],
+        exports: [
+            {
+                kind: "custom-element-definition",
+                name: declaration.tagName,
+                declaration: { name: declaration.name, module: path },
+            },
+        ],
+    })),
+});

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@realmorg/vite-plugin",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "2.0.0-alpha.3",
+  "description": "Vite plugin that pre-assembles REALM components for strict Content Security Policies and writes a custom-elements.json manifest.",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "linkedom": "0.18.13",
+    "@realmorg/realm": "2.0.0-alpha.3"
+  },
+  "peerDependencies": {
+    "vite": ">=7"
+  },
+  "devDependencies": {
+    "@types/node": "26.6.5",
+    "@vitest/coverage-v8": "5.0.5",
+    "playwright": "1.64.1",
+    "typescript": "7.0.2",
+    "vite": "8.3.4",
+    "vitest": "5.0.5",
+    "tsconfig": "0.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/realmorg/realm.git",
+    "directory": "packages/vite-plugin"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "realm",
+    "vite-plugin",
+    "web-components",
+    "csp"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "vitest run --coverage",
+    "typecheck": "tsc --noEmit"
+  }
 }