@halcyontech/vscode-ibmi-types 2.15.3 → 2.16.0

package/Instance.d.ts

@@ -1,7 +1,8 @@
 import * as vscode from "vscode";
-import { ConnectionConfig, ConnectionData, IBMiEvent } from "./typings";
+import { ILELibrarySettings } from "./api/CompileTools";
 import IBMi, { ConnectionResult } from "./api/IBMi";
 import { ConnectionStorage } from "./api/configuration/storage/ConnectionStorage";
+import { ConnectionConfig, ConnectionData, IBMiEvent } from "./typings";
 export interface ConnectionOptions {
     data: ConnectionData;
     reconnecting?: boolean;
@@ -23,6 +24,7 @@ export default class Instance {
     disconnect(): Promise<void>;
     private setConnection;
     getConnection(): IBMi;
+    getLibraryList(connection: IBMi, workspaceFolder?: vscode.WorkspaceFolder): Promise<ILELibrarySettings>;
     setConfig(newConfig: ConnectionConfig): Promise<void>;
     /**
      * @deprecated Will be removed in `v3.0.0`; use {@link IBMi.getConfig()} instead

package/api/CompileTools.d.ts

@@ -1,5 +1,5 @@
 import IBMi from './IBMi';
-import { RemoteCommand, CommandResult } from './types';
+import { CommandResult, RemoteCommand } from './types';
 export interface ILELibrarySettings {
     currentLibrary: string;
     libraryList: string[];

package/api/IBMi.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import * as node_ssh from "node-ssh";
 import { IBMiComponent } from "./components/component";
+import { ComponentManager, ComponentSearchProps } from "./components/manager";
 import IBMiContent from "./IBMiContent";
 import { CodeForIStorage } from './configuration/storage/CodeForIStorage';
 import { Tools } from './Tools';
@@ -168,8 +169,8 @@ export default class IBMi {
      * @param name
      */
     upperCaseName(name: string): string;
-    getComponent<T extends IBMiComponent>(name: string, ignoreState?: boolean): T;
-    getComponentStates(): import("./components/component").ComponentInstallState[];
+    getComponentManager(): ComponentManager;
+    getComponent<T extends IBMiComponent>(name: string, options?: ComponentSearchProps): T;
     /**
      * Run SQL statements.
      * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).

package/api/IBMiContent.d.ts

@@ -5,7 +5,7 @@ import { EditorPath } from '../typings';
 import { FilterType } from './Filter';
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
-import { AttrOperands, IBMiError, IBMiMember, IBMiObject, IFSFile, ModuleExport, ProgramExportImportInfo, QsysPath, SpecialAuthorities } from './types';
+import { AttrOperands, CommandResult, IBMiError, IBMiMember, IBMiObject, IFSFile, ModuleExport, ProgramExportImportInfo, QsysPath, SpecialAuthorities } from './types';
 declare type Authority = "*ADD" | "*DLT" | "*EXECUTE" | "*READ" | "*UPD" | "*NONE" | "*ALL" | "*CHANGE" | "*USE" | "*EXCLUDE" | "*AUTLMGT";
 export declare type SortOrder = `name` | `type`;
 export declare type SortOptions = {
@@ -34,7 +34,7 @@ export default class IBMiContent {
      * @param content Raw content
      * @param encoding Optional encoding to write.
      */
-    writeStreamfileRaw(originalPath: string, content: Uint8Array, encoding?: string): Promise<string | void>;
+    writeStreamfileRaw(originalPath: string, content: string | Uint8Array, encoding?: string): Promise<string | void>;
     /**
      * Write utf8 content to a streamfile
      * @deprecated Use {@link IBMiContent.writeStreamfileRaw()} instead
@@ -226,5 +226,19 @@ export default class IBMiContent {
     downloadFile(localFile: EditorPath, remoteFile: string): Promise<void>;
     uploadDirectory(localDirectory: EditorPath, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<boolean>;
     downloadDirectory(localDirectory: EditorPath, remoteDirectory: string, options?: node_ssh.SSHGetPutDirectoryOptions): Promise<boolean>;
+    /**
+     * Copy one or more folders or files into a directory. Uses QSH's `cp` to keep all the attributes of the original file into its copy.
+     * @param paths one or more files/folders to copy
+     * @param toDirectory the directory where the files/folders will be copied into
+     * @returns the {@link CommandResult} of the `cp` command execution
+     */
+    copy(paths: string | string[], toDirectory: string): Promise<CommandResult>;
+    /**
+     * Move one or more folders or files into a directory. Uses QSH's `mv` to ensures attributes are not altered during the opration.
+     * @param paths one or more files/folders to copy
+     * @param toDirectory the directory where the files/folders will be copied into
+     * @returns the {@link CommandResult} of the `mv` command execution
+     */
+    move(paths: string | string[], toDirectory: string): Promise<CommandResult>;
 }
 export {};

package/api/Search.d.ts

@@ -1,5 +1,5 @@
-import { IBMiMember, SearchResults } from './types';
 import IBMi from './IBMi';
+import { IBMiMember, SearchResults } from './types';
 export declare namespace Search {
     function searchMembers(connection: IBMi, library: string, sourceFile: string, searchTerm: string, members: string | IBMiMember[], readOnly?: boolean): Promise<SearchResults>;
     function searchIFS(connection: IBMi, path: string, searchTerm: string): Promise<SearchResults | undefined>;

package/api/components/component.d.ts

@@ -2,7 +2,8 @@ import IBMi from "../IBMi";
 export declare type ComponentState = `NotChecked` | `NotInstalled` | `Installed` | `NeedsUpdate` | `Error`;
 export declare type ComponentIdentification = {
     name: string;
-    version: number;
+    version: number | string;
+    userManaged?: boolean;
 };
 export declare type ComponentInstallState = {
     id: ComponentIdentification;
@@ -55,4 +56,9 @@ export declare type IBMiComponent = {
      * Called when connecting to clear every persitent information related to the previous connection
      */
     reset?(): void | Promise<void>;
+    /**
+     * Called when the component should be uninstalled.
+     * Can only run against user-managed components.
+     */
+    uninstall?(connection: IBMi): Promise<void>;
 };

package/api/components/manager.d.ts

@@ -1,10 +1,14 @@
 import IBMi from "../IBMi";
-import { ComponentIdentification, ComponentInstallState, IBMiComponent } from "./component";
+import { ComponentIdentification, ComponentInstallState, ComponentState, IBMiComponent } from "./component";
+import { IBMiComponentRuntime } from "./runtime";
 interface ExtensionContextI {
     extension: {
         id: string;
     };
 }
+export interface ComponentSearchProps {
+    ignoreState?: boolean;
+}
 export declare class ComponentRegistry {
     private readonly components;
     registerComponent(context: ExtensionContextI | string, component: IBMiComponent): void;
@@ -16,8 +20,18 @@ export declare class ComponentManager {
     private readonly registered;
     constructor(connection: IBMi);
     getComponentIds(): ComponentIdentification[];
-    getInstallState(): ComponentInstallState[];
+    getComponentStates(): ComponentInstallState[];
+    /**
+     * Returns all components, user managed or not
+     */
+    getAllAvailableComponents(): IBMiComponent[];
+    installComponent(key: string): Promise<ComponentInstallState>;
+    uninstallComponent(key: string): Promise<ComponentInstallState>;
+    getRemoteState(key: string): Promise<ComponentState | undefined>;
     startup(lastInstalled?: ComponentInstallState[]): Promise<void>;
-    get<T extends IBMiComponent>(id: string, ignoreState?: boolean): T;
+    /**
+     * Returns the latest version of an installed component, or fetch a specific version
+     */
+    get<T extends IBMiComponent>(id: string, options?: ComponentSearchProps): T | undefined;
 }
-export {};
+export { IBMiComponentRuntime };

package/api/components/runtime.d.ts

@@ -0,0 +1,17 @@
+import IBMi from "../IBMi";
+import { ComponentState, IBMiComponent } from "./component";
+export declare class IBMiComponentRuntime {
+    protected readonly connection: IBMi;
+    readonly component: IBMiComponent;
+    static readonly InstallDirectory = "$HOME/.vscode/";
+    private state;
+    private cachedInstallDirectory;
+    constructor(connection: IBMi, component: IBMiComponent);
+    getInstallDirectory(): Promise<string>;
+    getState(): ComponentState;
+    setState(newState: ComponentState): Promise<void>;
+    overrideState(newState: ComponentState): Promise<void>;
+    update(installDirectory: string): Promise<void>;
+    startupCheck(): Promise<this>;
+    toString(): string;
+}

package/api/configuration/DebugConfiguration.d.ts

@@ -1,32 +1,26 @@
 import IBMi from "../IBMi";
 export declare const SERVICE_CERTIFICATE = "debug_service.pfx";
 export declare const CLIENT_CERTIFICATE = "debug_service.crt";
-export declare const LEGACY_CERT_DIRECTORY = "/QIBM/ProdData/IBMiDebugService/bin/certs";
 declare type ConfigLine = {
     key: string;
     value?: string;
 };
-export declare const DEBUG_CONFIG_FILE = "/QIBM/UserData/IBMiDebugService/C4iDebugService.env";
 export declare const ORIGINAL_DEBUG_CONFIG_FILE = "/QIBM/ProdData/IBMiDebugService/bin/DebugService.env";
 export declare class DebugConfiguration {
     private connection;
     constructor(connection: IBMi);
     readonly configLines: ConfigLine[];
-    private readOnly;
     private getContent;
     getOrDefault(key: string, defaultValue: string): string;
     get(key: string): string;
-    delete(key: string): void;
-    set(key: string, value?: string): void;
     load(): Promise<this>;
-    save(): Promise<void>;
     getRemoteServiceCertificatePath(): string;
     getRemoteClientCertificatePath(): string;
     getRemoteServiceRoot(): string;
     getRemoteServiceBin(): string;
     getRemoteServiceWorkDir(): string;
-    getCode4iDebug(): string;
-    setCode4iDebug(value: string): void;
+    getRemoteServiceWorkspace(): string;
+    getNavigatorLogFile(): string;
 }
 interface DebugServiceDetails {
     version: string;

package/api/configuration/config/ConnectionManager.d.ts

@@ -1,6 +1,6 @@
-import { Config } from "./VirtualConfig";
 import { ConnectionData } from "../../types";
 import { ConnectionConfig } from "./types";
+import { Config } from "./VirtualConfig";
 export declare class ConnectionManager {
     configMethod: Config;
     /**

package/api/configuration/storage/CodeForIStorage.d.ts

@@ -51,6 +51,7 @@ export declare class CodeForIStorage {
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     setServerSettingsCacheSpecific(name: string, newSettings: Partial<CachedServerSettings>): Promise<void>;
+    storeComponentState(connectionName: string, component: ComponentInstallState): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;
     deleteStaleServerSettingsCache(connections: ConnectionData[]): Promise<void>;
     getPreviousSearchTerms(): string[];

package/api/tests/components/customCli.d.ts

@@ -0,0 +1,12 @@
+import IBMi from "../../IBMi";
+import { IBMiComponent, ComponentState, ComponentIdentification } from "../../components/component";
+export declare class CustomCLI implements IBMiComponent {
+    static ID: string;
+    installPath: string;
+    getIdentification(): ComponentIdentification;
+    getFileName(): string;
+    setInstallDirectory(installDirectory: string): Promise<void>;
+    getRemoteState(connection: IBMi, installDirectory: string): Promise<ComponentState>;
+    update(connection: IBMi): Promise<ComponentState>;
+    uninstall(connection: IBMi): Promise<void>;
+}

package/api/types.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+import { Variables } from "./variables";
 export declare type DeploymentMethod = "all" | "staged" | "unstaged" | "changed" | "compare";
 export interface StandardIO {
     onStdout?: (data: Buffer) => void;
@@ -12,7 +13,6 @@ export interface StandardIO {
 export declare type ActionType = "member" | "streamfile" | "object" | "file";
 export declare type ActionRefresh = "no" | "parent" | "filter" | "browser";
 export declare type ActionEnvironment = "ile" | "qsh" | "pase";
-export declare type Variable = Record<string, string>;
 export declare enum CcsidOrigin {
     User = "user",
     System = "system"
@@ -22,7 +22,7 @@ export interface RemoteCommand {
     command: string;
     environment?: ActionEnvironment;
     cwd?: string;
-    env?: Record<string, string>;
+    env?: Record<string, string> | Variables;
     noLibList?: boolean;
 }
 export interface CommandData extends StandardIO {
@@ -46,6 +46,7 @@ export interface Action {
     postDownload?: string[];
     refresh?: ActionRefresh;
     runOnProtected?: boolean;
+    outputToFile?: string;
 }
 export interface ConnectionData {
     name: string;
@@ -138,6 +139,15 @@ export declare type IBMiMessages = {
 };
 export declare const OBJECT_BROWSER_MIMETYPE = "application/vnd.code.tree.objectbrowser";
 export declare const IFS_BROWSER_MIMETYPE = "application/vnd.code.tree.ifsbrowser";
+export declare const LIBRARY_LIST_MIMETYPE = "application/vnd.code.tree.libraryListView";
+export declare const URI_LIST_MIMETYPE = "text/uri-list";
+export declare const URI_LIST_SEPARATOR = "\r\n";
+export declare type ObjectBrowserDrag = {
+    library: string;
+    object: string;
+    type: string;
+    member?: string;
+};
 export interface WrapResult {
     newStatements: string[];
     outStmf: string;

package/api/variables.d.ts

@@ -0,0 +1,8 @@
+import IBMi from "./IBMi";
+export declare class Variables extends Map<string, string> {
+    constructor(connection?: IBMi, variables?: Record<string, string> | Map<string, string>);
+    set(key: string, value: string): this;
+    private expandVariables;
+    expand(input: string, keysToOmit?: string[]): string;
+    toPaseVariables(): Record<string, string>;
+}

package/commands/compare.d.ts

@@ -1,3 +1,2 @@
 import { Disposable } from "vscode";
-import Instance from "../Instance";
-export declare function registerCompareCommands(instance: Instance): Disposable[];
+export declare function registerCompareCommands(): Disposable[];

package/debug/certificates.d.ts

@@ -1,23 +1,12 @@
 import vscode from "vscode";
 import IBMi from "../api/IBMi";
-import IBMiContent from '../api/IBMiContent';
 import { DebugConfiguration } from '../api/configuration/DebugConfiguration';
 export declare type ImportedCertificate = {
     localFile?: vscode.Uri;
     remoteFile?: string;
     password: string;
 };
-/**
- * Generates or imports the debug service server certificate and generates the client certificate from it.
- * The keystore containing the certificate and its key must use the PKCS12 format.
- *
- * @param connection the IBM i where the certificate must be generated/imported
- * @param imported if defined, gives the location and password of a local or remote (i.e. on the IFS) service certificate to import
- */
-export declare function setup(connection: IBMi, imported?: ImportedCertificate): Promise<void>;
-export declare function debugKeyFileExists(connection: IBMi, debugConfig: DebugConfiguration): Promise<boolean>;
 export declare function remoteCertificatesExists(debugConfig?: DebugConfiguration): Promise<boolean>;
 export declare function downloadClientCert(connection: IBMi): Promise<void>;
 export declare function getLocalCertPath(connection: IBMi): string;
 export declare function checkClientCertificate(connection: IBMi, debugConfig?: DebugConfiguration): Promise<void>;
-export declare function sanityCheck(connection: IBMi, content: IBMiContent): Promise<void>;

package/debug/server.d.ts

@@ -4,8 +4,8 @@ export declare type DebugJob = {
     name: string;
     ports: number[];
 };
-export declare function debugPTFInstalled(): boolean;
-export declare function isSEPSupported(connection: IBMi): Promise<boolean>;
+export declare function debugPTFInstalled(connection: IBMi): boolean;
+export declare function isDebugSupported(connection: IBMi): Promise<boolean>;
 export declare function startService(connection: IBMi): Promise<boolean>;
 export declare function stopService(connection: IBMi): Promise<boolean>;
 export declare function getDebugServiceJob(): Promise<DebugJob>;

package/filesystems/local/actions.d.ts

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

package/filesystems/local/deployment.d.ts

@@ -1,5 +1,6 @@
 import vscode from 'vscode';
 import IBMi from '../../api/IBMi';
+import IBMiContent from '../../api/IBMiContent';
 import { DeploymentParameters } from '../../typings';
 export declare namespace Deployment {
     interface MD5Entry {
@@ -13,7 +14,7 @@ export declare namespace Deployment {
     const workspaceChanges: Map<vscode.WorkspaceFolder, Map<string, vscode.Uri>>;
     function initialize(context: vscode.ExtensionContext): void;
     function getConnection(): IBMi;
-    function getContent(): import("../../api/IBMiContent").default;
+    function getContent(): IBMiContent;
     function createRemoteDirectory(remotePath: string): Promise<import("../../typings").CommandResult>;
     function showErrorButton(): Promise<void>;
     function getWorkspaceFolder(workspaceIndex?: number): Promise<vscode.WorkspaceFolder>;

package/package.json

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

package/ui/actions.d.ts

@@ -1,6 +1,6 @@
+import vscode, { WorkspaceFolder } from 'vscode';
 import Instance from '../Instance';
 import { Action, DeploymentMethod } from '../typings';
-import vscode, { WorkspaceFolder } from 'vscode';
 import { BrowserItem } from './types';
 export declare function registerActionTools(context: vscode.ExtensionContext): void;
-export declare function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod, browserItem?: BrowserItem, workspaceFolder?: WorkspaceFolder): Promise<boolean>;
+export declare function runAction(instance: Instance, uris: vscode.Uri | vscode.Uri[], customAction?: Action, method?: DeploymentMethod, browserItems?: BrowserItem[], workspaceFolder?: WorkspaceFolder): 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): 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/uri/handler.d.ts

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

package/uri/handlers/open.d.ts

@@ -0,0 +1,14 @@
+import { Code4iUriHandler } from "../handler";
+/**
+ * Handles /open with the following query parameters:
+ *  - `path`: an IFS path; supports /QSYS.LIB paths to open members
+ *  - `host` (optional): the IBM i host to connect to; can be a host name, an IP or a server configuration name use current connection if not specified
+ *  - `user`(optional): if specified with host, a connection with the specified user must exist
+ *  - `readonly`: if specified, the member/file will be opened in read-only mode
+ *
+ * Examples:
+ * - /open?path=/tmp/test.txt
+ * - /open?path=/tmp/dontchange.txt&readonly
+ * - /open?host=PUB400.com&user=JOHNDOE&path=/tmp/dontchange.txt&readonly
+ */
+export declare const openURIHandler: Code4iUriHandler;

package/uri/handlers/sandbox.d.ts

@@ -0,0 +1,10 @@
+import { Code4iUriHandler } from "../handler";
+/**
+ * Handles /connect with the following query parameters:
+ *  - `server`: the IBM i to connect to
+ *  - `user`: an IBM i user profile
+ *  - `pass`: the profile's password
+ *  - `save` (optional): whether or not this connection should be saved
+ */
+export declare const sandboxURIHandler: Code4iUriHandler;
+export declare function initializeSandbox(): Promise<void>;

package/uri/index.d.ts

@@ -0,0 +1,3 @@
+import vscode from "vscode";
+import { Code4iUriHandler } from "./handler";
+export declare function registerURIHandler(context: vscode.ExtensionContext, ...handlers: Code4iUriHandler[]): void;

package/webviews/CustomUI.d.ts

@@ -1,7 +1,10 @@
 import vscode from 'vscode';
 declare type PanelOptions = {
     fullWidth?: boolean;
+    fullPage?: boolean;
+    css?: string;
 };
+declare type TreeLeafAction = "submit" | "browse";
 export interface Page<T> {
     panel: vscode.WebviewPanel;
     data?: T;
@@ -48,9 +51,10 @@ export declare class Section {
     addTabs(tabs: Tab[], selected?: number): this;
     addComplexTabs(tabs: ComplexTab[], selected?: number): this;
     addSelect(id: string, label: string, items: SelectItem[], description?: string): this;
-    addTree(id: string, label: string, treeItems: TreeListItem[], description?: string): 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 {
     private options?;
@@ -67,7 +71,7 @@ export declare class CustomUI extends Section {
     private createPage;
     private getHTML;
 }
-export declare type FieldType = "input" | "password" | "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" | "browser";
 export interface TreeListItemIcon {
     branch?: string;
     open?: string;
@@ -108,6 +112,7 @@ export declare class Field {
     inputType?: InputType;
     min?: number;
     max?: number;
+    treeLeafAction?: TreeLeafAction;
     constructor(type: FieldType, id: string, label: string, description?: string);
     getHTML(): string;
     private renderLabel;

package/sandbox.d.ts

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