@devframes/plugin-code-server 0.0.1

package/dist/types.d.mts

@@ -0,0 +1,99 @@
+//#region src/types.d.ts
+/** Lifecycle state of the managed code-server process. */
+type CodeServerStatus = 'stopped' | 'starting' | 'running' | 'error';
+/**
+ * Result of probing the host for a usable `code-server` binary. Drives the
+ * launcher UI: when `installed` is false the SPA renders install instructions
+ * instead of a launch button.
+ */
+interface CodeServerDetection {
+  /** Whether detection has run at least once on this context. */
+  checked: boolean;
+  /** Whether the `code-server` binary resolved and reported a version. */
+  installed: boolean;
+  /** Version string reported by `code-server --version`, when installed. */
+  version?: string;
+  /** The binary name / path probed (configurable via options). */
+  bin: string;
+}
+/** Serializable, secret-free description of the code-server process. */
+interface CodeServerServerInfo {
+  status: CodeServerStatus;
+  /** Port code-server is bound to, when starting/running. */
+  port?: number;
+  /** Epoch ms the current process was started. */
+  startedAt?: number;
+  /** OS process id, when running. */
+  pid?: number;
+  /** Last error message, when `status === 'error'`. */
+  error?: string;
+}
+/**
+ * The full shared-state payload broadcast to subscribed clients. Deliberately
+ * carries no authentication material — see {@link CodeServerAuth}.
+ */
+interface CodeServerSharedState {
+  detection: CodeServerDetection;
+  server: CodeServerServerInfo;
+}
+/**
+ * Auto-authentication handoff for the iframe. code-server runs with password
+ * auth (`HASHED_PASSWORD`); the valid session is the SHA-256 of a server-side
+ * token. The client sets `cookieName=cookieValue` for the current host before
+ * loading the iframe, so the editor loads already signed in — no login page.
+ *
+ * Returned only from the `start` / `status` RPCs (the connection is already
+ * authorized with devframe's auth), never published to shared state.
+ */
+interface CodeServerAuth {
+  cookieName: string;
+  cookieValue: string;
+}
+/** Result of the `status` query — shared state plus auth when running. */
+interface CodeServerStatusResult extends CodeServerSharedState {
+  auth?: CodeServerAuth;
+}
+/** Result of the `start` action — identical shape to {@link CodeServerStatusResult}. */
+type CodeServerStartResult = CodeServerStatusResult;
+/** Wire payload for the `start` RPC. */
+interface CodeServerStartRequest {
+  /** Workspace folder to open. Defaults to the configured / context cwd. */
+  folder?: string;
+}
+/** Options accepted by {@link createCodeServerDevframe}. */
+interface CodeServerOptions {
+  /** code-server binary to detect and launch. Defaults to `code-server` (PATH). */
+  bin?: string;
+  /** Workspace folder code-server opens. Defaults to `ctx.cwd`. */
+  cwd?: string;
+  /** Force a specific code-server port. Defaults to a free port near 8080. */
+  serverPort?: number;
+  /** Host code-server binds to. Defaults to `0.0.0.0` so the preview is reachable. */
+  host?: string;
+  /** Extra CLI arguments forwarded verbatim to code-server. */
+  args?: string[];
+  /** Environment variables merged into the code-server process. */
+  env?: Record<string, string>;
+  /**
+   * `--cookie-suffix` passed to code-server, isolating its session cookie from
+   * other local code-server instances. Supported on recent code-server only;
+   * left unset by default for compatibility.
+   */
+  cookieSuffix?: string;
+  /** Milliseconds to wait for code-server readiness before failing. */
+  startTimeout?: number;
+  /** Mount path override for the launcher SPA. */
+  basePath?: string;
+  /** Launcher SPA dist dir override. Defaults to the bundled SPA. */
+  distDir?: string;
+  /** CLI binary name. */
+  command?: string;
+  /** Preferred dev-server port for the launcher SPA. */
+  port?: number;
+  /** Port range for the launcher SPA dev server (e.g. `[9000, 9100]`). */
+  portRange?: [number, number];
+  /** Prefer a random port for the launcher SPA. */
+  random?: boolean;
+}
+//#endregion
+export { CodeServerAuth, CodeServerDetection, CodeServerOptions, CodeServerServerInfo, CodeServerSharedState, CodeServerStartRequest, CodeServerStartResult, CodeServerStatus, CodeServerStatusResult };

package/dist/types.mjs

@@ -0,0 +1 @@
+export {};

package/dist/vite.d.mts

@@ -0,0 +1,18 @@
+import { CodeServerOptions } from "./types.mjs";
+import { DevframeVitePlugin, ViteDevBridgeOptions } from "devframe/helpers/vite";
+
+//#region src/vite.d.ts
+interface CodeServerViteOptions extends CodeServerOptions {
+  /** Forwarded to the underlying `viteDevBridge` (mount base, etc.). */
+  vite?: ViteDevBridgeOptions;
+}
+/**
+ * Mount the code-server launcher into an existing Vite dev server. Returns two
+ * plugins: a bridge that starts the devframe RPC + WebSocket server (so the
+ * launcher can detect/start/stop code-server), and a static mount that serves
+ * the bundled SPA at the mount base. The bridge is listed first so its
+ * `__connection.json` route is matched ahead of the SPA fallback.
+ */
+declare function codeServerVite(options?: CodeServerViteOptions): DevframeVitePlugin[];
+//#endregion
+export { CodeServerViteOptions, codeServerVite };

package/dist/vite.mjs

@@ -0,0 +1,20 @@
+import { n as createCodeServerDevframe } from "./src-BDRH3xta.mjs";
+import { viteDevBridge } from "devframe/helpers/vite";
+//#region src/vite.ts
+/**
+* Mount the code-server launcher into an existing Vite dev server. Returns two
+* plugins: a bridge that starts the devframe RPC + WebSocket server (so the
+* launcher can detect/start/stop code-server), and a static mount that serves
+* the bundled SPA at the mount base. The bridge is listed first so its
+* `__connection.json` route is matched ahead of the SPA fallback.
+*/
+function codeServerVite(options = {}) {
+	const { vite, ...codeServerOptions } = options;
+	const definition = createCodeServerDevframe(codeServerOptions);
+	return [viteDevBridge(definition, {
+		...vite,
+		devMiddleware: true
+	}), viteDevBridge(definition, vite)];
+}
+//#endregion
+export { codeServerVite };

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@devframes/plugin-code-server",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "Run code-server (VS Code in the browser) as a devframe panel — detect a local install, launch it on demand, and embed the editor in an auto-authenticated iframe.",
+  "author": "Anthony Fu <anthonyfu117@hotmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/devframes/devframe#readme",
+  "repository": {
+    "directory": "plugins/code-server",
+    "type": "git",
+    "url": "git+https://github.com/devframes/devframe.git"
+  },
+  "bugs": "https://github.com/devframes/devframe/issues",
+  "keywords": [
+    "devframe",
+    "devframe-plugin",
+    "devtools",
+    "code-server",
+    "vscode"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./client": "./dist/client/index.mjs",
+    "./cli": "./dist/cli.mjs",
+    "./constants": "./dist/constants.mjs",
+    "./node": "./dist/node/index.mjs",
+    "./rpc": "./dist/rpc/index.mjs",
+    "./types": "./dist/types.mjs",
+    "./vite": "./dist/vite.mjs",
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.mts",
+  "bin": {
+    "devframe-code-server": "./bin.mjs"
+  },
+  "files": [
+    "bin.mjs",
+    "dist"
+  ],
+  "peerDependencies": {
+    "vite": "^8.0.0",
+    "devframe": "0.5.4"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "get-port-please": "^3.2.0",
+    "iframe-pane": "^1.1.0",
+    "nostics": "^1.1.4"
+  },
+  "devDependencies": {
+    "@antfu/design": "^0.2.1",
+    "@iconify-json/ph": "^1.2.0",
+    "@storybook/html-vite": "^10.4.6",
+    "@types/node": "^25.9.1",
+    "colorjs.io": "^0.6.0",
+    "h3": "2.0.1-rc.22",
+    "storybook": "^10.4.6",
+    "tsdown": "^0.22.0",
+    "unocss": "^66.0.0",
+    "vite": "^8.0.14",
+    "vitest": "^4.1.7",
+    "ws": "^8.21.0",
+    "devframe": "0.5.4"
+  },
+  "scripts": {
+    "build": "tsdown && vite build --config src/spa/vite.config.ts",
+    "watch": "tsdown --watch",
+    "typecheck": "tsc --noEmit",
+    "dev": "vite --config src/spa/vite.config.ts --host 0.0.0.0",
+    "storybook": "storybook dev -p 6013 --host 0.0.0.0",
+    "build-storybook": "storybook build",
+    "test": "vitest run"
+  }
+}