@halcyontech/vscode-ibmi-types 2.11.0 → 2.13.0

package/api/Configuration.d.ts

@@ -47,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

@@ -24,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
@@ -48,12 +49,13 @@ export default class IBMi {
     content: IBMiContent;
     shell?: string;
     commandsExecuted: number;
+    maximumArgsLength: number;
     dangerousVariants: boolean;
     constructor();
     /**
      * @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;
     }>;
@@ -75,6 +77,7 @@ export default class IBMi {
     sendCommand(options: CommandData): Promise<CommandResult>;
     private appendOutput;
     private determineClear;
+    private disconnect;
     end(): Promise<void>;
     /**
      * SQL only available when runner is installed and CCSID is valid.

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';
@@ -164,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

@@ -7,7 +7,8 @@ export default class Instance {
     private connection;
     private storage;
     private emitter;
-    private events;
+    private subscribers;
+    private deprecationCount;
     constructor(context: vscode.ExtensionContext);
     setConnection(connection?: IBMi): Promise<void>;
     getConnection(): IBMi;
@@ -15,6 +16,22 @@ export default class Instance {
     getConfig(): ConnectionConfiguration.Parameters;
     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 { IBMiMember, 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, searchTerm: string, members: IBMiMember[] | 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;
@@ -38,6 +40,7 @@ export declare type CachedServerSettings = {
     pathChecked?: boolean;
     userDefaultCCSID: number | null;
     debugConfigLoaded: boolean;
+    maximumArgsLength: number;
 } | undefined;
 export declare class GlobalStorage extends Storage {
     private static instance;
@@ -67,12 +70,18 @@ export declare class GlobalStorage extends Storage {
         pathChecked?: boolean;
         userDefaultCCSID: number;
         debugConfigLoaded: boolean;
+        maximumArgsLength: number;
     };
     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

@@ -27,7 +27,7 @@ export declare namespace Tools {
      * @param member Optional
      * @param iasp Optional: an iASP name
      */
-    function qualifyPath(library: string, object: string, member?: string, iasp?: string, sanitise?: boolean): string;
+    function qualifyPath(library: string, object: string, member?: string, iasp?: string, noEscape?: boolean): string;
     /**
      * Unqualify member path from root
      */
@@ -54,11 +54,12 @@ export declare namespace Tools {
      */
     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): vscode.Tab[];
+    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

package/api/debug/certificates.d.ts

@@ -18,6 +18,7 @@ export declare const LEGACY_CERT_DIRECTORY = "/QIBM/ProdData/IBMiDebugService/bi
  * @param imported if defined, gives the location and password of a local or remote (i.e. on the IFS) service certificate to import
  */
 export declare function setup(connection: IBMi, imported?: ImportedCertificate): Promise<void>;
+export declare function debugKeyFileExists(connection: IBMi, debugConfig: DebugConfiguration): Promise<boolean>;
 export declare function remoteCertificatesExists(debugConfig?: DebugConfiguration): Promise<boolean>;
 export declare function downloadClientCert(connection: IBMi): Promise<void>;
 export declare function getLocalCertPath(connection: IBMi): string;

package/api/debug/config.d.ts

@@ -17,6 +17,8 @@ export declare class DebugConfiguration {
     getRemoteServiceRoot(): string;
     getRemoteServiceBin(): string;
     getRemoteServiceWorkDir(): string;
+    getCode4iDebug(): string;
+    setCode4iDebug(value: string): void;
 }
 interface DebugServiceDetails {
     version: string;

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.11.0",
+  "version": "2.13.0",
   "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;
@@ -189,3 +189,17 @@ export interface WrapResult {
 }
 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;
+};