@halcyontech/vscode-ibmi-types 2.16.2 → 2.17.0

package/api/IBMi.d.ts

@@ -1,15 +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 } from './configuration/config/types';
+import { ConnectionConfig, RemoteConfigFile } from './configuration/config/types';
+import { ConfigFile } from './configuration/serverFile';
 import { CodeForIStorage } from './configuration/storage/CodeForIStorage';
-import { AspInfo, CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand } from './types';
+import { AspInfo, CommandData, CommandResult, ConnectionData, EditorPath, IBMiMember, RemoteCommand } from './types';
 export interface MemberParts extends IBMiMember {
     basename: string;
 }
@@ -17,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>;
@@ -30,6 +31,15 @@ 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>;
+}
 export default class IBMi {
     static GlobalStorage: CodeForIStorage;
     static connectionManager: ConnectionManager;
@@ -44,6 +54,7 @@ export default class IBMi {
     private userDefaultCCSID;
     private sshdCcsid;
     private componentManager;
+    private configFiles;
     /**
      * @deprecated Will become private in v3.0.0 - use {@link IBMi.getConfig} instead.
      */
@@ -89,6 +100,7 @@ export default class IBMi {
      * Will only be called once per connection.
      */
     setDisconnectedCallback(callback: DisconnectCallback): void;
+    getConfigFile<T>(id: keyof ConnectionConfigFiles): ConfigFile<T>;
     get canUseCqsh(): boolean;
     /**
      * Primarily used for running SQL statements.
@@ -106,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;
     /**
@@ -117,6 +126,7 @@ export default class IBMi {
      */
     getSystemVersion(): number;
     usingBash(): boolean;
+    loadRemoteConfigs(): Promise<void>;
     /**
      * - Send PASE/QSH/ILE commands simply
      * - Commands sent here end in the 'IBM i Output' channel

package/api/IBMiContent.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import * as node_ssh from "node-ssh";
-import { EditorPath } from '../typings';
+import { EditorPath } from './types';
 import { FilterType } from './Filter';
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
@@ -227,12 +227,12 @@ export default class IBMiContent {
     uploadDirectory(localDirectory: EditorPath, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<boolean>;
     downloadDirectory(localDirectory: EditorPath, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<boolean>;
     /**
-     * Copy one or more folders or files into a directory. Uses QSH's `cp` to keep all the attributes of the original file into its copy.
+     * Copy one or more folders or files into a directory or file. Uses ILE `CPY` to keep all the attributes of the original file into its copy.
      * @param paths one or more files/folders to copy
-     * @param toDirectory the directory where the files/folders will be copied into
-     * @returns the {@link CommandResult} of the `cp` command execution
+     * @param toPath the directory or file where the files/folders will be copied into
+     * @returns the {@link CommandResult} of the `CPY` command execution
      */
-    copy(paths: string | string[], toDirectory: string): Promise<CommandResult>;
+    copy(paths: string | string[], toPath: string): Promise<CommandResult>;
     /**
      * Move one or more folders or files into a directory. Uses QSH's `mv` to ensures attributes are not altered during the opration.
      * @param paths one or more files/folders to copy

package/api/Tools.d.ts

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

package/api/configuration/config/types.d.ts

@@ -33,6 +33,9 @@ export interface ConnectionConfig extends ConnectionProfile {
     lastDownloadLocation: string;
     [name: string]: any;
 }
+export interface RemoteConfigFile {
+    codefori?: Partial<ConnectionConfig>;
+}
 export interface ObjectFilters {
     name: string;
     filterType: FilterType;

package/api/configuration/serverFile.d.ts

@@ -0,0 +1,23 @@
+import IBMi from "../IBMi";
+declare type ConfigResult = `not_loaded` | `no_exist` | `failed_to_parse` | `invalid` | `ok`;
+interface LoadResult {
+    server: ConfigResult;
+}
+export declare class ConfigFile<T> {
+    private connection;
+    readonly fallback: T;
+    private state;
+    private basename;
+    private serverFile;
+    private serverData;
+    validateData: ((loadedConfig: any) => T) | undefined;
+    constructor(connection: IBMi, configId: string, fallback: T);
+    getPaths(): {
+        server: string;
+    };
+    loadFromServer(): Promise<void>;
+    get(): Promise<T>;
+    reset(): void;
+    getState(): LoadResult;
+}
+export {};

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;

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/filesystems/qsys/sourceDateHandler.d.ts

@@ -3,12 +3,14 @@ export declare class SourceDateHandler {
     readonly baseDates: Map<string, string[]>;
     readonly baseSource: Map<string, string>;
     readonly recordLengths: Map<string, number>;
+    readonly baseSequences: Map<string, number[]>;
     private enabled;
     private timeout?;
     private readonly timeoutDelay;
     private highlightSince?;
     private highlightBefore?;
     private lineEditedBefore?;
+    private sequenceNumbersShowing;
     private readonly sourceDateSearchBarItem;
     constructor(context: vscode.ExtensionContext);
     setEnabled(enabled: boolean): void;
@@ -20,6 +22,7 @@ export declare class SourceDateHandler {
     private _diffRefreshGutter;
     calcNewSourceDates(alias: string, body: string): string[];
     private toggleSourceDateGutter;
+    private toggleSequenceNumbers;
     private clearDateSearch;
     private newDateSearch;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@halcyontech/vscode-ibmi-types",
-  "version": "2.16.2",
+  "version": "2.17.0",
   "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[]>;