@halcyontech/vscode-ibmi-types 2.1.1 → 2.3.0

package/api/CompileTools.d.ts

@@ -1,4 +1,4 @@
-import vscode from 'vscode';
+import vscode, { EventEmitter } from 'vscode';
 import { Action, CommandResult, DeploymentMethod, RemoteCommand } from '../typings';
 import Instance from './Instance';
 export interface ILELibrarySettings {
@@ -7,9 +7,9 @@ export interface ILELibrarySettings {
 }
 export declare namespace CompileTools {
     function register(context: vscode.ExtensionContext): void;
-    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod): Promise<void>;
+    function runAction(instance: Instance, uri: vscode.Uri, customAction?: Action, method?: DeploymentMethod): Promise<boolean>;
     /**
      * Execute a command
      */
-    function runCommand(instance: Instance, options: RemoteCommand, title?: string): Promise<CommandResult | null>;
+    function runCommand(instance: Instance, options: RemoteCommand, writeEvent?: EventEmitter<string>): Promise<CommandResult | null>;
 }

package/api/Configuration.d.ts

@@ -1,7 +1,8 @@
-/// <reference types="vscode" />
+import * as vscode from 'vscode';
 export declare type SourceDateMode = "edit" | "diff";
+export declare function onCodeForIBMiConfigurationChange<T>(props: string | string[], todo: (value: vscode.ConfigurationChangeEvent) => void): vscode.Disposable;
 export declare namespace GlobalConfiguration {
-    function get<T>(prop: string): T | undefined;
+    function get<T>(key: string): T | undefined;
     function set(key: string, value: any): Thenable<void>;
 }
 export declare namespace ConnectionConfiguration {

package/api/CustomUI.d.ts

@@ -1,4 +1,7 @@
 import vscode from 'vscode';
+declare type PanelOptions = {
+    fullWidth?: boolean;
+};
 export interface Page<T> {
     panel: vscode.WebviewPanel;
     data?: T;
@@ -42,10 +45,11 @@ export declare class Section {
     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;
-    addButtons(...buttons: Button[]): this;
+    addButtons(...buttons: (Button | undefined)[]): this;
     addField(field: Field): this;
 }
 export declare class CustomUI extends Section {
+    private options?;
     /**
      * 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).
@@ -55,6 +59,7 @@ export declare class CustomUI extends Section {
      * @returns a Promise<Page<T>> if no callback is provided
      */
     loadPage<T>(title: string, callback?: (page: Page<T>) => void): Promise<Page<T>> | undefined;
+    setOptions(options: PanelOptions): this;
     private createPage;
     private getHTML;
 }
@@ -101,3 +106,4 @@ export declare class Field {
     private renderLabel;
     private renderDescription;
 }
+export {};

package/api/IBMiContent.d.ts

@@ -2,6 +2,7 @@ import { IBMiError, IBMiFile, IBMiMember, IBMiObject, IFSFile, QsysPath } from '
 import { default as IBMi } from './IBMi';
 import { Tools } from './Tools';
 declare type Authority = "*ADD" | "*DLT" | "*EXECUTE" | "*READ" | "*UPD" | "*NONE" | "*ALL" | "*CHANGE" | "*USE" | "*EXCLUDE" | "*AUTLMGT";
+export declare type SortOrder = `name` | `type`;
 export declare type SortOptions = {
     order: "name" | "date" | "?";
     ascending?: boolean;
@@ -65,7 +66,7 @@ export default class IBMiContent {
         library: string;
         object?: string;
         types?: string[];
-    }, sortOrder?: `name` | `type`): Promise<IBMiFile[]>;
+    }, sortOrder?: SortOrder): Promise<IBMiFile[]>;
     /**
      * @param lib
      * @param spf

package/api/Search.d.ts

@@ -10,6 +10,6 @@ export declare namespace Search {
         number: number;
         content: string;
     }
-    function searchMembers(instance: Instance, library: string, sourceFile: string, memberFilter: string, searchTerm: string, filter?: string): Promise<Result[]>;
+    function searchMembers(instance: Instance, library: string, sourceFile: string, memberFilter: string, searchTerm: string, readOnly?: boolean): Promise<Result[]>;
     function searchIFS(instance: Instance, path: string, searchTerm: string): Promise<Result[]>;
 }

package/api/Storage.d.ts

@@ -56,6 +56,8 @@ export declare class GlobalStorage extends Storage {
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;
+    getPreviousSearchTerms(): string[];
+    setPreviousSearchTerms(previousSearchTerms: string[]): Promise<void>;
 }
 export declare class ConnectionStorage extends Storage {
     private connectionName;

package/api/Tools.d.ts

@@ -39,4 +39,5 @@ export declare namespace Tools {
     function getGitAPI(): API | undefined;
     function distinct(value: any, index: number, array: any[]): boolean;
     function md5Hash(file: vscode.Uri): string;
+    function capitalize(text: string): string;
 }

package/api/errors/handler.d.ts

@@ -0,0 +1,29 @@
+import { FileError } from "../../typings";
+export declare enum RecordType {
+    TIMESTAMP = "TIMESTAMP",
+    PROCESSOR = "PROCESSOR",
+    FILE_ID = "FILEID",
+    FILE_ID_CONT = "FILEIDCONT",
+    FILE_END = "FILEEND",
+    ERROR_INFORMATION = "ERROR",
+    EXPANSION = "EXPANSION",
+    PROGRAM = "PROGRAM",
+    MAP_DEFINE = "MAPDEFINE",
+    MAP_START = "MAPSTART",
+    MAP_END = "MAPEND",
+    FEEDBACK_CODE = "FEEDBACK"
+}
+export interface FileId {
+    version: number;
+    sourceId: number;
+    line: number;
+    length: number;
+    filename: string;
+    sourcefileTimestamp: number;
+    tempFlag: number;
+}
+export declare function formatName(input: string): string;
+export declare function formatIFS(path: string): string;
+export declare function parseErrors(lines: string[]): Map<string, FileError[]>;
+export declare function getLinesByRecodType(lines: string[], recordType: RecordType, sourceFileId?: number): string[];
+export declare function getSourcePath(lines: string[], fileId: number): string;

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/package.json

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

package/typings.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="node" />
-import { WorkspaceFolder } from "vscode";
-import Instance from "./api/Instance";
 import { Ignore } from 'ignore';
+import { ProviderResult, TreeItem, TreeItemCollapsibleState, WorkspaceFolder } from "vscode";
+import { ConnectionConfiguration } from './api/Configuration';
 import { CustomUI } from "./api/CustomUI";
+import Instance from "./api/Instance";
 import { Tools } from "./api/Tools";
 import { DeployTools } from "./api/local/deployTools";
 export interface CodeForIBMi {
@@ -28,6 +29,7 @@ export interface StandardIO {
  * External interface for extensions to call `code-for-ibmi.runCommand`
  */
 export interface RemoteCommand {
+    title?: string;
     command: string;
     environment?: "ile" | "qsh" | "pase";
     cwd?: string;
@@ -44,11 +46,13 @@ export interface CommandResult {
     stderr: string;
     command?: string;
 }
+export declare type ActionType = "member" | "streamfile" | "object" | "file";
+export declare type ActionEnvironment = "ile" | "qsh" | "pase";
 export interface Action {
     name: string;
     command: string;
-    type?: "member" | "streamfile" | "object" | "file";
-    environment: "ile" | "qsh" | "pase";
+    type?: ActionType;
+    environment: ActionEnvironment;
     extensions?: string[];
     deployFirst?: boolean;
     postDownload?: string[];
@@ -59,7 +63,7 @@ export interface ConnectionData {
     port: number;
     username: string;
     password?: string;
-    privateKey: string | null;
+    privateKeyPath?: string;
     keepaliveInterval?: number;
 }
 export interface Server {
@@ -104,10 +108,6 @@ export interface IBMiError {
     code: string;
     text: string;
 }
-export interface Filter {
-    library: string;
-    filter: string;
-}
 export interface FileError {
     sev: number;
     lineNum: number;
@@ -121,6 +121,38 @@ export interface QsysFsOptions {
     readonly?: boolean;
 }
 export declare type IBMiEvent = "connected" | "disconnected" | "deployLocation" | "deploy";
-export interface Library {
+export interface WithPath {
     path: string;
 }
+export interface Library extends WithPath {
+}
+export declare type FocusOptions = {
+    select?: boolean;
+    focus?: boolean;
+    expand?: boolean | number;
+};
+export declare type BrowserItemParameters = {
+    icon?: string;
+    state?: TreeItemCollapsibleState;
+    parent?: BrowserItem;
+};
+export declare class BrowserItem extends TreeItem {
+    readonly params?: BrowserItemParameters;
+    constructor(label: string, params?: BrowserItemParameters);
+    get parent(): BrowserItem;
+    getChildren?(): ProviderResult<BrowserItem[]>;
+    refresh?(): void;
+    reveal?(options?: FocusOptions): Thenable<void>;
+}
+export interface FilteredItem {
+    filter: ConnectionConfiguration.ObjectFilters;
+}
+export interface ObjectItem extends FilteredItem, WithPath {
+    object: IBMiObject;
+}
+export interface SourcePhysicalFileItem extends FilteredItem, WithPath {
+    sourceFile: IBMiFile;
+}
+export interface MemberItem extends FilteredItem, WithPath {
+    member: IBMiMember;
+}