@codingame/monaco-vscode-working-copy-service-override 20.1.1 → 20.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codingame/monaco-vscode-working-copy-service-override",
-  "version": "20.1.1",
+  "version": "20.2.1",
   "private": false,
   "description": "VSCode public API plugged on the monaco editor - working-copy service-override",
   "keywords": [],
@@ -15,10 +15,10 @@
   },
   "type": "module",
   "dependencies": {
-    "@codingame/monaco-vscode-6f931a91-88ea-5232-897f-a17ec3929ba5-common": "20.1.1",
-    "@codingame/monaco-vscode-api": "20.1.1",
-    "@codingame/monaco-vscode-caeb744c-8e3f-5c11-80fb-0f057d24d544-common": "20.1.1",
-    "@codingame/monaco-vscode-files-service-override": "20.1.1"
+    "@codingame/monaco-vscode-6f931a91-88ea-5232-897f-a17ec3929ba5-common": "20.2.1",
+    "@codingame/monaco-vscode-api": "20.2.1",
+    "@codingame/monaco-vscode-caeb744c-8e3f-5c11-80fb-0f057d24d544-common": "20.2.1",
+    "@codingame/monaco-vscode-files-service-override": "20.2.1"
   },
   "main": "index.js",
   "module": "index.js",

package/vscode/src/vs/workbench/services/workingCopy/common/workingCopyBackupTracker.d.ts

@@ -10,6 +10,13 @@ import { IWorkingCopyEditorHandler } from "./workingCopyEditorService.js";
 import { IWorkingCopyEditorService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/workingCopy/common/workingCopyEditorService.service";
 import { IEditorService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/editor/common/editorService.service";
 import { IEditorGroupsService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/editor/common/editorGroupsService.service";
+/**
+ * The working copy backup tracker deals with:
+ * - restoring backups that exist
+ * - creating backups for modified working copies
+ * - deleting backups for saved working copies
+ * - handling backups on shutdown
+ */
 export declare abstract class WorkingCopyBackupTracker extends Disposable {
     protected readonly workingCopyBackupService: IWorkingCopyBackupService;
     protected readonly workingCopyService: IWorkingCopyService;

package/vscode/src/vs/workbench/services/workingCopy/common/workingCopyEditorService.d.ts

@@ -5,8 +5,18 @@ import { Disposable, IDisposable } from "@codingame/monaco-vscode-api/vscode/vs/
 import { IEditorService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/editor/common/editorService.service";
 import { IWorkingCopyEditorService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/workingCopy/common/workingCopyEditorService.service";
 export interface IWorkingCopyEditorHandler {
+    /**
+     * Whether the handler is capable of opening the specific backup in
+     * an editor.
+     */
     handles(workingCopy: IWorkingCopyIdentifier): boolean | Promise<boolean>;
+    /**
+     * Whether the provided working copy is opened in the provided editor.
+     */
     isOpen(workingCopy: IWorkingCopyIdentifier, editor: EditorInput): boolean;
+    /**
+     * Create an editor that is suitable of opening the provided working copy.
+     */
     createEditor(workingCopy: IWorkingCopyIdentifier): EditorInput | Promise<EditorInput>;
 }
 export declare class WorkingCopyEditorService extends Disposable implements IWorkingCopyEditorService {

package/vscode/src/vs/workbench/services/workingCopy/common/workingCopyHistory.d.ts

@@ -1,22 +1,60 @@
 import { URI } from "@codingame/monaco-vscode-api/vscode/vs/base/common/uri";
 import { SaveSource } from "@codingame/monaco-vscode-api/vscode/vs/workbench/common/editor";
 export interface IWorkingCopyHistoryEvent {
+    /**
+     * The entry this event is about.
+     */
     readonly entry: IWorkingCopyHistoryEntry;
 }
 export interface IWorkingCopyHistoryEntry {
+    /**
+     * Unique identifier of this entry for the working copy.
+     */
     readonly id: string;
+    /**
+     * The associated working copy of this entry.
+     */
     readonly workingCopy: {
         readonly resource: URI;
         readonly name: string;
     };
+    /**
+     * The location on disk of this history entry.
+     */
     readonly location: URI;
+    /**
+     * The time when this history entry was created.
+     */
     timestamp: number;
+    /**
+     * Associated source with the history entry.
+     */
     source: SaveSource;
+    /**
+     * Optional additional metadata associated with the
+     * source that can help to describe the source.
+     */
     sourceDescription: string | undefined;
 }
 export interface IWorkingCopyHistoryEntryDescriptor {
+    /**
+     * The associated resource of this history entry.
+     */
     readonly resource: URI;
+    /**
+     * Optional associated timestamp to use for the
+     * history entry. If not provided, the current
+     * time will be used.
+     */
     readonly timestamp?: number;
+    /**
+     * Optional source why the entry was added.
+     */
     readonly source?: SaveSource;
 }
+/**
+ * A limit on how many I/O operations we allow to run in parallel.
+ * We do not want to spam the file system with too many requests
+ * at the same time, so we limit to a maximum degree of parallellism.
+ */
 export declare const MAX_PARALLEL_HISTORY_IO_OPS = 20;

package/vscode/src/vs/workbench/services/workingCopy/common/workingCopyHistoryService.d.ts

@@ -15,6 +15,11 @@ import { ILogService } from "@codingame/monaco-vscode-api/vscode/vs/platform/log
 import { SaveSource } from "@codingame/monaco-vscode-api/vscode/vs/workbench/common/editor";
 import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
 export interface IWorkingCopyHistoryModelOptions {
+    /**
+     * Whether to flush when the model changes. If not
+     * configured, `model.store()` has to be called
+     * explicitly.
+     */
     flushOnChange: boolean;
 }
 export declare class WorkingCopyHistoryModel {

package/vscode/src/vs/workbench/services/workingCopy/common/workingCopyService.d.ts

@@ -3,6 +3,9 @@ import { Disposable, IDisposable } from "@codingame/monaco-vscode-api/vscode/vs/
 import { IWorkingCopy, IWorkingCopyIdentifier, IWorkingCopySaveEvent as IBaseWorkingCopySaveEvent } from "@codingame/monaco-vscode-caeb744c-8e3f-5c11-80fb-0f057d24d544-common/vscode/vs/workbench/services/workingCopy/common/workingCopy";
 import { IWorkingCopyService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/workingCopy/common/workingCopyService.service";
 export interface IWorkingCopySaveEvent extends IBaseWorkingCopySaveEvent {
+    /**
+     * The working copy that was saved.
+     */
     readonly workingCopy: IWorkingCopy;
 }
 export declare class WorkingCopyService extends Disposable implements IWorkingCopyService {