@halcyontech/vscode-ibmi-types 2.13.5 → 2.14.0

package/api/CompileTools.d.ts

@@ -1,4 +1,4 @@
-import vscode, { EventEmitter } from 'vscode';
+import vscode, { EventEmitter, WorkspaceFolder } from 'vscode';
 import { Action, BrowserItem, CommandResult, DeploymentMethod, RemoteCommand } from '../typings';
 import Instance from './Instance';
 export interface ILELibrarySettings {
@@ -7,7 +7,7 @@ export interface ILELibrarySettings {
 }
 export declare namespace CompileTools {
     function register(context: vscode.ExtensionContext): void;
-    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod, browserItem?: BrowserItem): Promise<boolean>;
+    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod, browserItem?: BrowserItem, workspaceFolder?: WorkspaceFolder): Promise<boolean>;
     /**
      * Execute a command
      */

package/api/Configuration.d.ts

@@ -3,6 +3,7 @@ import { ConnectionData, DeploymentMethod } from '../typings';
 import { FilterType } from './Filter';
 export declare type SourceDateMode = "edit" | "diff";
 export declare type DefaultOpenMode = "browse" | "edit";
+export declare type ReconnectMode = "always" | "never" | "ask";
 export declare function onCodeForIBMiConfigurationChange<T>(props: string | string[], todo: (value: vscode.ConfigurationChangeEvent) => void): vscode.Disposable;
 export declare namespace GlobalConfiguration {
     function get<T>(key: string): T | undefined;

package/api/IBMi.d.ts

@@ -9,10 +9,12 @@ export interface MemberParts extends IBMiMember {
     basename: string;
 }
 export default class IBMi {
+    private systemVersion;
     private qccsid;
-    private jobCcsid;
+    private userJobCcsid;
     /** User default CCSID is job default CCSID */
     private userDefaultCCSID;
+    private sshdCcsid;
     private componentManager;
     client: node_ssh.NodeSSH;
     currentHost: string;
@@ -39,6 +41,7 @@ export default class IBMi {
     variantChars: {
         american: string;
         local: string;
+        qsysNameRegex?: RegExp;
     };
     /**
      * Strictly for storing errors from sendCommand.
@@ -50,7 +53,18 @@ export default class IBMi {
     shell?: string;
     commandsExecuted: number;
     maximumArgsLength: number;
-    dangerousVariants: boolean;
+    get canUseCqsh(): boolean;
+    /**
+     * Primarily used for running SQL statements.
+     */
+    get userCcsidInvalid(): boolean;
+    /**
+     * Determines if the client should do variant translation.
+     * False when cqsh should be used.
+     * True when cqsh is not available and the job CCSID is not the same as the SSHD CCSID.
+     */
+    get requiresTranslation(): boolean;
+    get dangerousVariants(): boolean;
     constructor();
     /**
      * @returns {Promise<{success: boolean, error?: any}>} Was succesful at connecting or not.
@@ -59,6 +73,10 @@ export default class IBMi {
         success: boolean;
         error?: any;
     }>;
+    /**
+     * Can return 0 if the OS version was not detected.
+     */
+    getSystemVersion(): number;
     usingBash(): boolean;
     /**
      * - Send PASE/QSH/ILE commands simply
@@ -69,6 +87,7 @@ export default class IBMi {
      *   `env` to customise them.
      */
     runCommand(data: RemoteCommand): Promise<CommandResult>;
+    static escapeForShell(command: string): string;
     sendQsh(options: CommandData): Promise<CommandResult>;
     /**
      * Send commands to pase through the SSH connection.
@@ -83,13 +102,11 @@ export default class IBMi {
      * 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;
+    private getSshCcsid;
+    getSysEnvVars(): Promise<{
+        [name: string]: string;
+    }>;
     /**
      * Generates path to a temp file on the IBM i
      * @param {string} key Key to the temp file to be re-used
@@ -136,16 +153,17 @@ export default class IBMi {
      * @param statements
      * @returns a Result set
      */
-    runSQL(statements: string): Promise<Tools.DB2Row[]>;
-    getEncoding(): {
-        fallback: boolean;
-        ccsid: number;
-        invalid: boolean;
-    };
+    runSQL(statements: string, options?: {
+        fakeBindings?: (string | number)[];
+        forceSafe?: boolean;
+    }): Promise<Tools.DB2Row[]>;
+    validQsysName(name: string): boolean;
+    getCcsid(): number;
     getCcsids(): {
         qccsid: number;
         runtimeCcsid: number;
         userDefaultCCSID: number;
+        sshdCcsid: number;
     };
     checkUserSpecialAuthorities(authorities: SpecialAuthorities[], user?: string): Promise<{
         valid: boolean;

package/api/IBMiContent.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { MarkdownString } from 'vscode';
 import { AttrOperands, IBMiError, IBMiMember, IBMiObject, IFSFile, QsysPath } from '../typings';
 import { FilterType } from './Filter';
@@ -121,7 +122,7 @@ export default class IBMiContent {
      * @param filter: the criterias used to list the members
      * @returns
      */
-    getMemberInfo(library: string, sourceFile: string, member: string): Promise<IBMiMember | undefined>;
+    getMemberInfo(library: string, sourceFile: string, member: string): Promise<IBMiMember>;
     /**
      * Get list of items in a path
      * @param remotePath

package/api/Storage.d.ts

@@ -22,6 +22,7 @@ export declare type LastConnection = {
     timestamp: number;
 };
 export declare type CachedServerSettings = {
+    lastCheckedOnVersion: string | undefined;
     aspInfo: {
         [id: number]: string;
     };
@@ -31,10 +32,6 @@ export declare type CachedServerSettings = {
         [name: string]: string | undefined;
     };
     remoteFeaturesKeys: string | null;
-    variantChars: {
-        american: string;
-        local: string;
-    };
     badDataAreasChecked: boolean | null;
     libraryListValidated: boolean | null;
     pathChecked?: boolean;
@@ -52,6 +49,7 @@ export declare class GlobalStorage extends Storage {
     setLastConnection(name: string): Promise<void>;
     setLastConnections(lastConnections: LastConnection[]): Promise<void>;
     getServerSettingsCache(name: string): {
+        lastCheckedOnVersion: string;
         aspInfo: {
             [id: number]: string;
         };
@@ -61,10 +59,6 @@ export declare class GlobalStorage extends Storage {
             [name: string]: string;
         };
         remoteFeaturesKeys: string;
-        variantChars: {
-            american: string;
-            local: string;
-        };
         badDataAreasChecked: boolean;
         libraryListValidated: boolean;
         pathChecked?: boolean;

package/api/Tools.d.ts

@@ -19,6 +19,7 @@ export declare namespace Tools {
      * @returns rows
      */
     function db2Parse(output: string, input?: string): DB2Row[];
+    function bufferToUx(input: string): string;
     function makeid(length?: number): string;
     /**
      * Build the IFS path string to an object or member
@@ -36,12 +37,12 @@ export declare namespace Tools {
      * @param Path
      * @returns the escaped path
      */
-    function escapePath(Path: string): string;
+    function escapePath(Path: string, alreadyQuoted?: boolean): string;
     function getGitAPI(): API | undefined;
     function distinct(value: any, index: number, array: any[]): boolean;
     function md5Hash(file: vscode.Uri): string;
     function capitalize(text: string): string;
-    function sanitizeLibraryNames(libraries: string[]): string[];
+    function sanitizeObjNamesForPase(libraries: string[]): string[];
     function parseMessages(output: string): IBMiMessages;
     function parseQSysPath(path: string): QsysPath;
     /**

package/components/component.d.ts

@@ -30,8 +30,11 @@ export declare type IBMiComponentType<T extends IBMiComponent> = new (c: IBMi) =
  */
 export declare abstract class IBMiComponent {
     protected readonly connection: IBMi;
+    static readonly InstallDirectory = "$HOME/.vscode/";
     private state;
+    private cachedInstallDirectory;
     constructor(connection: IBMi);
+    getInstallDirectory(): Promise<string>;
     getState(): ComponentState;
     check(): Promise<this>;
     toString(): string;

package/components/cqsh/index.d.ts

@@ -0,0 +1,12 @@
+import { ComponentState, IBMiComponent } from "../component";
+export declare class cqsh extends IBMiComponent {
+    getIdentification(): {
+        name: string;
+        version: number;
+    };
+    getFileName(): string;
+    getPath(): Promise<string>;
+    protected getRemoteState(): Promise<ComponentState>;
+    protected update(): Promise<ComponentState>;
+    testCommand(): Promise<boolean>;
+}

package/components/manager.d.ts

@@ -1,6 +1,6 @@
 import vscode from "vscode";
 import IBMi from "../api/IBMi";
-import { IBMiComponent, IBMiComponentType } from "./component";
+import { ComponentState, IBMiComponent, IBMiComponentType } from "./component";
 export declare class ComponentRegistry {
     private readonly components;
     registerComponent(context: vscode.ExtensionContext, component: IBMiComponentType<any>): void;
@@ -11,6 +11,10 @@ export declare class ComponentManager {
     private readonly connection;
     private readonly registered;
     constructor(connection: IBMi);
+    getState(): {
+        id: import("./component").ComponentIdentification;
+        state: ComponentState;
+    }[];
     startup(): Promise<void>;
     get<T extends IBMiComponent>(type: IBMiComponentType<T>, ignoreState?: boolean): T | undefined;
 }

package/package.json

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

package/typings.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { Ignore } from 'ignore';
 import { MarkdownString, ProviderResult, Range, TreeItem, TreeItemCollapsibleState, WorkspaceFolder } from "vscode";
 import { ConnectionConfiguration } from './api/Configuration';

package/locale/index.d.ts

@@ -1,5 +0,0 @@
-export declare type Locale = {
-    [id: string]: string;
-};
-export declare function updateLocale(): void;
-export declare function t(id: string, ...values: any[]): string;