@bendyline/docblocks 1.1.2 → 2.0.0

package/dist/vscode/messages.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Typed message protocol between the extension host and webview.
+ */
+export type DocumentSessionMessageStatus = 'idle' | 'saved' | 'dirty' | 'saving' | 'error' | 'conflict' | 'closed';
+export type DocumentConflictChoice = 'use-local' | 'use-external';
+/** Host-observed details that help a user distinguish two text branches. */
+export 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;
+}
+export declare const DOCBLOCKS_ACCENT_COLORS: readonly ["brown", "green", "blue", "purple", "maroon", "orange", "gray"];
+export type DocBlocksAccentColor = (typeof DOCBLOCKS_ACCENT_COLORS)[number];
+export interface VscodeEditorSettings {
+    autoSave: boolean;
+    accentColor: DocBlocksAccentColor;
+}
+/**
+ * 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.
+ */
+export interface ExportTargetGrantMessage {
+    grantId: string;
+    displayLabel: string;
+}
+/** Messages sent from the extension host to the webview. */
+export 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. */
+export type WebviewToExtensionMessage = {
+    type: 'ready';
+} | {
+    type: 'setAutoSave';
+    enabled: boolean;
+} | {
+    type: 'setAccentColor';
+    accentColor: DocBlocksAccentColor;
+} | {
+    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;
+} | {
+    type: 'resolveExportTarget';
+    requestId: number;
+    filename: string;
+} | {
+    type: 'pickExportTarget';
+    requestId: number;
+    filename: string;
+    currentGrantId: string | null;
+} | {
+    type: 'readWorkspaceFile';
+    requestId: number;
+    path: string;
+};
+export 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.
+ */
+export 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.
+ */
+export declare function parseExtensionToWebviewMessage(value: unknown): ExtensionToWebviewMessage | null;
+export declare function isDocBlocksAccentColor(value: unknown): value is DocBlocksAccentColor;
+export declare function isSafeExportFilename(value: unknown): value is string;
+export declare function isSafeMimeType(value: unknown): value is string;
+//# sourceMappingURL=messages.d.ts.map

package/dist/vscode/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/vscode/messages.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,MAAM,MAAM,4BAA4B,GACpC,MAAM,GACN,OAAO,GACP,OAAO,GACP,QAAQ,GACR,OAAO,GACP,UAAU,GACV,QAAQ,CAAC;AAEb,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG,cAAc,CAAC;AAElE,4EAA4E;AAC5E,MAAM,WAAW,8BAA8B;IAC7C,uEAAuE;IACvE,wBAAwB,EAAE,MAAM,CAAC;IACjC,qFAAqF;IACrF,uBAAuB,EAAE,MAAM,CAAC;IAChC,0DAA0D;IAC1D,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kFAAkF;IAClF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,gFAAgF;IAChF,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAED,eAAO,MAAM,uBAAuB,2EAQ1B,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE5E,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,oBAAoB,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,4DAA4D;AAC5D,MAAM,MAAM,yBAAyB,GACjC;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,0BAA0B,EAAE,MAAM,CAAC;CACpC,GACD;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GACD;IACE,IAAI,EAAE,cAAc,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,4BAA4B,CAAC;IACrC,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,0BAA0B,EAAE,MAAM,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,QAAQ,EAAE,8BAA8B,GAAG,IAAI,CAAC;CACjD,GACD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAA;CAAE,GAChD;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,QAAQ,EAAE,oBAAoB,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACzD;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,iBAAiB,EAAE,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI,CAAA;CAAE,GACnF;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,sBAAsB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI,CAAA;CAAE,GAC5F;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,wBAAwB,GAAG,IAAI,CAAA;CAAE,GAC1F;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GAC3E;IAAE,IAAI,EAAE,oBAAoB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,4DAA4D;AAC5D,MAAM,MAAM,yBAAyB,GACjC;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GACzC;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,WAAW,EAAE,oBAAoB,CAAA;CAAE,GAC7D;IACE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,GACD;IACE,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;CAC7B,GACD;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,sBAAsB,CAAA;CAAE,GAC9E;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GACxC;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC3F;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACvD;IACE,IAAI,EAAE,YAAY,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB,GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACpE;IACE,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,GACD;IAAE,IAAI,EAAE,mBAAmB,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnE,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,OAAO,GAAG,yBAAyB,GAAG,IAAI,CAyI/F;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,OAAO,GAAG,yBAAyB,GAAG,IAAI,CA0L/F;AA+DD,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,oBAAoB,CAEpF;AAyGD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAWpE;AAiBD,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAO9D"}