@halcyontech/vscode-ibmi-types 2.14.3 → 2.14.4

package/api/CustomUI.d.ts

@@ -58,7 +58,7 @@ export declare class CustomUI extends Section {
      * @param callback
      * @returns a Promise<Page<T>> if no callback is provided
      */
-    loadPage<T>(title: string, callback?: (page: Page<T>) => void): Promise<Page<T>> | undefined;
+    loadPage<T>(title: string): Promise<Page<T>> | undefined;
     setOptions(options: PanelOptions): this;
     private createPage;
     private getHTML;

package/api/IBMi.d.ts

@@ -1,6 +1,6 @@
 import * as node_ssh from "node-ssh";
 import * as vscode from "vscode";
-import { IBMiComponent, IBMiComponentType } from "../components/component";
+import { IBMiComponent } from "../components/component";
 import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, SpecialAuthorities } from "../typings";
 import { ConnectionConfiguration } from "./Configuration";
 import IBMiContent from "./IBMiContent";
@@ -144,7 +144,11 @@ export default class IBMi {
      * @param name
      */
     upperCaseName(name: string): string;
-    getComponent<T extends IBMiComponent>(type: IBMiComponentType<T>, ignoreState?: boolean): T | undefined;
+    getComponent<T extends IBMiComponent>(name: string, ignoreState?: boolean): T;
+    getComponentStates(): {
+        id: import("../components/component").ComponentIdentification;
+        state: import("../components/component").ComponentState;
+    }[];
     /**
      * Run SQL statements.
      * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).

package/api/Tools.d.ts

@@ -87,4 +87,21 @@ export declare namespace Tools {
      * @returns a Date object
      */
     function parseAttrDate(timestamp: string): number;
+    /**
+     * Transforms a file path into an OS agnostic path.
+     * - Replaces full home directory path by ~
+     * - Replaces all \ into / on Windows
+     *
+     * @param filePath
+     * @returns
+     */
+    function normalizePath(filePath: string): string;
+    /**
+     * Transforms a normalized path into an OS specific path.
+     * - Replaces ~ with the current home directory
+     * - Changes all / to \ on Windows
+     * @param path
+     * @returns
+     */
+    function resolvePath(path: string): string;
 }

package/components/component.d.ts

@@ -4,7 +4,6 @@ export declare type ComponentIdentification = {
     name: string;
     version: number;
 };
-export declare type IBMiComponentType<T extends IBMiComponent> = new (c: IBMi) => T;
 /**
  * Defines a component that is managed per IBM i.
  *
@@ -12,8 +11,8 @@ export declare type IBMiComponentType<T extends IBMiComponent> = new (c: IBMi) =
  *
  * For example, this class:
  * ```
- * class MyIBMIComponent extends IBMiComponent {
- *  //implements getName(), getRemoteState() and update()
+ * class MyIBMIComponent implements IBMiComponent {
+ *  //implements getName, getRemoteState and update
  * }
  * ```
  * Must be registered like this, when the extension providing the component gets activated:
@@ -28,26 +27,17 @@ 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;
+export declare type IBMiComponent = {
     /**
-     * The name of this component; mainly used for display and logging purposes
+     * The identification of this component; name must be unique
      *
      * @returns a human-readable name
      */
-    abstract getIdentification(): ComponentIdentification;
+    getIdentification(): ComponentIdentification;
     /**
      * @returns the component's {@link ComponentState state} on the IBM i
      */
-    protected abstract getRemoteState(): ComponentState | Promise<ComponentState>;
+    getRemoteState(connection: IBMi, installDirectory: string): ComponentState | Promise<ComponentState>;
     /**
      * Called whenever the components needs to be installed or updated, depending on its {@link ComponentState state}.
      *
@@ -55,5 +45,9 @@ export declare abstract class IBMiComponent {
      *
      * @returns the component's {@link ComponentState state} after the update is done
      */
-    protected abstract update(): ComponentState | Promise<ComponentState>;
-}
+    update(connection: IBMi, installDirectory: string): ComponentState | Promise<ComponentState>;
+    /**
+     * Called when connecting to clear every persitent information related to the previous connection
+     */
+    reset?(): void | Promise<void>;
+};

package/components/copyToImport.d.ts

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

package/components/cqsh/index.d.ts

@@ -1,12 +1,14 @@
+import IBMi from "../../api/IBMi";
 import { ComponentState, IBMiComponent } from "../component";
-export declare class cqsh extends IBMiComponent {
+export declare class CustomQSh implements IBMiComponent {
+    static ID: string;
+    installPath: string;
     getIdentification(): {
         name: string;
         version: number;
     };
     getFileName(): string;
-    getPath(): Promise<string>;
-    protected getRemoteState(): Promise<ComponentState>;
-    protected update(): Promise<ComponentState>;
-    testCommand(): Promise<boolean>;
+    getRemoteState(connection: IBMi, installDirectory: string): Promise<ComponentState>;
+    update(connection: IBMi): Promise<ComponentState>;
+    testCommand(connection: IBMi): Promise<boolean>;
 }

package/components/getMemberInfo.d.ts

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

package/components/getNewLibl.d.ts

@@ -1,12 +1,14 @@
+import IBMi from "../api/IBMi";
 import { ComponentState, IBMiComponent } from "./component";
-export declare class GetNewLibl extends IBMiComponent {
+export declare class GetNewLibl implements IBMiComponent {
+    static ID: string;
     getIdentification(): {
         name: string;
         version: number;
     };
-    protected getRemoteState(): Promise<ComponentState>;
-    protected update(): Promise<ComponentState>;
-    getLibraryListFromCommand(ileCommand: string): Promise<{
+    getRemoteState(connection: IBMi): Promise<ComponentState>;
+    update(connection: IBMi): Promise<ComponentState>;
+    getLibraryListFromCommand(connection: IBMi, ileCommand: string): Promise<{
         currentLibrary: string;
         libraryList: string[];
     }>;

package/components/manager.d.ts

@@ -1,10 +1,10 @@
 import vscode from "vscode";
 import IBMi from "../api/IBMi";
-import { ComponentState, IBMiComponent, IBMiComponentType } from "./component";
+import { ComponentState, IBMiComponent } from "./component";
 export declare class ComponentRegistry {
     private readonly components;
-    registerComponent(context: vscode.ExtensionContext, component: IBMiComponentType<any>): void;
-    getComponents(): Map<string, IBMiComponentType<any>[]>;
+    registerComponent(context: vscode.ExtensionContext, component: IBMiComponent): void;
+    getComponents(): Map<string, IBMiComponent[]>;
 }
 export declare const extensionComponentRegistry: ComponentRegistry;
 export declare class ComponentManager {
@@ -16,5 +16,5 @@ export declare class ComponentManager {
         state: ComponentState;
     }[];
     startup(): Promise<void>;
-    get<T extends IBMiComponent>(type: IBMiComponentType<T>, ignoreState?: boolean): T | undefined;
+    get<T extends IBMiComponent>(id: string, ignoreState?: boolean): T;
 }

package/package.json

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

package/typings.d.ts

@@ -74,7 +74,6 @@ export interface ConnectionData {
     port: number;
     username: string;
     password?: string;
-    privateKey?: string;
     privateKeyPath?: string;
     keepaliveInterval?: number;
 }