@bendyline/docblocks 2.0.0 → 2.1.1

package/dist/share/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Canonical wire format for a document embedded in a DocBlocks URL hash.
+ *
+ * The base64 payload is deliberately small and versioned:
+ *
+ *   "DBSHARE" + version byte + mode byte + bounded DBK bytes
+ *
+ * The DBK itself is validated at the filesystem import boundary. Keeping the
+ * launch mode outside the archive means the copied Markdown is never mutated
+ * merely to choose its initial presentation.
+ */
+type SharedDocumentMode = 'slideshow' | 'video' | 'page' | 'document' | 'narrate';
+interface SharedDocumentPayload {
+    readonly archive: Uint8Array;
+    readonly mode: SharedDocumentMode | null;
+}
+type SharedDocumentHashParseResult = {
+    readonly kind: 'none';
+} | {
+    readonly kind: 'valid';
+    readonly payload: SharedDocumentPayload;
+} | {
+    readonly kind: 'invalid';
+    readonly message: string;
+};
+declare const SHARED_DOCUMENT_LIMITS: Readonly<{
+    /** A conservative interoperability threshold, not a universal browser limit. */
+    portableUrlCharacters: 4096;
+    /** Hard cap applied before a hash is copied or decoded. */
+    urlCharacters: 32768;
+    /** Maximum UTF-8 Markdown accepted by the first-party link generator. */
+    markdownBytes: number;
+    /** Maximum compressed DBK bytes carried by the versioned envelope. */
+    archiveBytes: number;
+}>;
+/** Build the exact `#shared(<base64>)` fragment for a bounded DBK archive. */
+declare function createSharedDocumentHash(archive: Uint8Array, mode?: SharedDocumentMode | null): string;
+/** Replace any existing hash on a base URL with a validated shared payload. */
+declare function createSharedDocumentUrl(baseUrl: string, archive: Uint8Array, mode?: SharedDocumentMode | null): string;
+/** Parse a hash without ever treating malformed shared input as workspace routing. */
+declare function parseSharedDocumentHash(hash: string): SharedDocumentHashParseResult;
+
+export { SHARED_DOCUMENT_LIMITS, type SharedDocumentHashParseResult, type SharedDocumentMode, type SharedDocumentPayload, createSharedDocumentHash, createSharedDocumentUrl, parseSharedDocumentHash };

package/dist/share/index.js

@@ -0,0 +1,12 @@
+import {
+  SHARED_DOCUMENT_LIMITS,
+  createSharedDocumentHash,
+  createSharedDocumentUrl,
+  parseSharedDocumentHash
+} from "../chunk-LMMOFRGQ.js";
+export {
+  SHARED_DOCUMENT_LIMITS,
+  createSharedDocumentHash,
+  createSharedDocumentUrl,
+  parseSharedDocumentHash
+};

package/dist/{types-CsX6EN2t.d.ts → types-BEg5SQ1_.d.ts}

@@ -1,7 +1,7 @@
 import { a as WorkspacePath } from './workspace-path-CWVrcuPL.js';
 
 /** Stable error codes shared by every filesystem transport and backend. */
-type FsErrorCode = 'invalid-path' | 'path-escape' | 'not-found' | 'already-exists' | 'type-mismatch' | 'not-empty' | 'permission-denied' | 'conflict' | 'quota-exceeded' | 'not-supported' | 'busy' | 'disposed' | 'closed' | 'aborted' | 'io';
+type FsErrorCode = 'invalid-path' | 'path-escape' | 'not-found' | 'already-exists' | 'type-mismatch' | 'not-empty' | 'permission-denied' | 'conflict' | 'corrupt' | 'quota-exceeded' | 'not-supported' | 'busy' | 'disposed' | 'closed' | 'aborted' | 'io';
 type FsOperation = 'parse-path' | 'read' | 'stat' | 'list' | 'write' | 'create-directory' | 'remove' | 'move' | 'snapshot' | 'watch' | 'dispose';
 /** Plain-data form safe to send over IPC, postMessage, or JSON. */
 interface SerializedFsError {

package/dist/{types-eOlt9J7n.d.ts → types-CueK0tvU.d.ts}

@@ -1,4 +1,4 @@
-import { S as SerializedFsError, r as FileSystemProviderCapabilities, k as FileSystemEntrySnapshot, m as FileSystemFileRead, K as FileSystemWriteOptions, n as FileSystemFileSnapshot, g as FileSystemCreateDirectoryOptions, h as FileSystemDirectorySnapshot, u as FileSystemRemoveOptions, v as FileSystemRemoveResult, o as FileSystemMoveOptions, w as FileSystemSnapshot, C as FileSystemWatchEvent, F as FileCommitResult, j as FileSystemEntry, b as FileMeta } from './types-CsX6EN2t.js';
+import { S as SerializedFsError, r as FileSystemProviderCapabilities, k as FileSystemEntrySnapshot, m as FileSystemFileRead, K as FileSystemWriteOptions, n as FileSystemFileSnapshot, g as FileSystemCreateDirectoryOptions, h as FileSystemDirectorySnapshot, u as FileSystemRemoveOptions, v as FileSystemRemoveResult, o as FileSystemMoveOptions, w as FileSystemSnapshot, C as FileSystemWatchEvent, F as FileCommitResult, j as FileSystemEntry, b as FileMeta } from './types-BEg5SQ1_.js';
 import { a as WorkspacePath } from './workspace-path-CWVrcuPL.js';
 
 /** Stable capabilities shared by the Electron v2 client and native backend. */
@@ -324,22 +324,17 @@ interface DocBlocksHostExportAPI {
     /** Write only to an exact target granted by the main process. */
     save(documentId: string, filename: string, grantId: string | null, data: ArrayBuffer | Uint8Array): Promise<HostExportTargetGrant | null>;
 }
-/** System ffmpeg detection and invocation. */
+/** System ffmpeg detection. */
 interface DocBlocksHostFfmpegAPI {
     /** True if `ffmpeg` is available on PATH (or bundled). */
     available(): Promise<boolean>;
     /** Version string from `ffmpeg -version`, or null if unavailable. */
     version(): Promise<string | null>;
-    /** Render a physically contained workspace-relative Markdown file to MP4. */
-    renderVideo(workspaceId: string, markdownPath: string, options: {
-        fps?: number;
-        quality?: 'draft' | 'normal' | 'high';
-    }): Promise<string>;
 }
 /** Auto-updater control. */
 interface DocBlocksHostUpdaterAPI {
-    /** Kick off a check; resolves to true if an update is available. */
-    checkForUpdates(): Promise<boolean>;
+    /** Kick off a check without collapsing a failed check into "no update". */
+    checkForUpdates(): Promise<UpdateCheckResult>;
     /** Current app version string. */
     getVersion(): Promise<string>;
     /**
@@ -353,6 +348,17 @@ interface DocBlocksHostUpdaterAPI {
     onStatus(listener: (status: UpdaterStatus) => void): () => void;
 }
 type UpdateInstallResult = 'installing' | 'cancelled' | 'not-ready';
+type UpdateCheckResult = {
+    kind: 'available';
+    version: string;
+} | {
+    kind: 'not-available';
+} | {
+    kind: 'store-managed';
+} | {
+    kind: 'error';
+    message: string;
+};
 type UpdaterStatus = {
     kind: 'checking';
 } | {
@@ -421,10 +427,25 @@ type ExternalBinaryCommitResult = {
     version: string | null;
     data: ArrayBuffer | null;
 };
-/** Environment metadata provided by the host. */
+/**
+ * Environment metadata provided by the host.
+ *
+ * Read synchronously by the renderer, so a host implementation must have
+ * these values in hand before it exposes the bridge — they cannot be awaited.
+ *
+ * Every field is main-process authority. A host must derive them from what it
+ * actually knows about itself (in Electron: `app.getVersion()` and
+ * `app.isPackaged`) and never from renderer-visible environment variables:
+ * `npm_package_version` exists only under an `npm run` script and `NODE_ENV`
+ * is unset in a packaged app, so both silently lie in exactly the builds users
+ * install. `appVersion` in particular reaches users through the About surface
+ * and issue-report URLs.
+ */
 interface HostEnvironment {
     platform: 'darwin' | 'win32' | 'linux';
+    /** Real, user-facing app version. Never a placeholder like '0.0.0'. */
     appVersion: string;
+    /** True only in an unpackaged development run. */
     isDev: boolean;
 }
 type HostCloseReason = 'window-close' | 'app-quit' | 'update-install' | 'reload' | 'force-reload';
@@ -447,6 +468,8 @@ type HostPrepareCloseResult = {
  * renderer never chooses request or window identifiers.
  */
 interface DocBlocksHostLifecycleAPI {
+    /** Request the main-owned guarded close path for this renderer window. */
+    requestWindowClose(): void;
     onPrepareClose(listener: (request: HostPrepareCloseRequest) => Promise<HostPrepareCloseResult>): () => void;
     onCancelClose(listener: (requestId: string) => void): () => void;
 }
@@ -475,4 +498,4 @@ interface DocBlocksHostAPI {
     onOpenRequest(listener: (request: OpenRequest) => void): () => void;
 }
 
-export { type GitStatus as A, type HostEnvironment as B, type HostExportTargetGrant as C, type DocBlocksHostAPI as D, ELECTRON_FILE_SYSTEM_V2_CAPABILITIES as E, type HostFileSystemV2OpenRequest as F, type GitBranchInfo as G, type HostCloseReason as H, type HostFileSystemV2Result as I, type HostFileSystemV2WatchMessage as J, type HostPrepareCloseRequest as K, type HostPrepareCloseResult as L, type MenuCommand as M, type UpdaterStatus as N, type OpenRequest as O, type UpdateInstallResult as U, type DocBlocksHostExportAPI as a, type DocBlocksHostExternalAPI as b, type DocBlocksHostFfmpegAPI as c, type DocBlocksHostFsAPI as d, type DocBlocksHostFsV2API as e, type DocBlocksHostGitAPI as f, type DocBlocksHostLifecycleAPI as g, type DocBlocksHostShellAPI as h, type DocBlocksHostUpdaterAPI as i, type DocBlocksHostWorkspacesAPI as j, type ElectronWorkspaceInfo as k, type ExternalBinaryCommitResult as l, type GitCapabilities as m, type GitCloneHandle as n, type GitCloneProgress as o, type GitError as p, type GitErrorCode as q, type GitFileAtRevision as r, type GitFileChange as s, type GitFileStatusCode as t, type GitLogEntry as u, type GitLogOptions as v, type GitRemoteInfo as w, type GitRepoDetection as x, type GitResult as y, type GitRevision as z };
+export { type GitStatus as A, type HostEnvironment as B, type HostExportTargetGrant as C, type DocBlocksHostAPI as D, ELECTRON_FILE_SYSTEM_V2_CAPABILITIES as E, type HostFileSystemV2OpenRequest as F, type GitBranchInfo as G, type HostCloseReason as H, type HostFileSystemV2Result as I, type HostFileSystemV2WatchMessage as J, type HostPrepareCloseRequest as K, type HostPrepareCloseResult as L, type MenuCommand as M, type UpdateInstallResult as N, type OpenRequest as O, type UpdaterStatus as P, type UpdateCheckResult as U, type DocBlocksHostExportAPI as a, type DocBlocksHostExternalAPI as b, type DocBlocksHostFfmpegAPI as c, type DocBlocksHostFsAPI as d, type DocBlocksHostFsV2API as e, type DocBlocksHostGitAPI as f, type DocBlocksHostLifecycleAPI as g, type DocBlocksHostShellAPI as h, type DocBlocksHostUpdaterAPI as i, type DocBlocksHostWorkspacesAPI as j, type ElectronWorkspaceInfo as k, type ExternalBinaryCommitResult as l, type GitCapabilities as m, type GitCloneHandle as n, type GitCloneProgress as o, type GitError as p, type GitErrorCode as q, type GitFileAtRevision as r, type GitFileChange as s, type GitFileStatusCode as t, type GitLogEntry as u, type GitLogOptions as v, type GitRemoteInfo as w, type GitRepoDetection as x, type GitResult as y, type GitRevision as z };

package/dist/vscode/index.d.ts

@@ -1,3 +1,225 @@
-/** Runtime-validated VS Code host/webview wire protocol. */
-export * from './messages.js';
-//# sourceMappingURL=index.d.ts.map
+/**
+ * Typed message protocol between the extension host and webview.
+ */
+type DocumentSessionMessageStatus = 'idle' | 'saved' | 'dirty' | 'saving' | 'error' | 'conflict' | 'closed';
+type DocumentConflictChoice = 'use-local' | 'use-external';
+/** Host-observed details that help a user distinguish two text branches. */
+interface DocumentConflictDetailsMessage {
+    /** VS Code document version on which the DocBlocks draft was based. */
+    localBaseDocumentVersion: number;
+    /** Current VS Code document version observed outside the DocBlocks edit pipeline. */
+    externalDocumentVersion: number;
+    /** UTF-8 encoded sizes of the complete text snapshots. */
+    localBytes: number;
+    externalBytes: number | null;
+    /** Times are extension-host observations, not filesystem-authoritative mtimes. */
+    localEditedAt: number | null;
+    externalObservedAt: number | null;
+    /** Whether VS Code reported the external document snapshot as not yet saved. */
+    externalIsDirty: boolean | null;
+}
+declare const DOCBLOCKS_ACCENT_COLORS: readonly ["brown", "green", "blue", "purple", "maroon", "orange", "gray"];
+type DocBlocksAccentColor = (typeof DOCBLOCKS_ACCENT_COLORS)[number];
+declare const DOCBLOCKS_WRITE_CANVAS_TEXT_SIZE_MIN = 12;
+declare const DOCBLOCKS_WRITE_CANVAS_TEXT_SIZE_MAX = 32;
+declare const DOCBLOCKS_WRITE_CANVAS_LINE_SPACING_MIN = 1.2;
+declare const DOCBLOCKS_WRITE_CANVAS_LINE_SPACING_MAX = 2.4;
+interface VscodeWriteCanvasSettings {
+    textSize: number;
+    lineSpacing: number;
+}
+declare const DEFAULT_VSCODE_WRITE_CANVAS_SETTINGS: Readonly<VscodeWriteCanvasSettings>;
+interface VscodeEditorSettings {
+    autoSave: boolean;
+    accentColor: DocBlocksAccentColor;
+    writeCanvasSettings: VscodeWriteCanvasSettings;
+}
+/**
+ * An opaque, one-shot authority to write one host-owned export target.
+ * The label is presentation-only and must never be interpreted as a path.
+ */
+interface ExportTargetGrantMessage {
+    grantId: string;
+    displayLabel: string;
+}
+/** Messages sent from the extension host to the webview. */
+type ExtensionToWebviewMessage = {
+    type: 'setContent';
+    content: string;
+    documentVersion: number;
+    fileName: string;
+    sessionId: string;
+    sessionRevision: number;
+    acknowledgedClientRevision: number;
+} | {
+    type: 'editAcknowledged';
+    sessionId: string;
+    clientRevision: number;
+    sessionRevision: number;
+    accepted: boolean;
+    message: string | null;
+} | {
+    type: 'sessionState';
+    sessionId: string;
+    status: DocumentSessionMessageStatus;
+    revision: number;
+    persistedRevision: number;
+    acknowledgedClientRevision: number;
+    documentVersion: number;
+    error: string | null;
+    conflict: DocumentConflictDetailsMessage | null;
+} | {
+    type: 'saveResult';
+    sessionId: string;
+    requestId: number;
+    ok: boolean;
+    revision: number;
+    persistedRevision: number;
+    documentVersion: number;
+    message: string | null;
+} | {
+    type: 'themeChange';
+    theme: 'light' | 'dark';
+} | {
+    type: 'editorSettings';
+    settings: VscodeEditorSettings;
+} | {
+    type: 'mediaResolved';
+    requestId: number;
+    url: string;
+} | {
+    type: 'mediaListed';
+    requestId: number;
+    entries: MediaEntryMessage[];
+} | {
+    type: 'mediaAdded';
+    requestId: number;
+    path: string;
+} | {
+    type: 'mediaRemoved';
+    requestId: number;
+} | {
+    type: 'mediaError';
+    requestId: number;
+    message: string;
+} | {
+    type: 'exportSaved';
+    requestId: number;
+    target: ExportTargetGrantMessage | null;
+} | {
+    type: 'exportError';
+    requestId: number;
+    message: string;
+} | {
+    type: 'exportTargetResolved';
+    requestId: number;
+    target: ExportTargetGrantMessage | null;
+} | {
+    type: 'exportTargetPicked';
+    requestId: number;
+    target: ExportTargetGrantMessage | null;
+} | {
+    type: 'workspaceFileRead';
+    requestId: number;
+    dataBase64: string | null;
+} | {
+    type: 'workspaceFileError';
+    requestId: number;
+    message: string;
+};
+/** Messages sent from the webview to the extension host. */
+type WebviewToExtensionMessage = {
+    type: 'ready';
+} | {
+    type: 'setAutoSave';
+    enabled: boolean;
+} | {
+    type: 'setAccentColor';
+    accentColor: DocBlocksAccentColor;
+} | {
+    type: 'setWriteCanvasSettings';
+    settings: VscodeWriteCanvasSettings;
+} | {
+    type: 'openLink';
+    href: string;
+} | {
+    type: 'edit';
+    content: string;
+    sessionId: string;
+    clientRevision: number;
+    baseDocumentVersion: number;
+} | {
+    type: 'save';
+    sessionId: string;
+    requestId: number;
+    clientRevision: number;
+    baseDocumentVersion: number;
+} | {
+    type: 'resolveConflict';
+    sessionId: string;
+    choice: DocumentConflictChoice;
+} | {
+    type: 'resolveMedia';
+    requestId: number;
+    ref: string;
+} | {
+    type: 'listMedia';
+    requestId: number;
+} | {
+    type: 'addMedia';
+    requestId: number;
+    name: string;
+    dataBase64: string;
+    mimeType: string;
+} | {
+    type: 'removeMedia';
+    requestId: number;
+    ref: string;
+} | {
+    type: 'saveExport';
+    requestId: number;
+    filename: string;
+    dataBase64: string;
+    mimeType: string;
+    grantId: string | null;
+    /** Optional validated basename edit; the host derives it from the opaque grant. */
+    targetFilename: string | null;
+} | {
+    type: 'resolveExportTarget';
+    requestId: number;
+    filename: string;
+} | {
+    type: 'pickExportTarget';
+    requestId: number;
+    filename: string;
+    currentGrantId: string | null;
+} | {
+    type: 'readWorkspaceFile';
+    requestId: number;
+    path: string;
+};
+interface MediaEntryMessage {
+    name: string;
+    mimeType: string;
+    size: number;
+}
+/**
+ * The webview boundary is untrusted at runtime. Keep malformed or stale
+ * messages out of the document session instead of relying on a TypeScript
+ * assertion in the extension host.
+ */
+declare function parseWebviewToExtensionMessage(value: unknown): WebviewToExtensionMessage | null;
+/**
+ * Validate host responses before they influence webview state. This protects
+ * the browser side from protocol drift and from messages injected by another
+ * script in the webview document; a TypeScript MessageEvent annotation is not
+ * runtime validation.
+ */
+declare function parseExtensionToWebviewMessage(value: unknown): ExtensionToWebviewMessage | null;
+declare function isDocBlocksAccentColor(value: unknown): value is DocBlocksAccentColor;
+declare function isDocBlocksWriteCanvasTextSize(value: unknown): value is number;
+declare function isDocBlocksWriteCanvasLineSpacing(value: unknown): value is number;
+declare function isSafeExportFilename(value: unknown): value is string;
+declare function isSafeMimeType(value: unknown): value is string;
+
+export { DEFAULT_VSCODE_WRITE_CANVAS_SETTINGS, DOCBLOCKS_ACCENT_COLORS, DOCBLOCKS_WRITE_CANVAS_LINE_SPACING_MAX, DOCBLOCKS_WRITE_CANVAS_LINE_SPACING_MIN, DOCBLOCKS_WRITE_CANVAS_TEXT_SIZE_MAX, DOCBLOCKS_WRITE_CANVAS_TEXT_SIZE_MIN, type DocBlocksAccentColor, type DocumentConflictChoice, type DocumentConflictDetailsMessage, type DocumentSessionMessageStatus, type ExportTargetGrantMessage, type ExtensionToWebviewMessage, type MediaEntryMessage, type VscodeEditorSettings, type VscodeWriteCanvasSettings, type WebviewToExtensionMessage, isDocBlocksAccentColor, isDocBlocksWriteCanvasLineSpacing, isDocBlocksWriteCanvasTextSize, isSafeExportFilename, isSafeMimeType, parseExtensionToWebviewMessage, parseWebviewToExtensionMessage };