@isothrum/editor 0.0.0-stage → 0.1.0

package/src/lib/tool/text/en.ts

@@ -0,0 +1,371 @@
+/**
+ * The editor's words, in English: the source the other languages follow. `EditorText` is this
+ * object's type, so a translation that misses a key (or a function's arguments) doesn't compile.
+ * Not translated: machine, LAN and port names, images, OS ids, commands, file names, key letters,
+ * and the engine's own messages (they come from Isoloom).
+ */
+export const en = {
+  toolbar: {
+    blocks: { switch: "Switch", router: "Router", firewall: "Firewall", container: "Container", vm: "Virtual machine", mine: "My devices" },
+    kindsOf: (block: string) => `Kinds of ${block.toLowerCase()}`,
+    devices: "Devices",
+    hand: "Hand: move the canvas",
+    select: "Selection: select, move, delete",
+    lan: "LAN",
+    lanTitle: "LAN / VLAN: an area; machines inside it get an address on it",
+    switch: "Switch",
+    switchTitle: "Switch: ports in VLANs, and a trunk",
+    note: "Note",
+    noteTitle: "Note: text, a box or an ellipse, to explain the lab",
+    forget: (device: string) => `Forget ${device}`,
+    forgetLabel: (device: string) => `Forget the device ${device}`,
+    undo: "Undo",
+    undoTitle: "Undo · Ctrl/⌘ Z",
+    redo: "Redo",
+    redoTitle: "Redo · Ctrl/⌘ Shift Z",
+  },
+  /** The line under the toolbar. */
+  hints: {
+    lan: "Click on the canvas to place a LAN; machines inside it get an address on it. Double-click its name or range to edit it.",
+    note: "Click on the canvas to place a note, then double-click it to write. Notes stay in the editor, not in isoloom.yml.",
+    place: (device: string) => `Click on the canvas to place a ${device.toLowerCase()}. Esc to cancel.`,
+    hand: "Drag to move the canvas. Press V to select again.",
+    cable: "Drag from a dot on one machine to another to cable them.",
+    select: "Drag on the canvas to select several machines: Delete, or Ctrl/⌘ C, V, D. Hold Space to move the canvas.",
+  },
+  /** The built-in devices of the toolbar, by preset id. Without a hint, the hint is what the device runs (its OS or image). */
+  devices: {
+    router: { label: "Router", hint: "automatic: its networks reach each other" },
+    "router-frr": { label: "Router (FRR)", hint: "FRRouting container you configure" },
+    firewall: { label: "Firewall", hint: "nftables on Alpine" },
+    container: { label: "Linux container" },
+    web: { label: "Web server", hint: "nginx, port 80" },
+    database: { label: "Database", hint: "PostgreSQL, port 5432" },
+    desktop: { label: "Linux desktop", hint: "Xfce with VNC: right-click it, Screen; password vncpassword" },
+    "linux-vm": { label: "Linux VM" },
+    "ubuntu-vm": { label: "Ubuntu VM" },
+    "kali-vm": { label: "Kali VM" },
+    "windows-vm": { label: "Windows VM" },
+    workstation: { label: "Workstation", hint: "where the user lands" },
+    "cisco-iol": { label: "Cisco IOL router", hint: "IOS on Linux, your vrnetlab build" },
+    "cisco-iol-l2": { label: "Cisco IOL switch", hint: "IOL-L2, your vrnetlab build" },
+  },
+  /** A device saved from the canvas: what it runs (an image, an OS, or this). */
+  myDevice: (what: string) => `your device: ${what}`,
+  myDeviceRouter: "automatic router",
+  status: {
+    loading: "Loading…",
+    toFix: (count: number) => `${String(count)} to fix`,
+    valid: "Valid",
+  },
+  run: {
+    autoStart: "Start this lab when the app opens",
+    autoStartNote: "On this computer, when the app opens on this lab and it isn't running already.",
+    statusTitle: (up: number, total: number) => `${String(up)} of ${String(total)} machines up`,
+    probed: "ports read from the machines",
+    inferred: "ports from the machines' states (VMs aren't probed)",
+    run: "Run",
+    starting: "Starting…",
+    stop: "Stop",
+    stopping: "Stopping…",
+    vmsTitle: "A lab with VMs runs with Vagrant (and VirtualBox or libvirt): install it from vagrantup.com, or export the lab",
+    runVmsTitle: "Run the lab on this machine (VMs with Vagrant)",
+    startingVmsLog: "Starting the VMs with vagrant up (the first time downloads their boxes: minutes)…",
+    runTitle: "Run the lab on this machine (Docker)",
+    startingLog: "Starting the lab with docker compose…",
+    window: "Run on this machine",
+    running: "The lab is running. Select a LAN or a cable to capture its traffic.",
+    stopped: "The lab is stopped.",
+    noDocker:
+      "Docker doesn't answer. Install and start it; on Linux, also add yourself to the docker group (sudo usermod -aG docker $USER, then log in again).",
+    noLiveCapture: (wireshark: boolean, dir: string) =>
+      `${
+        wireshark
+          ? "Wireshark can't capture live from this account: run sudo usermod -aG wireshark $USER, then log in again. Until then, captures"
+          : "Wireshark isn't installed: captures"
+      } are saved as .pcap files under ${dir}.`,
+  },
+  capture: {
+    capturing: (network: string) => `Capturing ${network}`,
+    writingTo: "Writing to",
+    live: "Live in Wireshark.",
+    stop: "Stop the capture",
+    start: "Capture traffic",
+    runFirst: "Run the lab to capture its traffic.",
+  },
+  link: {
+    suspend: "Suspend the link",
+    resume: "Resume the link",
+    suspendAll: "Suspend every link",
+    resumeAll: "Resume every link",
+    cableSuspended: "Link suspended: nothing gets through.",
+    lanSuspended: (ports: number) => (ports === 1 ? "1 link suspended." : `${String(ports)} links suspended.`),
+    runFirst: "Run the lab to suspend its links.",
+  },
+  export: "Export",
+  engineDidntLoad: (error: string) => `The engine didn't load: ${error}`,
+  engineFailed: (error: string) => `The engine failed on this lab: ${error}`,
+  toasts: {
+    brokenLink: "This share link is damaged: the lab couldn't be read.",
+    openedShared: (lab: string) => `Opened the shared lab “${lab}”. Undo brings back yours.`,
+    linkCopied: "Share link copied: anyone who opens it gets a copy of this lab.",
+    copyPrompt: "Copy this link to share the lab:",
+    savedDevice: (device: string) => `Saved “${device}”: it's at the end of the toolbar.`,
+    gns3Opened: (lab: string, machines: number, lans: number) =>
+      `Opened “${lab}” from GNS3: ${String(machines)} machine${machines === 1 ? "" : "s"}, ${String(lans)} LAN${lans === 1 ? "" : "s"}.`,
+    undoBringsBack: "Undo brings back your lab.",
+    gns3Unreadable: "This GNS3 project couldn't be read.",
+  },
+  windows: {
+    machine: "Machine",
+    lan: (lan: string) => `LAN ${lan}`,
+    cable: (a: string, b: string) => `Cable ${a} ↔ ${b}`,
+    portOn: (machine: string) => `Port on ${machine}`,
+    cableNote: "Each cable is its own small network (a /29); the two ends get its first two addresses.",
+    removeCable: "Remove cable",
+    conditions: {
+      title: "Link conditions",
+      delay: "Delay (ms, each way)",
+      jitter: "Jitter (ms)",
+      loss: "Loss (%)",
+      rate: "Bandwidth (Mbit/s)",
+      hint: "A slow or lossy link, applied with tc netem on each end. Empty means none.",
+      onLan: "This cable puts the machine on the LAN: set conditions on the LAN.",
+      onVlan: "Conditions go on a cable or a plain LAN; not on a switch's VLAN yet.",
+    },
+    selected: (count: number) => `${String(count)} selected`,
+    selection: (items: number, cables: number) =>
+      `${String(items)} ${items === 1 ? "item" : "items"}, ${String(cables)} ${cables === 1 ? "cable" : "cables"}. Drag one of them to move them together.`,
+    deleteSelection: (count: number) => `Delete ${String(count)} (Delete key)`,
+    close: "Close",
+  },
+  lab: {
+    title: "Lab",
+    containers: "Containers",
+    vms: "VMs",
+    lans: "LANs",
+    cables: "Cables",
+    toFix: "To fix",
+    valid: "The lab is valid: ready to export.",
+    routing:
+      "A router needs its own forwarding configuration: each cable is its own network, and nothing routes between them for you.",
+  },
+  menu: {
+    menu: "Menu",
+    example: "Load the example lab",
+    vlanExample: "Load the VLAN example",
+    gns3: "Open a GNS3 project…",
+    gns3File: "GNS3 project",
+    share: "Copy a share link",
+    fit: "Fit to screen",
+    clear: "Clear the canvas",
+    light: "Light theme",
+    dark: "Dark theme",
+    style: "Style",
+    styles: { sketch: "Sketch: hand-drawn", business: "Business: crisp and sober" },
+    language: "Language",
+    about: "About Isothrum",
+    blog: "Blog",
+  },
+  welcome: {
+    menuHint: "Example, theme, language…",
+    toolbarHint: "Pick a device, then click on the canvas",
+    pitch: "Draw a network lab of containers and VMs. Download it, ready to run with Docker, Vagrant or Terraform.",
+    example: "Load the example lab",
+    how: "How it works",
+  },
+  inspector: {
+    name: "Name",
+    runsAs: "Runs as",
+    automaticRouter: "Automatic router",
+    container: "Container (Docker)",
+    vm: "Virtual machine",
+    routerNote:
+      "Nothing to configure: the networks it is on (its LANs, VLANs and cables) reach each other through Isoloom's own router. To configure routing yourself, run it as a container (FRR) or a VM.",
+    image: "Image",
+    keepRunning: "Keep it running",
+    applianceNote: "Cisco IOL runs from your own image: build it with",
+    ciscoOs: "Cisco OS",
+    needsKvm: "Runs in QEMU: the Docker host needs /dev/kvm.",
+    dynamipsFirmware: (name: string) => `Put your 7200 IOS image in the download as images/${name}.bin.`,
+    iosConfig: "IOS configuration",
+    iosConfigHint: "Added to the one Isothrum writes (hostname, admin/admin over SSH, each interface’s address). Applied on first boot.",
+    keepRunningHint: "For an image with no service of its own (Alpine, Ubuntu, Kali…): a machine to work from.",
+    os: "Operating system",
+    provision: "Provisioning steps (one per line)",
+    ports: "Service ports",
+    access: "The user lands on this machine",
+    cables: "Cables",
+    noCables: "None yet: drag from one of its dots to another machine.",
+    saveTitle: "Keep this machine's setup as a device in the toolbar, to place it again",
+    save: "Save as a device",
+    remove: "Remove machine",
+  },
+  /** On the canvas: machines, LANs, switches, routers, notes. */
+  canvas: {
+    imageShort: "Image",
+    hosts: (n: number) => (n === 1 ? "1 host" : `${String(n)} hosts`),
+    roles: { router: "Router", firewall: "Firewall", workstation: "Workstation", server: "Server", desktop: "Desktop", host: "Host" },
+    switchModel: (ports: number) => `Switch · ${String(ports)} ports`,
+    live: {
+      up: "Running",
+      starting: "Starting",
+      unhealthy: "Unhealthy",
+      down: "Stopped",
+      portUp: "Link up",
+      portDown: "Link down",
+      portUnknown: "Unknown (stopped, or the port belongs to the device's OS)",
+      lanPorts: (up: number, total: number) => `${String(up)} of ${String(total)} ports on this LAN are up`,
+      cable: { up: "Carries traffic", cut: "Suspended: nothing gets through", down: "Down: an end is stopped or its port is down" },
+      cableShort: { cut: "suspended", down: "down" },
+    },
+    editTitle: (what: string) => `${what}: double-click to edit`,
+    unnamed: "unnamed",
+    machineName: "Machine name",
+    vm: "VM",
+    automatic: "Automatic",
+    container: "Container",
+    access: "access",
+    addressTitle: (network: string, fixed: boolean) => `${network}: double-click to fix this address${fixed ? " (fixed)" : ""}`,
+    fixed: "fixed",
+    addressOn: (network: string) => `Address on ${network}`,
+    lanName: "LAN name",
+    addressBlock: "Address block",
+    internetOnTitle: "Reaches the internet (click to cut it off)",
+    internetOffTitle: "No internet (click to allow it)",
+    internetOn: "Internet access: on",
+    internetOff: "Internet access: off",
+    showAreaTitle: "Show the LAN's area",
+    hideAreaTitle: "Hide the LAN's area (the LAN stays: only its rectangle goes)",
+    showArea: "Show the area",
+    hideArea: "Hide the area",
+    switchName: "Switch name",
+    port: (n: number) => `Port ${String(n)}`,
+    trunkPort: "Trunk port",
+    trunkCarries: (vlans: string) => `trunk, carries ${vlans}`,
+    noVlan: "no VLAN",
+    clickToChange: "(click to change)",
+    vlanNumber: "VLAN number",
+    vlanBlock: "VLAN address block",
+    remove: (what: string) => `Remove ${what}`,
+    routerName: "Router name",
+    portFree: (port: string) => `${port}: free`,
+    textOnly: "Text only",
+    box: "Box",
+    ellipse: "Ellipse",
+    colors: { yellow: "yellow", red: "red", blue: "blue", green: "green", violet: "violet" },
+    color: (color: string) => `Color ${color}`,
+    write: "Double-click to write",
+    note: "Note",
+    /** A note in lists (it has no name of its own). */
+    noteName: "note",
+  },
+  exportPanel: {
+    copy: "Copy",
+    copied: "Copied",
+    labName: "Lab name (the zip's name)",
+    fixFirst: "Fix the lab before exporting",
+    download: (lab: string) => `Download ${lab}.zip`,
+    onlySpec: "Only isoloom.yml",
+    where: "Where it runs",
+    whereIntro: "The zip holds one folder per target. Unzip it, then start the one that suits you.",
+    mixed:
+      "This lab mixes containers and VMs, so it runs with Vagrant. Make it all containers (Docker, Kubernetes, a cloud VM) or all VMs (Proxmox, cloud VMs) to unlock more targets.",
+    install: "Isoloom starts any of them with one command. Install it once:",
+    files: (count: number) => `${String(count)} ${count === 1 ? "file" : "files"}`,
+    downloadOnly: (target: string) => `Download ${target} only (with isoloom.yml)`,
+    downloadTarget: (target: string) => `Download ${target}`,
+    withIsoloom: "With Isoloom (stop it with isoloom down)",
+    withTool: "Or with the tool directly",
+    run: "Run",
+    specIntro: "The lab as one readable file, to keep in Git or edit by hand.",
+    showSpec: "Show the file",
+    hideSpec: "Hide the file",
+    /** Target names: "Vagrant (containers and VMs)", "AWS (one VM per machine)"… */
+    containersAndVms: "containers and VMs",
+    dockerOnOneVm: "Docker on one VM",
+    oneVmPerMachine: "one VM per machine",
+  },
+  /** What the canvas checks before the engine runs. */
+  issues: {
+    vlanBlocks: (vlan: string, block: string, other: string, sw: string) => `${vlan} is ${block} on one switch and ${other} on ${sw}.`,
+    areaBlock: (lan: string, block: string, switches: string) => `The ${lan} area is ${block}, its switches say ${switches}.`,
+    noName: { machine: "A machine has no name.", lan: "A LAN has no name.", switch: "A switch has no name." },
+    sameName: {
+      machine: (name: string) => `Two machines are named “${name}”.`,
+      lan: (name: string) => `Two LANs are named “${name}”.`,
+      switch: (name: string) => `Two switches are named “${name}”.`,
+    },
+    badPort: (machine: string, entry: string) => `“${entry}” in ${machine}'s ports isn't a port: a number from 1 to 65535, then /udp, /http, /https or /tls if it isn't plain TCP.`,
+  },
+  gns3: {
+    notGns3: "This isn't a GNS3 project: open the .gns3 file (inside a .gns3project, it's the one at the top).",
+    noTopology: "This file has no GNS3 topology in it.",
+    cisco: (node: string, kind: string) =>
+      `${node}: a Cisco ${kind} router became an automatic router; its IOS configuration isn't carried over.`,
+    firewall: (node: string) => `${node}: a firewall became an automatic router (its rules aren't carried over).`,
+    noEquivalent: (node: string, type: string) => `${node}: GNS3's “${type}” node has no equivalent; skipped.`,
+    noNodes: "The project has no nodes.",
+  },
+  account: {
+    signIn: "Sign in with Cyber Auth",
+    signOut: "Sign out",
+    signedInAs: (name: string) => `Signed in as ${name}`,
+  },
+  projects: {
+    save: "Save to my projects",
+    saveAs: "Save as a new project…",
+    openList: "Open a project…",
+    saveAsPrompt: "Name of the new project:",
+    windowTitle: "My projects",
+    loading: "Loading your projects…",
+    none: "No project yet: save this lab to start one.",
+    open: "open",
+    openButton: "Open",
+    delete: (name: string) => `Delete ${name}`,
+    confirmDelete: (name: string) => `Delete the project “${name}” and its history?`,
+    failed: (error: string) => `Couldn't load your projects: ${error}`,
+    history: (name: string) => `Earlier versions of ${name}`,
+    noVersions: "No earlier version yet.",
+    restore: "Open",
+    historyHint: "Opening a version puts it on the canvas: Undo brings back the current one, and the next save keeps it.",
+    opened: (name: string) => `Opened “${name}”. Undo brings back the lab that was there.`,
+    status: {
+      idle: (name: string) => `Project “${name}”`,
+      saving: (name: string) => `Saving “${name}”…`,
+      saved: (name: string) => `Saved to “${name}”`,
+      error: (name: string) => `Couldn't save “${name}”`,
+    },
+  },
+  machineRun: {
+    display: "Screen (VNC)",
+    displayTitle: "The machine's screen: its VNC server, or the VM's display",
+    displayOpened: (what: string) => `Opened ${what}`,
+    consoleHint: "Double-click a machine for its console; right-click it for its screen and more.",
+    runFirst: "Run the lab to open its consoles.",
+    running: "Running in the lab.",
+    stopped: "Stopped (the rest of the lab runs).",
+    unknown: "Not in the running lab: start the lab again to add it.",
+    console: "Console",
+    restart: "Restart",
+    stop: "Stop",
+    start: "Start",
+    snapshots: "Snapshots",
+    takeSnapshot: "Take one",
+    snapshotHint: "Save the machine as it is now (its files, a router's saved configuration); not its volumes",
+    snapshotPrompt: "Name of the snapshot (optional):",
+    noSnapshots: "None yet.",
+    restore: "Restore",
+    inUse: "in use",
+    ownImage: "Back to its own image",
+    deleteSnapshot: (label: string) => `Delete the snapshot ${label}`,
+  },
+  update: {
+    available: (version: string) => `Isothrum ${version} is available.`,
+    restart: "Restart to update",
+    installing: "Updating…",
+    later: "Later",
+  },
+};
+
+export type EditorText = typeof en;