@rainbow-robotics/muscat-plugin-kit 0.1.2-dev.5 → 0.1.2-dev.50

package/cli/vite.mjs

@@ -0,0 +1,281 @@
+import react from "@vitejs/plugin-react";
+import cssInjectedByJsPlugin from "vite-plugin-css-injected-by-js";
+import postcss from "postcss";
+import { createRequire } from "node:module";
+import { existsSync, readFileSync, readdirSync } from "node:fs";
+import { basename, extname, resolve } from "node:path";
+
+
+const HOST_PROVIDED_EXTERNALS = [
+  /^react(\/.*)?$/,
+  /^react-dom(\/.*)?$/,
+  /^@rainbow-robotics\/plugin-ui(\/.*)?$/,
+  /^@repo\/rb-components(\/.*)?$/,
+];
+
+const UI_ENTRY_PREFIX = "muscat-ui-entry:";
+const RESOLVED_UI_ENTRY_PREFIX = "\0" + UI_ENTRY_PREFIX;
+const SHARED_RUNTIME_PREFIX = "muscat-shared-runtime:";
+const RESOLVED_SHARED_RUNTIME_PREFIX = "\0" + SHARED_RUNTIME_PREFIX;
+const STYLE_EXTENSIONS = [".css", ".scss", ".sass", ".less"];
+// `@rainbow-robotics/plugin-ui/react` ships transpiled-only (see
+// build-dist.mjs: `bundle: false, // consumers resolve deps themselves") — its
+// `export * from "@repo/rb-components/new_components"` is a monorepo-private
+// package no external plugin can npm-install. So a "dev" plugin can't use its
+// own local copy of plugin-ui/react (or /sdk, whose RbContext must stay one
+// singleton with host.tsx's Provider) — these, plus react/react-dom itself
+// (so elements created by rb-components match the instance rendering them)
+// and host-ui (the plain-function toast/alert/confirm/prompt channel), all
+// redirect to the host's already-loaded instances instead.
+const SHARED_RUNTIME_FILES = {
+  react: "react",
+  "react/jsx-runtime": "react_jsx-runtime",
+  "react/jsx-dev-runtime": "react_jsx-dev-runtime",
+  "react-dom": "react-dom",
+  "react-dom/client": "react-dom_client",
+  "@rainbow-robotics/plugin-ui/react": "plugin-ui_react",
+  "@rainbow-robotics/plugin-ui/sdk": "plugin-ui_sdk",
+  "@rainbow-robotics/plugin-ui/host-ui": "plugin-ui_host-ui",
+  "@rainbow-robotics/plugin-ui/ws": "plugin-ui_ws",
+};
+
+function cssString(value) {
+  return String(value).replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/\n/g, "\\a ");
+}
+
+function readPluginId(root) {
+  try {
+    const manifest = JSON.parse(readFileSync(resolve(root, "manifest.json"), "utf8"));
+    return typeof manifest.id === "string" && manifest.id ? manifest.id : null;
+  } catch {
+    return null;
+  }
+}
+
+function pluginScopeSelector(pluginId) {
+  if (!pluginId) return ":where([data-muscat-plugin-root])";
+  return `:where([data-muscat-plugin-id="${cssString(pluginId)}"])`;
+}
+
+function discoverUiEntries(uiDir) {
+  return Object.fromEntries(
+    readdirSync(uiDir)
+      .filter((f) => /\.(tsx?|jsx?)$/.test(f))
+      .map((f) => [basename(f, extname(f)), resolve(uiDir, f)]),
+  );
+}
+
+function discoverUiStyles(uiDir, entryName) {
+  return STYLE_EXTENSIONS.flatMap((ext) => [
+    resolve(uiDir, `style${ext}`),
+    resolve(uiDir, `styles${ext}`),
+    resolve(uiDir, `${entryName}${ext}`),
+  ]).filter((file, index, files) => existsSync(file) && files.indexOf(file) === index);
+}
+
+function isKeyframesRule(rule) {
+  for (let node = rule.parent; node; node = node.parent) {
+    if (node.type === "atrule" && /keyframes$/i.test(node.name)) return true;
+  }
+  return false;
+}
+
+function scopeSelector(selector, rootSelector) {
+  const trimmed = selector.trim();
+  if (
+    !trimmed ||
+    trimmed.includes("[data-muscat-plugin-root]") ||
+    trimmed.includes("[data-muscat-plugin-id")
+  ) {
+    return selector;
+  }
+  if (/^(:root|:host)\b/.test(trimmed)) {
+    return trimmed.replace(/^(:root|:host)\b/, rootSelector);
+  }
+  if (/^(html|body)\b/.test(trimmed)) {
+    return trimmed.replace(/^(html|body)\b/, rootSelector);
+  }
+  return `${rootSelector} ${trimmed}`;
+}
+
+function scopePluginCss(css, rootSelector) {
+  if (!css.trim()) return css;
+  const root = postcss.parse(css);
+  root.walkRules((rule) => {
+    if (isKeyframesRule(rule)) return;
+    rule.selectors = rule.selectors.map((selector) => scopeSelector(selector, rootSelector));
+  });
+  return root.toString();
+}
+
+function createUiEntryPlugin(uiDir, entries) {
+  return {
+    name: "muscat-ui-entry",
+    enforce: "pre",
+    resolveId(id) {
+      if (id.startsWith(UI_ENTRY_PREFIX)) return "\0" + id;
+    },
+    load(id) {
+      if (!id.startsWith(RESOLVED_UI_ENTRY_PREFIX)) return;
+      const entryName = id.slice(RESOLVED_UI_ENTRY_PREFIX.length);
+      const entry = entries[entryName];
+      if (!entry) throw new Error(`Unknown Muscat UI entry: ${entryName}`);
+
+      const styleImports = discoverUiStyles(uiDir, entryName)
+        .map((file) => {
+          this.addWatchFile(file);
+          return `import ${JSON.stringify(file)};`;
+        })
+        .join("\n");
+
+      return `${styleImports}\nexport { default } from ${JSON.stringify(entry)};\n`;
+    },
+  };
+}
+
+function resolveFromPlugin(root, specifier) {
+  try {
+    return createRequire(resolve(root, "package.json")).resolve(specifier);
+  } catch {
+    return null;
+  }
+}
+
+function exactSpecifier(specifier) {
+  return new RegExp(`^${specifier.replace(/[.*+?^${}()|[\]\\]/g, "\\$&")}$`);
+}
+
+function reactAliases(root) {
+  return [
+    "react",
+    "react/jsx-runtime",
+    "react/jsx-dev-runtime",
+    "react-dom",
+    "react-dom/client",
+  ].flatMap((specifier) => {
+    const resolved = resolveFromPlugin(root, specifier);
+    return resolved ? [{ find: exactSpecifier(specifier), replacement: resolved }] : [];
+  });
+}
+
+function createSharedRuntimePlugin(baseUrl) {
+  const base = baseUrl.replace(/\/$/, "");
+
+  return {
+    name: "muscat-shared-runtime",
+    enforce: "pre",
+    resolveId(id) {
+      if (id in SHARED_RUNTIME_FILES) return "\0" + SHARED_RUNTIME_PREFIX + id;
+    },
+    load(id) {
+      if (!id.startsWith(RESOLVED_SHARED_RUNTIME_PREFIX)) return;
+      const specifier = id.slice(RESOLVED_SHARED_RUNTIME_PREFIX.length);
+      const file = SHARED_RUNTIME_FILES[specifier];
+      if (!file) throw new Error(`Unknown Muscat shared runtime module: ${specifier}`);
+
+      const url = JSON.stringify(`${base}/${file}.js`);
+      if (specifier === "react" || specifier === "react-dom") {
+        return `export * from ${url};\nimport sharedDefault from ${url};\nexport default sharedDefault;\n`;
+      }
+      return `export * from ${url};\n`;
+    },
+  };
+}
+
+const REACT_REFRESH_ACCEPT_MARKER =
+  "\nif (import.meta.hot && !inWebWorker) {\n  RefreshRuntime.__hmr_import(import.meta.url).then((currentExports) => {";
+
+function createManualHmrBoundaryPlugin(uiDir) {
+  const normalizedUiDir = uiDir.replace(/\/$/, "");
+
+  return {
+    name: "muscat-manual-hmr-boundary",
+    apply: "serve",
+    enforce: "post",
+    transform(code, id) {
+      const [file] = id.split("?");
+      if (!file.startsWith(`${normalizedUiDir}/`) || !/\.[jt]sx?$/.test(file)) return null;
+
+      const markerIndex = code.lastIndexOf(REACT_REFRESH_ACCEPT_MARKER);
+      if (markerIndex === -1) return null;
+
+      // preview-host provides the same production ReactDOM as Nexus. Vite's
+      // React Fast Refresh receives updates but cannot drive that renderer, so
+      // let the bootstrap module handle HMR by re-rendering the updated entry.
+      return { code: code.slice(0, markerIndex), map: null };
+    },
+  };
+}
+
+export function muscat(options = {}) {
+  const pluginRoot = process.cwd();
+  const uiDir = resolve(pluginRoot, "ui");
+  const entries = discoverUiEntries(uiDir);
+  const rootSelector = pluginScopeSelector(readPluginId(pluginRoot));
+  const sharedRuntimeBase = process.env.MUSCAT_PLUGIN_SHARED_RUNTIME_BASE;
+  const wrappedEntries = Object.fromEntries(
+    Object.keys(entries).map((name) => [name, `${UI_ENTRY_PREFIX}${name}`]),
+  );
+  const reactPlugins = options.react === false ? [] : [react(options.react)];
+
+  return [
+    ...reactPlugins,
+    createUiEntryPlugin(uiDir, entries),
+    ...(sharedRuntimeBase ? [createSharedRuntimePlugin(sharedRuntimeBase)] : []),
+    ...(sharedRuntimeBase ? [createManualHmrBoundaryPlugin(uiDir)] : []),
+    cssInjectedByJsPlugin({
+      relativeCSSInjection: true,
+      preRenderCSSCode: (css) => scopePluginCss(css, rootSelector),
+    }),
+    {
+      name: "muscat-plugin-build",
+      apply: "build",
+      config: () => ({
+        build: {
+          target: "esnext",
+          outDir: "dist",
+          emptyOutDir: false,
+          rollupOptions: {
+            input: wrappedEntries,
+            external: HOST_PROVIDED_EXTERNALS,
+            // Entries only `export default App` (the host mounts it). Without
+            // this, Vite treats entries as self-executing apps and tree-shakes
+            // the unused default export away.
+            preserveEntrySignatures: "strict",
+            output: {
+              format: "es",
+              entryFileNames: "[name].js",
+              chunkFileNames: "chunks/[name]-[hash].js",
+              assetFileNames: "assets/[name]-[hash][extname]",
+            },
+          },
+        },
+      }),
+    },
+    {
+      name: "muscat-plugin-dev",
+      apply: "serve",
+      config: () => {
+        return {
+          resolve: {
+            alias: sharedRuntimeBase ? [] : reactAliases(pluginRoot),
+            dedupe: ["react", "react-dom"],
+          },
+          optimizeDeps: sharedRuntimeBase
+            ? { noDiscovery: true, include: [] }
+            : {
+                include: [
+                  "react",
+                  "react-dom",
+                  "react-dom/client",
+                  "@rainbow-robotics/plugin-ui/react",
+                  "@rainbow-robotics/plugin-ui/sdk",
+                  "@rainbow-robotics/plugin-ui/host-ui",
+                  "@rainbow-robotics/plugin-ui/ws",
+                ],
+              },
+        };
+      },
+    },
+  ];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rainbow-robotics/muscat-plugin-kit",
-  "version": "0.1.2-dev.5",
+  "version": "0.1.2-dev.50",
   "type": "module",
   "engines": {
     "node": ">=20"
@@ -13,6 +13,25 @@
     "create-muscat-plugin": "./cli/bin/create-muscat-plugin.mjs",
     "muscat-pk": "./cli/bin/muscat-pk.mjs"
   },
+  "exports": {
+    "./vite": {
+      "types": "./cli/vite.d.mts",
+      "default": "./cli/vite.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@vitejs/plugin-react": ">=4",
+    "vite": ">=5"
+  },
+  "peerDependenciesMeta": {
+    "@vitejs/plugin-react": {
+      "optional": true
+    },
+    "vite": {
+      "optional": true
+    }
+  },
   "files": [
     "cli",
     "package.json"
@@ -20,7 +39,9 @@
   "scripts": {
     "lint": "node cli/src/check-package.mjs",
     "check": "node cli/src/check-package.mjs",
-    "check-types": "node cli/src/check-package.mjs"
+    "check-types": "node cli/src/check-package.mjs",
+    "storybook:build": "node cli/prepack.mjs",
+    "prepack": "node cli/prepack.mjs"
   },
   "devDependencies": {
     "@eslint/js": "^9.22.0",
@@ -31,10 +52,16 @@
     "@types/react-dom": "^19.0.4"
   },
   "dependencies": {
-    "@rainbow-robotics/preview-host": "*",
-    "esbuild": "^0.25.0"
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "@rainbow-robotics/plugin-ui": "0.1.2-dev.50",
+    "@rainbow-robotics/preview-host": "0.1.2-dev.50",
+    "postcss": "^8.5.8",
+    "socket.io": "^4.8.1",
+    "typescript": "^5.8.0",
+    "vite-plugin-css-injected-by-js": "^3.5.2",
+    "zod": "^3.25.0"
   },
   "optionalDependencies": {
     "esbuild-wasm": "^0.25.0"
   }
-}
+}

package/cli/src/pack.mjs

@@ -1,61 +0,0 @@
-// muscat-pk pack — build, then create a distributable ZIP with a size report.
-import { execSync } from "node:child_process";
-import { existsSync, readFileSync, readdirSync, rmSync, statSync } from "node:fs";
-import { basename, resolve } from "node:path";
-import { buildPlugin, exportRos2Build, pinRequirements } from "./build.mjs";
-import { findPluginRoot, humanSize, log } from "./util.mjs";
-
-function dirSize(dir) {
-  let total = 0;
-  for (const entry of readdirSync(dir)) {
-    const full = resolve(dir, entry);
-    const st = statSync(full);
-    total += st.isDirectory() ? dirSize(full) : st.size;
-  }
-  return total;
-}
-
-export async function runPack() {
-  const pluginRoot = findPluginRoot();
-  log.step("pinning requirements.txt to latest PyPI versions");
-  await pinRequirements(pluginRoot);
-  await buildPlugin({ root: pluginRoot, minify: true });
-  await exportRos2Build(pluginRoot);
-
-  const manifest = JSON.parse(
-    readFileSync(resolve(pluginRoot, "manifest.json"), "utf8"),
-  );
-  const zipName = `${basename(pluginRoot)}-${manifest.version || "0.0.0"}.zip`;
-  const zipPath = resolve(pluginRoot, zipName);
-  rmSync(zipPath, { force: true });
-
-  // Contents: dist/ + back-end files if present.
-  const entries = ["dist"];
-  for (const f of ["main.py", "requirements.txt"]) {
-    if (existsSync(resolve(pluginRoot, f))) entries.push(f);
-  }
-  if (existsSync(resolve(pluginRoot, "ros2_ws/install"))) {
-    entries.push("ros2_ws/install");
-  }
-
-  log.step(`packing ${entries.join(", ")} → ${zipName}`);
-  try {
-    execSync(`zip -r -q "${zipPath}" ${entries.map((e) => `"${e}"`).join(" ")}`, {
-      cwd: pluginRoot,
-      stdio: "inherit",
-    });
-  } catch {
-    throw new Error("`zip` not found. Install zip or pack manually.");
-  }
-
-  const zipBytes = statSync(zipPath).size;
-  log.ok(`${zipName}   ${humanSize(zipBytes)}`);
-  for (const e of entries) {
-    const full = resolve(pluginRoot, e);
-    const size = statSync(full).isDirectory() ? dirSize(full) : statSync(full).size;
-    log.info(`  ├─ ${e}   ${humanSize(size)}`);
-  }
-  log.warn(
-    "robot install checks free space via GET /plugin/capacity (507 if low).",
-  );
-}

package/cli/templates/common/main.py

@@ -1,21 +0,0 @@
-import asyncio
-
-from rb_sdk import RBManipulateSDK  # PyPI: rainbow-rb-sdk
-
-sdk = RBManipulateSDK()
-
-
-async def on_action(payload: dict):
-    # Matches manifest.actions[].topic — handle the "grip" action here.
-    width = payload.get("width")
-    print(f"[__PLUGIN_NAME__] grip width={width}")
-    # TODO: drive the robot via the SDK.
-
-
-async def main():
-    await sdk.subscribe("rby2/plugin/__PLUGIN_ID__/grip", on_action)
-    await sdk.spin()
-
-
-if __name__ == "__main__":
-    asyncio.run(main())

package/cli/templates/common/src/content.tsx

@@ -1,32 +0,0 @@
-import { useState } from "react";
-import { connect } from "@rainbow-robotics/plugin-ui/connect";
-import { Slider, Button, Text, Switch, useRb } from "@rainbow-robotics/plugin-ui/react";
-
-function App() {
-  const rb = useRb();
-  const [width, setWidth] = useState(20);
-  const [open, setOpen] = useState(false);
-
-  return (
-    <>
-      <Text>__PLUGIN_NAME__ width: {width}</Text>
-      <Slider
-        value={width}
-        min={0}
-        max={100}
-        onChange={(event: { detail?: number }) => setWidth(event.detail ?? 0)}
-      />
-      <Button label="Grip" onPress={() => rb.action("grip", { width })} />
-      <Switch
-        checked={open}
-        onChange={(event: { detail?: boolean }) => {
-          const next = event.detail ?? false;
-          setOpen(next);
-          rb.notify(next ? "opened" : "closed", "info");
-        }}
-      />
-    </>
-  );
-}
-
-connect(App);