@halcyontech/vscode-ibmi-types 1.7.6 → 1.8.0

package/api/CompileTools.d.ts

@@ -1,6 +1,10 @@
 import vscode from 'vscode';
 import Instance from './Instance';
 import { CommandResult, RemoteCommand } from '../typings';
+export interface ILELibrarySettings {
+    currentLibrary: string;
+    libraryList: string[];
+}
 export declare namespace CompileTools {
     interface EvfEventInfo {
         asp?: string;
@@ -19,6 +23,6 @@ export declare namespace CompileTools {
     /**
      * Execute a command
      */
-    export function runCommand(instance: Instance, options: RemoteCommand): Promise<CommandResult | null>;
+    export function runCommand(instance: Instance, options: RemoteCommand, title?: string): Promise<CommandResult | null>;
     export {};
 }

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

@@ -23,12 +23,13 @@ export interface ComplexTab {
 }
 export declare class Section {
     readonly fields: Field[];
+    addHeading(label: string, level?: 1 | 2 | 3 | 4 | 5 | 6): this;
     addHorizontalRule(): this;
     addCheckbox(id: string, label: string, description?: string, checked?: boolean): this;
     addInput(id: string, label: string, description?: string, options?: {
         default?: string;
         readonly?: boolean;
-        multiline?: boolean;
+        rows?: number;
     }): this;
     addParagraph(label: string): this;
     addFile(id: string, label: string, description?: string): this;
@@ -42,15 +43,18 @@ 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";
+export declare type FieldType = "input" | "password" | "submit" | "buttons" | "checkbox" | "file" | "complexTabs" | "tabs" | "tree" | "select" | "paragraph" | "hr" | "heading";
 export interface TreeListItemIcon {
     branch?: string;
     open?: string;
@@ -84,7 +88,7 @@ export declare class Field {
     complexTabItems?: ComplexTab[];
     default?: string;
     readonly?: boolean;
-    multiline?: boolean;
+    rows?: number;
     constructor(type: FieldType, id: string, label: string, description?: string);
     getHTML(): string;
     private renderLabel;

package/api/IBMi.d.ts

@@ -1,13 +1,8 @@
 import * as vscode from "vscode";
 import * as node_ssh from "node-ssh";
 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 { ConnectionData, CommandData, StandardIO, CommandResult, IBMiMember, RemoteCommand } 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 { 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,13 +71,20 @@ 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[]>;
+    /**
+     * 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

package/api/Search.d.ts

@@ -3,7 +3,7 @@ export declare namespace Search {
     interface Result {
         path: string;
         lines: Line[];
-        filter?: string;
+        readonly?: boolean;
         label?: string;
     }
     interface Line {

package/api/Storage.d.ts

@@ -13,6 +13,20 @@ export declare type LastConnection = {
     name: string;
     timestamp: number;
 };
+export declare type CachedServerSettings = {
+    aspInfo: {
+        [id: number]: string;
+    };
+    qccsid: number | null;
+    remoteFeatures: {
+        [name: string]: string | undefined;
+    };
+    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 +36,22 @@ 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;
+        };
+        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;
@@ -39,5 +69,6 @@ export declare class ConnectionStorage extends Storage {
     setDeployment(existingPaths: DeploymentPath): Promise<void>;
     getDebugCommands(): DebugCommands;
     setDebugCommands(existingCommands: DebugCommands): Promise<void>;
+    getWorkspaceDeployPath(workspaceFolder: vscode.WorkspaceFolder): string;
 }
 export {};

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;

package/package.json

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

package/testing/connection.d.ts

@@ -0,0 +1,2 @@
+import { TestSuite } from ".";
+export declare const ConnectionSuite: TestSuite;

package/testing/content.d.ts

@@ -0,0 +1,2 @@
+import { TestSuite } from ".";
+export declare const ContentSuite: TestSuite;

package/testing/index.d.ts

@@ -0,0 +1,12 @@
+import vscode from "vscode";
+export declare type TestSuite = {
+    name: string;
+    tests: TestCase[];
+};
+export interface TestCase {
+    name: string;
+    status?: "running" | "failed" | "pass";
+    failure?: string;
+    test: () => Promise<void>;
+}
+export declare function initialise(context: vscode.ExtensionContext): void;

package/testing/testCasesTree.d.ts

@@ -0,0 +1,21 @@
+import vscode from "vscode";
+import { TestCase, TestSuite } from ".";
+export declare class TestSuitesTreeProvider implements vscode.TreeDataProvider<vscode.TreeItem> {
+    readonly testSuites: TestSuite[];
+    private readonly emitter;
+    readonly onDidChangeTreeData: vscode.Event<void | vscode.TreeItem | vscode.TreeItem[] | null | undefined>;
+    constructor(testSuites: TestSuite[]);
+    refresh(element?: TestSuiteItem): void;
+    getTreeItem(element: vscode.TreeItem): vscode.TreeItem | Thenable<vscode.TreeItem>;
+    getChildren(element?: TestSuiteItem): vscode.ProviderResult<vscode.TreeItem[]>;
+}
+declare class TestSuiteItem extends vscode.TreeItem {
+    readonly testSuite: TestSuite;
+    constructor(testSuite: TestSuite);
+    getChilren(): TestCaseItem[];
+}
+declare class TestCaseItem extends vscode.TreeItem {
+    readonly testCase: TestCase;
+    constructor(suiteName: string, testCase: TestCase);
+}
+export {};

package/typings.d.ts

@@ -1,12 +1,11 @@
 /// <reference types="node" />
-import { ExtensionContext, Uri } from "vscode";
+import { Uri } 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[]>;
 }
@@ -81,8 +80,9 @@ export interface IBMiMember {
     file: string;
     name: string;
     extension: string;
-    recordLength: number;
-    text: string;
+    changed: string;
+    recordLength?: number;
+    text?: string;
     asp?: string;
 }
 export interface IFSFile {
@@ -107,7 +107,6 @@ export interface FileError {
     code: string;
 }
 export interface QsysFsOptions {
-    filter?: string;
     readonly?: boolean;
 }
 export declare type IBMiEvent = "connected" | "disconnected" | "deployLocation";