@halcyontech/vscode-ibmi-types 2.4.0 → 2.6.0

package/api/CompileTools.d.ts

@@ -1,5 +1,5 @@
 import vscode, { EventEmitter } from 'vscode';
-import { Action, CommandResult, DeploymentMethod, RemoteCommand } from '../typings';
+import { Action, BrowserItem, CommandResult, DeploymentMethod, RemoteCommand } from '../typings';
 import Instance from './Instance';
 export interface ILELibrarySettings {
     currentLibrary: string;
@@ -7,7 +7,7 @@ export interface ILELibrarySettings {
 }
 export declare namespace CompileTools {
     function register(context: vscode.ExtensionContext): void;
-    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod): Promise<boolean>;
+    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod, browserItem?: BrowserItem): Promise<boolean>;
     /**
      * Execute a command
      */

package/api/Configuration.d.ts

@@ -1,4 +1,5 @@
 import * as vscode from 'vscode';
+import { DeploymentMethod } from '../typings';
 export declare type SourceDateMode = "edit" | "diff";
 export declare function onCodeForIBMiConfigurationChange<T>(props: string | string[], todo: (value: vscode.ConfigurationChangeEvent) => void): vscode.Disposable;
 export declare namespace GlobalConfiguration {
@@ -35,6 +36,7 @@ export declare namespace ConnectionConfiguration {
         debugEnableDebugTracing: boolean;
         readOnlyMode: boolean;
         quickConnect: boolean;
+        defaultDeploymentMethod: DeploymentMethod | '';
         [name: string]: any;
     }
     interface ObjectFilters {

package/api/IBMi.d.ts

@@ -1,7 +1,7 @@
 import * as node_ssh from "node-ssh";
 import * as vscode from "vscode";
 import { ConnectionConfiguration } from "./Configuration";
-import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, StandardIO } from "../typings";
+import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand } from "../typings";
 export interface MemberParts extends IBMiMember {
     basename: string;
 }
@@ -38,12 +38,6 @@ export default class IBMi {
         success: boolean;
         error?: any;
     }>;
-    /**
-     * @deprecated Use runCommand instead
-     * @param {string} command
-     * @param {string} [directory] If not passed, will use current home directory
-     */
-    remoteCommand(command: string, directory?: string): Promise<String | CommandResult>;
     /**
      * - Send PASE/QSH/ILE commands simply
      * - Commands sent here end in the 'IBM i Output' channel
@@ -54,10 +48,6 @@ export default class IBMi {
      */
     runCommand(data: RemoteCommand): Promise<CommandResult>;
     sendQsh(options: CommandData): Promise<CommandResult>;
-    /**
-     * @deprecated Use sendCommand instead
-     */
-    paseCommand(command: string, directory?: string, returnType?: number, standardIO?: StandardIO): Promise<String | CommandResult>;
     /**
      * Send commands to pase through the SSH connection.
      * Commands sent here end up in the 'Code for IBM i' output channel.

package/api/Storage.d.ts

@@ -28,6 +28,7 @@ export declare type CachedServerSettings = {
     };
     badDataAreasChecked: boolean | null;
     libraryListValidated: boolean | null;
+    pathChecked?: boolean;
 } | undefined;
 export declare class GlobalStorage extends Storage {
     private static instance;
@@ -53,6 +54,7 @@ export declare class GlobalStorage extends Storage {
         };
         badDataAreasChecked: boolean;
         libraryListValidated: boolean;
+        pathChecked?: boolean;
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;

package/api/Tools.d.ts

@@ -26,7 +26,7 @@ export declare namespace Tools {
      * @param member
      * @param iasp Optional: an iASP name
      */
-    function qualifyPath(library: string, object: string, member: string, iasp?: string): string;
+    function qualifyPath(library: string, object: string, member: string, iasp?: string, sanitise?: boolean): string;
     /**
      * Unqualify member path from root
      */
@@ -40,4 +40,5 @@ export declare namespace Tools {
     function distinct(value: any, index: number, array: any[]): boolean;
     function md5Hash(file: vscode.Uri): string;
     function capitalize(text: string): string;
+    function sanitizeLibraryNames(libraries: string[]): string[];
 }

package/api/debug/certificates.d.ts

@@ -1,6 +1,12 @@
 import IBMi from "../IBMi";
-export declare function getKeystorePath(connection: IBMi): string;
-export declare function getLocalCertPath(connection: IBMi): string;
-export declare function checkRemoteExists(connection: IBMi): Promise<boolean>;
+export declare function getRemoteServerCertPath(connection: IBMi): string;
+export declare function getRemoteClientCertPath(connection: IBMi): string;
+export declare function remoteServerCertExists(connection: IBMi): Promise<boolean>;
+export declare function remoteClientCertExists(connection: IBMi): Promise<boolean>;
+/**
+ * Generate all certifcates on the server
+ */
 export declare function setup(connection: IBMi): Promise<void>;
-export declare function checkLocalExists(connection: IBMi): Promise<boolean>;
+export declare function downloadClientCert(connection: IBMi): Promise<void>;
+export declare function getLocalCertPath(connection: IBMi): string;
+export declare function localClientCertExists(connection: IBMi): Promise<boolean>;

package/api/debug/index.d.ts

@@ -1,10 +1,13 @@
 import { ExtensionContext } from "vscode";
 import Instance from "../Instance";
+import { ILELibrarySettings } from "../CompileTools";
+export declare function isManaged(): boolean;
 export declare function initialize(context: ExtensionContext): Promise<void>;
 interface DebugOptions {
     password: string;
     library: string;
     object: string;
+    libraries: ILELibrarySettings;
 }
 export declare function startDebug(instance: Instance, options: DebugOptions): Promise<void>;
 export {};

package/api/errors/diagnostics.d.ts

@@ -12,6 +12,7 @@ export declare function registerDiagnostics(): vscode.Disposable[];
  * Does what it says on the tin.
  */
 export declare function clearDiagnostics(): void;
+export declare function clearDiagnostic(uri: vscode.Uri, changeRange: vscode.Range): void;
 export declare function refreshDiagnosticsFromServer(instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
 export declare function refreshDiagnosticsFromLocal(instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
 export declare function handleEvfeventLines(lines: string[], instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;

package/api/local/deployTools.d.ts

@@ -1,8 +1,13 @@
 import { Ignore } from 'ignore';
-import vscode, { WorkspaceFolder } from 'vscode';
+import vscode, { Uri, WorkspaceFolder } from 'vscode';
 import { DeploymentMethod, DeploymentParameters } from '../../typings';
+declare type ServerFileChanges = {
+    uploads: Uri[];
+    relativeRemoteDeletes: string[];
+};
 export declare namespace DeployTools {
     function launchActionsSetup(workspaceFolder?: WorkspaceFolder): Promise<void>;
+    function getRemoteDeployDirectory(workspaceFolder: WorkspaceFolder): string | undefined;
     /**
      * Deploy a workspace to a remote IFS location.
      * @param workspaceIndex if no index is provided, a prompt will be shown to pick one if there are multiple workspaces,
@@ -10,15 +15,19 @@ export declare namespace DeployTools {
      * @param method if no method is provided, a prompt will be shown to pick the deployment method.
      * @returns the index of the deployed workspace or `undefined` if the deployment failed
      */
-    function launchDeploy(workspaceIndex?: number, method?: DeploymentMethod): Promise<number | undefined>;
+    function launchDeploy(workspaceIndex?: number, method?: DeploymentMethod): Promise<{
+        remoteDirectory: string;
+        workspaceId: number;
+    } | undefined>;
     function deploy(parameters: DeploymentParameters): Promise<boolean>;
     function getDeployChangedFiles(parameters: DeploymentParameters): Promise<vscode.Uri[]>;
     function getDeployGitFiles(parameters: DeploymentParameters, changeType: 'staged' | 'working'): Promise<vscode.Uri[]>;
     function getDeployCompareFiles(parameters: DeploymentParameters, progress?: vscode.Progress<{
         message?: string;
-    }>): Promise<vscode.Uri[]>;
+    }>): Promise<ServerFileChanges>;
     function getDeployAllFiles(parameters: DeploymentParameters): Promise<vscode.Uri[]>;
     function setDeployLocation(node: any, workspaceFolder?: WorkspaceFolder, value?: string): Promise<void>;
     function buildPossibleDeploymentDirectory(workspace: vscode.WorkspaceFolder): string;
     function getDefaultIgnoreRules(workspaceFolder: vscode.WorkspaceFolder): Promise<Ignore>;
 }
+export {};

package/api/local/deployment.d.ts

@@ -19,6 +19,7 @@ export declare namespace Deployment {
     function toMD5Entry(line: string): MD5Entry;
     function toRelative(root: vscode.Uri, file: vscode.Uri): string;
     function findFiles(parameters: DeploymentParameters, includePattern: string, excludePattern?: string): Promise<vscode.Uri[]>;
+    function deleteFiles(parameters: DeploymentParameters, toDelete: string[]): Promise<void>;
     function sendCompressed(parameters: DeploymentParameters, files: vscode.Uri[], progress: vscode.Progress<{
         message?: string;
     }>): Promise<void>;

package/api/local/env.d.ts

@@ -2,3 +2,4 @@ import { WorkspaceFolder } from "vscode";
 export declare function getEnvConfig(currentWorkspace: WorkspaceFolder): Promise<{
     [key: string]: string;
 }>;
+export declare function getBranchLibraryName(currentBranch: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halcyontech/vscode-ibmi-types",
-  "version": "2.4.0",
+  "version": "2.6.0",
   "description": "Types for vscode-ibmi",
   "typings": "./typings.d.ts",
   "scripts": {

package/typings.d.ts

@@ -28,12 +28,16 @@ export interface StandardIO {
 /**
  * External interface for extensions to call `code-for-ibmi.runCommand`
  */
+export declare type ActionType = "member" | "streamfile" | "object" | "file";
+export declare type ActionRefresh = "no" | "parent" | "filter" | "browser";
+export declare type ActionEnvironment = "ile" | "qsh" | "pase";
 export interface RemoteCommand {
     title?: string;
     command: string;
-    environment?: "ile" | "qsh" | "pase";
+    environment?: ActionEnvironment;
     cwd?: string;
     env?: Record<string, string>;
+    noLibList?: boolean;
 }
 export interface CommandData extends StandardIO {
     command: string;
@@ -46,8 +50,6 @@ export interface CommandResult {
     stderr: string;
     command?: string;
 }
-export declare type ActionType = "member" | "streamfile" | "object" | "file";
-export declare type ActionEnvironment = "ile" | "qsh" | "pase";
 export interface Action {
     name: string;
     command: string;
@@ -56,6 +58,8 @@ export interface Action {
     extensions?: string[];
     deployFirst?: boolean;
     postDownload?: string[];
+    refresh?: ActionRefresh;
+    runOnProtected?: boolean;
 }
 export interface ConnectionData {
     name: string;
@@ -63,6 +67,7 @@ export interface ConnectionData {
     port: number;
     username: string;
     password?: string;
+    privateKey?: string;
     privateKeyPath?: string;
     keepaliveInterval?: number;
 }
@@ -73,6 +78,7 @@ export interface Profile {
     profile: string;
 }
 export interface QsysPath {
+    asp?: string;
     library: string;
     name: string;
 }
@@ -101,7 +107,7 @@ export interface IFSFile {
     name: string;
     path: string;
     size?: number;
-    modified?: Date | string;
+    modified?: Date;
     owner?: string;
 }
 export interface IBMiError {