@draftably/editor 0.1.0 → 0.2.0

package/dist/types/src/components/controls.d.ts

@@ -1,6 +1,6 @@
 /** Small form and button primitives shared by panels, menus and dialogs. */
 import { type JSX } from 'solid-js';
-import { type CommandId } from '../state/commands';
+import type { Command } from '../state/canvas-commands';
 /** Attributes that give an element the shared tooltip. See `Tips`. */
 export declare const tip: (label: string, keys?: string, hint?: string) => {
     'data-tip': string;
@@ -20,12 +20,15 @@ export declare function IconButton(props: {
     pressed?: boolean;
     variant?: 'ghost' | 'primary';
 } & Omit<JSX.ButtonHTMLAttributes<HTMLButtonElement>, 'children'>): JSX.Element;
-/** An icon button that runs a command and explains itself from the command's own words. */
-export declare function CommandButton(props: {
-    command: CommandId;
+/**
+ * An icon button for one table of commands: it runs a command and explains itself from the
+ * command's own words.
+ */
+export declare const commandButton: <Id extends string>(table: Record<Id, Command>, run: (id: Id) => void, enabled: (id: Id) => boolean) => (props: {
+    command: Id;
     label?: string;
     pressed?: boolean;
-}): JSX.Element;
+}) => JSX.Element;
 /** Text with each word of a query marked where it matches. */
 export declare function Highlight(props: {
     text: string;

package/dist/types/src/state/canvas-commands.d.ts

@@ -0,0 +1,169 @@
+export interface Command {
+    label: string;
+    /** Shortcut shown in menus. */
+    keys?: string;
+    icon?: string;
+    /** What it does, in a sentence: shown in tooltips and the palette. */
+    hint?: string;
+    run: () => unknown;
+    /** Allowed while a timeline preview is open. */
+    duringTimeline?: boolean;
+    /** Exits the brush before running. */
+    endsBrush?: boolean;
+    enabled?: () => boolean;
+    /** Why this cannot work here, shown instead of running it. */
+    blocked?: () => string | null;
+}
+declare function undoCommand(): void;
+declare function redoCommand(): void;
+export declare const hasSelection: () => boolean;
+export declare const canvasCommands: {
+    undo: {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: typeof undoCommand;
+        duringTimeline: true;
+        enabled: () => boolean;
+    };
+    redo: {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: typeof redoCommand;
+        enabled: () => boolean;
+    };
+    'add-node': {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+    };
+    'add-connected': {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => string | undefined;
+    };
+    duplicate: {
+        hint: string;
+        enabled: () => boolean;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+    };
+    group: {
+        hint: string;
+        enabled: () => boolean;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => string;
+    };
+    ungroup: {
+        hint: string;
+        enabled: () => boolean;
+        label: string;
+        keys: string;
+        run: () => void;
+    };
+    pin: {
+        hint: string;
+        enabled: () => boolean;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+    };
+    delete: {
+        hint: string;
+        label: string;
+        enabled: () => boolean;
+        keys: string;
+        icon: string;
+        run: () => void;
+    };
+    'delete-deep': {
+        label: string;
+        keys: string;
+        run: () => void;
+    };
+    layout: {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => Promise<import("./session/layout").LayoutOutcome>;
+        blocked: () => string | null;
+        endsBrush: true;
+    };
+    'layout-rebuild': {
+        hint: string;
+        label: string;
+        keys: string;
+        run: () => Promise<import("./session/layout").LayoutOutcome>;
+        blocked: () => string | null;
+        endsBrush: true;
+    };
+    'layout-accept': {
+        label: string;
+        run: () => void;
+    };
+    'layout-discard': {
+        label: string;
+        run: () => void;
+    };
+    reroute: {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+    };
+    'auto-ports': {
+        hint: string;
+        label: string;
+        keys: string;
+        run: () => void;
+    };
+    fit: {
+        hint: string;
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+        duringTimeline: true;
+    };
+    'zoom-in': {
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+        duringTimeline: true;
+    };
+    'zoom-out': {
+        label: string;
+        keys: string;
+        icon: string;
+        run: () => void;
+        duringTimeline: true;
+    };
+    'reset-camera': {
+        label: string;
+        keys: string;
+        run: () => void;
+        duringTimeline: true;
+    };
+};
+export type CanvasCommandId = keyof typeof canvasCommands;
+/** Run `command` unless a timeline preview or its own check blocks it, reporting failures. */
+export declare function runChecked(id: string, command: Command): undefined;
+export declare const checkedEnabled: (command: Command) => boolean;
+export declare const runCanvasCommand: (id: CanvasCommandId) => undefined;
+export declare const canvasCommandEnabled: (id: CanvasCommandId) => boolean;
+export {};

package/dist/types/src/state/canvas-keyboard.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Canvas shortcuts and shape copy and paste for the active session. The app runs its own keys
+ * around these in `keyboard.ts`; an embedded editor uses them as they are.
+ */
+export declare const isEditable: (el: EventTarget | null) => boolean;
+/**
+ * Run the canvas shortcut for `e`. True when the key was used, or belongs to a field, so the host
+ * should not act on it. `closeMenu` lets Escape close the host's open menu, before it clears the
+ * selection; it returns true when it closed one.
+ */
+export declare function handleCanvasKey(e: KeyboardEvent, closeMenu?: () => boolean): boolean;
+export declare function handleKeyUp(e: KeyboardEvent): void;
+export declare function copyShapes(e: ClipboardEvent): void;
+/** Paste copied shapes: from the clipboard text, or the session's own copy when it is empty. */
+export declare function pasteShapes(e: ClipboardEvent): void;

package/dist/types/src/state/links.d.ts

@@ -4,8 +4,11 @@ import type { DiagramSession } from './session';
  * Null when no file on disk is open.
  */
 export declare function linkBase(s: DiagramSession): string | null;
+/** `href` joined to a URL `link-base`, or null. */
+export declare const joined: (s: DiagramSession, href: string) => string | null;
 /** What opening `href` does, for a tooltip or the Inspector. */
 export declare function describeLink(s: DiagramSession, href: string): string;
+/** A path inside the served folder, relative to it, or null. */
+export declare function servedPath(file: string): string | null;
 /** A link as an exported SVG carries it: file paths from the diagram's folder, URLs as written. */
 export declare function exportHref(s: DiagramSession, href: string): string;
-export declare function openLink(s: DiagramSession, href: string): void;

package/dist/types/src/state/workspace.d.ts

@@ -0,0 +1,3 @@
+import type { WorkspaceInfo } from '../server/workspace';
+/** The served folder, or null on the static site and in an embedded editor. */
+export declare const workspace: import("solid-js").Accessor<WorkspaceInfo | null>, setWorkspace: import("solid-js").Setter<WorkspaceInfo | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@draftably/editor",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "The Draftably diagram editor: drag boxes and lines, and get the .draft source back.",
   "license": "MIT",
   "type": "module",