@isothrum/editor 0.0.0-stage → 0.1.0

package/dist/types/lib/tool/text/index.d.ts

@@ -0,0 +1,419 @@
+import { type EditorText } from "./en";
+export type { EditorText };
+export declare function editorText(lang: string): EditorText;
+/** English: the source the other languages follow. */
+export declare const defaultText: {
+    toolbar: {
+        blocks: {
+            switch: string;
+            router: string;
+            firewall: string;
+            container: string;
+            vm: string;
+            mine: string;
+        };
+        kindsOf: (block: string) => string;
+        devices: string;
+        hand: string;
+        select: string;
+        lan: string;
+        lanTitle: string;
+        switch: string;
+        switchTitle: string;
+        note: string;
+        noteTitle: string;
+        forget: (device: string) => string;
+        forgetLabel: (device: string) => string;
+        undo: string;
+        undoTitle: string;
+        redo: string;
+        redoTitle: string;
+    };
+    hints: {
+        lan: string;
+        note: string;
+        place: (device: string) => string;
+        hand: string;
+        cable: string;
+        select: string;
+    };
+    devices: {
+        router: {
+            label: string;
+            hint: string;
+        };
+        "router-frr": {
+            label: string;
+            hint: string;
+        };
+        firewall: {
+            label: string;
+            hint: string;
+        };
+        container: {
+            label: string;
+        };
+        web: {
+            label: string;
+            hint: string;
+        };
+        database: {
+            label: string;
+            hint: string;
+        };
+        desktop: {
+            label: string;
+            hint: string;
+        };
+        "linux-vm": {
+            label: string;
+        };
+        "ubuntu-vm": {
+            label: string;
+        };
+        "kali-vm": {
+            label: string;
+        };
+        "windows-vm": {
+            label: string;
+        };
+        workstation: {
+            label: string;
+            hint: string;
+        };
+        "cisco-iol": {
+            label: string;
+            hint: string;
+        };
+        "cisco-iol-l2": {
+            label: string;
+            hint: string;
+        };
+    };
+    myDevice: (what: string) => string;
+    myDeviceRouter: string;
+    status: {
+        loading: string;
+        toFix: (count: number) => string;
+        valid: string;
+    };
+    run: {
+        autoStart: string;
+        autoStartNote: string;
+        statusTitle: (up: number, total: number) => string;
+        probed: string;
+        inferred: string;
+        run: string;
+        starting: string;
+        stop: string;
+        stopping: string;
+        vmsTitle: string;
+        runVmsTitle: string;
+        startingVmsLog: string;
+        runTitle: string;
+        startingLog: string;
+        window: string;
+        running: string;
+        stopped: string;
+        noDocker: string;
+        noLiveCapture: (wireshark: boolean, dir: string) => string;
+    };
+    capture: {
+        capturing: (network: string) => string;
+        writingTo: string;
+        live: string;
+        stop: string;
+        start: string;
+        runFirst: string;
+    };
+    link: {
+        suspend: string;
+        resume: string;
+        suspendAll: string;
+        resumeAll: string;
+        cableSuspended: string;
+        lanSuspended: (ports: number) => string;
+        runFirst: string;
+    };
+    export: string;
+    engineDidntLoad: (error: string) => string;
+    engineFailed: (error: string) => string;
+    toasts: {
+        brokenLink: string;
+        openedShared: (lab: string) => string;
+        linkCopied: string;
+        copyPrompt: string;
+        savedDevice: (device: string) => string;
+        gns3Opened: (lab: string, machines: number, lans: number) => string;
+        undoBringsBack: string;
+        gns3Unreadable: string;
+    };
+    windows: {
+        machine: string;
+        lan: (lan: string) => string;
+        cable: (a: string, b: string) => string;
+        portOn: (machine: string) => string;
+        cableNote: string;
+        removeCable: string;
+        conditions: {
+            title: string;
+            delay: string;
+            jitter: string;
+            loss: string;
+            rate: string;
+            hint: string;
+            onLan: string;
+            onVlan: string;
+        };
+        selected: (count: number) => string;
+        selection: (items: number, cables: number) => string;
+        deleteSelection: (count: number) => string;
+        close: string;
+    };
+    lab: {
+        title: string;
+        containers: string;
+        vms: string;
+        lans: string;
+        cables: string;
+        toFix: string;
+        valid: string;
+        routing: string;
+    };
+    menu: {
+        menu: string;
+        example: string;
+        vlanExample: string;
+        gns3: string;
+        gns3File: string;
+        share: string;
+        fit: string;
+        clear: string;
+        light: string;
+        dark: string;
+        style: string;
+        styles: {
+            sketch: string;
+            business: string;
+        };
+        language: string;
+        about: string;
+        blog: string;
+    };
+    welcome: {
+        menuHint: string;
+        toolbarHint: string;
+        pitch: string;
+        example: string;
+        how: string;
+    };
+    inspector: {
+        name: string;
+        runsAs: string;
+        automaticRouter: string;
+        container: string;
+        vm: string;
+        routerNote: string;
+        image: string;
+        keepRunning: string;
+        applianceNote: string;
+        ciscoOs: string;
+        needsKvm: string;
+        dynamipsFirmware: (name: string) => string;
+        iosConfig: string;
+        iosConfigHint: string;
+        keepRunningHint: string;
+        os: string;
+        provision: string;
+        ports: string;
+        access: string;
+        cables: string;
+        noCables: string;
+        saveTitle: string;
+        save: string;
+        remove: string;
+    };
+    canvas: {
+        imageShort: string;
+        hosts: (n: number) => string;
+        roles: {
+            router: string;
+            firewall: string;
+            workstation: string;
+            server: string;
+            desktop: string;
+            host: string;
+        };
+        switchModel: (ports: number) => string;
+        live: {
+            up: string;
+            starting: string;
+            unhealthy: string;
+            down: string;
+            portUp: string;
+            portDown: string;
+            portUnknown: string;
+            lanPorts: (up: number, total: number) => string;
+            cable: {
+                up: string;
+                cut: string;
+                down: string;
+            };
+            cableShort: {
+                cut: string;
+                down: string;
+            };
+        };
+        editTitle: (what: string) => string;
+        unnamed: string;
+        machineName: string;
+        vm: string;
+        automatic: string;
+        container: string;
+        access: string;
+        addressTitle: (network: string, fixed: boolean) => string;
+        fixed: string;
+        addressOn: (network: string) => string;
+        lanName: string;
+        addressBlock: string;
+        internetOnTitle: string;
+        internetOffTitle: string;
+        internetOn: string;
+        internetOff: string;
+        showAreaTitle: string;
+        hideAreaTitle: string;
+        showArea: string;
+        hideArea: string;
+        switchName: string;
+        port: (n: number) => string;
+        trunkPort: string;
+        trunkCarries: (vlans: string) => string;
+        noVlan: string;
+        clickToChange: string;
+        vlanNumber: string;
+        vlanBlock: string;
+        remove: (what: string) => string;
+        routerName: string;
+        portFree: (port: string) => string;
+        textOnly: string;
+        box: string;
+        ellipse: string;
+        colors: {
+            yellow: string;
+            red: string;
+            blue: string;
+            green: string;
+            violet: string;
+        };
+        color: (color: string) => string;
+        write: string;
+        note: string;
+        noteName: string;
+    };
+    exportPanel: {
+        copy: string;
+        copied: string;
+        labName: string;
+        fixFirst: string;
+        download: (lab: string) => string;
+        onlySpec: string;
+        where: string;
+        whereIntro: string;
+        mixed: string;
+        install: string;
+        files: (count: number) => string;
+        downloadOnly: (target: string) => string;
+        downloadTarget: (target: string) => string;
+        withIsoloom: string;
+        withTool: string;
+        run: string;
+        specIntro: string;
+        showSpec: string;
+        hideSpec: string;
+        containersAndVms: string;
+        dockerOnOneVm: string;
+        oneVmPerMachine: string;
+    };
+    issues: {
+        vlanBlocks: (vlan: string, block: string, other: string, sw: string) => string;
+        areaBlock: (lan: string, block: string, switches: string) => string;
+        noName: {
+            machine: string;
+            lan: string;
+            switch: string;
+        };
+        sameName: {
+            machine: (name: string) => string;
+            lan: (name: string) => string;
+            switch: (name: string) => string;
+        };
+        badPort: (machine: string, entry: string) => string;
+    };
+    gns3: {
+        notGns3: string;
+        noTopology: string;
+        cisco: (node: string, kind: string) => string;
+        firewall: (node: string) => string;
+        noEquivalent: (node: string, type: string) => string;
+        noNodes: string;
+    };
+    account: {
+        signIn: string;
+        signOut: string;
+        signedInAs: (name: string) => string;
+    };
+    projects: {
+        save: string;
+        saveAs: string;
+        openList: string;
+        saveAsPrompt: string;
+        windowTitle: string;
+        loading: string;
+        none: string;
+        open: string;
+        openButton: string;
+        delete: (name: string) => string;
+        confirmDelete: (name: string) => string;
+        failed: (error: string) => string;
+        history: (name: string) => string;
+        noVersions: string;
+        restore: string;
+        historyHint: string;
+        opened: (name: string) => string;
+        status: {
+            idle: (name: string) => string;
+            saving: (name: string) => string;
+            saved: (name: string) => string;
+            error: (name: string) => string;
+        };
+    };
+    machineRun: {
+        display: string;
+        displayTitle: string;
+        displayOpened: (what: string) => string;
+        consoleHint: string;
+        runFirst: string;
+        running: string;
+        stopped: string;
+        unknown: string;
+        console: string;
+        restart: string;
+        stop: string;
+        start: string;
+        snapshots: string;
+        takeSnapshot: string;
+        snapshotHint: string;
+        snapshotPrompt: string;
+        noSnapshots: string;
+        restore: string;
+        inUse: string;
+        ownImage: string;
+        deleteSnapshot: (label: string) => string;
+    };
+    update: {
+        available: (version: string) => string;
+        restart: string;
+        installing: string;
+        later: string;
+    };
+};

package/dist/types/lib/tool/topology.d.ts

@@ -0,0 +1,2 @@
+import { type CableEdge, type LabNode } from "./model";
+export declare function toTopology(name: string, nodes: LabNode[], edges: CableEdge[]): string;

package/dist/types/lib/tool/vlans.d.ts

@@ -0,0 +1,24 @@
+import { type CableEdge, type LabNode, type SwitchNode } from "./model";
+/** VLANs and switch ports. VLANs are lab-wide: `vlan10` is the same network on every switch. */
+export declare const vlanName: (id: number) => string;
+export declare function vlanColor(id: number): string;
+/** A trunk port's look: striped with the colors of the VLANs it carries (muted when none). */
+export declare function trunkStripes(vlans: {
+    id: number;
+}[]): string;
+/** The VLAN number in a LAN's name (`vlan10` -> 10), when the LAN is a VLAN. */
+export declare function vlanOf(lanName: string): number | null;
+/** Whether a switch handle is a trunk: the T port, or any port set to "trunk". */
+export declare function isTrunkPort(sw: SwitchNode, handle: string | null | undefined): boolean;
+/** The VLAN of an access port, or null (a trunk, an unassigned port, not a port). */
+export declare function accessVlan(sw: SwitchNode, handle: string | null | undefined): number | null;
+/** A port's label next to its cable: 1, 2… or T. */
+export declare function switchPortLabel(handle: string | null | undefined): string;
+/**
+ * The LAN each switch's VLANs belong to in isoloom.yml: switches joined by a cable, or sharing a
+ * VLAN number (VLANs are lab-wide here), are one LAN, named after the first. Returns a switch's
+ * LAN name by its id.
+ */
+export declare function switchLans(nodes: LabNode[], edges: CableEdge[]): (switchId: string) => string;
+/** The name Isoloom gives a trunk's interface: its LAN's, within Linux's limit (`sw1`, then `sw1.10`). */
+export declare const trunkInterface: (lan: string) => string;

package/dist/types/lib/utils.d.ts

@@ -0,0 +1,2 @@
+import { type ClassValue } from "clsx";
+export declare function cn(...inputs: ClassValue[]): string;

package/dist/types/model.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The editor's lab model and conversions, with no React: a lab's nodes and cables, the topology the
+ * engine reads, and helpers to lay a topology out again. Used by hosts that work with labs outside
+ * the canvas (the website's MCP server builds and reads topologies with these).
+ */
+export * from "./lib/tool/model.js";
+export { type Topology, type LaidOut, draftFromTopology } from "./lib/tool/layout.js";
+export { toTopology } from "./lib/tool/topology.js";
+export { PORT_PROTOCOLS, readPorts, portsText, type Service } from "./lib/tool/ports.js";
+export { exampleLab, vlanExample } from "./lib/tool/examples.js";
+export { planOf, ownFiles, type Engine, type Plan, type GeneratedFile } from "./lib/tool/engine.js";
+export { groupByTarget, type Target, type TargetText } from "./lib/tool/export-targets.js";
+export { canvasIssues, type IssueText } from "./lib/tool/issues.js";

package/package.json

@@ -1,6 +1,90 @@
 {
   "name": "@isothrum/editor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "The Isothrum lab editor: a React canvas that draws infrastructure labs and compiles them to an Isoloom spec, plus the Isothrum WebAssembly engine. Shared by the Isothrum desktop app and isothrum.com.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./model": {
+      "types": "./dist/types/model.d.ts",
+      "import": "./dist/model.js",
+      "default": "./dist/model.js"
+    },
+    "./styles/globals.css": "./styles/globals.css",
+    "./styles/theme.css": "./styles/theme.css",
+    "./wasm/isothrum_wasm.js": "./wasm/isothrum_wasm.js",
+    "./wasm/isothrum_wasm_bg.wasm": "./wasm/isothrum_wasm_bg.wasm",
+    "./build-desktop-editor": "./scripts/build-desktop-editor.mjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "styles",
+    "wasm",
+    "desktop-editor",
+    "scripts",
+    "tsconfig.json",
+    "tsconfig.build.json",
+    "README.md",
+    "LICENSE",
+    "NOTICE",
+    "PUBLISHING.md"
+  ],
+  "scripts": {
+    "build": "npm run build:lib && npm run build:types && npm run build:desktop",
+    "build:lib": "node scripts/build-lib.mjs",
+    "build:types": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "build:desktop": "node scripts/build-desktop-editor.mjs dist/desktop",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "check": "npm run typecheck && npm run test && npm run build",
+    "prepack": "npm run build"
+  },
+  "peerDependencies": {
+    "@xyflow/react": "^12.12.0",
+    "next-themes": "^0.4.6",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "dependencies": {
+    "@base-ui/react": "^1.5.0",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "lucide-react": "^1.16.0",
+    "roughjs": "^4.6.6",
+    "simple-icons": "^16.34.0",
+    "tailwind-merge": "^3.6.0"
+  },
+  "devDependencies": {
+    "@fontsource-variable/geist": "^5.3.0",
+    "@fontsource-variable/geist-mono": "^5.3.0",
+    "@fontsource-variable/shantell-sans": "^5.3.0",
+    "@tailwindcss/cli": "^4.3.3",
+    "@tailwindcss/typography": "^0.5.19",
+    "@types/node": "^20",
+    "@types/react": "^19",
+    "@types/react-dom": "^19",
+    "@xyflow/react": "^12.12.0",
+    "esbuild": "^0.28.2",
+    "fast-check": "^4.10.2",
+    "next-themes": "^0.4.6",
+    "react": "19.2.4",
+    "react-dom": "19.2.4",
+    "shadcn": "^4.8.0",
+    "tailwindcss": "^4",
+    "tsc-alias": "^1.8.10",
+    "tw-animate-css": "^1.4.0",
+    "typescript": "^5",
+    "vitest": "^4.1.11"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/scripts/build-desktop-editor.mjs

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+// Builds the editor as a static page for a desktop/offline host (Tauri): the script, the styles,
+// the fonts and the WebAssembly engine, into the folder given (default out-desktop/).
+//   node scripts/build-desktop-editor.mjs [out]
+import { build } from "esbuild";
+import { execFileSync } from "node:child_process";
+import { cpSync, mkdirSync, rmSync } from "node:fs";
+import { join, resolve } from "node:path";
+
+const root = resolve(import.meta.dirname, "..");
+const out = resolve(process.argv[2] ?? join(root, "out-desktop"));
+rmSync(out, { recursive: true, force: true });
+mkdirSync(out, { recursive: true });
+
+await build({
+  entryPoints: { editor: join(root, "desktop-editor/main.tsx") },
+  bundle: true,
+  format: "esm",
+  outdir: out,
+  minify: true,
+  sourcemap: false,
+  jsx: "automatic",
+  loader: { ".woff2": "file", ".woff": "file" },
+  assetNames: "fonts/[name]-[hash]",
+  // The package's "@/..." imports resolve to src/.
+  alias: { "@": join(root, "src") },
+  define: {
+    "process.env.NODE_ENV": '"production"',
+  },
+  // Some libraries read process.env beyond what's defined above: no Node here.
+  banner: { js: 'globalThis.process ??= { env: { NODE_ENV: "production" } };' },
+  // The engine is loaded at run time from /wasm, as on the site.
+  external: ["/wasm/*"],
+  logLevel: "warning",
+});
+
+execFileSync(join(root, "node_modules/.bin/tailwindcss"), ["-i", join(root, "desktop-editor/editor.css"), "-o", join(out, "styles.css"), "--minify"], {
+  cwd: root,
+  stdio: ["ignore", "ignore", "inherit"],
+});
+cpSync(join(root, "desktop-editor/index.html"), join(out, "index.html"));
+cpSync(join(root, "wasm"), join(out, "wasm"), { recursive: true });
+console.log(`desktop editor: ${out}`);

package/scripts/build-lib.mjs

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+// Bundles the package's two entries to ESM, leaving every dependency external so the host's bundler
+// resolves and dedupes them (React above all). Types are emitted separately by tsc.
+//   node scripts/build-lib.mjs
+import { build } from "esbuild";
+import { resolve } from "node:path";
+
+const root = resolve(import.meta.dirname, "..");
+
+const common = {
+  bundle: true,
+  format: "esm",
+  platform: "neutral",
+  target: "es2020",
+  jsx: "automatic",
+  sourcemap: true,
+  // "@/..." resolves to src/; everything else stays an external import.
+  alias: { "@": resolve(root, "src") },
+  packages: "external",
+  logLevel: "warning",
+};
+
+// The React component entry: a client module for the host (Next marks it so).
+await build({
+  ...common,
+  entryPoints: { index: resolve(root, "src/index.ts") },
+  outdir: resolve(root, "dist"),
+  banner: { js: '"use client";' },
+});
+
+// The pure lab-model entry: no React, safe on a server (no "use client").
+await build({
+  ...common,
+  entryPoints: { model: resolve(root, "src/model.ts") },
+  outdir: resolve(root, "dist"),
+});
+
+console.log("lib: dist/index.js, dist/model.js");