@vscode/web-editors 0.0.2-2 → 0.0.2-21

package/dist/index.d.ts

@@ -2167,10 +2167,19 @@ 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;
@@ -2338,6 +2347,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 +2362,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
@@ -2639,5 +2656,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, type IDisposable, JsonFormatOptions, JsonValue, type MessageEndpoint, type MessageLikeEvent, ScopeRegistration, TextEdit, VsCodeAppEmbeddingEventsProxy, VsCodeAppHostClient, VsCodeAppHostClientOptions, VsCodeAppHostProxy, WebEditorClient, WebEditorClientOptions, WebEditorClientState, WebEditorHost, WebEditorHostOptions, WebEditorHostProxy, WebEditorProxy, WebEditorUpdate, WindowMessageTransport, applyContentEdits, applyTextEdits, createWindowParentConnection, decodeFromEditor, encodeForEditor, vscodeAppEmbeddingEventsInterface, vscodeAppHostInterface, webEditorHostInterface, webEditorInterface };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -4141,6 +4141,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 +4177,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(),
@@ -4423,6 +4424,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 +4437,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,13 +4445,15 @@ 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 });
@@ -4459,10 +4469,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;
 	}
@@ -4519,6 +4539,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