@halcyontech/vscode-ibmi-types 1.9.1 → 2.1.0

package/api/CompileTools.d.ts

@@ -1,28 +1,15 @@
 import vscode from 'vscode';
-import { CommandResult, RemoteCommand } from '../typings';
+import { Action, CommandResult, DeploymentMethod, RemoteCommand } from '../typings';
 import Instance from './Instance';
 export interface ILELibrarySettings {
     currentLibrary: string;
     libraryList: string[];
 }
 export declare namespace CompileTools {
-    interface EvfEventInfo {
-        asp?: string;
-        library: string;
-        object: string;
-        extension?: string;
-        workspace?: number;
-    }
-    export function register(context: vscode.ExtensionContext): void;
-    /**
-     * Does what it says on the tin.
-     */
-    export function clearDiagnostics(): void;
-    export function refreshDiagnostics(instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
-    export function runAction(instance: Instance, uri: vscode.Uri): Promise<void>;
+    function register(context: vscode.ExtensionContext): void;
+    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod): Promise<void>;
     /**
      * Execute a command
      */
-    export function runCommand(instance: Instance, options: RemoteCommand, title?: string): Promise<CommandResult | null>;
-    export {};
+    function runCommand(instance: Instance, options: RemoteCommand, title?: string): Promise<CommandResult | null>;
 }

package/api/Configuration.d.ts

@@ -27,6 +27,7 @@ export declare namespace ConnectionConfiguration {
         connectringStringFor5250: string;
         autoSaveBeforeAction: boolean;
         showDescInLibList: boolean;
+        debugCertDirectory: string;
         debugPort: string;
         debugIsSecure: boolean;
         debugUpdateProductionFiles: boolean;

package/api/CustomUI.d.ts

@@ -6,6 +6,7 @@ export interface Page<T> {
 export interface Button {
     id: string;
     label: string;
+    requiresValidation?: boolean;
 }
 export interface SelectItem {
     text: string;
@@ -30,6 +31,9 @@ export declare class Section {
         default?: string;
         readonly?: boolean;
         rows?: number;
+        minlength?: number;
+        maxlength?: number;
+        regexTest?: string;
     }): this;
     addParagraph(label: string): this;
     addFile(id: string, label: string, description?: string): this;
@@ -54,7 +58,7 @@ export declare class CustomUI extends Section {
     private createPage;
     private getHTML;
 }
-export declare type FieldType = "input" | "password" | "submit" | "buttons" | "checkbox" | "file" | "complexTabs" | "tabs" | "tree" | "select" | "paragraph" | "hr" | "heading";
+export declare type FieldType = "input" | "password" | "buttons" | "checkbox" | "file" | "complexTabs" | "tabs" | "tree" | "select" | "paragraph" | "hr" | "heading";
 export interface TreeListItemIcon {
     branch?: string;
     open?: string;
@@ -89,6 +93,9 @@ export declare class Field {
     default?: string;
     readonly?: boolean;
     rows?: number;
+    minlength?: number;
+    maxlength?: number;
+    regexTest?: string;
     constructor(type: FieldType, id: string, label: string, description?: string);
     getHTML(): string;
     private renderLabel;

package/api/IBMiContent.d.ts

@@ -1,6 +1,7 @@
 import { IBMiError, IBMiFile, IBMiMember, IBMiObject, IFSFile, QsysPath } from '../typings';
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
+declare type Authority = "*ADD" | "*DLT" | "*EXECUTE" | "*READ" | "*UPD" | "*NONE" | "*ALL" | "*CHANGE" | "*USE" | "*EXCLUDE" | "*AUTLMGT";
 export declare type SortOptions = {
     order: "name" | "date" | "?";
     ascending?: boolean;
@@ -17,7 +18,7 @@ export default class IBMiContent {
     /**
      * Download the contents of a source member
      */
-    downloadMemberContent(asp: string | undefined, library: string, sourceFile: string, member: string): Promise<string>;
+    downloadMemberContent(asp: string | undefined, library: string, sourceFile: string, member: string, localPath?: string): Promise<string>;
     /**
      * Upload to a member
      */
@@ -77,10 +78,10 @@ export default class IBMiContent {
      * @param remotePath
      * @return an array of IFSFile
      */
-    getFileList(remotePath: string, sort?: SortOptions): Promise<IFSFile[]>;
+    getFileList(remotePath: string, sort?: SortOptions, onListError?: (errors: string[]) => void): Promise<IFSFile[]>;
     memberResolve(member: string, files: QsysPath[]): Promise<IBMiMember | undefined>;
     objectResolve(object: string, libraries: string[]): Promise<string | undefined>;
-    streamfileResolve(name: string, directories: string[]): Promise<string | undefined>;
+    streamfileResolve(names: string[], directories: string[]): Promise<string | undefined>;
     /**
      * Fix Comments in an SQL string so that the comments always start at position 0 of the line.
      * Required to work with QZDFMDB2.
@@ -106,4 +107,10 @@ export default class IBMiContent {
      * @param remotePath: a remote IFS path
      */
     isDirectory(remotePath: string): Promise<boolean>;
+    checkObject(object: {
+        library: string;
+        name: string;
+        type: string;
+    }, ...authorities: Authority[]): Promise<boolean>;
 }
+export {};

package/api/Storage.d.ts

@@ -27,6 +27,7 @@ export declare type CachedServerSettings = {
         local: string;
     };
     badDataAreasChecked: boolean | null;
+    libraryListValidated: boolean | null;
 } | undefined;
 export declare class GlobalStorage extends Storage {
     private static instance;
@@ -51,6 +52,7 @@ export declare class GlobalStorage extends Storage {
             local: string;
         };
         badDataAreasChecked: boolean;
+        libraryListValidated: boolean;
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;

package/api/Tools.d.ts

@@ -1,3 +1,4 @@
+import vscode from "vscode";
 import { API } from "./import/git";
 export declare namespace Tools {
     class SqlError extends Error {
@@ -17,7 +18,7 @@ export declare namespace Tools {
      * @returns rows
      */
     function db2Parse(output: string): DB2Row[];
-    function makeid(): string;
+    function makeid(length?: number): string;
     /**
      * Build the IFS path string to a member
      * @param library
@@ -37,4 +38,5 @@ export declare namespace Tools {
     function escapePath(Path: string): string;
     function getGitAPI(): API | undefined;
     function distinct(value: any, index: number, array: any[]): boolean;
+    function md5Hash(file: vscode.Uri): string;
 }

package/api/debug/certificates.d.ts

@@ -1,5 +1,5 @@
 import IBMi from "../IBMi";
-export declare function getKeystorePath(): string;
+export declare function getKeystorePath(connection: IBMi): string;
 export declare function getLocalCertPath(connection: IBMi): string;
 export declare function checkRemoteExists(connection: IBMi): Promise<boolean>;
 export declare function setup(connection: IBMi): Promise<void>;

package/api/errors/diagnostics.d.ts

@@ -0,0 +1,17 @@
+import * as vscode from "vscode";
+import Instance from "../Instance";
+export interface EvfEventInfo {
+    asp?: string;
+    library: string;
+    object: string;
+    extension?: string;
+    workspace?: vscode.WorkspaceFolder;
+}
+export declare function registerDiagnostics(): vscode.Disposable[];
+/**
+ * Does what it says on the tin.
+ */
+export declare function clearDiagnostics(): 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>;

package/api/errors/handler.d.ts

@@ -1,4 +1,29 @@
 import { FileError } from "../../typings";
+export declare enum RecordType {
+    TIMESTAMP = "TIMESTAMP",
+    PROCESSOR = "PROCESSOR",
+    FILE_ID = "FILEID",
+    FILE_ID_CONT = "FILEIDCONT",
+    FILE_END = "FILEEND",
+    ERROR_INFORMATION = "ERROR",
+    EXPANSION = "EXPANSION",
+    PROGRAM = "PROGRAM",
+    MAP_DEFINE = "MAPDEFINE",
+    MAP_START = "MAPSTART",
+    MAP_END = "MAPEND",
+    FEEDBACK_CODE = "FEEDBACK"
+}
+export interface FileId {
+    version: number;
+    sourceId: number;
+    line: number;
+    length: number;
+    filename: string;
+    sourcefileTimestamp: number;
+    tempFlag: number;
+}
 export declare function formatName(input: string): string;
 export declare function formatIFS(path: string): string;
 export declare function parseErrors(lines: string[]): Map<string, FileError[]>;
+export declare function getLinesByRecodType(lines: string[], recordType: RecordType, sourceFileId?: number): string[];
+export declare function getSourcePath(lines: string[], fileId: number): string;

package/api/errors/parser.d.ts

@@ -0,0 +1,2 @@
+import { FileError } from "../../typings";
+export declare function parseErrors(lines: string[]): Map<string, FileError[]>;

package/api/local/LocalLanguageActions.d.ts

@@ -0,0 +1,2 @@
+import { Action } from "../../typings";
+export declare const LocalLanguageActions: Record<string, Action[]>;

package/api/local/actions.d.ts

@@ -1,7 +1,4 @@
 import { WorkspaceFolder } from "vscode";
 import { Action } from "../../typings";
 export declare function getLocalActions(currentWorkspace: WorkspaceFolder): Promise<Action[]>;
-/**
- * Gets actions from the `iproj.json` file
- */
-export declare function getiProjActions(currentWorkspace: WorkspaceFolder): Promise<Action[]>;
+export declare function getEvfeventFiles(currentWorkspace: WorkspaceFolder): Promise<import("vscode").Uri[]>;

package/api/local/deployTools.d.ts

@@ -0,0 +1,24 @@
+import { Ignore } from 'ignore';
+import vscode, { WorkspaceFolder } from 'vscode';
+import { DeploymentMethod, DeploymentParameters } from '../../typings';
+export declare namespace DeployTools {
+    function launchActionsSetup(workspaceFolder?: WorkspaceFolder): Promise<void>;
+    /**
+     * Deploy a workspace to a remote IFS location.
+     * @param workspaceIndex if no index is provided, a prompt will be shown to pick one if there are multiple workspaces,
+     * otherwise the current workspace will be used.
+     * @param method if no method is provided, a prompt will be shown to pick the deployment method.
+     * @returns the index of the deployed workspace or `undefined` if the deployment failed
+     */
+    function launchDeploy(workspaceIndex?: number, method?: DeploymentMethod): Promise<number | undefined>;
+    function deploy(parameters: DeploymentParameters): Promise<boolean>;
+    function getDeployChangedFiles(parameters: DeploymentParameters): Promise<vscode.Uri[]>;
+    function getDeployGitFiles(parameters: DeploymentParameters, changeType: 'staged' | 'working'): Promise<vscode.Uri[]>;
+    function getDeployCompareFiles(parameters: DeploymentParameters, progress?: vscode.Progress<{
+        message?: string;
+    }>): Promise<vscode.Uri[]>;
+    function getDeployAllFiles(parameters: DeploymentParameters): Promise<vscode.Uri[]>;
+    function setDeployLocation(node: any, workspaceFolder?: WorkspaceFolder, value?: string): Promise<void>;
+    function buildPossibleDeploymentDirectory(workspace: vscode.WorkspaceFolder): string;
+    function getDefaultIgnoreRules(workspaceFolder: vscode.WorkspaceFolder): Promise<Ignore>;
+}

package/api/local/deployment.d.ts

@@ -1,13 +1,25 @@
 import vscode from 'vscode';
 import { DeploymentParameters } from '../../typings';
+import IBMi from '../IBMi';
 export declare namespace Deployment {
+    interface MD5Entry {
+        path: string;
+        md5: string;
+    }
+    const BUTTON_BASE = "$(cloud-upload) Deploy";
+    const BUTTON_WORKING = "$(sync~spin) Deploying";
+    const deploymentLog: vscode.OutputChannel;
+    const button: vscode.StatusBarItem;
+    const workspaceChanges: Map<vscode.WorkspaceFolder, Map<string, vscode.Uri>>;
     function initialize(context: vscode.ExtensionContext): void;
-    /**
-     * Deploy a workspace to a remote IFS location.
-     * @param workspaceIndex if no index is provided, a prompt will be shown to pick one if there are multiple workspaces,
-     * otherwise the current workspace will be used.
-     * @returns the index of the deployed workspace or `undefined` if the deployment failed
-     */
-    function launchDeploy(workspaceIndex?: number): Promise<number | undefined>;
-    function deploy(parameters: DeploymentParameters): Promise<boolean>;
+    function getConnection(): IBMi;
+    function createRemoteDirectory(remotePath: string): Promise<import("../../typings").CommandResult>;
+    function showErrorButton(): Promise<void>;
+    function getWorkspaceFolder(workspaceIndex?: number): Promise<vscode.WorkspaceFolder>;
+    function toMD5Entry(line: string): MD5Entry;
+    function toRelative(root: vscode.Uri, file: vscode.Uri): string;
+    function findFiles(parameters: DeploymentParameters, includePattern: string, excludePattern?: string): Promise<vscode.Uri[]>;
+    function sendCompressed(parameters: DeploymentParameters, files: vscode.Uri[], progress: vscode.Progress<{
+        message?: string;
+    }>): Promise<void>;
 }

package/extension.d.ts

@@ -1,4 +1,4 @@
 import { ExtensionContext } from "vscode";
 import { CodeForIBMi } from "./typings";
 export declare function activate(context: ExtensionContext): Promise<CodeForIBMi>;
-export declare function deactivate(): void;
+export declare function deactivate(): Promise<void>;

package/locale/ids/da.d.ts

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

package/locale/ids/en.d.ts

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

package/locale/ids/fr.d.ts

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

package/locale/index.d.ts

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

package/package.json

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

package/typings.d.ts

@@ -3,11 +3,14 @@ import { WorkspaceFolder } from "vscode";
 import Instance from "./api/Instance";
 import { Ignore } from 'ignore';
 import { CustomUI } from "./api/CustomUI";
+import { Tools } from "./api/Tools";
+import { DeployTools } from "./api/local/deployTools";
 export interface CodeForIBMi {
     instance: Instance;
     customUI: () => CustomUI;
-    deploy: (parameters: DeploymentParameters) => Promise<boolean>;
+    deployTools: typeof DeployTools;
     evfeventParser: (lines: string[]) => Map<string, FileError[]>;
+    tools: typeof Tools;
 }
 export declare type DeploymentMethod = "all" | "staged" | "unstaged" | "changed" | "compare";
 export interface DeploymentParameters {
@@ -46,7 +49,7 @@ export interface Action {
     command: string;
     type?: "member" | "streamfile" | "object" | "file";
     environment: "ile" | "qsh" | "pase";
-    extensions: string[];
+    extensions?: string[];
     deployFirst?: boolean;
     postDownload?: string[];
 }
@@ -107,7 +110,8 @@ export interface Filter {
 }
 export interface FileError {
     sev: number;
-    linenum: number;
+    lineNum: number;
+    toLineNum: number;
     column: number;
     toColumn: number;
     text: string;