@halcyontech/vscode-ibmi-types 2.17.2 → 3.0.5

package/typings.d.ts

@@ -1,24 +1,33 @@
-import { CustomUI } from "./webviews/CustomUI";
+import { Ignore } from "ignore";
+import { Uri, WorkspaceFolder } from "vscode";
 import Instance from "./Instance";
-import { DeployTools } from "./filesystems/local/deployTools";
 import { ComponentRegistry } from './api/components/manager';
+import { ConnectionManager } from "./api/configuration/config/ConnectionManager";
 import { DeploymentMethod, FileError } from "./api/types";
-import { Ignore } from "ignore";
-import { WorkspaceFolder } from "vscode";
+import { CustomEditor } from "./editors/customEditorProvider";
+import { DeployTools } from "./filesystems/local/deployTools";
+import { ActionTools } from "./api/actions";
 import { VscodeTools } from "./ui/Tools";
+import { SearchTools } from "./api/SearchTools";
+import { CustomUI } from "./webviews/CustomUI";
 export interface CodeForIBMi {
     instance: Instance;
     customUI: () => CustomUI;
-    deployTools: typeof DeployTools;
+    customEditor: <T>(target: string, onSave: (data: T) => Promise<void>, onClosed?: () => void) => CustomEditor<T>;
     evfeventParser: (lines: string[]) => Map<string, FileError[]>;
     tools: typeof VscodeTools;
+    deployTools: typeof DeployTools;
+    actionTools: typeof ActionTools;
     componentRegistry: ComponentRegistry;
+    connectionManager: ConnectionManager;
+    searchTools: typeof SearchTools;
 }
 export interface DeploymentParameters {
     method: DeploymentMethod;
     workspaceFolder: WorkspaceFolder;
     remotePath: string;
     ignoreRules?: Ignore;
+    selectedFiles?: Uri[];
 }
 export * from "./api/types";
 export * from "./ui/types";

package/ui/Tools.d.ts

@@ -1,8 +1,8 @@
 import vscode from "vscode";
-import { API } from "../filesystems/local/gitApi";
-import { IBMiObject, IBMiMember, IFSFile } from '../typings';
 import IBMi from '../api/IBMi';
 import { Tools } from '../api/Tools';
+import { API } from "../filesystems/local/gitApi";
+import { ConnectionProfile, IBMiMember, IBMiObject, IFSFile } from '../typings';
 export declare namespace VscodeTools {
     function getGitAPI(): API | undefined;
     function md5Hash(file: vscode.Uri): string;
@@ -23,6 +23,7 @@ export declare namespace VscodeTools {
     */
     function findUriTabs(uriToFind: vscode.Uri | string): vscode.Tab[];
     function generateTooltipHtmlTable(header: string, rows: Record<string, any>): string;
+    function escapeHtml(html: string): string;
     /**
      * Runs a function while a context value is set to true.
      *
@@ -36,6 +37,8 @@ export declare namespace VscodeTools {
     function sourcePhysicalFileToToolTip(connection: IBMi, path: string, object: IBMiObject): Promise<vscode.MarkdownString>;
     function memberToToolTip(path: string, member: IBMiMember): vscode.MarkdownString;
     function ifsFileToToolTip(path: string, ifsFile: IFSFile): vscode.MarkdownString;
+    function profileToToolTip(profile: ConnectionProfile): vscode.MarkdownString;
+    function includesCaseInsensitive(haystack: string[], needle: string): boolean;
     const qualifyPath: typeof Tools.qualifyPath;
     const unqualifyPath: typeof Tools.unqualifyPath;
     const escapePath: typeof Tools.escapePath;
@@ -50,4 +53,5 @@ export declare namespace VscodeTools {
     const normalizePath: typeof Tools.normalizePath;
     const resolvePath: typeof Tools.resolvePath;
     const makeid: typeof Tools.makeid;
+    const ensureFullPath: typeof Tools.ensureFullPath;
 }

package/ui/actions.d.ts

@@ -1,8 +1,9 @@
 import vscode, { WorkspaceFolder } from 'vscode';
+import IBMi from '../api/IBMi';
 import Instance from '../Instance';
-import { Action, DeploymentMethod } from '../typings';
+import { Action, ActionResult, DeploymentMethod } from '../typings';
 import { BrowserItem } from './types';
-export declare type ActionTarget = {
+export type ActionTarget = {
     uri: vscode.Uri;
     extension: string;
     fragment: string;
@@ -14,9 +15,9 @@ export declare type ActionTarget = {
     output: string[];
 };
 export declare function registerActionTools(context: vscode.ExtensionContext): void;
-export declare function uriToActionTarget(uri: vscode.Uri, workspaceFolder?: WorkspaceFolder): ActionTarget;
-export declare function runAction(instance: Instance, uris: vscode.Uri | vscode.Uri[], customAction?: Action, method?: DeploymentMethod, browserItems?: BrowserItem[], workspaceFolder?: WorkspaceFolder): Promise<boolean>;
-export declare type AvailableAction = {
+export declare function uriToActionTarget(uri: vscode.Uri, workspaceFolder?: WorkspaceFolder, ibmi?: IBMi): ActionTarget;
+export declare function runAction(instance: Instance, uris: vscode.Uri | vscode.Uri[], customAction?: Action, method?: DeploymentMethod, browserItems?: BrowserItem[], workspaceFolder?: WorkspaceFolder): Promise<ActionResult>;
+export type AvailableAction = {
     label: string;
     action: Action;
 };

package/ui/connection.d.ts

@@ -1,3 +1,5 @@
+import { CancellationToken } from "vscode";
 import IBMi, { ConnectionErrorCode, ConnectionMessageType } from "../api/IBMi";
 export declare function messageCallback(type: ConnectionMessageType, message: string): void;
+export declare function inputBoxCallback(prompt: string, placeHolder: string, ignoreFocusOut: boolean, token: CancellationToken): Promise<string>;
 export declare function handleConnectionResults(connection: IBMi, error: ConnectionErrorCode, data: any): Promise<boolean>;

package/ui/diagnostics.d.ts

@@ -13,6 +13,6 @@ export declare function registerDiagnostics(): vscode.Disposable[];
  */
 export declare function clearDiagnostics(): void;
 export declare function clearDiagnostic(uri: vscode.Uri, changeRange: vscode.Range): void;
-export declare function refreshDiagnosticsFromServer(instance: Instance, evfeventInfo: EvfEventInfo, keepDiagnostics?: boolean): Promise<void>;
+export declare function refreshDiagnosticsFromServer(instance: Instance, evfeventInfo: EvfEventInfo[], keepDiagnostics?: boolean): Promise<void>;
 export declare function refreshDiagnosticsFromLocal(instance: Instance, evfeventInfo: EvfEventInfo): Promise<void>;
 export declare function handleEvfeventLines(lines: string[], instance: Instance, evfeventInfo: EvfEventInfo): void;

package/ui/types.d.ts

@@ -1,6 +1,6 @@
-import { TreeItemCollapsibleState, TreeItem, ProviderResult, MarkdownString } from "vscode";
+import { MarkdownString, ProviderResult, TreeItem, TreeItemCollapsibleState } from "vscode";
 import { FocusOptions, IBMiMember, IBMiObject, ObjectFilters, WithPath } from "../api/types";
-export declare type BrowserItemParameters = {
+export type BrowserItemParameters = {
     icon?: string;
     color?: string;
     state?: TreeItemCollapsibleState;
@@ -20,7 +20,12 @@ export declare class BrowserItem extends TreeItem {
     constructor(label: string, params?: BrowserItemParameters);
     get parent(): BrowserItem;
     getChildren?(): ProviderResult<BrowserItem[]>;
-    refresh?(): void;
+    refresh?(): Thenable<void>;
     reveal?(options?: FocusOptions): Thenable<void>;
     getToolTip?(): Promise<MarkdownString | undefined>;
 }
+export type SemanticVersion = {
+    major: number;
+    minor: number;
+    patch: number;
+};

package/uri/handler.d.ts

@@ -1,6 +1,6 @@
 import vscode from "vscode";
 import IBMi from "../api/IBMi";
-export declare type Code4iUriHandler = {
+export type Code4iUriHandler = {
     canHandle(path: string): boolean;
     handle(uri: vscode.Uri, connection?: IBMi): void | Promise<void>;
 };

package/webviews/CustomUI.d.ts

@@ -1,10 +1,10 @@
-import vscode from 'vscode';
-declare type PanelOptions = {
+import vscode, { ProviderResult } from 'vscode';
+type PanelOptions = {
     fullWidth?: boolean;
     fullPage?: boolean;
     css?: string;
 };
-declare type TreeLeafAction = "submit" | "browse";
+type TreeLeafAction = "submit" | "browse";
 export interface Page<T> {
     panel: vscode.WebviewPanel;
     data?: T;
@@ -28,7 +28,7 @@ export interface ComplexTab {
     label: string;
     fields: Field[];
 }
-declare type InputType = "text" | "number";
+type InputType = "text" | "number";
 export declare class Section {
     readonly fields: Field[];
     addHeading(label: string, level?: 1 | 2 | 3 | 4 | 5 | 6): this;
@@ -50,28 +50,32 @@ export declare class Section {
     addPassword(id: string, label: string, description?: string, defaultValue?: string): this;
     addTabs(tabs: Tab[], selected?: number): this;
     addComplexTabs(tabs: ComplexTab[], selected?: number): this;
-    addSelect(id: string, label: string, items: SelectItem[], description?: string): this;
+    addSelect(id: string, label: string, items: SelectItem[], description?: string, readonly?: boolean): this;
     addTree(id: string, label: string, treeItems: TreeListItem[], description?: string, onClick?: TreeLeafAction): this;
     addButtons(...buttons: (Button | undefined)[]): this;
     addField(field: Field): this;
     addBrowser(id: string, items: TreeListItem[]): this;
 }
-export declare class CustomUI extends Section {
+export declare class CustomHTML extends Section {
     private options?;
+    setOptions(options: PanelOptions): this;
+    protected getSpecificScript(): string;
+    protected getHTML(panel: vscode.WebviewPanel, title: string): string;
+}
+export declare class CustomUI extends CustomHTML {
     /**
      * If no callback is provided, a Promise will be returned.
      * If the page is already opened, it grabs the focus and return no Promise (as it's alreay handled by the first call).
      *
-     * @param title
-     * @param callback
+     * @param title the title displayed in the webview tab
+     * @param checkData an optional function that can check and updates the data before they are returned. If it returns `false`, the view will stay open.
      * @returns a Promise<Page<T>> if no callback is provided
      */
-    loadPage<T>(title: string): Promise<Page<T>> | undefined;
-    setOptions(options: PanelOptions): this;
+    loadPage<T>(title: string, checkData?: (data: T) => ProviderResult<boolean>): Promise<Page<T>> | undefined;
     private createPage;
-    private getHTML;
+    protected getSpecificScript(): string;
 }
-export declare type FieldType = "input" | "password" | "buttons" | "checkbox" | "file" | "complexTabs" | "tabs" | "tree" | "select" | "paragraph" | "hr" | "heading" | "browser";
+export type FieldType = "input" | "password" | "buttons" | "checkbox" | "file" | "complexTabs" | "tabs" | "tree" | "select" | "paragraph" | "hr" | "heading" | "browser";
 export interface TreeListItemIcon {
     branch?: string;
     open?: string;
@@ -82,7 +86,7 @@ export interface TreeListItem {
     subItems?: TreeListItem[];
     open?: boolean;
     selected?: boolean;
-    focused?: boolean;
+    active?: boolean;
     icons?: TreeListItemIcon;
     value?: string;
     path?: number[];
@@ -117,5 +121,7 @@ export declare class Field {
     getHTML(): string;
     private renderLabel;
     private renderDescription;
+    private renderTreeItem;
+    private renderIcon;
 }
 export {};

package/api/components/copyToImport.d.ts

@@ -1,14 +0,0 @@
-import IBMi from "../IBMi";
-import { WrapResult } from "../types";
-import { ComponentState, IBMiComponent } from "./component";
-export declare class CopyToImport implements IBMiComponent {
-    static ID: string;
-    static isSimple(statement: string): boolean;
-    getIdentification(): {
-        name: string;
-        version: number;
-    };
-    getRemoteState(): ComponentState;
-    update(): ComponentState | Promise<ComponentState>;
-    wrap(connection: IBMi, statement: string): WrapResult;
-}

package/api/components/cqsh/index.d.ts

@@ -1,17 +0,0 @@
-import IBMi from "../../IBMi";
-import { ComponentState, IBMiComponent } from "../component";
-export declare class CustomQSh implements IBMiComponent {
-    static ID: string;
-    private localAssetPath;
-    setLocalAssetPath(newPath: string): void;
-    installPath: string;
-    getIdentification(): {
-        name: string;
-        version: number;
-    };
-    getFileName(): string;
-    setInstallDirectory(installDirectory: string): Promise<void>;
-    getRemoteState(connection: IBMi, installDirectory: string): Promise<ComponentState>;
-    update(connection: IBMi): Promise<ComponentState>;
-    testCommand(connection: IBMi): Promise<boolean>;
-}

package/api/components/getMemberInfo.d.ts

@@ -1,19 +0,0 @@
-import IBMi from "../IBMi";
-import { ComponentState, IBMiComponent } from "../components/component";
-import { IBMiMember } from "../types";
-export declare class GetMemberInfo implements IBMiComponent {
-    static ID: string;
-    private readonly procedureName;
-    private readonly currentVersion;
-    private installedVersion;
-    reset(): void;
-    getIdentification(): {
-        name: string;
-        version: number;
-    };
-    getRemoteState(connection: IBMi): Promise<ComponentState>;
-    update(connection: IBMi): Promise<ComponentState>;
-    private static parseDateString;
-    getMemberInfo(connection: IBMi, library: string, sourceFile: string, member: string): Promise<IBMiMember | undefined>;
-    getMultipleMemberInfo(connection: IBMi, members: IBMiMember[]): Promise<IBMiMember[] | undefined>;
-}

package/api/components/getNewLibl.d.ts

@@ -1,20 +0,0 @@
-import IBMi from "../IBMi";
-import { ComponentState, IBMiComponent } from "./component";
-export declare class GetNewLibl implements IBMiComponent {
-    static ID: string;
-    private readonly procedureName;
-    private readonly currentVersion;
-    private installedVersion;
-    reset(): void;
-    getIdentification(): {
-        name: string;
-        version: number;
-    };
-    getRemoteState(connection: IBMi): Promise<ComponentState>;
-    update(connection: IBMi): Promise<ComponentState>;
-    getLibraryListFromCommand(connection: IBMi, ileCommand: string): Promise<{
-        currentLibrary: string;
-        libraryList: string[];
-    }>;
-    private getSource;
-}

package/filesystems/local/actions.d.ts

@@ -1,5 +0,0 @@
-import { WorkspaceFolder } from "vscode";
-import { Action } from "../../api/types";
-export declare function getLocalActionsFiles(currentWorkspace?: WorkspaceFolder): Promise<import("vscode").Uri[]>;
-export declare function getLocalActions(currentWorkspace: WorkspaceFolder): Promise<Action[]>;
-export declare function getEvfeventFiles(currentWorkspace: WorkspaceFolder): Promise<import("vscode").Uri[]>;