@halcyontech/vscode-ibmi-types 2.16.3 → 2.17.2

package/api/IBMi.d.ts

@@ -1,16 +1,15 @@
 /// <reference types="node" />
 import * as node_ssh from "node-ssh";
 import { EventEmitter } from 'stream';
-import { EditorPath } from '../typings';
 import IBMiContent from "./IBMiContent";
 import { Tools } from './Tools';
 import { IBMiComponent } from "./components/component";
 import { ComponentManager, ComponentSearchProps } from "./components/manager";
 import { ConnectionManager } from './configuration/config/ConnectionManager';
 import { ConnectionConfig, RemoteConfigFile } from './configuration/config/types';
-import { CodeForIStorage } from './configuration/storage/CodeForIStorage';
-import { AspInfo, CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand } from './types';
 import { ConfigFile } from './configuration/serverFile';
+import { CodeForIStorage } from './configuration/storage/CodeForIStorage';
+import { AspInfo, CommandData, CommandResult, ConnectionData, EditorPath, IBMiMember, RemoteCommand } from './types';
 export interface MemberParts extends IBMiMember {
     basename: string;
 }
@@ -18,6 +17,7 @@ export declare type ConnectionMessageType = 'info' | 'warning' | 'error';
 export declare type ConnectionErrorCode = `shell_config` | `home_directory_creation` | `QCPTOIMPF_exists` | `QCPFRMIMPF_exists` | `default_not_bash` | `invalid_bashrc` | `invalid_temp_lib` | `no_auto_conv_ebcdic` | `not_loaded_debug_config` | `no_sql_runner` | `ccsid_warning`;
 export interface ConnectionResult {
     success: boolean;
+    error?: string;
     errorCodes?: ConnectionErrorCode[];
 }
 declare type DisconnectCallback = (conn: IBMi) => Promise<void>;
@@ -31,6 +31,12 @@ interface ConnectionCallbacks {
     message: (type: ConnectionMessageType, message: string) => void;
     cancelEmitter?: EventEmitter;
 }
+interface ConnectionOptions {
+    callbacks: ConnectionCallbacks;
+    reconnecting?: boolean;
+    reloadServerSettings?: boolean;
+    customClient?: node_ssh.NodeSSH;
+}
 interface ConnectionConfigFiles {
     settings: ConfigFile<RemoteConfigFile>;
 }
@@ -112,10 +118,7 @@ export default class IBMi {
     getConfig(): ConnectionConfig;
     setConfig(newConfig: ConnectionConfig): void;
     constructor();
-    /**
-     * @returns {Promise<{success: boolean, error?: any}>} Was succesful at connecting or not.
-     */
-    connect(connectionObject: ConnectionData, callbacks: ConnectionCallbacks, reconnecting?: boolean, reloadServerSettings?: boolean): Promise<ConnectionResult>;
+    connect(connectionObject: ConnectionData, options: ConnectionOptions): Promise<ConnectionResult>;
     private ensureTempLibraryExists;
     private ensureTempDirectory;
     /**

package/api/IBMiContent.d.ts

@@ -1,11 +1,10 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import * as node_ssh from "node-ssh";
-import { EditorPath } from '../typings';
 import { FilterType } from './Filter';
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
-import { AttrOperands, CommandResult, IBMiError, IBMiMember, IBMiObject, IFSFile, ModuleExport, ProgramExportImportInfo, QsysPath, SpecialAuthorities } from './types';
+import { AttrOperands, CommandResult, EditorPath, IBMiError, IBMiMember, IBMiObject, IFSFile, ModuleExport, ProgramExportImportInfo, QsysPath, SpecialAuthorities } from './types';
 declare type Authority = "*ADD" | "*DLT" | "*EXECUTE" | "*READ" | "*UPD" | "*NONE" | "*ALL" | "*CHANGE" | "*USE" | "*EXCLUDE" | "*AUTLMGT";
 export declare type SortOrder = `name` | `type`;
 export declare type SortOptions = {

package/api/Tools.d.ts

@@ -1,5 +1,4 @@
-import { IBMiMessages, QsysPath } from './types';
-import { EditorPath } from "../typings";
+import { EditorPath, IBMiMessages, QsysPath } from './types';
 export declare namespace Tools {
     class SqlError extends Error {
         sqlstate: string;

package/api/configuration/storage/BaseStorage.d.ts

@@ -1,13 +1,20 @@
-export declare abstract class BaseStorage {
-    protected readonly globalState: any;
-    private uniqueKeyPrefix;
-    constructor(globalState: any);
+/// <reference types="vscode" />
+/**
+ * A common type that works for both a Map and VS Code's Memento
+ */
+export declare type GlobalState = {
+    keys(): Iterable<string>;
+    get<T>(key: string): T | undefined;
+    update?(key: string, value: any): Thenable<void>;
+    set?(key: string, value: any): void;
+};
+export declare class BaseStorage {
+    protected readonly globalState: GlobalState;
+    private uniqueKeyPrefix?;
+    constructor(globalState: GlobalState);
     keys(): readonly string[];
     setUniqueKeyPrefix(prefix: string): void;
     get<T>(key: string): T | undefined;
     set(key: string, value: any): Promise<void>;
     getStorageKey(key: string): string;
 }
-export declare class VirtualStorage extends BaseStorage {
-    constructor();
-}

package/api/configuration/storage/CodeForIStorage.d.ts

@@ -1,5 +1,5 @@
-import { AspInfo, ConnectionData } from "../../types";
 import { ComponentInstallState } from "../../components/component";
+import { AspInfo, ConnectionData } from "../../types";
 import { BaseStorage } from "./BaseStorage";
 export declare type PathContent = Record<string, string[]>;
 export declare type DeploymentPath = Record<string, string>;

package/api/configuration/storage/ConnectionStorage.d.ts

@@ -1,5 +1,5 @@
 import { BaseStorage } from "./BaseStorage";
-import { PathContent, DeploymentPath, DebugCommands } from "./CodeForIStorage";
+import { DebugCommands, DeploymentPath, PathContent } from "./CodeForIStorage";
 declare type AuthorisedExtension = {
     id: string;
     displayName: string;
@@ -8,7 +8,7 @@ declare type AuthorisedExtension = {
 };
 export declare class ConnectionStorage {
     private internalStorage;
-    private connectionName;
+    private connectionName?;
     constructor(internalStorage: BaseStorage);
     get ready(): boolean;
     setConnectionName(connectionName: string): void;
@@ -33,5 +33,6 @@ export declare class ConnectionStorage {
     revokeExtensionAuthorisation(...extensions: AuthorisedExtension[]): Promise<void>;
     hasMessageBeenShown(messageId: string): boolean;
     markMessageAsShown(messageId: string): Promise<void>;
+    unmarkMessageAsShown(messageId: string): Promise<void>;
 }
 export {};

package/api/types.d.ts

@@ -58,6 +58,7 @@ export interface ConnectionData {
     privateKeyPath?: string;
     keepaliveInterval?: number;
     readyTimeout?: number;
+    sshDebug?: boolean;
 }
 export interface Server {
     name: string;
@@ -192,4 +193,7 @@ export interface ModuleExport {
     symbolType: string;
     argumentOptimization: string;
 }
+export declare type EditorPath = string | {
+    fsPath: string;
+};
 export * from "./configuration/config/types";

package/package.json

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

package/typings.d.ts

@@ -20,8 +20,5 @@ export interface DeploymentParameters {
     remotePath: string;
     ignoreRules?: Ignore;
 }
-export declare type EditorPath = string | {
-    fsPath: string;
-};
 export * from "./api/types";
 export * from "./ui/types";

package/ui/actions.d.ts

@@ -2,5 +2,22 @@ import vscode, { WorkspaceFolder } from 'vscode';
 import Instance from '../Instance';
 import { Action, DeploymentMethod } from '../typings';
 import { BrowserItem } from './types';
+export declare type ActionTarget = {
+    uri: vscode.Uri;
+    extension: string;
+    fragment: string;
+    protected: boolean;
+    workspaceFolder?: vscode.WorkspaceFolder;
+    executionOK: boolean;
+    hasRun: boolean;
+    processed: boolean;
+    output: string[];
+};
 export declare function registerActionTools(context: vscode.ExtensionContext): void;
+export declare function uriToActionTarget(uri: vscode.Uri, workspaceFolder?: WorkspaceFolder): ActionTarget;
 export declare function runAction(instance: Instance, uris: vscode.Uri | vscode.Uri[], customAction?: Action, method?: DeploymentMethod, browserItems?: BrowserItem[], workspaceFolder?: WorkspaceFolder): Promise<boolean>;
+export declare type AvailableAction = {
+    label: string;
+    action: Action;
+};
+export declare function getAllAvailableActions(targets: ActionTarget[], scheme: string): Promise<AvailableAction[]>;

package/config/Storage.d.ts

@@ -1,10 +0,0 @@
-import * as vscode from 'vscode';
-import { BaseStorage } from '../api/configuration/storage/BaseStorage';
-export declare class VsStorage extends BaseStorage {
-    protected readonly globalState: vscode.Memento;
-    private connectionName;
-    constructor(context: vscode.ExtensionContext);
-    keys(): readonly string[];
-    get<T>(key: string): T | undefined;
-    set(key: string, value: any): Promise<void>;
-}