@difizen/libro-language-client 0.1.18

package/es/common/fileOperations.d.ts

@@ -0,0 +1,118 @@
+import * as proto from '@difizen/vscode-languageserver-protocol';
+import type { Disposable, FileCreateEvent, FileRenameEvent, FileDeleteEvent, FileWillCreateEvent, FileWillRenameEvent, FileWillDeleteEvent, Event as VEvent, WorkspaceEdit, Uri, CancellationToken } from 'vscode';
+import type { DynamicFeature, RegistrationData, NextSignature, FeatureState, FeatureClient } from './features.js';
+import { FileType } from './vscodeAdaptor/vscodeAdaptor.js';
+/**
+ * File operation middleware
+ *
+ * @since 3.16.0
+ */
+export interface FileOperationsMiddleware {
+    didCreateFiles?: NextSignature<FileCreateEvent, Promise<void>>;
+    willCreateFiles?: NextSignature<FileWillCreateEvent, Thenable<WorkspaceEdit | null | undefined>>;
+    didRenameFiles?: NextSignature<FileRenameEvent, Promise<void>>;
+    willRenameFiles?: NextSignature<FileWillRenameEvent, Thenable<WorkspaceEdit | null | undefined>>;
+    didDeleteFiles?: NextSignature<FileDeleteEvent, Promise<void>>;
+    willDeleteFiles?: NextSignature<FileWillDeleteEvent, Thenable<WorkspaceEdit | null | undefined>>;
+}
+interface FileOperationsWorkspaceMiddleware {
+    workspace?: FileOperationsMiddleware;
+}
+interface Event<I> {
+    readonly files: ReadonlyArray<I>;
+}
+declare abstract class FileOperationFeature<I, E extends Event<I>> implements DynamicFeature<proto.FileOperationRegistrationOptions> {
+    protected readonly _client: FeatureClient<FileOperationsWorkspaceMiddleware>;
+    private readonly _event;
+    private readonly _registrationType;
+    private readonly _clientCapability;
+    private readonly _serverCapability;
+    private _listener;
+    private readonly _filters;
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>, event: VEvent<E>, registrationType: proto.RegistrationType<proto.FileOperationRegistrationOptions>, clientCapability: keyof proto.FileOperationClientCapabilities, serverCapability: keyof proto.FileOperationOptions);
+    getState(): FeatureState;
+    protected filterSize(): number;
+    get registrationType(): proto.RegistrationType<proto.FileOperationRegistrationOptions>;
+    fillClientCapabilities(capabilities: proto.ClientCapabilities): void;
+    initialize(capabilities: proto.ServerCapabilities): void;
+    register(data: RegistrationData<proto.FileOperationRegistrationOptions>): void;
+    abstract send(data: E): Promise<void>;
+    unregister(id: string): void;
+    clear(): void;
+    protected getFileType(uri: Uri): Promise<FileType | undefined>;
+    protected filter(event: E, prop: (i: I) => Uri): Promise<E>;
+    protected static getFileType(uri: Uri): Promise<FileType | undefined>;
+    private static asMinimatchOptions;
+}
+declare abstract class NotificationFileOperationFeature<I, E extends {
+    readonly files: ReadonlyArray<I>;
+}, P> extends FileOperationFeature<I, E> {
+    private _notificationType;
+    private _accessUri;
+    private _createParams;
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>, event: VEvent<E>, notificationType: proto.ProtocolNotificationType<P, proto.FileOperationRegistrationOptions>, clientCapability: keyof proto.FileOperationClientCapabilities, serverCapability: keyof proto.FileOperationOptions, accessUri: (i: I) => Uri, createParams: (e: E) => P);
+    send(originalEvent: E): Promise<void>;
+    protected abstract doSend(event: E, next: (event: E) => Promise<void>): Promise<void>;
+}
+declare abstract class CachingNotificationFileOperationFeature<I, E extends {
+    readonly files: ReadonlyArray<I>;
+}, P> extends NotificationFileOperationFeature<I, E, P> {
+    protected _willListener: Disposable | undefined;
+    private readonly _fsPathFileTypes;
+    protected getFileType(uri: Uri): Promise<FileType | undefined>;
+    protected cacheFileTypes(event: E, prop: (i: I) => Uri): Promise<void>;
+    protected clearFileTypeCache(): void;
+    unregister(id: string): void;
+    clear(): void;
+}
+export declare class DidCreateFilesFeature extends NotificationFileOperationFeature<Uri, FileCreateEvent, proto.CreateFilesParams> {
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>);
+    protected doSend(event: FileCreateEvent, next: (event: FileCreateEvent) => Promise<void>): Promise<void>;
+}
+export declare class DidRenameFilesFeature extends CachingNotificationFileOperationFeature<{
+    oldUri: Uri;
+    newUri: Uri;
+}, FileRenameEvent, proto.RenameFilesParams> {
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>);
+    register(data: RegistrationData<proto.FileOperationRegistrationOptions>): void;
+    private willRename;
+    protected doSend(event: FileRenameEvent, next: (event: FileRenameEvent) => Promise<void>): Promise<void>;
+}
+export declare class DidDeleteFilesFeature extends CachingNotificationFileOperationFeature<Uri, FileDeleteEvent, proto.DeleteFilesParams> {
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>);
+    register(data: RegistrationData<proto.FileOperationRegistrationOptions>): void;
+    private willDelete;
+    protected doSend(event: FileCreateEvent, next: (event: FileCreateEvent) => Promise<void>): Promise<void>;
+}
+interface RequestEvent<I> {
+    readonly token: CancellationToken;
+    readonly files: ReadonlyArray<I>;
+    waitUntil(thenable: Thenable<WorkspaceEdit>): void;
+    waitUntil(thenable: Thenable<any>): void;
+}
+declare abstract class RequestFileOperationFeature<I, E extends RequestEvent<I>, P> extends FileOperationFeature<I, E> {
+    private _requestType;
+    private _accessUri;
+    private _createParams;
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>, event: VEvent<E>, requestType: proto.ProtocolRequestType<P, proto.WorkspaceEdit | null, never, void, proto.FileOperationRegistrationOptions>, clientCapability: keyof proto.FileOperationClientCapabilities, serverCapability: keyof proto.FileOperationOptions, accessUri: (i: I) => Uri, createParams: (e: Event<I>) => P);
+    send(originalEvent: E & RequestEvent<I>): Promise<void>;
+    private waitUntil;
+    protected abstract doSend(event: E, next: (event: RequestEvent<I>) => Thenable<WorkspaceEdit> | Thenable<any>): Thenable<WorkspaceEdit> | Thenable<any>;
+}
+export declare class WillCreateFilesFeature extends RequestFileOperationFeature<Uri, FileWillCreateEvent, proto.CreateFilesParams> {
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>);
+    protected doSend(event: FileWillCreateEvent, next: (event: FileWillCreateEvent) => Thenable<WorkspaceEdit> | Thenable<any>): Thenable<WorkspaceEdit> | Thenable<any>;
+}
+export declare class WillRenameFilesFeature extends RequestFileOperationFeature<{
+    oldUri: Uri;
+    newUri: Uri;
+}, FileWillRenameEvent, proto.RenameFilesParams> {
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>);
+    protected doSend(event: FileWillRenameEvent, next: (event: FileWillRenameEvent) => Thenable<WorkspaceEdit> | Thenable<any>): Thenable<WorkspaceEdit> | Thenable<any>;
+}
+export declare class WillDeleteFilesFeature extends RequestFileOperationFeature<Uri, FileWillDeleteEvent, proto.DeleteFilesParams> {
+    constructor(client: FeatureClient<FileOperationsWorkspaceMiddleware>);
+    protected doSend(event: FileWillDeleteEvent, next: (event: FileWillDeleteEvent) => Thenable<WorkspaceEdit> | Thenable<any>): Thenable<WorkspaceEdit> | Thenable<any>;
+}
+export {};
+//# sourceMappingURL=fileOperations.d.ts.map

package/es/common/fileOperations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fileOperations.d.ts","sourceRoot":"","sources":["../../src/common/fileOperations.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,KAAK,MAAM,yCAAyC,CAAC;AAEjE,OAAO,KAAK,EACV,UAAU,EACV,eAAe,EACf,eAAe,EACf,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,KAAK,IAAI,MAAM,EACf,aAAa,EACb,GAAG,EACH,iBAAiB,EAClB,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,aAAa,EACd,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAkB5D;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,eAAe,CAAC,EAAE,aAAa,CAC7B,mBAAmB,EACnB,QAAQ,CAAC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC,CAC3C,CAAC;IACF,cAAc,CAAC,EAAE,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,eAAe,CAAC,EAAE,aAAa,CAC7B,mBAAmB,EACnB,QAAQ,CAAC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC,CAC3C,CAAC;IACF,cAAc,CAAC,EAAE,aAAa,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/D,eAAe,CAAC,EAAE,aAAa,CAC7B,mBAAmB,EACnB,QAAQ,CAAC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC,CAC3C,CAAC;CACH;AAED,UAAU,iCAAiC;IACzC,SAAS,CAAC,EAAE,wBAAwB,CAAC;CACtC;AAED,UAAU,KAAK,CAAC,CAAC;IACf,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CAClC;AAED,uBAAe,oBAAoB,CAAC,CAAC,EAAE,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,CACvD,YAAW,cAAc,CAAC,KAAK,CAAC,gCAAgC,CAAC;IAEjE,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,iCAAiC,CAAC,CAAC;IAC7E,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAY;IACnC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAiE;IACnG,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA8C;IAChF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IACrE,OAAO,CAAC,SAAS,CAAyB;IAG1C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAOvB;gBAGA,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC,EACxD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAChB,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,gCAAgC,CAAC,EAChF,gBAAgB,EAAE,MAAM,KAAK,CAAC,+BAA+B,EAC7D,gBAAgB,EAAE,MAAM,KAAK,CAAC,oBAAoB;IAUpD,QAAQ,IAAI,YAAY;IAQxB,SAAS,CAAC,UAAU,IAAI,MAAM;IAI9B,IAAW,gBAAgB,IAAI,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAE5F;IAEM,sBAAsB,CAAC,YAAY,EAAE,KAAK,CAAC,kBAAkB,GAAG,IAAI;IAOpE,UAAU,CAAC,YAAY,EAAE,KAAK,CAAC,kBAAkB,GAAG,IAAI;IAkBxD,QAAQ,CACb,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,gCAAgC,CAAC,GAC7D,IAAI;aAiBS,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAErC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAQ5B,KAAK,IAAI,IAAI;IAQpB,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;cAI9C,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;qBAsD1C,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAQ3E,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAWlC;AAED,uBAAe,gCAAgC,CAC7C,CAAC,EACD,CAAC,SAAS;IAAE,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;CAAE,EAC9C,CAAC,CACD,SAAQ,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC;IAClC,OAAO,CAAC,iBAAiB,CAGvB;IACF,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,aAAa,CAAc;gBAGjC,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC,EACxD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAChB,gBAAgB,EAAE,KAAK,CAAC,wBAAwB,CAC9C,CAAC,EACD,KAAK,CAAC,gCAAgC,CACvC,EACD,gBAAgB,EAAE,MAAM,KAAK,CAAC,+BAA+B,EAC7D,gBAAgB,EAAE,MAAM,KAAK,CAAC,oBAAoB,EAClD,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,EACxB,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;IAQd,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAelD,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CACtF;AAED,uBAAe,uCAAuC,CACpD,CAAC,EACD,CAAC,SAAS;IAAE,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAA;CAAE,EAC9C,CAAC,CACD,SAAQ,gCAAgC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IACjD,SAAS,CAAC,aAAa,EAAE,UAAU,GAAG,SAAS,CAAC;IAChD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA+B;cAEvC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;cAa7D,cAAc,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG;IAS5D,SAAS,CAAC,kBAAkB;IAIZ,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAQ5B,KAAK,IAAI,IAAI;CAO9B;AAED,qBAAa,qBAAsB,SAAQ,gCAAgC,CACzE,GAAG,EACH,eAAe,EACf,KAAK,CAAC,iBAAiB,CACxB;gBACa,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC;IAYpE,SAAS,CAAC,MAAM,CACd,KAAK,EAAE,eAAe,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;CAMjB;AAED,qBAAa,qBAAsB,SAAQ,uCAAuC,CAChF;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,MAAM,EAAE,GAAG,CAAA;CAAE,EAC5B,eAAe,EACf,KAAK,CAAC,iBAAiB,CACxB;gBACa,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC;IAYpD,QAAQ,CACtB,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,gCAAgC,CAAC,GAC7D,IAAI;IAOP,OAAO,CAAC,UAAU;IAIlB,SAAS,CAAC,MAAM,CACd,KAAK,EAAE,eAAe,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;CAOjB;AAED,qBAAa,qBAAsB,SAAQ,uCAAuC,CAChF,GAAG,EACH,eAAe,EACf,KAAK,CAAC,iBAAiB,CACxB;gBACa,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC;IAYpD,QAAQ,CACtB,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,gCAAgC,CAAC,GAC7D,IAAI;IAOP,OAAO,CAAC,UAAU;IAIlB,SAAS,CAAC,MAAM,CACd,KAAK,EAAE,eAAe,EACtB,IAAI,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,GAC9C,OAAO,CAAC,IAAI,CAAC;CAOjB;AAED,UAAU,YAAY,CAAC,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACjC,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC;IACnD,SAAS,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED,uBAAe,2BAA2B,CACxC,CAAC,EACD,CAAC,SAAS,YAAY,CAAC,CAAC,CAAC,EACzB,CAAC,CACD,SAAQ,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC;IAClC,OAAO,CAAC,YAAY,CAMlB;IACF,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,aAAa,CAAqB;gBAGxC,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC,EACxD,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,EAChB,WAAW,EAAE,KAAK,CAAC,mBAAmB,CACpC,CAAC,EACD,KAAK,CAAC,aAAa,GAAG,IAAI,EAC1B,KAAK,EACL,IAAI,EACJ,KAAK,CAAC,gCAAgC,CACvC,EACD,gBAAgB,EAAE,MAAM,KAAK,CAAC,+BAA+B,EAC7D,gBAAgB,EAAE,MAAM,KAAK,CAAC,oBAAoB,EAClD,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,EACxB,YAAY,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IAQrB,IAAI,CAAC,aAAa,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;YAKtD,SAAS;IAiBvB,SAAS,CAAC,QAAQ,CAAC,MAAM,CACvB,KAAK,EAAE,CAAC,EACR,IAAI,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GACxE,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC;CAC3C;AAED,qBAAa,sBAAuB,SAAQ,2BAA2B,CACrE,GAAG,EACH,mBAAmB,EACnB,KAAK,CAAC,iBAAiB,CACxB;gBACa,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC;IAYpE,SAAS,CAAC,MAAM,CACd,KAAK,EAAE,mBAAmB,EAC1B,IAAI,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAC5E,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC;CAM3C;AAED,qBAAa,sBAAuB,SAAQ,2BAA2B,CACrE;IAAE,MAAM,EAAE,GAAG,CAAC;IAAC,MAAM,EAAE,GAAG,CAAA;CAAE,EAC5B,mBAAmB,EACnB,KAAK,CAAC,iBAAiB,CACxB;gBACa,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC;IAYpE,SAAS,CAAC,MAAM,CACd,KAAK,EAAE,mBAAmB,EAC1B,IAAI,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAC5E,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC;CAM3C;AAED,qBAAa,sBAAuB,SAAQ,2BAA2B,CACrE,GAAG,EACH,mBAAmB,EACnB,KAAK,CAAC,iBAAiB,CACxB;gBACa,MAAM,EAAE,aAAa,CAAC,iCAAiC,CAAC;IAYpE,SAAS,CAAC,MAAM,CACd,KAAK,EAAE,mBAAmB,EAC1B,IAAI,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC,GAC5E,QAAQ,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,GAAG,CAAC;CAM3C"}