@halcyontech/vscode-ibmi-types 1.6.8 → 1.6.14

package/api/CompileTools.d.ts

@@ -0,0 +1,24 @@
+import vscode from 'vscode';
+import Instance from './Instance';
+import { CommandResult, RemoteCommand } from '../typings';
+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>;
+    /**
+     * Execute a command
+     */
+    export function runCommand(instance: Instance, options: RemoteCommand): Promise<CommandResult | null>;
+    export {};
+}

package/api/IBMi.d.ts

@@ -2,13 +2,13 @@ import * as vscode from "vscode";
 import * as node_ssh from "node-ssh";
 import { ConnectionConfiguration } from "./Configuration";
 import { ConnectionData, CommandData, StandardIO, CommandResult } from "../typings";
-interface MemberParts {
-    asp: string | undefined;
-    library: string | undefined;
-    file: string | undefined;
-    member: string | undefined;
-    extension: string | undefined;
-    basename: string | undefined;
+export interface MemberParts {
+    asp?: string;
+    library: string;
+    file: string;
+    member: string;
+    extension: string;
+    basename: string;
 }
 export default class IBMi {
     client: node_ssh.NodeSSH;
@@ -81,4 +81,3 @@ export default class IBMi {
     downloadDirectory(localDirectory: string | vscode.Uri, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<void>;
     fileToPath(file: string | vscode.Uri): string;
 }
-export {};

package/api/IBMiContent.d.ts

@@ -31,7 +31,7 @@ export default class IBMiContent {
      * @param member Will default to file provided
      * @param deleteTable Will delete the table after download
      */
-    getTable(library: string, file: string, member: string, deleteTable: boolean): Promise<Tools.DB2Row[]>;
+    getTable(library: string, file: string, member: string, deleteTable?: boolean): Promise<Tools.DB2Row[]>;
     /**
      * Get list of libraries with description and attribute
      * @param libraries Array of libraries to retrieve

package/api/Instance.d.ts

@@ -18,5 +18,5 @@ export default class Instance {
     getConfig(): ConnectionConfiguration.Parameters;
     getContent(): IBMiContent;
     getStorage(): Storage;
-    onEvent(event: "connected", func: Function): void;
+    onEvent(event: "connected" | "disconnected", func: Function): void;
 }

package/api/Storage.d.ts

@@ -1,6 +1,6 @@
 import vscode from 'vscode';
-export interface PathContent extends Record<string, string[]> {
-}
+export declare type PathContent = Record<string, string[]>;
+export declare type DeploymentPath = Record<string, string>;
 export declare class Storage {
     readonly context: vscode.ExtensionContext;
     readonly connectionName: string;
@@ -13,6 +13,6 @@ export declare class Storage {
     setLastProfile(lastProfile: string): Promise<void>;
     getPreviousCurLibs(): string[];
     setPreviousCurLibs(previousCurLibs: string[]): Promise<void>;
-    getDeployment(): PathContent;
-    setDeployment(existingPaths: PathContent): Promise<void>;
+    getDeployment(): DeploymentPath;
+    setDeployment(existingPaths: DeploymentPath): Promise<void>;
 }

package/api/configVars.d.ts

@@ -0,0 +1,3 @@
+import { ConnectionData } from "../typings";
+export declare function replace(data: string): string;
+export declare function replaceAll(connectionObject: ConnectionData): void;

package/api/errors/handler.d.ts

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

package/api/errors/handlers/new.d.ts

@@ -0,0 +1,9 @@
+import { FileError } from '../../../typings';
+export declare namespace NewHandler {
+    /**
+     * Returns object of files and their errors
+     * @param lines file contents
+     * @returns Errors object
+     */
+    function parse(lines: string[]): Map<string, FileError[]>;
+}

package/api/errors/handlers/old.d.ts

@@ -0,0 +1,9 @@
+import { FileError } from '../../../typings';
+export declare namespace OldHandler {
+    /**
+     * Returns object of files and their errors
+     * @param lines file contents
+     * @returns Errors object
+     */
+    function parse(lines: string[]): Map<string, FileError[]>;
+}

package/api/local/actions.d.ts

@@ -0,0 +1,7 @@
+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[]>;

package/api/local/deployment.d.ts

@@ -0,0 +1,14 @@
+import vscode from 'vscode';
+import Instance from '../Instance';
+import { DeploymentParameters } from '../../typings';
+export declare namespace Deployment {
+    function initialize(context: vscode.ExtensionContext, instance: Instance): 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>;
+}

package/api/local/env.d.ts

@@ -0,0 +1,4 @@
+import { WorkspaceFolder } from "vscode";
+export declare function getEnvConfig(currentWorkspace: WorkspaceFolder): Promise<{
+    [key: string]: string;
+}>;

package/package.json

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

package/sandbox.d.ts

@@ -0,0 +1,3 @@
+import { ExtensionContext } from "vscode";
+export declare function registerUriHandler(context: ExtensionContext): Promise<void>;
+export declare function handleStartup(): Promise<void>;

package/typings.d.ts

@@ -1,11 +1,27 @@
 /// <reference types="node" />
-import { ExtensionContext } from "vscode";
+import { ExtensionContext, Uri } from "vscode";
 import Instance from "./api/Instance";
+import { Ignore } from 'ignore';
 export interface CodeForIBMi {
     instance: Instance;
     baseContext: ExtensionContext;
     CustomUI: object;
     Field: object;
+    deploy: (parameters: DeploymentParameters) => Promise<boolean>;
+    evfeventParser: (lines: string[]) => Map<string, FileError[]>;
+}
+export declare enum DeploymentMethod {
+    "all" = 0,
+    "staged" = 1,
+    "unstaged" = 2,
+    "changed" = 3,
+    "compare" = 4
+}
+export interface DeploymentParameters {
+    method: DeploymentMethod;
+    localFolder: Uri;
+    remotePath: string;
+    ignoreRules?: Ignore;
 }
 export interface StandardIO {
     onStdout?: (data: Buffer) => void;
@@ -19,16 +35,12 @@ export interface RemoteCommand {
     command: string;
     environment?: "ile" | "qsh" | "pase";
     cwd?: string;
-    env?: {
-        [name: string]: string;
-    };
+    env?: Record<string, string>;
 }
 export interface CommandData extends StandardIO {
     command: string;
     directory?: string;
-    env?: {
-        [name: string]: string;
-    };
+    env?: Record<string, string>;
 }
 export interface CommandResult {
     code: number | null;
@@ -52,7 +64,7 @@ export interface ConnectionData {
     username: string;
     password?: string;
     privateKey: string | null;
-    keepaliveInterval: number;
+    keepaliveInterval?: number;
 }
 export interface Server {
     name: string;
@@ -88,3 +100,15 @@ export interface IBMiError {
     code: string;
     text: string;
 }
+export interface Filter {
+    library: string;
+    filter: string;
+}
+export interface FileError {
+    sev: number;
+    linenum: number;
+    column: number;
+    toColumn: number;
+    text: string;
+    code: string;
+}