@halcyontech/vscode-ibmi-types 1.7.10 → 1.9.0

package/api/CompileTools.d.ts

@@ -1,6 +1,6 @@
 import vscode from 'vscode';
-import Instance from './Instance';
 import { CommandResult, RemoteCommand } from '../typings';
+import Instance from './Instance';
 export interface ILELibrarySettings {
     currentLibrary: string;
     libraryList: string[];

package/api/Configuration.d.ts

@@ -9,6 +9,7 @@ export declare namespace ConnectionConfiguration {
         host: string;
         autoClearTempData: boolean;
         connectionProfiles: ConnectionProfile[];
+        commandProfiles: CommandProfile[];
         autoSortIFSShortcuts: boolean;
         enableSQL: boolean;
         tempLibrary: string;
@@ -31,6 +32,7 @@ export declare namespace ConnectionConfiguration {
         debugUpdateProductionFiles: boolean;
         debugEnableDebugTracing: boolean;
         readOnlyMode: boolean;
+        quickConnect: boolean;
         [name: string]: any;
     }
     interface ObjectFilters {
@@ -55,6 +57,10 @@ export declare namespace ConnectionConfiguration {
         ifsShortcuts: string[];
         customVariables: CustomVariable[];
     }
+    interface CommandProfile {
+        name: string;
+        command: string;
+    }
     function update(parameters: Parameters): Promise<void>;
     /**
      * Will load an existing config if it exists, otherwise will create it with default values.

package/api/CustomUI.d.ts

@@ -43,12 +43,15 @@ export declare class Section {
 }
 export declare class CustomUI extends Section {
     /**
-     * If no callback is provided, a Promise will be returned
+     * If no callback is provided, a Promise will be returned.
+     * If the page is already opened, it grabs the focus and return no Promise (as it's alreay handled by the first call).
+     *
      * @param title
      * @param callback
      * @returns a Promise<Page<T>> if no callback is provided
      */
     loadPage<T>(title: string, callback?: (page: Page<T>) => void): Promise<Page<T>> | undefined;
+    private createPage;
     private getHTML;
 }
 export declare type FieldType = "input" | "password" | "submit" | "buttons" | "checkbox" | "file" | "complexTabs" | "tabs" | "tree" | "select" | "paragraph" | "hr" | "heading";

package/api/IBMi.d.ts

@@ -1,13 +1,8 @@
-import * as vscode from "vscode";
 import * as node_ssh from "node-ssh";
+import * as vscode from "vscode";
 import { ConnectionConfiguration } from "./Configuration";
-import { ConnectionData, CommandData, StandardIO, CommandResult } from "../typings";
-export interface MemberParts {
-    asp?: string;
-    library: string;
-    file: string;
-    member: string;
-    extension: string;
+import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, StandardIO } from "../typings";
+export interface MemberParts extends IBMiMember {
     basename: string;
 }
 export default class IBMi {
@@ -39,20 +34,34 @@ export default class IBMi {
     /**
      * @returns {Promise<{success: boolean, error?: any}>} Was succesful at connecting or not.
      */
-    connect(connectionObject: ConnectionData): Promise<{
+    connect(connectionObject: ConnectionData, reconnecting?: boolean, reloadServerSettings?: boolean): Promise<{
         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
+     * - When sending `ile` commands:
+     *   By default, it will use the library list of the connection,
+     *   but `&LIBL` and `&CURLIB` can be passed in the property
+     *   `env` to customise them.
+     */
+    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.
+     */
     sendCommand(options: CommandData): Promise<CommandResult>;
     private appendOutput;
     private determineClear;

package/api/IBMiContent.d.ts

@@ -1,6 +1,10 @@
+import { IBMiError, IBMiFile, IBMiMember, IBMiObject, IFSFile, QsysPath } from '../typings';
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
-import { IBMiError, IBMiFile, IBMiMember, IBMiObject, IFSFile } from '../typings';
+export declare type SortOptions = {
+    order: "name" | "date" | "?";
+    ascending?: boolean;
+};
 export default class IBMiContent {
     readonly ibmi: IBMi;
     constructor(ibmi: IBMi);
@@ -24,6 +28,13 @@ export default class IBMiContent {
      * @returns a Result set
      */
     runSQL(statement: string): Promise<Tools.DB2Row[]>;
+    /**
+     * @param ileCommand Command that would change the library list, like CHGLIBL
+     */
+    getLibraryListFromCommand(ileCommand: string): Promise<{
+        currentLibrary: string;
+        libraryList: string[];
+    } | undefined>;
     /**
      * Download the contents of a table.
      * @param library
@@ -38,6 +49,12 @@ export default class IBMiContent {
      * @returns an array of libraries as IBMiObject
      */
     getLibraryList(libraries: string[]): Promise<IBMiObject[]>;
+    /**
+     * Validates a list of libraries
+     * @param newLibl Array of libraries to validate
+     * @returns Bad libraries
+     */
+    validateLibraryList(newLibl: string[]): Promise<string[]>;
     /**
      * @param filters
      * @param sortOrder
@@ -54,16 +71,39 @@ export default class IBMiContent {
      * @param mbr
      * @returns an array of IBMiMember
      */
-    getMemberList(lib: string, spf: string, mbr?: string, ext?: string): Promise<IBMiMember[]>;
+    getMemberList(lib: string, spf: string, mbr?: string, ext?: string, sort?: SortOptions): Promise<IBMiMember[]>;
     /**
      * Get list of items in a path
      * @param remotePath
      * @return an array of IFSFile
      */
-    getFileList(remotePath: string): Promise<IFSFile[]>;
+    getFileList(remotePath: string, sort?: SortOptions): Promise<IFSFile[]>;
+    memberResolve(member: string, files: QsysPath[]): Promise<IBMiMember | undefined>;
+    objectResolve(object: string, libraries: string[]): Promise<string | undefined>;
+    streamfileResolve(name: string, directories: string[]): Promise<string | undefined>;
+    /**
+     * Fix Comments in an SQL string so that the comments always start at position 0 of the line.
+     * Required to work with QZDFMDB2.
+     * @param inSql; sql statement
+     * @returns correctly formattted sql string containing comments
+     */
+    private fixCommentsInSQLString;
     /**
      * @param errorsString; several lines of `code:text`...
      * @returns errors
      */
     parseIBMiErrors(errorsString: string): IBMiError[];
+    /**
+     * @param century; century code (1=20xx, 0=19xx)
+     * @param dateString: string in YYMMDD
+     * @param timeString: string in HHMMSS
+     * @returns date
+     */
+    getDspfdDate(century?: string, YYMMDD?: string, HHMMSS?: string): Date;
+    /**
+     * Return `true` if `remotePath` denotes a directory
+     *
+     * @param remotePath: a remote IFS path
+     */
+    isDirectory(remotePath: string): Promise<boolean>;
 }

package/api/Storage.d.ts

@@ -13,6 +13,21 @@ export declare type LastConnection = {
     name: string;
     timestamp: number;
 };
+export declare type CachedServerSettings = {
+    aspInfo: {
+        [id: number]: string;
+    };
+    qccsid: number | null;
+    remoteFeatures: {
+        [name: string]: string | undefined;
+    };
+    remoteFeaturesKeys: string | null;
+    variantChars: {
+        american: string;
+        local: string;
+    };
+    badDataAreasChecked: boolean | null;
+} | undefined;
 export declare class GlobalStorage extends Storage {
     private static instance;
     static initialize(context: vscode.ExtensionContext): void;
@@ -22,6 +37,23 @@ export declare class GlobalStorage extends Storage {
     getLastConnections(): LastConnection[];
     setLastConnection(name: string): Promise<void>;
     setLastConnections(lastConnections: LastConnection[]): Promise<void>;
+    getServerSettingsCache(name: string): {
+        aspInfo: {
+            [id: number]: string;
+        };
+        qccsid: number;
+        remoteFeatures: {
+            [name: string]: string;
+        };
+        remoteFeaturesKeys: string;
+        variantChars: {
+            american: string;
+            local: string;
+        };
+        badDataAreasChecked: boolean;
+    };
+    setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
+    deleteServerSettingsCache(name: string): Promise<void>;
 }
 export declare class ConnectionStorage extends Storage {
     private connectionName;

package/api/Terminal.d.ts

@@ -1,4 +1,9 @@
+import vscode from 'vscode';
 import Instance from './Instance';
 export declare namespace Terminal {
-    function selectAndOpen(instance: Instance): void;
+    enum TerminalType {
+        PASE = "PASE",
+        _5250 = "5250"
+    }
+    function selectAndOpen(instance: Instance, openType?: TerminalType): Promise<vscode.Terminal>;
 }

package/api/Tools.d.ts

@@ -1,5 +1,9 @@
 import { API } from "./import/git";
 export declare namespace Tools {
+    class SqlError extends Error {
+        sqlstate: string;
+        constructor(message: string);
+    }
     interface DB2Headers {
         name: string;
         from: number;
@@ -22,10 +26,15 @@ export declare namespace Tools {
      * @param iasp Optional: an iASP name
      */
     function qualifyPath(library: string, object: string, member: string, iasp?: string): string;
+    /**
+     * Unqualify member path from root
+     */
+    function unqualifyPath(memberPath: string): string;
     /**
      * @param Path
      * @returns the escaped path
      */
     function escapePath(Path: string): string;
     function getGitAPI(): API | undefined;
+    function distinct(value: any, index: number, array: any[]): boolean;
 }

package/api/debug/server.d.ts

@@ -1,6 +1,7 @@
 import IBMi from "../IBMi";
 import IBMiContent from "../IBMiContent";
 export declare function startup(connection: IBMi): Promise<void>;
+export declare function stop(connection: IBMi): Promise<void>;
 export declare function getRunningJob(localPort: string, content: IBMiContent): Promise<string | undefined>;
 export declare function end(connection: IBMi): Promise<void>;
 /**

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@halcyontech/vscode-ibmi-types",
-  "version": "1.7.10",
+  "version": "1.9.0",
   "description": "Types for vscode-ibmi",
   "typings": "./typings.d.ts",
   "scripts": {
-    "prepublish": "rm -rf filesystems schemas views webviews languages",
+    "prepublish": "rm -rf filesystems schemas views webviews languages testing",
     "deploy": "npm publish --access public"
   },
   "repository": {

package/typings.d.ts

@@ -1,19 +1,18 @@
 /// <reference types="node" />
-import { ExtensionContext, Uri } from "vscode";
+import { WorkspaceFolder } from "vscode";
 import Instance from "./api/Instance";
 import { Ignore } from 'ignore';
+import { CustomUI } from "./api/CustomUI";
 export interface CodeForIBMi {
     instance: Instance;
-    baseContext: ExtensionContext;
-    CustomUI: object;
-    Field: object;
+    customUI: () => CustomUI;
     deploy: (parameters: DeploymentParameters) => Promise<boolean>;
     evfeventParser: (lines: string[]) => Map<string, FileError[]>;
 }
 export declare type DeploymentMethod = "all" | "staged" | "unstaged" | "changed" | "compare";
 export interface DeploymentParameters {
     method: DeploymentMethod;
-    localFolder: Uri;
+    workspaceFolder: WorkspaceFolder;
     remotePath: string;
     ignoreRules?: Ignore;
 }
@@ -66,9 +65,11 @@ export interface Server {
 export interface Profile {
     profile: string;
 }
-export interface IBMiObject {
+export interface QsysPath {
     library: string;
     name: string;
+}
+export interface IBMiObject extends QsysPath {
     type: string;
     text: string;
     attribute?: string;
@@ -81,14 +82,20 @@ export interface IBMiMember {
     file: string;
     name: string;
     extension: string;
-    recordLength: number;
-    text: string;
+    recordLength?: number;
+    text?: string;
     asp?: string;
+    lines?: number;
+    created?: Date;
+    changed?: Date;
 }
 export interface IFSFile {
     type: "directory" | "streamfile";
     name: string;
     path: string;
+    size?: number;
+    modified?: Date | string;
+    owner?: string;
 }
 export interface IBMiError {
     code: string;
@@ -109,4 +116,7 @@ export interface FileError {
 export interface QsysFsOptions {
     readonly?: boolean;
 }
-export declare type IBMiEvent = "connected" | "disconnected" | "deployLocation";
+export declare type IBMiEvent = "connected" | "disconnected" | "deployLocation" | "deploy";
+export interface Library {
+    path: string;
+}