@isothrum/editor 0.0.0-stage → 0.1.0

package/dist/types/components/tool/hooks/use-context-menus.d.ts

@@ -0,0 +1,25 @@
+/** A right-click on a machine (desktop): its console, its screen, starting or stopping it. */
+export interface MachineMenuAt {
+    x: number;
+    y: number;
+    machine: string;
+}
+/**
+ * A right-click on a cable or a LAN (desktop): capture its traffic, suspend or resume it.
+ * `machines`: a cable's ends that are machines (their ports); none for a whole LAN.
+ */
+export interface LinkMenuAt {
+    x: number;
+    y: number;
+    network: string;
+    title: string;
+    machines?: string[];
+}
+/** The right-click menus open on the canvas (desktop app only). */
+export declare function useContextMenus(): {
+    machineMenu: MachineMenuAt | null;
+    setMachineMenu: import("react").Dispatch<import("react").SetStateAction<MachineMenuAt | null>>;
+    linkMenu: LinkMenuAt | null;
+    setLinkMenu: import("react").Dispatch<import("react").SetStateAction<LinkMenuAt | null>>;
+    closeMenus: () => void;
+};

package/dist/types/components/tool/hooks/use-design.d.ts

@@ -0,0 +1,10 @@
+import type { Design } from "../../../lib/tool/model.js";
+/**
+ * The canvas's look: a preference of this browser (a share link brings its own). The desktop
+ * app opens in business, the site in the sketch.
+ */
+export declare function useDesign(): {
+    design: Design;
+    setDesign: import("react").Dispatch<import("react").SetStateAction<Design>>;
+    chooseDesign: (d: Design) => void;
+};

package/dist/types/components/tool/hooks/use-desktop.d.ts

@@ -0,0 +1,50 @@
+import { type DesktopInfo, type Invoke, type LabLive, type Snapshot, type SuspendedLink } from "../../../lib/tool/desktop.js";
+/** The desktop app's side of the editor: running the lab on this machine (none in a browser). */
+export type RunState = "stopped" | "starting" | "running" | "stopping";
+/** The app's commands (null in a browser), what the app says about itself, and the lab's run state. */
+export declare function useDesktopState(): {
+    invoke: Invoke | null;
+    info: DesktopInfo | null;
+    setInfo: import("react").Dispatch<import("react").SetStateAction<DesktopInfo | null>>;
+    run: RunState;
+    setRun: import("react").Dispatch<import("react").SetStateAction<RunState>>;
+    update: string | null;
+    setUpdate: import("react").Dispatch<import("react").SetStateAction<string | null>>;
+    updating: boolean;
+    setUpdating: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+};
+export type DesktopState = ReturnType<typeof useDesktopState>;
+/**
+ * The running lab now (desktop): its machines' states and their ports, read from them, its
+ * machines' snapshots, and the links cut. Read again every 3 seconds while it runs.
+ */
+export declare function useLiveLab(invoke: Invoke | null, labName: string, run: RunState): {
+    machineStates: Record<string, string>;
+    snapshots: Snapshot[];
+    links: SuspendedLink[];
+    setLinks: import("react").Dispatch<import("react").SetStateAction<SuspendedLink[]>>;
+    live: LabLive | null;
+    setLive: import("react").Dispatch<import("react").SetStateAction<LabLive | null>>;
+    refreshStates: () => Promise<void>;
+};
+export type LiveLab = ReturnType<typeof useLiveLab>;
+/** The Run window's state and its log. */
+export declare function useRunPanel(): {
+    runOpen: boolean;
+    setRunOpen: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    runLog: string;
+    setRunLog: import("react").Dispatch<import("react").SetStateAction<string>>;
+};
+/** Auto-start (desktop): this lab starts when the app opens on it, once the engine has its spec. */
+export declare function useAutoStart(invoke: Invoke | null, labName: string): {
+    autoStart: boolean;
+    setAutoStart: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    autoStartPending: boolean;
+    setAutoStartPending: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+};
+/**
+ * On opening: what the app says about itself, whether a newer release is out (signed; from
+ * GitHub's latest release), and whether the lab still runs from before the app was reopened. If
+ * not, and it is set to, it starts.
+ */
+export declare function useDesktopStartup(state: DesktopState, initialName: string, setAutoStartPending: (pending: boolean) => void): void;

package/dist/types/components/tool/hooks/use-devices.d.ts

@@ -0,0 +1,17 @@
+import type { MachineData } from "../../../lib/tool/model.js";
+import { type Preset } from "../../../lib/tool/presets.js";
+import type { EditorText } from "../../../lib/tool/text/index.js";
+import type { Tools } from "./use-tools";
+/**
+ * Devices saved from the canvas, in this browser (loaded after mount: no localStorage on the
+ * server), and the toolbar's blocks, each placing the kind picked last.
+ */
+export declare function useDevices(tools: Tools, setToast: (message: string) => void, t: EditorText): {
+    presets: Preset[];
+    blocks: import("../../../lib/tool/blocks.js").Block[];
+    blockChoice: Record<string, string>;
+    pickFromBlock: (block: string, tool: string) => void;
+    /** Saving a machine again under the same name replaces that device. */
+    saveDevice: (m: MachineData) => void;
+    forgetDevice: (id: string) => void;
+};

package/dist/types/components/tool/hooks/use-downloads.d.ts

@@ -0,0 +1,9 @@
+import type { Engine, Plan } from "../../../lib/tool/engine.js";
+/** The Export window's downloads: the whole lab, one target, or isoloom.yml alone. */
+export declare function useDownloads(engine: Engine | null, plan: Plan | null, topology: string, labName: string): {
+    downloadError: string | null;
+    downloadAll: () => void;
+    /** One target's zip: isoloom.yml and that target's folder. */
+    downloadTarget: (dir: string) => void;
+    downloadSpec: () => void;
+};