@vscode/web-editors 0.0.2-4 → 0.0.2-41

package/dist/index.d.ts

@@ -2148,6 +2148,7 @@ declare const zHostCapabilities: ZodObject<{
   supportsContentEdits: ZodOptional<ZodBoolean>;
   supportsOptions: ZodOptional<ZodBoolean>;
   supportsForceUpdate: ZodOptional<ZodBoolean>;
+  supportsHostTransport: ZodOptional<ZodBoolean>;
 }, $strip>;
 declare const zTextEdit: ZodObject<{
   offset: ZodNumber;
@@ -2167,13 +2168,24 @@ declare const zContentEdit: ZodDiscriminatedUnion<[ZodObject<{
     newText: ZodString;
   }, $strip>>;
 }, $strip>], "kind">;
+declare const zWebEditorUpdate: ZodObject<{
+  content: ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>;
+  options: ZodOptional<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>;
+  readOnly: ZodOptional<ZodBoolean>;
+  serverRevision: ZodOptional<ZodNumber>;
+  acknowledgedClientRevision: ZodOptional<ZodNumber>;
+  force: ZodOptional<ZodBoolean>;
+}, $strip>;
 type ContentEdit = output<typeof zContentEdit>;
 type TextEdit = output<typeof zTextEdit>;
 type EditorCapabilities = output<typeof zEditorCapabilities>;
 type HostCapabilities = output<typeof zHostCapabilities>;
+type WebEditorUpdate = output<typeof zWebEditorUpdate>;
 type ContentType = "text" | "json";
 declare const webEditorHostInterface: any;
 declare const webEditorInterface: any;
+declare const webEditorHostTransportInterface: any;
+declare const webEditorClientTransportInterface: any;
 declare const zEmbeddedAppDescriptor: ZodObject<{
   handleId: ZodString;
   appId: ZodString;
@@ -2196,6 +2208,8 @@ declare const vscodeAppEmbeddingEventsInterface: any;
 type WebEditorHostProxy = InterfaceClient<typeof webEditorHostInterface>;
 /** Typed proxy used by the host to invoke editor methods. */
 type WebEditorProxy = InterfaceClient<typeof webEditorInterface>;
+type WebEditorHostTransportProxy = InterfaceClient<typeof webEditorHostTransportInterface>;
+type WebEditorClientTransportProxy = InterfaceClient<typeof webEditorClientTransportInterface>;
 /** Typed proxy used by an app to invoke `vscode-app-host` methods. */
 type VsCodeAppHostProxy = InterfaceClient<typeof vscodeAppHostInterface>;
 type VsCodeAppEmbeddingEventsProxy = InterfaceClient<typeof vscodeAppEmbeddingEventsInterface>;
@@ -2271,6 +2285,16 @@ interface IDisposable {
 type EventListener<T> = (event: T) => void;
 type Event<T> = (listener: EventListener<T>) => IDisposable;
 //#endregion
+//#region src/hostTransport.d.ts
+/**
+ * Optional message transport between a web editor and its host.
+ */
+interface HostTransport {
+  readonly onMessage: Event<JsonValue>;
+  /** Sends a notification to the host. */
+  sendMessage(message: JsonValue): void;
+}
+//#endregion
 //#region src/host/WebEditorHost.d.ts
 interface WebEditorHostOptions {
   /**
@@ -2293,6 +2317,8 @@ interface WebEditorHostOptions {
   jsonFormat?: JsonFormatOptions;
   /** Host capabilities advertised on `initialized`. */
   capabilities?: HostCapabilities;
+  /** Optional message transport to expose to the editor. */
+  hostTransport?: HostTransport;
   /** Called when the editor sends malformed input. Defaults to `console.error`. */
   onError?: (message: string, detail?: unknown) => void;
 }
@@ -2306,16 +2332,19 @@ interface WebEditorHostOptions {
 declare class WebEditorHost implements IDisposable {
   private readonly _connection;
   private readonly _editor;
+  private readonly _clientTransport;
   private readonly _contentType;
   private readonly _jsonFormat;
   private readonly _onError;
   private readonly _capabilities;
+  private readonly _hostTransportSubscription;
   private _text;
   private _readOnly;
   private _serverRevision;
   private _acknowledgedClientRevision;
   private _editorInitialized;
   private _editorCapabilities;
+  private readonly _pendingHostTransportMessages;
   private readonly _onDidChangeText;
   readonly onDidChangeText: Event<{
     text: string;
@@ -2338,6 +2367,12 @@ declare class WebEditorHost implements IDisposable {
   setText(text: string, opts?: {
     force?: boolean;
   }): void;
+  /**
+   * Reassign this host/editor connection to another logical document.
+   * The forced update advances the server revision, making edits queued by
+   * the previous logical document stale before the caller switches routing.
+   */
+  reuse(text: string, readOnly: boolean): void;
   getReadOnly(): boolean;
   setReadOnly(readOnly: boolean): void;
   /**
@@ -2347,6 +2382,8 @@ declare class WebEditorHost implements IDisposable {
   applyEdits(edits: readonly ContentEdit[]): void;
   dispose(): void;
   private _pushFullUpdate;
+  private _pushAcknowledgement;
+  private _acknowledgeAndRestore;
 }
 //#endregion
 //#region src/client/connection.d.ts
@@ -2446,11 +2483,15 @@ interface WebEditorClientState {
 declare class WebEditorClient implements IDisposable {
   private readonly _connection;
   private readonly _host;
+  private readonly _hostTransportProxy;
   private readonly _onError;
+  private _hostTransport;
   private _content;
   private _readOnly;
   private _options;
   private _hostCapabilities;
+  private readonly _pendingHostTransportMessages;
+  private _hostTransportActivated;
   private _clientRevision;
   private _basedOnServerRevision;
   /** Number of un-acked local revisions. While > 0 the editor has pending edits. */
@@ -2473,6 +2514,7 @@ declare class WebEditorClient implements IDisposable {
   readonly onDidChangeOptions: Event<{
     options: JsonValue;
   }>;
+  private readonly _onDidReceiveHostMessage;
   /** Resolves once the host has acknowledged `initialized`. */
   readonly onDidConnect: Promise<{
     capabilities: HostCapabilities | undefined;
@@ -2485,6 +2527,8 @@ declare class WebEditorClient implements IDisposable {
    * second one.
    */
   get connection(): HubRpcConnection;
+  /** Optional notification transport supplied by the web editor host. */
+  get hostTransport(): HostTransport | undefined;
   getContent(): JsonValue;
   getReadOnly(): boolean;
   getOptions(): JsonValue;
@@ -2639,5 +2683,5 @@ declare class VsCodeAppHostClient {
   }): Promise<EditorAssociationResult>;
 }
 //#endregion
-export { AppContext, type ConnectionInput, ContentEdit, ContentType, EditorAssociationResult, EditorCapabilities, EditorRegistrationStatus, EditorScope, EmbeddedAppAccessOptions, EmbeddedAppDescriptor, EmbeddedAppHandle, EmbeddingContext, type Event, HostCapabilities, type IDisposable, JsonFormatOptions, JsonValue, type MessageEndpoint, type MessageLikeEvent, ScopeRegistration, TextEdit, VsCodeAppEmbeddingEventsProxy, VsCodeAppHostClient, VsCodeAppHostClientOptions, VsCodeAppHostProxy, WebEditorClient, WebEditorClientOptions, WebEditorClientState, WebEditorHost, WebEditorHostOptions, WebEditorHostProxy, WebEditorProxy, WindowMessageTransport, applyContentEdits, applyTextEdits, createWindowParentConnection, decodeFromEditor, encodeForEditor, vscodeAppEmbeddingEventsInterface, vscodeAppHostInterface, webEditorHostInterface, webEditorInterface };
+export { AppContext, type ConnectionInput, ContentEdit, ContentType, EditorAssociationResult, EditorCapabilities, EditorRegistrationStatus, EditorScope, EmbeddedAppAccessOptions, EmbeddedAppDescriptor, EmbeddedAppHandle, EmbeddingContext, type Event, HostCapabilities, HostTransport, type IDisposable, JsonFormatOptions, JsonValue, type MessageEndpoint, type MessageLikeEvent, ScopeRegistration, TextEdit, VsCodeAppEmbeddingEventsProxy, VsCodeAppHostClient, VsCodeAppHostClientOptions, VsCodeAppHostProxy, WebEditorClient, WebEditorClientOptions, WebEditorClientState, WebEditorClientTransportProxy, WebEditorHost, WebEditorHostOptions, WebEditorHostProxy, WebEditorHostTransportProxy, WebEditorProxy, WebEditorUpdate, WindowMessageTransport, applyContentEdits, applyTextEdits, createWindowParentConnection, decodeFromEditor, encodeForEditor, vscodeAppEmbeddingEventsInterface, vscodeAppHostInterface, webEditorClientTransportInterface, webEditorHostInterface, webEditorHostTransportInterface, webEditorInterface };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -4125,7 +4125,8 @@ const zEditorCapabilities = object({
 const zHostCapabilities = object({
 	supportsContentEdits: boolean().optional(),
 	supportsOptions: boolean().optional(),
-	supportsForceUpdate: boolean().optional()
+	supportsForceUpdate: boolean().optional(),
+	supportsHostTransport: boolean().optional()
 });
 const zTextEdit = object({
 	offset: number().int().nonnegative(),
@@ -4141,6 +4142,14 @@ const zContentEdit = discriminatedUnion("kind", [object({
 	path: array(string()),
 	stringEdits: array(zTextEdit)
 })]);
+const zWebEditorUpdate = object({
+	content: zJsonValue.optional(),
+	options: zJsonValue.optional(),
+	readOnly: boolean().optional(),
+	serverRevision: number().int().nonnegative().optional(),
+	acknowledgedClientRevision: number().int().nonnegative().optional(),
+	force: boolean().optional()
+});
 const webEditorHostInterface = defineInterface({
 	id: "web-editor-host",
 	description: "Methods the host exposes to the editor (web-editor/0.12)."
@@ -4169,14 +4178,7 @@ const webEditorInterface = defineInterface({
 	id: "web-editor",
 	description: "Methods the editor exposes to the host (web-editor/0.12)."
 }, {
-	update: notificationType(object({
-		content: zJsonValue.optional(),
-		options: zJsonValue.optional(),
-		readOnly: boolean().optional(),
-		serverRevision: number().int().nonnegative().optional(),
-		acknowledgedClientRevision: number().int().nonnegative().optional(),
-		force: boolean().optional()
-	})),
+	update: notificationType(zWebEditorUpdate),
 	applyContentEdits: notificationType(object({
 		edits: array(zContentEdit),
 		serverRevision: number().int().nonnegative(),
@@ -4184,6 +4186,14 @@ const webEditorInterface = defineInterface({
 	})),
 	getContentSchema: requestType(object({}), object({ schema: zJsonValue }))
 });
+const webEditorHostTransportInterface = defineInterface({
+	id: "web-editor-host-transport",
+	description: "Optional messages the web editor sends to its host."
+}, { message: notificationType(object({ message: zJsonValue })) });
+const webEditorClientTransportInterface = defineInterface({
+	id: "web-editor-client-transport",
+	description: "Optional messages the web editor host sends to the editor."
+}, { message: notificationType(object({ message: zJsonValue })) });
 /** Per-scope registration: `registered` (toolbar button) and `isDefault` (auto-open). */
 const zScopeRegistration = object({
 	registered: boolean(),
@@ -4381,16 +4391,19 @@ var Emitter = class {
 var WebEditorHost = class {
 	_connection;
 	_editor;
+	_clientTransport;
 	_contentType;
 	_jsonFormat;
 	_onError;
 	_capabilities;
+	_hostTransportSubscription;
 	_text;
 	_readOnly;
 	_serverRevision = 0;
 	_acknowledgedClientRevision = 0;
 	_editorInitialized = false;
 	_editorCapabilities;
+	_pendingHostTransportMessages = [];
 	_onDidChangeText = new Emitter();
 	onDidChangeText = this._onDidChangeText.event;
 	_onDidInitialize = new Emitter();
@@ -4404,8 +4417,12 @@ var WebEditorHost = class {
 		this._readOnly = options.readOnly ?? false;
 		this._jsonFormat = options.jsonFormat ?? {};
 		this._onError = options.onError ?? ((m, d) => console.error("WebEditorHost:", m, d));
-		this._capabilities = options.capabilities ?? { supportsForceUpdate: true };
+		this._capabilities = {
+			...options.capabilities ?? { supportsForceUpdate: true },
+			supportsHostTransport: options.hostTransport ? true : void 0
+		};
 		this._editor = this._connection.get(webEditorInterface);
+		this._clientTransport = this._connection.get(webEditorClientTransportInterface);
 		this._connection.register(webEditorHostInterface, {
 			initialized: (params) => {
 				if (params.contentType !== this._contentType) this._onError(`Editor contentType "${params.contentType}" does not match host "${this._contentType}"`);
@@ -4414,6 +4431,7 @@ var WebEditorHost = class {
 				this._serverRevision = 0;
 				this._acknowledgedClientRevision = 0;
 				this._pushFullUpdate();
+				for (const message of this._pendingHostTransportMessages.splice(0)) this._clientTransport.message({ message });
 				this._onDidInitialize.fire({ capabilities: params.capabilities });
 				return {
 					protocolVersion: "web-editor-host/0.12",
@@ -4423,6 +4441,12 @@ var WebEditorHost = class {
 			applyContentEdit: (params) => {
 				if (this._readOnly) {
 					this._onError("Editor sent applyContentEdit while readOnly");
+					this._acknowledgeAndRestore(params.clientRevision);
+					return;
+				}
+				if (params.basedOnServerRevision !== this._serverRevision) {
+					this._onError(`Editor edit is based on stale server revision ${params.basedOnServerRevision}; current revision is ${this._serverRevision}`);
+					this._acknowledgeAndRestore(params.clientRevision);
 					return;
 				}
 				let newValue;
@@ -4430,6 +4454,7 @@ var WebEditorHost = class {
 					newValue = applyContentEdits(encodeForEditor(this._text, this._contentType), params.edits);
 				} catch (e) {
 					this._onError("Failed to apply content edits from editor", e);
+					this._acknowledgeAndRestore(params.clientRevision);
 					return;
 				}
 				let newText;
@@ -4437,18 +4462,27 @@ var WebEditorHost = class {
 					newText = decodeFromEditor(newValue, this._contentType, this._jsonFormat);
 				} catch (e) {
 					this._onError("Failed to decode editor content", e);
+					this._acknowledgeAndRestore(params.clientRevision);
 					return;
 				}
-				this._acknowledgedClientRevision = params.clientRevision;
+				this._acknowledgedClientRevision = Math.max(this._acknowledgedClientRevision, params.clientRevision);
 				if (newText !== this._text) {
 					this._text = newText;
 					this._onDidChangeText.fire({ text: newText });
 				}
+				this._pushAcknowledgement();
 			},
 			reportSize: (params) => {
 				this._onDidReportSize.fire({ height: params.height });
 			}
 		});
+		if (options.hostTransport) {
+			this._connection.register(webEditorHostTransportInterface, { message: ({ message }) => options.hostTransport.sendMessage(message) });
+			this._hostTransportSubscription = options.hostTransport.onMessage((message) => {
+				if (this._editorInitialized) this._clientTransport.message({ message });
+				else this._pendingHostTransportMessages.push(message);
+			});
+		}
 	}
 	/** The text the host believes the document currently holds. */
 	getText() {
@@ -4459,10 +4493,20 @@ var WebEditorHost = class {
 	* root. If `force`, the editor must adopt it even with pending local edits.
 	*/
 	setText(text, opts = {}) {
-		if (text === this._text) return;
+		if (text === this._text && !opts.force) return;
 		this._text = text;
 		this._pushFullUpdate(opts.force);
 	}
+	/**
+	* Reassign this host/editor connection to another logical document.
+	* The forced update advances the server revision, making edits queued by
+	* the previous logical document stale before the caller switches routing.
+	*/
+	reuse(text, readOnly) {
+		this._readOnly = readOnly;
+		this._text = text;
+		this._pushFullUpdate(true);
+	}
 	getReadOnly() {
 		return this._readOnly;
 	}
@@ -4496,9 +4540,11 @@ var WebEditorHost = class {
 		});
 	}
 	dispose() {
+		this._hostTransportSubscription?.dispose();
 		this._onDidChangeText.dispose();
 		this._onDidInitialize.dispose();
 		this._onDidReportSize.dispose();
+		this._pendingHostTransportMessages.length = 0;
 		this._connection.close();
 	}
 	_pushFullUpdate(force) {
@@ -4519,6 +4565,17 @@ var WebEditorHost = class {
 			force
 		});
 	}
+	_pushAcknowledgement() {
+		if (!this._editorInitialized) return;
+		this._editor.update({
+			serverRevision: this._serverRevision,
+			acknowledgedClientRevision: this._acknowledgedClientRevision
+		});
+	}
+	_acknowledgeAndRestore(clientRevision) {
+		this._acknowledgedClientRevision = Math.max(this._acknowledgedClientRevision, clientRevision);
+		this._pushFullUpdate(true);
+	}
 };
 //#endregion
 //#region src/client/connection.ts
@@ -4666,11 +4723,15 @@ var HostConnection = class HostConnection {
 var WebEditorClient = class WebEditorClient {
 	_connection;
 	_host;
+	_hostTransportProxy;
 	_onError;
+	_hostTransport;
 	_content = void 0;
 	_readOnly = false;
 	_options = void 0;
 	_hostCapabilities;
+	_pendingHostTransportMessages = [];
+	_hostTransportActivated = false;
 	_clientRevision = 0;
 	_basedOnServerRevision = 0;
 	/** Number of un-acked local revisions. While > 0 the editor has pending edits. */
@@ -4683,6 +4744,7 @@ var WebEditorClient = class WebEditorClient {
 	onDidChangeReadOnly = this._onDidChangeReadOnly.event;
 	_onDidChangeOptions = new Emitter();
 	onDidChangeOptions = this._onDidChangeOptions.event;
+	_onDidReceiveHostMessage = new Emitter();
 	/** Resolves once the host has acknowledged `initialized`. */
 	onDidConnect;
 	static async connect(options) {
@@ -4694,6 +4756,7 @@ var WebEditorClient = class WebEditorClient {
 		this._connection = resolveConnection(options.connection);
 		this._onError = options.onError ?? ((m, d) => console.error("WebEditorClient:", m, d));
 		this._host = this._connection.get(webEditorHostInterface);
+		this._hostTransportProxy = this._connection.get(webEditorHostTransportInterface);
 		this._connection.register(webEditorInterface, {
 			update: (params) => this._handleUpdate(params),
 			applyContentEdits: (params) => this._handleApplyContentEdits(params),
@@ -4701,12 +4764,28 @@ var WebEditorClient = class WebEditorClient {
 				return { schema: options.getContentSchema ? await options.getContentSchema() : null };
 			}
 		});
+		this._connection.register(webEditorClientTransportInterface, { message: ({ message }) => {
+			if (this._hostTransportActivated) this._onDidReceiveHostMessage.fire(message);
+			else this._pendingHostTransportMessages.push(message);
+		} });
 		this.onDidConnect = this._host.initialized({
 			protocolVersion: "web-editor/0.12",
 			contentType: options.contentType ?? "text",
 			capabilities: options.capabilities
 		}).then((r) => {
 			this._hostCapabilities = r.capabilities;
+			if (r.capabilities?.supportsHostTransport) this._hostTransport = {
+				onMessage: (listener) => {
+					const disposable = this._onDidReceiveHostMessage.event(listener);
+					if (!this._hostTransportActivated) {
+						this._hostTransportActivated = true;
+						for (const message of this._pendingHostTransportMessages.splice(0)) listener(message);
+					}
+					return disposable;
+				},
+				sendMessage: (message) => this._hostTransportProxy.message({ message })
+			};
+			else this._pendingHostTransportMessages.length = 0;
 			return { capabilities: r.capabilities };
 		});
 	}
@@ -4718,6 +4797,10 @@ var WebEditorClient = class WebEditorClient {
 	get connection() {
 		return this._connection;
 	}
+	/** Optional notification transport supplied by the web editor host. */
+	get hostTransport() {
+		return this._hostTransport;
+	}
 	getContent() {
 		return this._content;
 	}
@@ -4766,6 +4849,8 @@ var WebEditorClient = class WebEditorClient {
 		this._onDidApplyHostEdits.dispose();
 		this._onDidChangeReadOnly.dispose();
 		this._onDidChangeOptions.dispose();
+		this._onDidReceiveHostMessage.dispose();
+		this._pendingHostTransportMessages.length = 0;
 		this._connection.close();
 	}
 	_handleUpdate(params) {
@@ -5016,6 +5101,6 @@ var VsCodeAppHostClient = class {
 	}
 };
 //#endregion
-export { EmbeddedAppHandle, VsCodeAppHostClient, WebEditorClient, WebEditorHost, WindowMessageTransport, applyContentEdits, applyTextEdits, createWindowParentConnection, decodeFromEditor, encodeForEditor, vscodeAppEmbeddingEventsInterface, vscodeAppHostInterface, webEditorHostInterface, webEditorInterface };
+export { EmbeddedAppHandle, VsCodeAppHostClient, WebEditorClient, WebEditorHost, WindowMessageTransport, applyContentEdits, applyTextEdits, createWindowParentConnection, decodeFromEditor, encodeForEditor, vscodeAppEmbeddingEventsInterface, vscodeAppHostInterface, webEditorClientTransportInterface, webEditorHostInterface, webEditorHostTransportInterface, webEditorInterface };
 
 //# sourceMappingURL=index.js.map