Add type for UserAction

Author: isc-bsaviano

src/api/atelier.d.ts

@@ -24,6 +24,15 @@ interface ServerInfoFeature {
   enabled: string;
 }
 
+export interface UserAction {
+  action: number;
+  target: string;
+  message: string;
+  reload: boolean;
+  doc: any;
+  errorText: string;
+}
+
 export interface Document {
   name: string;
   db: string;
@@ -34,7 +43,7 @@ export interface Document {
   enc: boolean;
   flags: number;
   content: string[] | Buffer;
-  ext: string;
+  ext?: UserAction | UserAction[];
 }
 
 export interface ServerInfo {

src/commands/delete.ts

@@ -8,6 +8,7 @@ import { explorerProvider } from "../extension";
 import { outputChannel } from "../utils";
 import { OtherStudioAction, fireOtherStudioAction } from "./studio";
 import { DocumentContentProvider } from "../providers/DocumentContentProvider";
+import { UserAction } from "../api/atelier";
 
 function deleteList(items: string[], workspaceFolder: string, namespace: string): Promise<any> {
   if (!items || !items.length) {
@@ -20,7 +21,7 @@ function deleteList(items: string[], workspaceFolder: string, namespace: string)
     files.forEach((file) => {
       if (file.result.ext) {
         const uri = DocumentContentProvider.getUri(file.result.name);
-        fireOtherStudioAction(OtherStudioAction.DeletedDocument, uri, file.result.ext);
+        fireOtherStudioAction(OtherStudioAction.DeletedDocument, uri, <UserAction>file.result.ext);
       }
     });
     outputChannel.appendLine(`Deleted items: ${files.filter((el) => el.result).length}`);

src/commands/studio.ts

@@ -9,6 +9,7 @@ import { RoutineNode } from "../explorer/models/routineNode";
 import { importAndCompile } from "./compile";
 import { ProjectNode } from "../explorer/models/projectNode";
 import { openCustomEditors } from "../providers/RuleEditorProvider";
+import { UserAction } from "../api/atelier";
 
 export let documentBeingProcessed: vscode.TextDocument = null;
 
@@ -119,9 +120,8 @@ export class StudioActions {
     );
   }
 
-  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-  public processUserAction(userAction): Thenable<any> {
-    const serverAction = parseInt(userAction.action || 0, 10);
+  public processUserAction(userAction: UserAction): Thenable<any> {
+    const serverAction = userAction.action;
     const { target, errorText } = userAction;
     if (errorText !== "") {
       outputChannel.appendLine(errorText);
@@ -314,7 +314,7 @@ export class StudioActions {
             this.projectEditAnswer = "1";
             return;
           }
-          const actionToProcess = data.result.content.pop();
+          const actionToProcess: UserAction = data.result.content.pop();
 
           if (actionToProcess.reload) {
             // Avoid the reload triggering the edit listener here
@@ -429,8 +429,7 @@ export class StudioActions {
       .then((action) => this.userAction(action));
   }
 
-  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-  public fireOtherStudioAction(action: OtherStudioAction, userAction?): void {
+  public fireOtherStudioAction(action: OtherStudioAction, userAction?: UserAction): void {
     const actionObject = {
       id: action.toString(),
       label: getOtherStudioActionLabel(action),
@@ -560,8 +559,11 @@ export async function _contextMenu(sourceControl: boolean, node: PackageNode | C
   }
 }
 
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-export async function fireOtherStudioAction(action: OtherStudioAction, uri?: vscode.Uri, userAction?): Promise<void> {
+export async function fireOtherStudioAction(
+  action: OtherStudioAction,
+  uri?: vscode.Uri,
+  userAction?: UserAction
+): Promise<void> {
   if (vscode.workspace.getConfiguration("objectscript.serverSourceControl", uri)?.get("disableOtherActionTriggers")) {
     return;
   }

src/providers/FileSystemProvider/FileSystemProvider.ts

@@ -16,7 +16,7 @@ import {
 import { config, intLangId, macLangId, workspaceState } from "../../extension";
 import { addIsfsFileToProject, modifyProject } from "../../commands/project";
 import { DocumentContentProvider } from "../DocumentContentProvider";
-import { Document } from "../../api/atelier";
+import { Document, UserAction } from "../../api/atelier";
 
 declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timeout;
 
@@ -453,7 +453,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
     const events: vscode.FileChangeEvent[] = [];
     try {
       if (doc.ext) {
-        fireOtherStudioAction(OtherStudioAction.DeletedDocument, uri, doc.ext);
+        fireOtherStudioAction(OtherStudioAction.DeletedDocument, uri, <UserAction>doc.ext);
       }
       // Remove entry from our cache, plus any now-empty ancestor entries
       let thisUri = vscode.Uri.parse(uri.toString(), true);