@halcyontech/vscode-ibmi-types 2.18.0 → 3.0.6

package/Instance.d.ts

@@ -11,6 +11,7 @@ export interface ConnectionOptions {
 }
 export default class Instance {
     private connection;
+    connected?: Promise<ConnectionResult>;
     private output;
     private storage;
     private emitter;
@@ -21,7 +22,7 @@ export default class Instance {
     getOutputContent(): string;
     private resetOutput;
     connect(options: ConnectionOptions): Promise<ConnectionResult>;
-    disconnect(): Promise<void>;
+    disconnect(keepTabsOpened?: boolean): Promise<void>;
     private setConnection;
     getConnection(): IBMi;
     getLibraryList(connection: IBMi, workspaceFolder?: vscode.WorkspaceFolder): Promise<ILELibrarySettings>;

package/api/CCSIDs.d.ts

@@ -0,0 +1,8 @@
+/**
+ * CCSID (Coded Character Set Identifier) definitions
+ * This file contains a comprehensive list of CCSIDs used for character encoding conversions
+ */
+export declare const CCSIDS: {
+    ccsid: string;
+    description: string;
+}[];

package/api/CompileTools.d.ts

@@ -10,7 +10,9 @@ export declare namespace CompileTools {
     interface RunCommandEvents {
         writeEvent?: (content: string) => void;
         commandConfirm?: (command: string) => Promise<string>;
+        updateProgress?: (message: string) => void;
     }
+    export function reset(): void;
     /**
      * Execute a command
      */

package/api/Filter.d.ts

@@ -1,8 +1,8 @@
-declare type Filter = {
+type Filter = {
     test: (text: string) => boolean;
     noFilter: boolean;
 };
-export declare type FilterType = 'simple' | 'regex';
+export type FilterType = 'simple' | 'regex';
 export declare function parseFilter(filterString?: string, type?: FilterType): Filter;
 /**
  * Return filterString if it is a single, generic name filter (e.g. QSYS*)

package/api/IBMi.d.ts

@@ -1,5 +1,6 @@
-/// <reference types="node" />
+import { BindingValue } from "@ibm/mapepire-js";
 import * as node_ssh from "node-ssh";
+import { ClientErrorExtensions } from "ssh2";
 import { EventEmitter } from 'stream';
 import IBMiContent from "./IBMiContent";
 import { Tools } from './Tools';
@@ -9,26 +10,27 @@ import { ConnectionManager } from './configuration/config/ConnectionManager';
 import { ConnectionConfig, RemoteConfigFile } from './configuration/config/types';
 import { ConfigFile } from './configuration/serverFile';
 import { CodeForIStorage } from './configuration/storage/CodeForIStorage';
-import { AspInfo, CommandData, CommandResult, ConnectionData, EditorPath, IBMiMember, RemoteCommand } from './types';
+import { AspInfo, CacheItem, CommandData, CommandResult, ConnectionData, EditorPath, IBMiMember, QsysPath, RemoteCommand } from './types';
 export interface MemberParts extends IBMiMember {
     basename: string;
 }
-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 type ConnectionMessageType = 'info' | 'warning' | 'error';
+export type ConnectionErrorCode = `shell_config` | `home_directory_creation` | `home_directory_permissions` | `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` | `component_signature_mismatch`;
 export interface ConnectionResult {
     success: boolean;
     error?: string;
     errorCodes?: ConnectionErrorCode[];
 }
-declare type DisconnectCallback = (conn: IBMi) => Promise<void>;
+export type DisconnectedCallback = (conn: IBMi, error?: Error & ClientErrorExtensions) => Promise<void>;
 interface ConnectionCallbacks {
     onConnectedOperations?: Function[];
-    timeoutCallback?: (conn: IBMi) => Promise<void>;
+    onDisconnected?: DisconnectedCallback;
     uiErrorHandler: (connection: IBMi, error: ConnectionErrorCode, data?: any) => Promise<boolean>;
     progress: (detail: {
         message: string;
     }) => void;
     message: (type: ConnectionMessageType, message: string) => void;
+    inputBox: (prompt: string, placeHolder: string, ignoreFocusOut: boolean) => Promise<string | undefined>;
     cancelEmitter?: EventEmitter;
 }
 interface ConnectionOptions {
@@ -39,6 +41,7 @@ interface ConnectionOptions {
 }
 interface ConnectionConfigFiles {
     settings: ConfigFile<RemoteConfigFile>;
+    [key: string]: ConfigFile<any>;
 }
 export default class IBMi {
     static GlobalStorage: CodeForIStorage;
@@ -50,9 +53,6 @@ export default class IBMi {
     private systemVersion;
     private qccsid;
     private userJobCcsid;
-    /** User default CCSID is job default CCSID */
-    private userDefaultCCSID;
-    private sshdCcsid;
     private componentManager;
     private configFiles;
     /**
@@ -70,6 +70,8 @@ export default class IBMi {
     currentConnectionName: string;
     private tempRemoteFiles;
     defaultUserLibraries: string[];
+    private sqlJob;
+    splfUserData: string | undefined;
     /**
      * Used to store ASP numbers and their names
      * Their names usually maps up to a directory in
@@ -78,6 +80,7 @@ export default class IBMi {
     private iAspInfo;
     private currentAsp;
     private libraryAsps;
+    connectionSuccessful: boolean;
     /**
      * @deprecated Will be replaced with {@link IBMi.getAllIAsps} in v3.0.0
      */
@@ -94,39 +97,38 @@ export default class IBMi {
     };
     shell?: string;
     maximumArgsLength: number;
+    ccsidCache: Map<string, CacheItem<number>>;
     appendOutput: (text: string) => void;
-    private disconnectedCallback;
     /**
-     * Will only be called once per connection.
+     * getConfigFile can return pre-defined configuration files,
+     * but can lazy load new configuration files as well.
+     *
+     * This does not load the configuration file from the server,
+     * it only returns a ConfigFile instance. You should check the
+     * state of the ConfigFile instance to see if it has been loaded,
+     * and if not, call `loadFromServer()` on it.
      */
-    setDisconnectedCallback(callback: DisconnectCallback): void;
     getConfigFile<T>(id: keyof ConnectionConfigFiles): ConfigFile<T>;
-    get canUseCqsh(): boolean;
+    loadRemoteConfigs(): Promise<void>;
     /**
      * Primarily used for running SQL statements.
      */
     get userCcsidInvalid(): boolean;
-    /**
-     * Determines if the client should do variant translation.
-     * False when cqsh should be used.
-     * True when cqsh is not available and the job CCSID is not the same as the SSHD CCSID.
-     */
-    get requiresTranslation(): boolean;
     get dangerousVariants(): boolean;
     get connected(): boolean;
     getContent(): IBMiContent;
     getConfig(): ConnectionConfig;
     setConfig(newConfig: ConnectionConfig): void;
+    getTempDirectory(): string;
     constructor();
     connect(connectionObject: ConnectionData, options: ConnectionOptions): Promise<ConnectionResult>;
-    private ensureTempLibraryExists;
-    private ensureTempDirectory;
+    private checkOrCreateTempLibrary;
+    private checkOrCreateTempDirectory;
     /**
      * Can return 0 if the OS version was not detected.
      */
     getSystemVersion(): number;
     usingBash(): boolean;
-    loadRemoteConfigs(): Promise<void>;
     /**
      * - Send PASE/QSH/ILE commands simply
      * - Commands sent here end in the 'IBM i Output' channel
@@ -143,18 +145,24 @@ export default class IBMi {
      * Commands sent here end up in the 'Code for IBM i' output channel.
      */
     sendCommand(options: CommandData): Promise<CommandResult>;
-    private disconnect;
-    dispose(): Promise<void>;
+    disconnect(): Promise<void>;
+    private dispose;
     /**
      * SQL only available when runner is installed and CCSID is valid.
      */
     get enableSQL(): boolean;
     sqlRunnerAvailable(): boolean;
+    getSqlJobId(): string;
     /**
      * Generates path to a temp file on the IBM i
      * @param {string} key Key to the temp file to be re-used
      */
     getTempRemote(key: string): string;
+    /**
+     * Cleans up a temp file and removes it from cache
+     * @param {string} key Key to the temp file to clean up
+     */
+    clearTempRemote(key: string): Promise<void>;
     parserMemberPath(string: string, checkExtension?: boolean): MemberParts;
     /**
      * @param {string} string
@@ -166,8 +174,6 @@ export default class IBMi {
      * @returns {string} result
      */
     sysNameInAmerican(string: string): string;
-    getLastDownloadLocation(): string;
-    setLastDownloadLocation(location: string): Promise<void>;
     /**
      * Creates a temporary directory and pass it on to a `process` function.
      * The directory is guaranteed to be empty when created and deleted after the `process` is done.
@@ -180,7 +186,7 @@ export default class IBMi {
      */
     upperCaseName(name: string): string;
     getComponentManager(): ComponentManager;
-    getComponent<T extends IBMiComponent>(name: string, options?: ComponentSearchProps): T;
+    getComponent<T extends IBMiComponent>(name: string, options?: ComponentSearchProps): Promise<T>;
     /**
      * Run SQL statements.
      * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).
@@ -189,17 +195,15 @@ export default class IBMi {
      * @param statements
      * @returns a Result set
      */
-    runSQL(statements: string, options?: {
-        fakeBindings?: (string | number)[];
-        forceSafe?: boolean;
+    runSQL(statements: string | string[], options?: {
+        bindings?: BindingValue[];
+        rows?: number;
     }): Promise<Tools.DB2Row[]>;
     validQsysName(name: string): boolean;
     getCcsid(): number;
     getCcsids(): {
         qccsid: number;
         runtimeCcsid: number;
-        userDefaultCCSID: number;
-        sshdCcsid: number;
     };
     debugPTFInstalled(): boolean;
     private getUserProfileAsp;
@@ -208,6 +212,7 @@ export default class IBMi {
     getIAspName(by: string | number): string | undefined;
     getCurrentIAspName(): string;
     lookupLibraryIAsp(library: string): Promise<string | undefined>;
+    getFileCcsid(path: string | QsysPath): Promise<number>;
     getLibraryIAsp(library: string): string;
     /**
      * @deprecated Use {@link IBMiContent.uploadFiles} instead.

package/api/IBMiContent.d.ts

@@ -1,13 +1,11 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import * as node_ssh from "node-ssh";
 import { FilterType } from './Filter';
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
 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 = {
+type Authority = "*ADD" | "*DLT" | "*EXECUTE" | "*READ" | "*UPD" | "*NONE" | "*ALL" | "*CHANGE" | "*USE" | "*EXCLUDE" | "*AUTLMGT";
+export type SortOrder = `name` | `type`;
+export type SortOptions = {
     order: "name" | "date";
     ascending?: boolean;
 };
@@ -23,7 +21,7 @@ export default class IBMiContent {
      * @param remotePath Remote IFS path
      * @param localPath Local path to download file to
      */
-    downloadStreamfileRaw(remotePath: string, localPath?: string): Promise<Buffer>;
+    downloadStreamfileRaw(remotePath: string, localPath?: string): Promise<NonSharedBuffer>;
     /**
      * @deprecated Use {@link IBMiContent.downloadStreamfileRaw()} instead
      */
@@ -48,16 +46,6 @@ export default class IBMiContent {
      * @param localPath
      */
     downloadMemberContent(library: string, sourceFile: string, member: string, localPath?: string): Promise<string>;
-    /**
-     * @deprecated Will be removed in `v3.0.0`; use {@link IBMiContent.downloadMemberContent()} without the `asp` parameter instead.
-     *
-     * @param asp
-     * @param library
-     * @param sourceFile
-     * @param member
-     * @param localPath
-     */
-    downloadMemberContent(asp: string | undefined, library: string, sourceFile: string, member: string, localPath?: string): Promise<string>;
     /**
      * Upload to a member
      *
@@ -67,15 +55,6 @@ export default class IBMiContent {
      * @param content
      */
     uploadMemberContent(library: string, sourceFile: string, member: string, content: string | Uint8Array): Promise<boolean>;
-    /**
-     * @deprecated Will be removed in `v3.0.0`; use {@link IBMiContent.uploadMemberContent()} without the `asp` parameter instead.
-     * @param asp
-     * @param library
-     * @param sourceFile
-     * @param member
-     * @param content
-     */
-    uploadMemberContent(asp: string | undefined, library: string, sourceFile: string, member: string, content: string | Uint8Array): Promise<boolean>;
     /**
      * @param statements Either an SQL statement or CL statement. CL statements start with @
      * @returns result set
@@ -151,17 +130,11 @@ export default class IBMiContent {
     getMemberList(filter: {
         library: string;
         sourceFile: string;
-        members?: string;
+        members?: string | string[];
         extensions?: string;
         sort?: SortOptions;
         filterType?: FilterType;
     }): Promise<IBMiMember[]>;
-    /**
-     *
-     * @param filter: the criterias used to list the members
-     * @returns
-     */
-    getMemberInfo(library: string, sourceFile: string, member: string): Promise<any>;
     /**
      * Get list of items in a path
      * @param remotePath
@@ -208,7 +181,6 @@ export default class IBMiContent {
         valid: boolean;
         missing: SpecialAuthorities[];
     }>;
-    getSshCcsid(): Promise<number>;
     getSysEnvVars(): Promise<{
         [name: string]: string;
     }>;
@@ -239,5 +211,18 @@ export default class IBMiContent {
      * @returns the {@link CommandResult} of the `mv` command execution
      */
     move(paths: string | string[], toDirectory: string): Promise<CommandResult>;
+    /**
+     * Returns the signature of an SQL component
+     * @param library
+     * @param name
+     * @param type
+     * @returns
+     */
+    getSQLRoutineSignature(library: string, name: string, type: "PROCEDURE" | "FUNCTION"): Promise<string>;
+    getSHA256FileHash(remoteFile: string): Promise<string>;
+    getLibraryListFromCommand(command: string): Promise<{
+        currentLibrary: string;
+        libraryList: string[];
+    }>;
 }
 export {};

package/api/{Search.d.ts → SearchTools.d.ts}

@@ -1,6 +1,6 @@
 import IBMi from './IBMi';
 import { IBMiMember, SearchResults } from './types';
-export declare namespace Search {
+export declare namespace SearchTools {
     function searchMembers(connection: IBMi, library: string, sourceFile: string, searchTerm: string, members: string | IBMiMember[], readOnly?: boolean): Promise<SearchResults>;
     function searchIFS(connection: IBMi, path: string, searchTerm: string): Promise<SearchResults | undefined>;
     function findIFS(connection: IBMi, path: string, findTerm: string): Promise<SearchResults | undefined>;

package/api/Tools.d.ts

@@ -4,20 +4,8 @@ export declare namespace Tools {
         sqlstate: string;
         constructor(message: string);
     }
-    interface DB2Headers {
-        name: string;
-        from: number;
-        length: number;
-    }
     interface DB2Row extends Record<string, string | number | null> {
     }
-    /**
-     * Parse standard out for `/usr/bin/db2`
-     * @param output /usr/bin/db2's output
-     * @returns rows
-     */
-    function db2Parse(output: string, input?: string): DB2Row[];
-    function bufferToUx(input: string): string;
     function makeid(length?: number): string;
     /**
      * Build the IFS path string to an object or member
@@ -41,17 +29,8 @@ export declare namespace Tools {
     function sanitizeObjNamesForPase(libraries: string[]): string[];
     function parseMessages(output: string): IBMiMessages;
     function parseQSysPath(path: string): QsysPath;
-    /**
-     * Fixes an SQL statement to make it compatible with db2 CLI program QZDFMDB2.
-     * - Changes `@clCommand` statements into Call `QSYS2.QCMDEX('clCommand')` procedure calls
-     * - Makes sure each comment (`--`) starts on a new line
-     * @param statement the statement to fix
-     * @returns statement compatible with QZDFMDB2
-     */
-    function fixSQL(statement: string, removeComments?: boolean): string;
     function fileToPath(file: EditorPath): string;
     function fixWindowsPath(path: string): string;
-    function assumeType(str: string, col?: string): string | number;
     /**
      * Converts a timestamp from the attr command (in the form `Thu Dec 21 21:47:02 2023`) into a Date object
      * @param timestamp an attr timestamp string
@@ -75,4 +54,19 @@ export declare namespace Tools {
      * @returns
      */
     function resolvePath(path: string): string;
+    /**
+     * Determines if CCSID conversion should be applied based on configuration and source file CCSID.
+     * @param sourceCcsid The CCSID of the source file
+     * @param config Connection configuration containing conversion settings
+     * @returns {requiresConversion, targetCcsid} - whether conversion is required and the target CCSID to use
+     */
+    function determineCcsidConversion(sourceCcsid: number, config: {
+        ccsidConversionEnabled?: boolean;
+        ccsidConvertFrom?: string;
+        ccsidConvertTo?: string;
+    }): {
+        requiresConversion: boolean;
+        targetCcsid: number;
+    };
+    function ensureFullPath(inputPath: string, remoteHomeDirectory: string | undefined): string;
 }

package/api/actions.d.ts

@@ -0,0 +1,12 @@
+import vscode from "vscode";
+import { Action } from "./types";
+export declare namespace ActionTools {
+    function getActions(workspace?: vscode.WorkspaceFolder): Promise<Action[]>;
+    function getConnectionActions(): Action[];
+    function getLocalActionsFiles(workspace: vscode.WorkspaceFolder): Promise<vscode.Uri[]>;
+    function updateAction(action: Action, workspace?: vscode.WorkspaceFolder, options?: {
+        newName?: string;
+        oldType?: string;
+        delete?: boolean;
+    }): Promise<void>;
+}

package/api/components/component.d.ts

@@ -1,13 +1,20 @@
 import IBMi from "../IBMi";
-export declare type ComponentState = `NotChecked` | `NotInstalled` | `Installed` | `NeedsUpdate` | `Error`;
-export declare type ComponentIdentification = {
+type ComponentStatus = `NotChecked` | `NotInstalled` | `NeedsUpdate` | `Installed` | `Error`;
+/** @deprecated use {@link SecureComponentState} instead */
+export type ComponentState = ComponentStatus;
+export type SecureComponentState = {
+    status: ComponentStatus;
+    remoteSignature?: string;
+};
+export type ComponentIdentification = {
     name: string;
     version: number | string;
+    signature: string;
     userManaged?: boolean;
 };
-export declare type ComponentInstallState = {
+export type ComponentInstallState = {
     id: ComponentIdentification;
-    state: ComponentState;
+    state: SecureComponentState;
 };
 /**
  * Defines a component that is managed per IBM i.
@@ -17,7 +24,7 @@ export declare type ComponentInstallState = {
  * For example, this class:
  * ```
  * class MyIBMIComponent implements IBMiComponent {
- *  //implements getName, getRemoteState and update
+ *  //implements getIdentification, getRemoteState and update
  * }
  * ```
  * Must be registered like this, when the extension providing the component gets activated:
@@ -32,26 +39,33 @@ export declare type ComponentInstallState = {
  * ```
  *
  */
-export declare type IBMiComponent = {
+export type IBMiComponent = {
     /**
-     * The identification of this component; name must be unique
+     * The identification of this component: a unique name and a signature
      *
-     * @returns a human-readable name
+     * @returns a {@link ComponentIdentification}
      */
     getIdentification(): ComponentIdentification;
     setInstallDirectory?(installDirectory: string): Promise<void>;
     /**
-     * @returns the component's {@link ComponentState state} on the IBM i
+     * Check and retrieve the Component's state from the remote system.
+     *
+     * @param connection
+     * @param installDirectory
+     * @param signature a unique identifier (i.e. a hash), part of the component's identification. It should be compared against a hash retrieved from the remote system.
+     * @returns the component's {@link SecureComponentState state} on the IBM i
      */
-    getRemoteState(connection: IBMi, installDirectory: string): ComponentState | Promise<ComponentState>;
+    getRemoteState(connection: IBMi, installDirectory: string): ComponentState | SecureComponentState | Promise<ComponentState | SecureComponentState>;
     /**
-     * Called whenever the components needs to be installed or updated, depending on its {@link ComponentState state}.
-     *
-     * The Component Manager is responsible for calling this, so the {@link ComponentState state} doesn't need to be checked here.
+     * Called whenever the components needs to be installed or updated, depending on its {@link SecureComponentState state}.
      *
-     * @returns the component's {@link ComponentState state} after the update is done
+     * The Component Manager is responsible for calling this, so the {@link SecureComponentState state} doesn't need to be checked here.
+     * @param connection
+     * @param installDirectory
+     * @param signature a unique identifier (i.e. a hash), part of the component's identification. It should be compared against a hash retrieved from the remote system.
+     * @returns the component's {@link SecureComponentState state} after the update is done
      */
-    update(connection: IBMi, installDirectory: string): ComponentState | Promise<ComponentState>;
+    update(connection: IBMi, installDirectory: string): ComponentState | SecureComponentState | Promise<ComponentState | SecureComponentState>;
     /**
      * Called when connecting to clear every persitent information related to the previous connection
      */
@@ -62,3 +76,4 @@ export declare type IBMiComponent = {
      */
     uninstall?(connection: IBMi): Promise<void>;
 };
+export {};

package/api/components/manager.d.ts

@@ -1,5 +1,5 @@
 import IBMi from "../IBMi";
-import { ComponentIdentification, ComponentInstallState, ComponentState, IBMiComponent } from "./component";
+import { ComponentIdentification, ComponentInstallState, IBMiComponent, SecureComponentState } from "./component";
 import { IBMiComponentRuntime } from "./runtime";
 interface ExtensionContextI {
     extension: {
@@ -11,8 +11,10 @@ export interface ComponentSearchProps {
 }
 export declare class ComponentRegistry {
     private readonly components;
+    private readonly disabled;
     registerComponent(context: ExtensionContextI | string, component: IBMiComponent): void;
     getComponents(): Map<string, IBMiComponent[]>;
+    disableComponent(key: string, id: string): void;
 }
 export declare const extensionComponentRegistry: ComponentRegistry;
 export declare class ComponentManager {
@@ -27,11 +29,12 @@ export declare class ComponentManager {
     getAllAvailableComponents(): IBMiComponent[];
     installComponent(key: string): Promise<ComponentInstallState>;
     uninstallComponent(key: string): Promise<ComponentInstallState>;
-    getRemoteState(key: string): Promise<ComponentState | undefined>;
+    getRemoteState(key: string): Promise<SecureComponentState | undefined>;
     startup(lastInstalled?: ComponentInstallState[]): Promise<void>;
+    startupComponent(key: string | IBMiComponent, lastInstalled?: ComponentInstallState[]): Promise<SecureComponentState>;
     /**
      * Returns the latest version of an installed component, or fetch a specific version
      */
-    get<T extends IBMiComponent>(id: string, options?: ComponentSearchProps): T | undefined;
+    get<T extends IBMiComponent>(id: string, options?: ComponentSearchProps): Promise<T | undefined>;
 }
 export { IBMiComponentRuntime };

package/api/components/mapepire/index.d.ts

@@ -0,0 +1,25 @@
+import { SQLJob } from "@ibm/mapepire-js";
+import IBMi from "../../IBMi";
+import { IBMiComponent, SecureComponentState } from "../component";
+import { sshSqlJob } from "./sqlJob";
+export declare class Mapepire implements IBMiComponent {
+    static readonly ID = "mapepire";
+    private readonly localAssetPath;
+    private installPath;
+    private readonly version;
+    readonly jobs: Map<string, SQLJob>;
+    constructor(localAssetRoot: string);
+    getIdentification(): {
+        name: string;
+        version: string;
+        signature: string;
+    };
+    setInstallDirectory(installDirectory: string): Promise<void>;
+    getRemoteState(connection: IBMi, installDirectory: string): Promise<SecureComponentState>;
+    update(connection: IBMi): Promise<SecureComponentState>;
+    getInitCommand(javaHome: string): string | undefined;
+    static useExec(connection: IBMi): Promise<boolean>;
+    newJob(connection: IBMi, javaPath?: string): Promise<sshSqlJob>;
+    endJobs(): Promise<void>;
+    reset(): void;
+}

package/api/components/mapepire/sqlJob.d.ts

@@ -0,0 +1,20 @@
+import type { ConnectionResult, ServerRequest } from "@ibm/mapepire-js";
+import { SQLJob } from "@ibm/mapepire-js";
+import { ClientChannel } from "ssh2";
+import { Mapepire } from ".";
+import IBMi from "../../IBMi";
+import { JobStatus } from "./types";
+export declare class sshSqlJob extends SQLJob {
+    static application: string;
+    private channel;
+    private onClose?;
+    getSshChannel(mapepire: Mapepire, connection: IBMi, javaPath: string): Promise<ClientChannel>;
+    send<T>(content: ServerRequest): Promise<T>;
+    getStatus(): JobStatus;
+    /**
+     * The same as mapepire-js#connect, but with SSH
+     */
+    connectSsh(channel: ClientChannel): Promise<ConnectionResult>;
+    close(): Promise<void>;
+    private end;
+}

package/api/components/mapepire/types.d.ts

@@ -0,0 +1,7 @@
+export declare enum JobStatus {
+    NOT_STARTED = "notStarted",
+    CONNECTING = "connecting",
+    READY = "ready",
+    BUSY = "busy",
+    ENDED = "ended"
+}

package/api/components/mapepire/version.d.ts

@@ -0,0 +1,4 @@
+export declare const VERSION = "2.3.5";
+export declare const SERVER_VERSION_TAG = "v2.3.5";
+export declare const SERVER_FILE_PREFIX = "mapepire-server-";
+export declare const SERVER_VERSION_FILE = "mapepire-server-2.3.5.jar";

package/api/components/runtime.d.ts

@@ -1,5 +1,5 @@
 import IBMi from "../IBMi";
-import { ComponentState, IBMiComponent } from "./component";
+import { ComponentState, IBMiComponent, SecureComponentState } from "./component";
 export declare class IBMiComponentRuntime {
     protected readonly connection: IBMi;
     readonly component: IBMiComponent;
@@ -8,10 +8,20 @@ export declare class IBMiComponentRuntime {
     private cachedInstallDirectory;
     constructor(connection: IBMi, component: IBMiComponent);
     getInstallDirectory(): Promise<string>;
-    getState(): ComponentState;
-    setState(newState: ComponentState): Promise<void>;
-    overrideState(newState: ComponentState): Promise<void>;
-    update(installDirectory: string): Promise<void>;
+    getState(): SecureComponentState;
+    setState(newState: SecureComponentState): Promise<void>;
+    overrideState(newState: SecureComponentState): Promise<void>;
+    update(): Promise<void>;
     startupCheck(): Promise<this>;
+    getCurrentState(): Promise<SecureComponentState>;
+    /**
+     * Ensure smooth transition for Components not returning a {@link SecureComponentState} yet.
+     * Remove once {@link ComponentState} is removed.
+     *
+     * @param state a deprecated {@link ComponentState} or a {@link SecureComponentState}
+     * @returns a {@link SecureComponentState} with a blank signature if `state` is a {@link ComponentState}
+     */
+    handleState(state: ComponentState | SecureComponentState): SecureComponentState;
+    deprecationWarning(local?: boolean): void;
     toString(): string;
 }