@halcyontech/vscode-ibmi-types 2.7.0 → 2.9.0

package/api/Configuration.d.ts

@@ -33,6 +33,7 @@ export declare namespace ConnectionConfiguration {
         showDescInLibList: boolean;
         debugCertDirectory: string;
         debugPort: string;
+        debugSepPort: string;
         debugIsSecure: boolean;
         debugUpdateProductionFiles: boolean;
         debugEnableDebugTracing: boolean;
@@ -41,6 +42,7 @@ export declare namespace ConnectionConfiguration {
         defaultDeploymentMethod: DeploymentMethod | '';
         protectedPaths: string[];
         showHiddenFiles: boolean;
+        lastDownloadLocation: string;
         [name: string]: any;
     }
     interface ObjectFilters {

package/api/IBMi.d.ts

@@ -30,7 +30,9 @@ export default class IBMi {
     };
     lastErrors: object[];
     config?: ConnectionConfiguration.Parameters;
+    shell?: string;
     commandsExecuted: number;
+    dangerousVariants: boolean;
     constructor();
     /**
      * @returns {Promise<{success: boolean, error?: any}>} Was succesful at connecting or not.
@@ -39,6 +41,7 @@ export default class IBMi {
         success: boolean;
         error?: any;
     }>;
+    usingBash(): boolean;
     /**
      * - Send PASE/QSH/ILE commands simply
      * - Commands sent here end in the 'IBM i Output' channel
@@ -80,5 +83,18 @@ export default class IBMi {
     downloadFile(localFile: string | vscode.Uri, remoteFile: string): Promise<void>;
     uploadDirectory(localDirectory: string | vscode.Uri, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<void>;
     downloadDirectory(localDirectory: string | vscode.Uri, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<void>;
+    getLastDownloadLocation(): string;
+    setLastDownloadLocation(location: string): Promise<void>;
     fileToPath(file: string | vscode.Uri): string;
+    /**
+     * Creates a temporary directory and pass it on to a `process` function.
+     * 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>;
+    /**
+     * Uppercases an object name, keeping the variant chars case intact
+     * @param name
+     */
+    upperCaseName(name: string): string;
 }

package/api/IBMiContent.d.ts

@@ -46,6 +46,11 @@ export default class IBMiContent {
      * Upload to a member
      */
     uploadMemberContent(asp: string | undefined, library: string, sourceFile: string, member: string, content: string | Uint8Array): Promise<boolean>;
+    /**
+     * @param statements Either an SQL statement or CL statement. CL statements start with @
+     * @returns result set
+     */
+    runStatements(...statements: string[]): Promise<Tools.DB2Row[]>;
     /**
      * Run SQL statements.
      * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).
@@ -96,7 +101,7 @@ export default class IBMiContent {
     /**
      * @param filters
      * @param sortOrder
-     * @returns an array of IBMiFile
+     * @returns an array of IBMiObject
      */
     getObjectList(filters: {
         library: string;
@@ -137,7 +142,7 @@ export default class IBMiContent {
      * @param timeString: string in HHMMSS
      * @returns date
      */
-    getDspfdDate(century?: string, YYMMDD?: string, HHMMSS?: string): Date;
+    getDspObjDdDate(century?: string, MMDDYY?: string, HHMMSS?: string): Date;
     /**
      * Return `true` if `remotePath` denotes a directory
      *
@@ -158,7 +163,7 @@ export default class IBMiContent {
      * @param parameters A key/value object of parameters
      * @returns Formatted CL string
      */
-    static toCl(command: string, parameters: {
+    toCl(command: string, parameters: {
         [parameter: string]: string | number | undefined;
     }): string;
 }

package/api/Storage.d.ts

@@ -2,6 +2,12 @@ import vscode from 'vscode';
 export declare type PathContent = Record<string, string[]>;
 export declare type DeploymentPath = Record<string, string>;
 export declare type DebugCommands = Record<string, string>;
+declare type AuthorisedExtension = {
+    id: string;
+    displayName: string;
+    since: number;
+    lastAccess: number;
+};
 declare abstract class Storage {
     protected readonly globalState: any;
     constructor(context: vscode.ExtensionContext);
@@ -59,6 +65,7 @@ export declare class GlobalStorage extends Storage {
         defaultCCSID: number;
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
+    setServerSettingsCacheSpecific(name: string, newSettings: Partial<CachedServerSettings>): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;
     getPreviousSearchTerms(): string[];
     setPreviousSearchTerms(previousSearchTerms: string[]): Promise<void>;
@@ -83,5 +90,10 @@ export declare class ConnectionStorage extends Storage {
     getRecentlyOpenedFiles(): string[];
     setRecentlyOpenedFiles(recentlyOpenedFiles: string[]): Promise<void>;
     clearRecentlyOpenedFiles(): Promise<void>;
+    grantExtensionAuthorisation(extension: vscode.Extension<any>): Promise<void>;
+    getExtensionAuthorisation(extension: vscode.Extension<any>): AuthorisedExtension;
+    getAuthorisedExtensions(): AuthorisedExtension[];
+    revokeAllExtensionAuthorisations(): void;
+    revokeExtensionAuthorisation(...extensions: AuthorisedExtension[]): Promise<void>;
 }
 export {};

package/api/Tools.d.ts

@@ -57,4 +57,6 @@ export declare namespace Tools {
      * @returns statement compatible with QZDFMDB2
      */
     function fixSQL(statement: string): string;
+    function generateTooltipHtmlTable(header: string, rows: Record<string, any>): string;
+    function fixWindowsPath(path: string): string;
 }

package/api/debug/certificates.d.ts

@@ -1,8 +1,9 @@
 import IBMi from "../IBMi";
-export declare function getRemoteServerCertPath(connection: IBMi): string;
-export declare function getRemoteClientCertPath(connection: IBMi): string;
-export declare function remoteServerCertExists(connection: IBMi): Promise<boolean>;
-export declare function remoteClientCertExists(connection: IBMi): Promise<boolean>;
+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
  */
@@ -10,3 +11,4 @@ export declare function setup(connection: IBMi): Promise<void>;
 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>;

package/api/debug/index.d.ts

@@ -8,6 +8,12 @@ interface DebugOptions {
     library: string;
     object: string;
     libraries: ILELibrarySettings;
+    sep?: {
+        type: DebugObjectType;
+        moduleName?: string;
+        procedureName?: string;
+    };
 }
+declare type DebugObjectType = "*PGM" | "*SRVPGM";
 export declare function startDebug(instance: Instance, options: DebugOptions): Promise<void>;
 export {};

package/api/debug/server.d.ts

@@ -1,11 +1,19 @@
 import IBMi from "../IBMi";
 import IBMiContent from "../IBMiContent";
-export declare function startup(connection: IBMi): Promise<void>;
-export declare function stop(connection: IBMi): Promise<void>;
+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(connection: IBMi): Promise<void>;
+export declare function end(instance: Instance): Promise<void>;
 /**
  * Gets a list of debug jobs stuck at MSGW in QSYSWRK
  */
 export declare function getStuckJobs(userProfile: string, content: IBMiContent): Promise<string[]>;
 export declare function endJobs(jobIds: string[], connection: IBMi): Promise<import("../../typings").CommandResult[]>;
+export {};

package/package.json

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

package/typings.d.ts

@@ -88,6 +88,13 @@ export interface IBMiObject extends QsysPath {
     sourceFile?: boolean;
     attribute?: string;
     memberCount?: number;
+    sourceLength?: number;
+    CCSID?: number;
+    size?: number;
+    created?: Date;
+    changed?: Date;
+    created_by?: string;
+    owner?: string;
 }
 export interface IBMiMember {
     library: string;
@@ -129,7 +136,8 @@ export declare type IBMiEvent = "connected" | "disconnected" | "deployLocation"
 export interface WithPath {
     path: string;
 }
-export interface Library extends WithPath {
+export interface WithLibrary {
+    library: string;
 }
 export declare type FocusOptions = {
     select?: boolean;
@@ -155,9 +163,6 @@ export interface FilteredItem {
 export interface ObjectItem extends FilteredItem, WithPath {
     object: IBMiObject;
 }
-export interface SourcePhysicalFileItem extends FilteredItem, WithPath {
-    sourceFile: IBMiObject;
-}
 export interface MemberItem extends FilteredItem, WithPath {
     member: IBMiMember;
 }
@@ -169,6 +174,7 @@ export declare type IBMiMessages = {
     messages: IBMiMessage[];
     findId(id: string): IBMiMessage | undefined;
 };
+export declare const OBJECT_BROWSER_MIMETYPE = "application/vnd.code.tree.objectbrowser";
 export declare const IFS_BROWSER_MIMETYPE = "application/vnd.code.tree.ifsbrowser";
 export declare type OpenEditableOptions = QsysFsOptions & {
     position?: Range;