@halcyontech/vscode-ibmi-types 2.9.0 → 2.10.0

package/api/Configuration.d.ts

@@ -15,7 +15,6 @@ export declare namespace ConnectionConfiguration {
         connectionProfiles: ConnectionProfile[];
         commandProfiles: CommandProfile[];
         autoSortIFSShortcuts: boolean;
-        enableSQL: boolean;
         tempLibrary: string;
         tempDir: string;
         sourceASP: string;
@@ -31,7 +30,6 @@ export declare namespace ConnectionConfiguration {
         connectringStringFor5250: string;
         autoSaveBeforeAction: boolean;
         showDescInLibList: boolean;
-        debugCertDirectory: string;
         debugPort: string;
         debugSepPort: string;
         debugIsSecure: boolean;

package/api/IBMi.d.ts

@@ -1,11 +1,17 @@
 import * as node_ssh from "node-ssh";
 import * as vscode from "vscode";
 import { ConnectionConfiguration } from "./Configuration";
-import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand } from "../typings";
+import { CcsidOrigin, CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, SpecialAuthorities } from "../typings";
+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;
+    /** User default CCSID is job default CCSID */
+    private userDefaultCCSID;
     client: node_ssh.NodeSSH;
     currentHost: string;
     currentPort: number;
@@ -16,11 +22,14 @@ export default class IBMi {
     };
     defaultUserLibraries: string[];
     outputChannel?: vscode.OutputChannel;
+    /**
+     * Used to store ASP numbers and their names
+     * Their names usually maps up to a directory in
+     * the root of the IFS, thus why we store it.
+     */
     aspInfo: {
         [id: number]: string;
     };
-    qccsid: number;
-    defaultCCSID: number;
     remoteFeatures: {
         [name: string]: string | undefined;
     };
@@ -28,6 +37,10 @@ export default class IBMi {
         american: string;
         local: string;
     };
+    /**
+     * Strictly for storing errors from sendCommand.
+     * Used when creating issues on GitHub.
+     * */
     lastErrors: object[];
     config?: ConnectionConfiguration.Parameters;
     shell?: string;
@@ -60,6 +73,17 @@ export default class IBMi {
     private appendOutput;
     private determineClear;
     end(): Promise<void>;
+    /**
+     * SQL only available when runner is installed and CCSID is valid.
+     */
+    get enableSQL(): boolean;
+    /**
+     * Do not use this API directly.
+     * It exists to support some backwards compatability.
+     * @deprecated
+     */
+    set enableSQL(value: boolean);
+    sqlRunnerAvailable(): boolean;
     /**
      * Generates path to a temp file on the IBM i
      * @param {string} key Key to the temp file to be re-used
@@ -97,4 +121,29 @@ export default class IBMi {
      * @param name
      */
     upperCaseName(name: string): string;
+    /**
+     * Run SQL statements.
+     * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).
+     * If a statement starts with @, it will be run as a CL command.
+     *
+     * @param statements
+     * @returns a Result set
+     */
+    runSQL(statements: string, opts?: {
+        userCcsid?: number;
+    }): Promise<Tools.DB2Row[]>;
+    getEncoding(): {
+        fallback: boolean;
+        ccsid: number;
+        invalid: boolean;
+    };
+    getCcsids(): {
+        origin: CcsidOrigin;
+        runtimeCcsid: number;
+        userDefaultCCSID: number;
+    };
+    checkUserSpecialAuthorities(authorities: SpecialAuthorities[], user?: string): Promise<{
+        valid: boolean;
+        missing: SpecialAuthorities[];
+    }>;
 }

package/api/IBMiContent.d.ts

@@ -58,6 +58,7 @@ export default class IBMiContent {
      *
      * @param statements
      * @returns a Result set
+     * @deprecated Use {@linkcode IBMi.runSQL IBMi.runSQL} instead
      */
     runSQL(statements: string): Promise<Tools.DB2Row[]>;
     /**
@@ -122,6 +123,12 @@ export default class IBMiContent {
         sort?: SortOptions;
         filterType?: FilterType;
     }): Promise<IBMiMember[]>;
+    /**
+     *
+     * @param filter: the criterias used to list the members
+     * @returns
+     */
+    getMemberInfo(library: string, sourceFile: string, member: string): Promise<IBMiMember | undefined>;
     /**
      * Get list of items in a path
      * @param remotePath
@@ -136,13 +143,6 @@ export default class IBMiContent {
      * @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
-     */
-    getDspObjDdDate(century?: string, MMDDYY?: string, HHMMSS?: string): Date;
     /**
      * Return `true` if `remotePath` denotes a directory
      *
@@ -155,7 +155,7 @@ export default class IBMiContent {
         type: string;
         member?: string;
     }, authorities?: Authority[]): Promise<boolean>;
-    testStreamFile(path: string, right: "r" | "w" | "x"): Promise<boolean>;
+    testStreamFile(path: string, right: "f" | "d" | "r" | "w" | "x"): Promise<boolean>;
     isProtectedPath(path: string): boolean;
     /**
      *

package/api/Storage.d.ts

@@ -23,7 +23,7 @@ export declare type CachedServerSettings = {
     aspInfo: {
         [id: number]: string;
     };
-    qccsid: number | null;
+    runtimeCcsid: number | null;
     remoteFeatures: {
         [name: string]: string | undefined;
     };
@@ -35,7 +35,8 @@ export declare type CachedServerSettings = {
     badDataAreasChecked: boolean | null;
     libraryListValidated: boolean | null;
     pathChecked?: boolean;
-    defaultCCSID: number | null;
+    userDefaultCCSID: number | null;
+    debugConfigLoaded: boolean;
 } | undefined;
 export declare class GlobalStorage extends Storage {
     private static instance;
@@ -50,7 +51,7 @@ export declare class GlobalStorage extends Storage {
         aspInfo: {
             [id: number]: string;
         };
-        qccsid: number;
+        runtimeCcsid: number;
         remoteFeatures: {
             [name: string]: string;
         };
@@ -62,7 +63,8 @@ export declare class GlobalStorage extends Storage {
         badDataAreasChecked: boolean;
         libraryListValidated: boolean;
         pathChecked?: boolean;
-        defaultCCSID: number;
+        userDefaultCCSID: number;
+        debugConfigLoaded: boolean;
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     setServerSettingsCacheSpecific(name: string, newSettings: Partial<CachedServerSettings>): Promise<void>;

package/api/Tools.d.ts

@@ -59,4 +59,13 @@ export declare namespace Tools {
     function fixSQL(statement: string): string;
     function generateTooltipHtmlTable(header: string, rows: Record<string, any>): string;
     function fixWindowsPath(path: string): string;
+    /**
+     * Runs a function while a context value is set to true.
+     *
+     * If multiple callers call this function with the same context, only the last one returning will unset the context value.
+     *
+     * @param context the context value that will be set to `true` during `task` execution
+     * @param task the function to run while the context value is `true`
+     */
+    function withContext<T>(context: string, task: () => Promise<T>): Promise<T>;
 }

package/api/debug/certificates.d.ts

@@ -1,14 +1,25 @@
+import vscode from "vscode";
 import IBMi from "../IBMi";
+import IBMiContent from '../IBMiContent';
+import { DebugConfiguration } from './config';
+export declare type ImportedCertificate = {
+    localFile?: vscode.Uri;
+    remoteFile?: string;
+    password: string;
+};
+export declare const SERVICE_CERTIFICATE = "debug_service.pfx";
+export declare const CLIENT_CERTIFICATE = "debug_service.crt";
 export declare const LEGACY_CERT_DIRECTORY = "/QIBM/ProdData/IBMiDebugService/bin/certs";
-export declare const DEFAULT_CERT_DIRECTORY = "/QIBM/UserData/IBMiDebugService/certs";
-export declare function getRemoteCertificateDirectory(connection: IBMi): string;
-export declare function getRemoteServerCertificatePath(connection: IBMi): string;
-export declare function remoteServerCertificateExists(connection: IBMi, legacy?: boolean): Promise<boolean>;
 /**
- * Generate all certifcates on the server
+ * Generates or imports the debug service server certificate and generates the client certificate from it.
+ * The keystore containing the certificate and its key must use the PKCS12 format.
+ *
+ * @param connection the IBM i where the certificate must be generated/imported
+ * @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): Promise<void>;
+export declare function setup(connection: IBMi, imported?: ImportedCertificate): Promise<void>;
+export declare function remoteCertificatesExists(debugConfig?: DebugConfiguration): Promise<boolean>;
 export declare function downloadClientCert(connection: IBMi): Promise<void>;
 export declare function getLocalCertPath(connection: IBMi): string;
-export declare function localClientCertExists(connection: IBMi): Promise<boolean>;
-export declare function legacyCertificateChecks(connection: IBMi, existingDebugService: string | undefined): Promise<void>;
+export declare function checkClientCertificate(connection: IBMi, debugConfig?: DebugConfiguration): Promise<void>;
+export declare function sanityCheck(connection: IBMi, content: IBMiContent): Promise<void>;

package/api/debug/config.d.ts

@@ -0,0 +1,33 @@
+declare type ConfigLine = {
+    key: string;
+    value?: string;
+};
+export declare const DEBUG_CONFIG_FILE = "/QIBM/ProdData/IBMiDebugService/bin/DebugService.env";
+export declare class DebugConfiguration {
+    readonly configLines: ConfigLine[];
+    private getContent;
+    getOrDefault(key: string, defaultValue: string): string;
+    get(key: string): string;
+    delete(key: string): void;
+    set(key: string, value?: string): void;
+    load(): Promise<this>;
+    save(): Promise<void>;
+    getRemoteServiceCertificatePath(): string;
+    getRemoteClientCertificatePath(): string;
+    getRemoteServiceRoot(): string;
+    getRemoteServiceBin(): string;
+    getRemoteServiceWorkDir(): string;
+}
+interface DebugServiceDetails {
+    version: string;
+    java: string;
+    semanticVersion: () => {
+        major: number;
+        minor: number;
+        patch: number;
+    };
+}
+export declare function resetDebugServiceDetails(): void;
+export declare function getDebugServiceDetails(): Promise<DebugServiceDetails>;
+export declare function getJavaHome(version: string): "/QOpenSys/QIBM/ProdData/JavaVM/jdk11/64bit" | "/QOpenSys/QIBM/ProdData/JavaVM/jdk80/64bit";
+export {};

package/api/debug/server.d.ts

@@ -1,19 +1,23 @@
 import IBMi from "../IBMi";
-import IBMiContent from "../IBMiContent";
-import Instance from "../Instance";
-interface DebugServiceDetails {
-    version: string;
-    java: string;
-}
-export declare function resetDebugServiceDetails(): void;
-export declare function getDebugServiceDetails(content: IBMiContent): Promise<DebugServiceDetails>;
-export declare function startup(instance: Instance): Promise<void>;
-export declare function stop(instance: Instance): Promise<void>;
-export declare function getRunningJob(localPort: string, content: IBMiContent): Promise<string | undefined>;
-export declare function end(instance: Instance): Promise<void>;
+import { Tools } from "../Tools";
+export declare type DebugJob = {
+    name: string;
+    ports: number[];
+};
+export declare function debugPTFInstalled(): boolean;
+export declare function isSEPSupported(): Promise<boolean>;
+export declare function startService(connection: IBMi): Promise<boolean>;
+export declare function stopService(connection: IBMi): Promise<boolean>;
+export declare function getDebugServiceJob(): Promise<DebugJob>;
+export declare function getDebugServerJob(): Promise<DebugJob>;
 /**
  * Gets a list of debug jobs stuck at MSGW in QSYSWRK
  */
-export declare function getStuckJobs(userProfile: string, content: IBMiContent): Promise<string[]>;
+export declare function getStuckJobs(connection: IBMi): Promise<string[]>;
 export declare function endJobs(jobIds: string[], connection: IBMi): Promise<import("../../typings").CommandResult[]>;
-export {};
+export declare function isDebugEngineRunning(): Promise<boolean>;
+export declare function startServer(): Promise<boolean>;
+export declare function stopServer(): Promise<boolean>;
+export declare function refreshDebugSensitiveItems(): void;
+export declare function readActiveJob(connection: IBMi, job: DebugJob): Promise<string | Tools.DB2Row>;
+export declare function readJVMInfo(connection: IBMi, job: DebugJob): Promise<string | Tools.DB2Row>;

package/api/errors/diagnostics.d.ts

@@ -15,4 +15,4 @@ export declare function clearDiagnostics(): void;
 export declare function clearDiagnostic(uri: vscode.Uri, changeRange: vscode.Range): void;
 export declare function refreshDiagnosticsFromServer(instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
 export declare function refreshDiagnosticsFromLocal(instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
-export declare function handleEvfeventLines(lines: string[], instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
+export declare function handleEvfeventLines(lines: string[], instance: Instance, evfeventInfo: EvfEventInfo): void;

package/package.json

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

package/typings.d.ts

@@ -31,6 +31,10 @@ export interface StandardIO {
 export declare type ActionType = "member" | "streamfile" | "object" | "file";
 export declare type ActionRefresh = "no" | "parent" | "filter" | "browser";
 export declare type ActionEnvironment = "ile" | "qsh" | "pase";
+export declare enum CcsidOrigin {
+    User = "user",
+    System = "system"
+}
 export interface RemoteCommand {
     title?: string;
     command: string;
@@ -146,6 +150,7 @@ export declare type FocusOptions = {
 };
 export declare type BrowserItemParameters = {
     icon?: string;
+    color?: string;
     state?: TreeItemCollapsibleState;
     parent?: BrowserItem;
 };
@@ -179,3 +184,4 @@ export declare const IFS_BROWSER_MIMETYPE = "application/vnd.code.tree.ifsbrowse
 export declare type OpenEditableOptions = QsysFsOptions & {
     position?: Range;
 };
+export declare type SpecialAuthorities = "*ALLOBJ" | "*AUDIT" | "*IOSYSCFG" | "*JOBCTL" | "*SAVSYS" | "*SECADM" | "*SERVICE" | "*SPLCTL";