@halcyontech/vscode-ibmi-types 2.10.1 → 2.12.1

package/api/Configuration.d.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-import { DeploymentMethod } from '../typings';
+import { ConnectionData, DeploymentMethod } from '../typings';
 import { FilterType } from './Filter';
 export declare type SourceDateMode = "edit" | "diff";
 export declare type DefaultOpenMode = "browse" | "edit";
@@ -8,6 +8,21 @@ export declare namespace GlobalConfiguration {
     function get<T>(key: string): T | undefined;
     function set(key: string, value: any): Thenable<void>;
 }
+export interface StoredConnection {
+    index: number;
+    data: ConnectionData;
+}
+export declare namespace ConnectionManager {
+    function getByName(name: string): StoredConnection | undefined;
+    function sort(): Thenable<void>;
+    function getAll(): ConnectionData[];
+    function storeNew(data: ConnectionData): Promise<StoredConnection>;
+    function deleteByName(name: string): Thenable<void>;
+    function updateByIndex(index: number, data: ConnectionData): Thenable<void>;
+    function getStoredPassword(context: vscode.ExtensionContext, connectionName: string): Thenable<string>;
+    function setStoredPassword(context: vscode.ExtensionContext, connectionName: string, password: string): Thenable<void>;
+    function deleteStoredPassword(context: vscode.ExtensionContext, connectionName: string): Thenable<void>;
+}
 export declare namespace ConnectionConfiguration {
     interface Parameters extends ConnectionProfile {
         host: string;
@@ -32,7 +47,6 @@ export declare namespace ConnectionConfiguration {
         showDescInLibList: boolean;
         debugPort: string;
         debugSepPort: string;
-        debugIsSecure: boolean;
         debugUpdateProductionFiles: boolean;
         debugEnableDebugTracing: boolean;
         readOnlyMode: boolean;

package/api/IBMi.d.ts

@@ -1,17 +1,19 @@
 import * as node_ssh from "node-ssh";
 import * as vscode from "vscode";
 import { ConnectionConfiguration } from "./Configuration";
-import { CcsidOrigin, CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, SpecialAuthorities } from "../typings";
+import { ComponentId } from "../components/component";
+import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, SpecialAuthorities } from "../typings";
+import IBMiContent from "./IBMiContent";
 import { Tools } from './Tools';
 export interface MemberParts extends IBMiMember {
     basename: string;
 }
 export default class IBMi {
-    private runtimeCcsidOrigin;
-    /** Runtime CCSID is either job CCSID or QCCSID */
-    private runtimeCcsid;
+    private qccsid;
+    private jobCcsid;
     /** User default CCSID is job default CCSID */
     private userDefaultCCSID;
+    private components;
     client: node_ssh.NodeSSH;
     currentHost: string;
     currentPort: number;
@@ -22,6 +24,7 @@ export default class IBMi {
     };
     defaultUserLibraries: string[];
     outputChannel?: vscode.OutputChannel;
+    outputChannelContent?: string;
     /**
      * Used to store ASP numbers and their names
      * Their names usually maps up to a directory in
@@ -43,6 +46,7 @@ export default class IBMi {
      * */
     lastErrors: object[];
     config?: ConnectionConfiguration.Parameters;
+    content: IBMiContent;
     shell?: string;
     commandsExecuted: number;
     dangerousVariants: boolean;
@@ -50,7 +54,7 @@ export default class IBMi {
     /**
      * @returns {Promise<{success: boolean, error?: any}>} Was succesful at connecting or not.
      */
-    connect(connectionObject: ConnectionData, reconnecting?: boolean, reloadServerSettings?: boolean): Promise<{
+    connect(connectionObject: ConnectionData, reconnecting?: boolean, reloadServerSettings?: boolean, onConnectedOperations?: Function[]): Promise<{
         success: boolean;
         error?: any;
     }>;
@@ -115,12 +119,13 @@ export default class IBMi {
      * The directory is guaranteed to be empty when created and deleted after the `process` is done.
      * @param process the process that will run on the empty directory
      */
-    withTempDirectory(process: (directory: string) => Promise<void>): Promise<void>;
+    withTempDirectory<T>(process: (directory: string) => Promise<T>): Promise<T>;
     /**
      * Uppercases an object name, keeping the variant chars case intact
      * @param name
      */
     upperCaseName(name: string): string;
+    getComponent<T>(id: ComponentId): T;
     /**
      * Run SQL statements.
      * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).
@@ -129,16 +134,14 @@ export default class IBMi {
      * @param statements
      * @returns a Result set
      */
-    runSQL(statements: string, opts?: {
-        userCcsid?: number;
-    }): Promise<Tools.DB2Row[]>;
+    runSQL(statements: string): Promise<Tools.DB2Row[]>;
     getEncoding(): {
         fallback: boolean;
         ccsid: number;
         invalid: boolean;
     };
     getCcsids(): {
-        origin: CcsidOrigin;
+        qccsid: number;
         runtimeCcsid: number;
         userDefaultCCSID: number;
     };

package/api/IBMiContent.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { MarkdownString } from 'vscode';
 import { AttrOperands, IBMiError, IBMiMember, IBMiObject, IFSFile, QsysPath } from '../typings';
 import { FilterType } from './Filter';
 import { default as IBMi } from './IBMi';
@@ -62,14 +63,7 @@ export default class IBMiContent {
      */
     runSQL(statements: 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.
+     * Download the contents of a member from a table.
      * @param library
      * @param file
      * @param member Will default to file provided
@@ -171,5 +165,9 @@ export default class IBMiContent {
     }), ...operands: AttrOperands[]): Promise<Record<string, string>>;
     countMembers(path: QsysPath): Promise<number>;
     countFiles(directory: string): Promise<number>;
+    objectToToolTip(path: string, object: IBMiObject): MarkdownString;
+    sourcePhysicalFileToToolTip(path: string, object: IBMiObject): Promise<MarkdownString>;
+    memberToToolTip(path: string, member: IBMiMember): MarkdownString;
+    ifsFileToToolTip(path: string, ifsFile: IFSFile): MarkdownString;
 }
 export {};

package/api/Instance.d.ts

@@ -1,22 +1,37 @@
 import * as vscode from "vscode";
+import { IBMiEvent } from "../typings";
+import { ConnectionConfiguration } from "./Configuration";
 import IBMi from "./IBMi";
-import IBMiContent from "./IBMiContent";
 import { ConnectionStorage } from "./Storage";
-import { ConnectionConfiguration } from "./Configuration";
-import { IBMiEvent } from "../typings";
 export default class Instance {
     private connection;
-    private content;
     private storage;
     private emitter;
-    private events;
+    private subscribers;
+    private deprecationCount;
     constructor(context: vscode.ExtensionContext);
     setConnection(connection?: IBMi): Promise<void>;
     getConnection(): IBMi;
     setConfig(newConfig: ConnectionConfiguration.Parameters): Promise<void>;
     getConfig(): ConnectionConfiguration.Parameters;
-    getContent(): IBMiContent;
+    getContent(): import("./IBMiContent").default;
     getStorage(): ConnectionStorage;
+    /**
+     * Subscribe to an {@link IBMiEvent}. When the event is triggerred, the `func` function gets executed.
+     *
+     * Each `context`/`name` couple must be unique.
+     * @param context the extension subscribing to the event
+     * @param event the {@link IBMiEvent} to subscribe to
+     * @param name a human-readable name summarizing the function
+     * @param func the function to execute when the {@link IBMiEvent} is triggerred
+     * @param transient if `true`, the function will only be executed once during the lifetime of a connection
+     */
+    subscribe(context: vscode.ExtensionContext, event: IBMiEvent, name: string, func: Function, transient?: boolean): void;
+    private getSubscribers;
+    /**
+     * @deprecated Will be removed in `v3.0.0`; use {@link subscribe} instead
+     */
     onEvent(event: IBMiEvent, func: Function): void;
     fire(event: IBMiEvent): void;
+    processEvent(event: IBMiEvent): Promise<void>;
 }

package/api/Search.d.ts

@@ -1,15 +1,7 @@
+import { SearchResults } from '../typings';
 import Instance from './Instance';
 export declare namespace Search {
-    interface Result {
-        path: string;
-        lines: Line[];
-        readonly?: boolean;
-        label?: string;
-    }
-    interface Line {
-        number: number;
-        content: string;
-    }
-    function searchMembers(instance: Instance, library: string, sourceFile: string, memberFilter: string, searchTerm: string, readOnly?: boolean): Promise<Result[]>;
-    function searchIFS(instance: Instance, path: string, searchTerm: string): Promise<Result[]>;
+    function searchMembers(instance: Instance, library: string, sourceFile: string, memberFilter: string, searchTerm: string, readOnly?: boolean): Promise<SearchResults>;
+    function searchIFS(instance: Instance, path: string, searchTerm: string): Promise<SearchResults | undefined>;
+    function findIFS(instance: Instance, path: string, findTerm: string): Promise<SearchResults | undefined>;
 }

package/api/Storage.d.ts

@@ -1,4 +1,5 @@
 import vscode from 'vscode';
+import { ConnectionData } from '../typings';
 export declare type PathContent = Record<string, string[]>;
 export declare type DeploymentPath = Record<string, string>;
 export declare type DebugCommands = Record<string, string>;
@@ -11,6 +12,7 @@ declare type AuthorisedExtension = {
 declare abstract class Storage {
     protected readonly globalState: any;
     constructor(context: vscode.ExtensionContext);
+    protected keys(): readonly string[];
     protected get<T>(key: string): T | undefined;
     protected set(key: string, value: any): Promise<void>;
     protected abstract getStorageKey(key: string): string;
@@ -23,7 +25,8 @@ export declare type CachedServerSettings = {
     aspInfo: {
         [id: number]: string;
     };
-    runtimeCcsid: number | null;
+    qccsid: number | null;
+    jobCcsid: number | null;
     remoteFeatures: {
         [name: string]: string | undefined;
     };
@@ -51,7 +54,8 @@ export declare class GlobalStorage extends Storage {
         aspInfo: {
             [id: number]: string;
         };
-        runtimeCcsid: number;
+        qccsid: number;
+        jobCcsid: number;
         remoteFeatures: {
             [name: string]: string;
         };
@@ -69,8 +73,13 @@ export declare class GlobalStorage extends Storage {
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     setServerSettingsCacheSpecific(name: string, newSettings: Partial<CachedServerSettings>): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;
+    deleteStaleServerSettingsCache(connections: ConnectionData[]): Promise<void>;
     getPreviousSearchTerms(): string[];
-    setPreviousSearchTerms(previousSearchTerms: string[]): Promise<void>;
+    addPreviousSearchTerm(term: string): Promise<void>;
+    clearPreviousSearchTerms(): Promise<void>;
+    getPreviousFindTerms(): string[];
+    addPreviousFindTerm(term: string): Promise<void>;
+    clearPreviousFindTerms(): Promise<void>;
 }
 export declare class ConnectionStorage extends Storage {
     private connectionName;

package/api/Terminal.d.ts

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

package/api/Tools.d.ts

@@ -18,7 +18,7 @@ export declare namespace Tools {
      * @param output /usr/bin/db2's output
      * @returns rows
      */
-    function db2Parse(output: string): DB2Row[];
+    function db2Parse(output: string, input?: string): DB2Row[];
     function makeid(length?: number): string;
     /**
      * Build the IFS path string to an object or member
@@ -44,11 +44,22 @@ export declare namespace Tools {
     function sanitizeLibraryNames(libraries: string[]): string[];
     function parseMessages(output: string): IBMiMessages;
     function parseQSysPath(path: string): QsysPath;
+    /**
+     * Check whether two given uris point to the same file/member
+     */
+    function areEquivalentUris(uriA: vscode.Uri, uriB: vscode.Uri): boolean;
     /**
      * We do this to find previously opened files with the same path, but different case OR readonly flags.
      * Without this, it's possible for the same document to be opened twice simply due to the readonly flag.
      */
     function findExistingDocumentUri(uri: vscode.Uri): vscode.Uri;
+    function findExistingDocument(uri: vscode.Uri): vscode.TextDocument;
+    function findExistingDocumentByName(nameAndExt: string): vscode.Uri;
+    /**
+     * Given the uri of a member or other resource, find all
+     * (if any) open tabs where that resource is being edited.
+    */
+    function findUriTabs(uriToFind: vscode.Uri | string): vscode.Tab[];
     /**
      * Fixes an SQL statement to make it compatible with db2 CLI program QZDFMDB2.
      * - Changes `@clCommand` statements into Call `QSYS2.QCMDEX('clCommand')` procedure calls
@@ -56,7 +67,7 @@ export declare namespace Tools {
      * @param statement the statement to fix
      * @returns statement compatible with QZDFMDB2
      */
-    function fixSQL(statement: string): string;
+    function fixSQL(statement: string, removeComments?: boolean): string;
     function generateTooltipHtmlTable(header: string, rows: Record<string, any>): string;
     function fixWindowsPath(path: string): string;
     /**

package/api/local/env.d.ts

@@ -1,5 +1,4 @@
 import { WorkspaceFolder } from "vscode";
-export declare function getEnvConfig(currentWorkspace: WorkspaceFolder): Promise<{
-    [key: string]: string;
-}>;
+export declare type Env = Record<string, string>;
+export declare function getEnvConfig(currentWorkspace: WorkspaceFolder): Promise<Env>;
 export declare function getBranchLibraryName(currentBranch: string): string;

package/components/component.d.ts

@@ -0,0 +1,32 @@
+import IBMi from "../api/IBMi";
+import { CopyToImport } from "./copyToImport";
+import { GetMemberInfo } from "./getMemberInfo";
+import { GetNewLibl } from "./getNewLibl";
+export declare enum ComponentState {
+    NotChecked = "NotChecked",
+    NotInstalled = "NotInstalled",
+    Installed = "Installed",
+    Error = "Error"
+}
+interface ComponentRegistry {
+    GetNewLibl?: GetNewLibl;
+    CopyToImport?: CopyToImport;
+    GetMemberInfo?: GetMemberInfo;
+}
+export declare type ComponentId = keyof ComponentRegistry;
+export declare abstract class ComponentT {
+    connection: IBMi;
+    state: ComponentState;
+    currentVersion: number;
+    constructor(connection: IBMi);
+    abstract getInstalledVersion(): Promise<number | undefined>;
+    abstract checkState(): Promise<boolean>;
+    abstract getState(): ComponentState;
+}
+export declare class ComponentManager {
+    private registered;
+    startup(connection: IBMi): Promise<void>;
+    get<T>(id: ComponentId): T | undefined;
+    private static checkState;
+}
+export {};

package/components/copyToImport.d.ts

@@ -0,0 +1,15 @@
+import IBMi from "../api/IBMi";
+import { WrapResult } from "../typings";
+import { ComponentState, ComponentT } from "./component";
+export declare class CopyToImport implements ComponentT {
+    connection: IBMi;
+    private readonly name;
+    state: ComponentState;
+    currentVersion: number;
+    constructor(connection: IBMi);
+    getInstalledVersion(): Promise<number>;
+    checkState(): Promise<boolean>;
+    getState(): ComponentState;
+    static isSimple(statement: string): boolean;
+    wrap(statement: string): WrapResult;
+}

package/components/getMemberInfo.d.ts

@@ -0,0 +1,19 @@
+import IBMi from "../api/IBMi";
+import { IBMiMember } from "../typings";
+import { ComponentState, ComponentT } from "./component";
+export declare class GetMemberInfo implements ComponentT {
+    connection: IBMi;
+    readonly name = "GETMBRINFO";
+    state: ComponentState;
+    currentVersion: number;
+    constructor(connection: IBMi);
+    getInstalledVersion(): Promise<number>;
+    checkState(): Promise<boolean>;
+    getState(): ComponentState;
+    /**
+     *
+     * @param filter: the criterias used to list the members
+     * @returns
+     */
+    getMemberInfo(library: string, sourceFile: string, member: string): Promise<IBMiMember | undefined>;
+}

package/components/getNewLibl.d.ts

@@ -0,0 +1,15 @@
+import IBMi from "../api/IBMi";
+import { ComponentState, ComponentT } from "./component";
+export declare class GetNewLibl implements ComponentT {
+    connection: IBMi;
+    state: ComponentState;
+    currentVersion: number;
+    constructor(connection: IBMi);
+    getInstalledVersion(): Promise<number>;
+    checkState(): Promise<boolean>;
+    getState(): ComponentState;
+    getLibraryListFromCommand(ileCommand: string): Promise<{
+        currentLibrary: string;
+        libraryList: string[];
+    } | undefined>;
+}

package/instantiate.d.ts

@@ -1,7 +1,5 @@
 import * as vscode from "vscode";
 import Instance from "./api/Instance";
-import { Search } from "./api/Search";
 export declare let instance: Instance;
-export declare function setSearchResults(term: string, results: Search.Result[]): void;
 export declare function disconnect(): Promise<boolean>;
 export declare function loadAllofExtension(context: vscode.ExtensionContext): Promise<void>;

package/package.json

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

package/typings.d.ts

@@ -49,7 +49,7 @@ export interface CommandData extends StandardIO {
     env?: Record<string, string>;
 }
 export interface CommandResult {
-    code: number | null;
+    code: number;
     stdout: string;
     stderr: string;
     command?: string;
@@ -183,5 +183,23 @@ export declare const IFS_BROWSER_MIMETYPE = "application/vnd.code.tree.ifsbrowse
 export declare type OpenEditableOptions = QsysFsOptions & {
     position?: Range;
 };
+export interface WrapResult {
+    newStatements: string[];
+    outStmf: string;
+}
 export declare type SpecialAuthorities = "*ALLOBJ" | "*AUDIT" | "*IOSYSCFG" | "*JOBCTL" | "*SAVSYS" | "*SECADM" | "*SERVICE" | "*SPLCTL";
 export declare type AttrOperands = 'ACCESS_TIME' | 'ALLOC_SIZE' | 'ALLOC_SIZE_64' | 'ALWCKPWR' | 'ALWSAV' | 'ASP' | 'AUDIT' | 'AUTH_GROUP' | 'AUTH_LIST_NAME' | 'AUTH_OWNER' | 'AUTH_USERS' | 'CCSID' | 'CHANGE_TIME' | 'CHECKED_OUT' | 'CHECKED_OUT_USER' | 'CHECKED_OUT_TIME' | 'CODEPAGE' | 'CREATE_TIME' | 'CRTOBJAUD' | 'CRTOBJSCAN' | 'DATA_SIZE' | 'DATA_SIZE_64' | 'DIR_FORMAT' | 'DISK_STG_OPT' | 'EXTENDED_ATTR_SIZE' | 'FILE_FORMAT' | 'FILE_ID' | 'JOURNAL_APPLY_CHANGES' | 'JOURNAL_ID' | 'JOURNAL_LIBRARY' | 'JOURNAL_NAME' | 'JOURNAL_OPTIONS' | 'JOURNAL_RCVR_ASP' | 'JOURNAL_RCVR_LIBRARY' | 'JOURNAL_RCVR_NAME' | 'JOURNAL_ROLLBACK_ENDED' | 'JOURNAL_START_TIME' | 'JOURNAL_STATUS' | 'LOCAL_REMOTE' | 'MAIN_STG_OPT' | 'MODIFY_TIME' | 'MULT_SIGS' | 'OBJTYPE' | 'PC_ARCHIVE' | 'PC_HIDDEN' | 'PC_READ_ONLY' | 'PC_SYSTEM' | 'RSTDRNMUNL' | 'SCAN' | 'SCAN_BINARY' | 'SCAN_CCSID1' | 'SCAN_CCSID2' | 'SCAN_SIGS_DIFF' | 'SCAN_STATUS' | 'SGID' | 'SIGNED' | 'STG_FREE' | 'SUID' | 'SYSTEM_ARCHIVE' | 'SYSTEM_USE' | 'SYS_SIGNED' | 'UDFS_DEFAULT_FORMAT' | 'USAGE_DAYS_USED' | 'USAGE_LAST_USED_TIME' | 'USAGE_RESET_TIME';
+export declare type SearchResults = {
+    term: string;
+    hits: SearchHit[];
+};
+export declare type SearchHit = {
+    path: string;
+    lines: SearchHitLine[];
+    readonly?: boolean;
+    label?: string;
+};
+export declare type SearchHitLine = {
+    number: number;
+    content: string;
+};

package/locale/ids/da.d.ts

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

package/locale/ids/en.d.ts

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

package/locale/ids/fr.d.ts

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