@codingame/monaco-vscode-base-service-override 20.1.1 → 20.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@codingame/monaco-vscode-base-service-override",
3
- "version": "20.1.1",
3
+ "version": "20.2.0",
4
4
  "private": false,
5
5
  "description": "VSCode public API plugged on the monaco editor - base service-override",
6
6
  "keywords": [],
@@ -15,13 +15,13 @@
15
15
  },
16
16
  "type": "module",
17
17
  "dependencies": {
18
- "@codingame/monaco-vscode-158b9837-fc78-5d9c-86f5-9134e4358643-common": "20.1.1",
19
- "@codingame/monaco-vscode-23aade48-f094-5c08-9555-97fc9cca96c9-common": "20.1.1",
20
- "@codingame/monaco-vscode-34a0ffd3-b9f5-5699-b43b-38af5732f38a-common": "20.1.1",
21
- "@codingame/monaco-vscode-60014c9d-b815-501d-83a9-4b08725c2ec2-common": "20.1.1",
22
- "@codingame/monaco-vscode-9a1a5840-af83-5d07-a156-ba32a36c5c4b-common": "20.1.1",
23
- "@codingame/monaco-vscode-api": "20.1.1",
24
- "@codingame/monaco-vscode-d987325e-3e05-53aa-b9ff-6f97476f64db-common": "20.1.1"
18
+ "@codingame/monaco-vscode-158b9837-fc78-5d9c-86f5-9134e4358643-common": "20.2.0",
19
+ "@codingame/monaco-vscode-23aade48-f094-5c08-9555-97fc9cca96c9-common": "20.2.0",
20
+ "@codingame/monaco-vscode-34a0ffd3-b9f5-5699-b43b-38af5732f38a-common": "20.2.0",
21
+ "@codingame/monaco-vscode-60014c9d-b815-501d-83a9-4b08725c2ec2-common": "20.2.0",
22
+ "@codingame/monaco-vscode-9a1a5840-af83-5d07-a156-ba32a36c5c4b-common": "20.2.0",
23
+ "@codingame/monaco-vscode-api": "20.2.0",
24
+ "@codingame/monaco-vscode-d987325e-3e05-53aa-b9ff-6f97476f64db-common": "20.2.0"
25
25
  },
26
26
  "main": "index.js",
27
27
  "module": "index.js",
@@ -5,7 +5,26 @@ import { IBrowserWorkbenchEnvironmentService } from "@codingame/monaco-vscode-34
5
5
  import { IOpenerService } from "@codingame/monaco-vscode-api/vscode/vs/platform/opener/common/opener.service";
6
6
  import { IProductService } from "@codingame/monaco-vscode-api/vscode/vs/platform/product/common/productService.service";
7
7
  export interface IURLCallbackProvider {
8
+ /**
9
+ * Indicates that a Uri has been opened outside of VSCode. The Uri
10
+ * will be forwarded to all installed Uri handlers in the system.
11
+ */
8
12
  readonly onCallback: Event<URI>;
13
+ /**
14
+ * Creates a Uri that - if opened in a browser - must result in
15
+ * the `onCallback` to fire.
16
+ *
17
+ * The optional `Partial<UriComponents>` must be properly restored for
18
+ * the Uri passed to the `onCallback` handler.
19
+ *
20
+ * For example: if a Uri is to be created with `scheme:"vscode"`,
21
+ * `authority:"foo"` and `path:"bar"` the `onCallback` should fire
22
+ * with a Uri `vscode://foo/bar`.
23
+ *
24
+ * If there are additional `query` values in the Uri, they should
25
+ * be added to the list of provided `query` arguments from the
26
+ * `Partial<UriComponents>`.
27
+ */
9
28
  create(options?: Partial<UriComponents>): URI;
10
29
  }
11
30
  export declare class BrowserURLService extends AbstractURLService {
@@ -4,6 +4,10 @@ import { IInstantiationService } from "@codingame/monaco-vscode-api/vscode/vs/pl
4
4
  import { IUserActivityService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/userActivity/common/userActivityService.service";
5
5
  export interface IMarkActiveOptions {
6
6
  whenHeldFor?: number;
7
+ /**
8
+ * Only consider this progress if the state is already active. Used to avoid
9
+ * background work from incorrectly marking the user as active (#237386)
10
+ */
7
11
  extendOnly?: boolean;
8
12
  }
9
13
  export declare class UserActivityService extends Disposable implements IUserActivityService {
@@ -11,8 +15,17 @@ export declare class UserActivityService extends Disposable implements IUserActi
11
15
  private readonly markInactive;
12
16
  private readonly changeEmitter;
13
17
  private active;
18
+ /**
19
+ * @inheritdoc
20
+ *
21
+ * Note: initialized to true, since the user just did something to open the
22
+ * window. The bundled DomActivityTracker will initially assume activity
23
+ * as well in order to unset this if the window gets abandoned.
24
+ */
14
25
  isActive: boolean;
26
+ /** @inheritdoc */
15
27
  onDidChangeIsActive: Event<boolean>;
16
28
  constructor(instantiationService: IInstantiationService);
29
+ /** @inheritdoc */
17
30
  markActive(opts?: IMarkActiveOptions): IDisposable;
18
31
  }
@@ -14,27 +14,70 @@ import { IProgress, IProgressStep } from "@codingame/monaco-vscode-api/vscode/vs
14
14
  import { IStoredFileWorkingCopy, IStoredFileWorkingCopyModel } from "@codingame/monaco-vscode-6f931a91-88ea-5232-897f-a17ec3929ba5-common/vscode/vs/workbench/services/workingCopy/common/storedFileWorkingCopy";
15
15
  import { IWorkingCopyFileService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/workingCopy/common/workingCopyFileService.service";
16
16
  export interface SourceTargetPair {
17
+ /**
18
+ * The source resource that is defined for move operations.
19
+ */
17
20
  readonly source?: URI;
21
+ /**
22
+ * The target resource the event is about.
23
+ */
18
24
  readonly target: URI;
19
25
  }
20
26
  export interface IFileOperationUndoRedoInfo {
27
+ /**
28
+ * Id of the undo group that the file operation belongs to.
29
+ */
21
30
  undoRedoGroupId?: number;
31
+ /**
32
+ * Flag indicates if the operation is an undo.
33
+ */
22
34
  isUndoing?: boolean;
23
35
  }
24
36
  export interface WorkingCopyFileEvent extends IWaitUntil {
37
+ /**
38
+ * An identifier to correlate the operation through the
39
+ * different event types (before, after, error).
40
+ */
25
41
  readonly correlationId: number;
42
+ /**
43
+ * The file operation that is taking place.
44
+ */
26
45
  readonly operation: FileOperation;
46
+ /**
47
+ * The array of source/target pair of files involved in given operation.
48
+ */
27
49
  readonly files: readonly SourceTargetPair[];
28
50
  }
29
51
  export interface IWorkingCopyFileOperationParticipant {
52
+ /**
53
+ * Participate in a file operation of working copies. Allows to
54
+ * change the working copies before they are being saved to disk.
55
+ */
30
56
  participate(files: SourceTargetPair[], operation: FileOperation, undoInfo: IFileOperationUndoRedoInfo | undefined, timeout: number, token: CancellationToken): Promise<void>;
31
57
  }
32
58
  export interface IStoredFileWorkingCopySaveParticipantContext {
59
+ /**
60
+ * The reason why the save was triggered.
61
+ */
33
62
  readonly reason: SaveReason;
63
+ /**
64
+ * Only applies to when a text file was saved as, for
65
+ * example when starting with untitled and saving. This
66
+ * provides access to the initial resource the text
67
+ * file had before.
68
+ */
34
69
  readonly savedFrom?: URI;
35
70
  }
36
71
  export interface IStoredFileWorkingCopySaveParticipant {
72
+ /**
73
+ * The ordinal number which determines the order of participation.
74
+ * Lower values mean to participant sooner
75
+ */
37
76
  readonly ordinal?: number;
77
+ /**
78
+ * Participate in a save operation of file stored working copies.
79
+ * Allows to make changes before content is being saved to disk.
80
+ */
38
81
  participate(workingCopy: IStoredFileWorkingCopy<IStoredFileWorkingCopyModel>, context: IStoredFileWorkingCopySaveParticipantContext, progress: IProgress<IProgressStep>, token: CancellationToken): Promise<void>;
39
82
  }
40
83
  export interface ICreateOperation {
@@ -55,6 +98,9 @@ export interface IMoveOperation {
55
98
  }
56
99
  export interface ICopyOperation extends IMoveOperation {
57
100
  }
101
+ /**
102
+ * Returns the working copies for a given resource.
103
+ */
58
104
  export type WorkingCopyProvider = (resourceOrFolder: URI) => IWorkingCopy[];
59
105
  export declare class WorkingCopyFileService extends Disposable implements IWorkingCopyFileService {
60
106
  private readonly fileService;