@halcyontech/vscode-ibmi-types 2.13.0 → 2.13.3

package/api/IBMi.d.ts

@@ -1,8 +1,8 @@
 import * as node_ssh from "node-ssh";
 import * as vscode from "vscode";
-import { ConnectionConfiguration } from "./Configuration";
-import { ComponentId } from "../components/component";
+import { IBMiComponent, IBMiComponentType } from "../components/component";
 import { CommandData, CommandResult, ConnectionData, IBMiMember, RemoteCommand, SpecialAuthorities } from "../typings";
+import { ConnectionConfiguration } from "./Configuration";
 import IBMiContent from "./IBMiContent";
 import { Tools } from './Tools';
 export interface MemberParts extends IBMiMember {
@@ -13,7 +13,7 @@ export default class IBMi {
     private jobCcsid;
     /** User default CCSID is job default CCSID */
     private userDefaultCCSID;
-    private components;
+    private componentManager;
     client: node_ssh.NodeSSH;
     currentHost: string;
     currentPort: number;
@@ -95,7 +95,7 @@ export default class IBMi {
      * @param {string} key Key to the temp file to be re-used
      */
     getTempRemote(key: string): string;
-    parserMemberPath(string: string): MemberParts;
+    parserMemberPath(string: string, checkExtension?: boolean): MemberParts;
     /**
      * @param {string} string
      * @returns {string} result
@@ -127,7 +127,7 @@ export default class IBMi {
      * @param name
      */
     upperCaseName(name: string): string;
-    getComponent<T>(id: ComponentId): T;
+    getComponent<T extends IBMiComponent>(type: IBMiComponentType<T>, ignoreState?: boolean): T | undefined;
     /**
      * Run SQL statements.
      * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).

package/api/IBMiContent.d.ts

@@ -12,7 +12,6 @@ export declare type SortOptions = {
 };
 export default class IBMiContent {
     readonly ibmi: IBMi;
-    private chgJobCCSID;
     constructor(ibmi: IBMi);
     private get config();
     private getTempRemote;
@@ -149,7 +148,7 @@ export default class IBMiContent {
         type: string;
         member?: string;
     }, authorities?: Authority[]): Promise<boolean>;
-    testStreamFile(path: string, right: "f" | "d" | "r" | "w" | "x"): Promise<boolean>;
+    testStreamFile(path: string, right: "e" | "f" | "d" | "r" | "w" | "x"): Promise<boolean>;
     isProtectedPath(path: string): boolean;
     /**
      *
@@ -169,5 +168,11 @@ export default class IBMiContent {
     sourcePhysicalFileToToolTip(path: string, object: IBMiObject): Promise<MarkdownString>;
     memberToToolTip(path: string, member: IBMiMember): MarkdownString;
     ifsFileToToolTip(path: string, ifsFile: IFSFile): MarkdownString;
+    /**
+     * Creates an empty unicode streamfile
+     * @param path the full path to the streamfile
+     * @throws an Error if the file could not be correctly created
+     */
+    createStreamFile(path: string): Promise<void>;
 }
 export {};

package/api/Search.d.ts

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

package/api/Tools.d.ts

@@ -70,6 +70,7 @@ export declare namespace Tools {
     function fixSQL(statement: string, removeComments?: boolean): string;
     function generateTooltipHtmlTable(header: string, rows: Record<string, any>): string;
     function fixWindowsPath(path: string): string;
+    function assumeType(str: string): string | number;
     /**
      * Runs a function while a context value is set to true.
      *
@@ -79,4 +80,10 @@ export declare namespace Tools {
      * @param task the function to run while the context value is `true`
      */
     function withContext<T>(context: string, task: () => Promise<T>): Promise<T>;
+    /**
+     * Converts a timestamp from the attr command (in the form `Thu Dec 21 21:47:02 2023`) into a Date object
+     * @param timestamp an attr timestamp string
+     * @returns a Date object
+     */
+    function parseAttrDate(timestamp: string): number;
 }

package/api/debug/config.d.ts

@@ -1,3 +1,4 @@
+import IBMi from "../IBMi";
 declare type ConfigLine = {
     key: string;
     value?: string;
@@ -31,5 +32,5 @@ interface DebugServiceDetails {
 }
 export declare function resetDebugServiceDetails(): void;
 export declare function getDebugServiceDetails(): Promise<DebugServiceDetails>;
-export declare function getJavaHome(version: string): "/QOpenSys/QIBM/ProdData/JavaVM/jdk11/64bit" | "/QOpenSys/QIBM/ProdData/JavaVM/jdk80/64bit";
+export declare function getJavaHome(connection: IBMi, version: string): string;
 export {};

package/components/component.d.ts

@@ -1,32 +1,56 @@
 import IBMi from "../api/IBMi";
-import { CopyToImport } from "./copyToImport";
-import { GetMemberInfo } from "./getMemberInfo";
-import { GetNewLibl } from "./getNewLibl";
-export declare enum ComponentState {
-    NotChecked = "NotChecked",
-    NotInstalled = "NotInstalled",
-    Installed = "Installed",
-    Error = "Error"
-}
-interface ComponentRegistry {
-    GetNewLibl?: GetNewLibl;
-    CopyToImport?: CopyToImport;
-    GetMemberInfo?: GetMemberInfo;
-}
-export declare type ComponentId = keyof ComponentRegistry;
-export declare abstract class ComponentT {
-    connection: IBMi;
-    state: ComponentState;
-    currentVersion: number;
+export declare type ComponentState = `NotChecked` | `NotInstalled` | `Installed` | `NeedsUpdate` | `Error`;
+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.
+ *
+ * Any class extending  {@link IBMiComponent} needs to register itself in the Component Registry.
+ *
+ * For example, this class:
+ * ```
+ * class MyIBMIComponent extends IBMiComponent {
+ *  //implements getName(), getRemoteState() and update()
+ * }
+ * ```
+ * Must be registered like this, when the extension providing the component gets activated:
+ * ```
+ * export async function activate(context: ExtensionContext) {
+ *   const codeForIBMiExtension = vscode.extensions.getExtension<CodeForIBMi>('halcyontechltd.code-for-ibmi');
+ *   if (codeForIBMiExtension) {
+ *     codeForIBMi = codeForIBMiExtension.isActive ? codeForIBMiExtension.exports : await codeForIBMiExtension.activate();
+ *     codeForIBMi.componentRegistry.registerComponent(context, MyIBMIComponent);
+ *   }
+ * }
+ * ```
+ *
+ */
+export declare abstract class IBMiComponent {
+    protected readonly connection: IBMi;
+    private state;
     constructor(connection: IBMi);
-    abstract getInstalledVersion(): Promise<number | undefined>;
-    abstract checkState(): Promise<boolean>;
-    abstract getState(): ComponentState;
-}
-export declare class ComponentManager {
-    private registered;
-    startup(connection: IBMi): Promise<void>;
-    get<T>(id: ComponentId): T | undefined;
-    private static checkState;
+    getState(): ComponentState;
+    check(): Promise<this>;
+    toString(): string;
+    /**
+     * The name of this component; mainly used for display and logging purposes
+     *
+     * @returns a human-readable name
+     */
+    abstract getIdentification(): ComponentIdentification;
+    /**
+     * @returns the component's {@link ComponentState state} on the IBM i
+     */
+    protected abstract getRemoteState(): ComponentState | Promise<ComponentState>;
+    /**
+     * Called whenever the components needs to be installed or updated, depending on its {@link ComponentState state}.
+     *
+     * The Component Manager is responsible for calling this, so the {@link ComponentState state} doesn't need to be checked here.
+     *
+     * @returns the component's {@link ComponentState state} after the update is done
+     */
+    protected abstract update(): ComponentState | Promise<ComponentState>;
 }
-export {};

package/components/copyToImport.d.ts

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

package/components/getMemberInfo.d.ts

@@ -1,19 +1,15 @@
-import IBMi from "../api/IBMi";
 import { IBMiMember } from "../typings";
-import { ComponentState, ComponentT } from "./component";
-export declare class GetMemberInfo implements ComponentT {
-    connection: IBMi;
-    readonly name = "GETMBRINFO";
-    state: ComponentState;
-    currentVersion: number;
-    constructor(connection: IBMi);
-    getInstalledVersion(): Promise<number>;
-    checkState(): Promise<boolean>;
-    getState(): ComponentState;
-    /**
-     *
-     * @param filter: the criterias used to list the members
-     * @returns
-     */
+import { ComponentState, IBMiComponent } from "./component";
+export declare class GetMemberInfo extends IBMiComponent {
+    private readonly procedureName;
+    private readonly currentVersion;
+    private installedVersion;
+    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>;
 }

package/components/getNewLibl.d.ts

@@ -1,15 +1,13 @@
-import IBMi from "../api/IBMi";
-import { ComponentState, ComponentT } from "./component";
-export declare class GetNewLibl implements ComponentT {
-    connection: IBMi;
-    state: ComponentState;
-    currentVersion: number;
-    constructor(connection: IBMi);
-    getInstalledVersion(): Promise<number>;
-    checkState(): Promise<boolean>;
-    getState(): ComponentState;
+import { ComponentState, IBMiComponent } from "./component";
+export declare class GetNewLibl extends IBMiComponent {
+    getIdentification(): {
+        name: string;
+        version: number;
+    };
+    protected getRemoteState(): Promise<ComponentState>;
+    protected update(): Promise<ComponentState>;
     getLibraryListFromCommand(ileCommand: string): Promise<{
         currentLibrary: string;
         libraryList: string[];
-    } | undefined>;
+    }>;
 }

package/components/manager.d.ts

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

package/package.json

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

package/typings.d.ts

@@ -6,12 +6,14 @@ import { CustomUI } from "./api/CustomUI";
 import Instance from "./api/Instance";
 import { Tools } from "./api/Tools";
 import { DeployTools } from "./api/local/deployTools";
+import { ComponentRegistry } from './components/manager';
 export interface CodeForIBMi {
     instance: Instance;
     customUI: () => CustomUI;
     deployTools: typeof DeployTools;
     evfeventParser: (lines: string[]) => Map<string, FileError[]>;
     tools: typeof Tools;
+    componentRegistry: ComponentRegistry;
 }
 export declare type DeploymentMethod = "all" | "staged" | "unstaged" | "changed" | "compare";
 export interface DeploymentParameters {