@draftably/editor 0.1.0 → 0.3.0

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

@@ -1,61 +0,0 @@
-import type { PdfOptions } from '../cli/pdf';
-/** How PNG, SVG and copied images look. The last choice is remembered in this browser. */
-export interface ExportLook {
-    /** PNG pixels per drawing pixel. */
-    scale: number;
-    /** Leave out the canvas color behind the drawing. */
-    transparent: boolean;
-    /** Draw the title, subtitle and key round the drawing. */
-    heading: boolean;
-    /** Carry the open file's `.draft` source. */
-    source: boolean;
-}
-declare const exportLook: import("solid-js").Accessor<ExportLook>;
-export { exportLook };
-export declare function setExportLook(patch: Partial<ExportLook>): void;
-/**
- * Open a PNG or SVG export that carries `.draft` source as a new scratch diagram, which the
- * example bar offers to save as a file. Resolves false when the image carries no source.
- */
-export declare function openImageSource(file: File): Promise<boolean>;
-export declare const sceneReady: () => boolean;
-export declare const filename: (extension: string) => string;
-/** Open diagram JSON, an editable SVG export, or a saved layout timeline. */
-export declare function importText(text: string, name?: string): Promise<void>;
-/** Embed an image as a new shape, or replace the image in an existing one. */
-export declare function insertImage(file: File, replaceId?: string | null): Promise<void>;
-export declare function openFile(file: File | undefined, replaceImageId?: string | null): Promise<void>;
-/** Convert before switching files; failed or cancelled imports leave the current work in place. */
-export declare function importForeignText(text: string, name?: string): Promise<void>;
-/**
- * Editable SVG: the drawing plus the full diagram in a metadata element. With `onlySelection` and
- * something selected, the image is cropped to the selected objects with a margin and no heading.
- */
-export declare function exportSvg(look?: ExportLook, onlySelection?: boolean): string;
-/** The files the PDF dialog starts with checked, in order. */
-declare const pdfFiles: import("solid-js").Accessor<string[]>;
-export { pdfFiles };
-/** Open the export dialog on PDF with `paths` chosen. */
-export declare function openPdfExport(paths: string[]): void;
-/**
- * Ask the server for one PDF of `paths` in order, as `draftably pdf` makes it, and download it.
- * Throws with the server's message, such as the file whose errors stopped the export.
- */
-export declare function exportPdf(paths: string[], opts: PdfOptions): Promise<void>;
-export type ExportFormat = 'json' | 'svg' | 'png';
-export declare function exportDocument(format: ExportFormat, look?: ExportLook, onlySelection?: boolean): Promise<void>;
-/** What Copy puts on the clipboard: every format at once, or one thing as text. */
-export type CopyAs = 'image' | 'svg' | 'source' | 'link';
-/**
- * Copy the diagram, or the selection when something is selected. `image` writes one clipboard item
- * with PNG, SVG, HTML and the SVG markup as text, so the app it is pasted into takes the format it
- * reads; a browser that refuses some of them gets the richest set it accepts, down to PNG alone.
- * The other kinds copy one thing as text.
- */
-export declare function copyImage(kind?: CopyAs, look?: ExportLook, onlySelection?: boolean): Promise<void>;
-/** Formats the export dialog makes. */
-export type ExportKind = 'png' | 'svg' | 'pdf' | 'copy';
-declare const exportKind: import("solid-js").Accessor<ExportKind>, setExportKind: import("solid-js").Setter<ExportKind>;
-export { exportKind, setExportKind };
-/** Open the export dialog on `kind`. */
-export declare function openExport(kind: ExportKind): void;

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

@@ -1,6 +0,0 @@
-/** Global keyboard shortcuts and clipboard handling for the editor. */
-export declare function handleKeyDown(e: KeyboardEvent): void | null;
-export declare function handleKeyUp(e: KeyboardEvent): void;
-export declare function handleCopy(e: ClipboardEvent): void;
-/** Paste images, copied objects, diagram JSON, or a list of titles to build from. */
-export declare function handlePaste(e: ClipboardEvent): Promise<void>;

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

@@ -1,61 +0,0 @@
-import type { WorkspaceFile, WorkspaceInfo } from '../server/workspace';
-export type LaunchMode = 'static' | 'start' | 'file' | 'example';
-/** The served folder, or null on the static site. */
-export declare const workspace: import("solid-js").Accessor<WorkspaceInfo | null>;
-/** The start screen shown over the editor (the static site's first run, or File › Start). */
-export declare const startOpen: import("solid-js").Accessor<boolean>;
-export declare const setStartOpen: import("solid-js").Setter<boolean>;
-/** Why the requested file or example could not be opened. */
-export declare const launchNotice: import("solid-js").Accessor<string>;
-/** What the page shows: the start page, or the editor on a file, an example or browser storage. */
-export declare const launchView: import("solid-js").Accessor<LaunchMode>;
-export declare const fileUrl: (path: string) => string;
-export declare const exampleUrl: (id: string) => string;
-export declare const startUrl: () => string;
-/**
- * A page of the public site (docs, the Playground). `draftably open` and the dev server have no
- * site, so their links go to draftably.dev.
- */
-export declare const siteUrl: (path?: string) => string;
-/** Home: the served folder's start page, or the public site's landing page. */
-export declare const homeUrl: () => string;
-/** The editor was opened from the Playground, as its "Open in the editor" does. */
-export declare const cameFromPlayground: () => boolean;
-/** What happens to the source when it goes to the Playground, said before it goes. */
-export declare function playgroundNote(): string;
-/**
- * Show the current source in the Playground. A file stays open here and the Playground opens in
- * a new tab; an example goes in this tab, since its source is all it has.
- */
-export declare function openInPlayground(): Promise<undefined>;
-/** List the folder's diagrams again. */
-export declare function refreshWorkspace(): Promise<void>;
-/**
- * Keep the folder's list current while the page is visible, so diagrams an agent or the command
- * line writes appear without a reload. Returns a function that stops watching.
- */
-export declare function watchWorkspace(intervalMs?: number): () => void;
-/** The served file drawn as SVG. The modified time makes a changed file a new image. */
-export declare const thumbnailUrl: (file: WorkspaceFile) => string;
-export declare function launch(): Promise<LaunchMode>;
-/** Write a new diagram file in the served folder. Resolves its path, or throws the reason. */
-export declare function createDiagramFile(path: string, source: string): Promise<string>;
-/** A file name for a title: "Billing flow" → "billing-flow.draft". */
-export declare const fileNameFor: (title: string) => string;
-/** Source for a new, nearly empty diagram. */
-export declare const newDiagramSource: (title: string) => string;
-/** Register work to close before the page shows another file, such as an open Compare. */
-export declare const onLeaveFile: (handler: () => void) => undefined;
-/**
- * Open a served file, or the start page, without reloading the page, so the current drawing
- * stays on screen until the next one is ready. Anything else (an example, another site, an edited
- * example that the browser should ask about) loads as a normal page.
- */
-export declare function go(url: string, { push }?: {
-    push?: boolean | undefined;
-}): Promise<void>;
-/**
- * Route plain clicks on links to served files and the start page through `go`, and follow the
- * browser's back and forward buttons. Returns a function that stops.
- */
-export declare function navigateInPlace(): () => void;

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

@@ -1,39 +0,0 @@
-export type MenuId = 'file' | 'edit' | 'view' | 'layout' | 'help' | 'export' | 'context' | 'appearance' | 'tools';
-export type RightTab = 'properties' | 'arrange' | 'source';
-export type DialogId = 'help' | 'palette' | 'quick-build' | 'confirm' | 'error' | 'export';
-export interface MenuState {
-    id: MenuId;
-    /** Element the menu is anchored to, or a point for context menus. */
-    anchor: HTMLElement | {
-        x: number;
-        y: number;
-    };
-}
-import type { ConfirmRequest } from './session';
-export type { ConfirmRequest };
-export declare const filesOpen: import("solid-js").Accessor<boolean>, inspectorOpen: import("solid-js").Accessor<boolean>, sidebarWidth: import("solid-js").Accessor<number>, inspectorWidth: import("solid-js").Accessor<number>, menu: import("solid-js").Accessor<MenuState | null>, dialog: import("solid-js").Accessor<DialogId | null>, confirmRequest: import("solid-js").Accessor<ConfirmRequest | null>, errorMessage: import("solid-js").Accessor<string>, quickBuildText: import("solid-js").Accessor<string>, rightTab: import("solid-js").Accessor<RightTab>, setRightTab: import("solid-js").Setter<RightTab>, creatingFile: import("solid-js").Accessor<boolean>, setCreatingFile: import("solid-js").Setter<boolean>, savingExample: import("solid-js").Accessor<boolean>, setSavingExample: import("solid-js").Setter<boolean>;
-/** The files panel is on screen: open, with a served folder to list. */
-export declare const filesShown: () => boolean;
-/** The objects panel is on screen. It shares the sidebar with the files panel, which comes first. */
-export declare const objectsOpen: () => boolean;
-export declare const setSidebarWidth: (width: number) => number;
-export declare const resetSidebarWidth: () => 264;
-export declare const setInspectorWidth: (width: number) => number;
-export declare const resetInspectorWidth: () => 280;
-export declare function setObjectsOpen(open: boolean): void;
-export declare function setFilesOpen(open: boolean): void;
-export declare function setInspectorOpen(open: boolean): void;
-export declare const propertiesOpen: () => boolean;
-export declare const arrangeOpen: () => boolean;
-export declare const sourceOpen: () => boolean;
-/** Open the right panel on a tab, or close it if that tab is already showing. */
-export declare function toggleRightTab(tab: RightTab): void;
-/** Hide the side panels, or bring back the ones that were open. */
-export declare function togglePanels(): void;
-export declare function openMenu(id: MenuId, anchor: MenuState['anchor']): void;
-export declare const closeMenu: () => null;
-export declare function openDialog(id: DialogId): void;
-export declare const closeDialog: () => null;
-export declare function confirmAction(request: ConfirmRequest): void;
-export declare function showError(message: string): void;
-export declare function openQuickBuild(text?: string): void;