@halcyontech/vscode-ibmi-types 2.6.5 → 2.7.0

package/api/Configuration.d.ts

@@ -1,5 +1,6 @@
 import * as vscode from 'vscode';
 import { DeploymentMethod } from '../typings';
+import { FilterType } from './Filter';
 export declare type SourceDateMode = "edit" | "diff";
 export declare type DefaultOpenMode = "browse" | "edit";
 export declare function onCodeForIBMiConfigurationChange<T>(props: string | string[], todo: (value: vscode.ConfigurationChangeEvent) => void): vscode.Disposable;
@@ -39,10 +40,12 @@ export declare namespace ConnectionConfiguration {
         quickConnect: boolean;
         defaultDeploymentMethod: DeploymentMethod | '';
         protectedPaths: string[];
+        showHiddenFiles: boolean;
         [name: string]: any;
     }
     interface ObjectFilters {
         name: string;
+        filterType: FilterType;
         library: string;
         object: string;
         types: string[];

package/api/Filter.d.ts

@@ -0,0 +1,13 @@
+declare type Filter = {
+    test: (text: string) => boolean;
+    noFilter: boolean;
+};
+export declare type FilterType = 'simple' | 'regex';
+export declare function parseFilter(filterString?: string, type?: FilterType): Filter;
+/**
+ * Return filterString if it is a single, generic name filter (e.g. QSYS*)
+ * @param filterString
+ * @returns filterString if it is a single generic name or undefined otherwise
+ */
+export declare function singleGenericName(filterString?: string): string;
+export {};

package/api/IBMi.d.ts

@@ -19,7 +19,8 @@ export default class IBMi {
     aspInfo: {
         [id: number]: string;
     };
-    qccsid: number | null;
+    qccsid: number;
+    defaultCCSID: number;
     remoteFeatures: {
         [name: string]: string | undefined;
     };

package/api/IBMiContent.d.ts

@@ -1,21 +1,43 @@
-import { IBMiError, IBMiFile, IBMiMember, IBMiObject, IFSFile, QsysPath } from '../typings';
+/// <reference types="node" />
+import { IBMiError, IBMiMember, IBMiObject, IFSFile, QsysPath } from '../typings';
+import { FilterType } from './Filter';
 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" | "?";
+    order: "name" | "date";
     ascending?: boolean;
 };
 export default class IBMiContent {
     readonly ibmi: IBMi;
+    private chgJobCCSID;
     constructor(ibmi: IBMi);
     private get config();
     private getTempRemote;
     private getNotUTF8CCSID;
     private convertToUTF8;
+    /**
+     *
+     * @param remotePath Remote IFS path
+     * @param localPath Local path to download file to
+     */
+    downloadStreamfileRaw(remotePath: string, localPath?: string): Promise<Buffer>;
+    /**
+     * @deprecated Use downloadStreamfileRaw instead
+     */
     downloadStreamfile(remotePath: string, localPath?: string): Promise<string>;
-    writeStreamfile(originalPath: any, content: any): Promise<string | void>;
+    /**
+     * @param originalPath
+     * @param content Raw content
+     * @param encoding Optional encoding to write.
+     */
+    writeStreamfileRaw(originalPath: string, content: Uint8Array, encoding?: string): Promise<string | void>;
+    /**
+     * Write utf8 content to a streamfile
+     * @deprecated Use writeStreamfileRaw instead
+     */
+    writeStreamfile(originalPath: string, content: string): Promise<string | void>;
     /**
      * Download the contents of a source member
      */
@@ -25,11 +47,14 @@ export default class IBMiContent {
      */
     uploadMemberContent(asp: string | undefined, library: string, sourceFile: string, member: string, content: string | Uint8Array): Promise<boolean>;
     /**
-     * Run an SQL statement
-     * @param statement
+     * Run SQL statements.
+     * Each statement must be separated by a semi-colon and a new line (i.e. ;\n).
+     * If a statement starts with @, it will be run as a CL command.
+     *
+     * @param statements
      * @returns a Result set
      */
-    runSQL(statement: string): Promise<Tools.DB2Row[]>;
+    runSQL(statements: string): Promise<Tools.DB2Row[]>;
     /**
      * @param ileCommand Command that would change the library list, like CHGLIBL
      */
@@ -44,7 +69,14 @@ export default class IBMiContent {
      * @param member Will default to file provided
      * @param deleteTable Will delete the table after download
      */
-    getTable(library: string, file: string, member: string, deleteTable?: boolean): Promise<Tools.DB2Row[]>;
+    getTable(library: string, file: string, member?: string, deleteTable?: boolean): Promise<Tools.DB2Row[]>;
+    /**
+     * Prepare a table in QTEMP using any number of preparation queries and return its content.
+     * @param prepareQueries : SQL statements that should create a table in QTEMP
+     * @param table : the name of the table expected to be found in QTEMP
+     * @returns : the table's content
+     */
+    getQTempTable(prepareQueries: string[], table: string): Promise<Tools.DB2Row[]>;
     /**
      * Get list of libraries with description and attribute
      * @param libraries Array of libraries to retrieve
@@ -57,6 +89,10 @@ export default class IBMiContent {
      * @returns Bad libraries
      */
     validateLibraryList(newLibl: string[]): Promise<string[]>;
+    getLibraries(filters: {
+        library: string;
+        filterType?: FilterType;
+    }): Promise<IBMiObject[]>;
     /**
      * @param filters
      * @param sortOrder
@@ -66,14 +102,21 @@ export default class IBMiContent {
         library: string;
         object?: string;
         types?: string[];
-    }, sortOrder?: SortOrder): Promise<IBMiFile[]>;
+        filterType?: FilterType;
+    }, sortOrder?: SortOrder): Promise<IBMiObject[]>;
     /**
-     * @param lib
-     * @param spf
-     * @param mbr
-     * @returns an array of IBMiMember
+     *
+     * @param filter: the criterias used to list the members
+     * @returns
      */
-    getMemberList(lib: string, spf: string, mbr?: string, ext?: string, sort?: SortOptions): Promise<IBMiMember[]>;
+    getMemberList(filter: {
+        library: string;
+        sourceFile: string;
+        members?: string;
+        extensions?: string;
+        sort?: SortOptions;
+        filterType?: FilterType;
+    }): Promise<IBMiMember[]>;
     /**
      * Get list of items in a path
      * @param remotePath
@@ -83,13 +126,6 @@ export default class IBMiContent {
     memberResolve(member: string, files: QsysPath[]): Promise<IBMiMember | undefined>;
     objectResolve(object: string, libraries: string[]): Promise<string | undefined>;
     streamfileResolve(names: string[], directories: string[]): Promise<string | undefined>;
-    /**
-     * Fix Comments in an SQL string so that the comments always start at position 0 of the line.
-     * Required to work with QZDFMDB2.
-     * @param inSql; sql statement
-     * @returns correctly formattted sql string containing comments
-     */
-    private fixCommentsInSQLString;
     /**
      * @param errorsString; several lines of `code:text`...
      * @returns errors
@@ -112,8 +148,18 @@ export default class IBMiContent {
         library: string;
         name: string;
         type: string;
-    }, ...authorities: Authority[]): Promise<boolean>;
+        member?: string;
+    }, authorities?: Authority[]): Promise<boolean>;
     testStreamFile(path: string, right: "r" | "w" | "x"): Promise<boolean>;
     isProtectedPath(path: string): boolean;
+    /**
+     *
+     * @param command Optionally qualified CL command
+     * @param parameters A key/value object of parameters
+     * @returns Formatted CL string
+     */
+    static toCl(command: string, parameters: {
+        [parameter: string]: string | number | undefined;
+    }): string;
 }
 export {};

package/api/Storage.d.ts

@@ -29,6 +29,7 @@ export declare type CachedServerSettings = {
     badDataAreasChecked: boolean | null;
     libraryListValidated: boolean | null;
     pathChecked?: boolean;
+    defaultCCSID: number | null;
 } | undefined;
 export declare class GlobalStorage extends Storage {
     private static instance;
@@ -55,6 +56,7 @@ export declare class GlobalStorage extends Storage {
         badDataAreasChecked: boolean;
         libraryListValidated: boolean;
         pathChecked?: boolean;
+        defaultCCSID: number;
     };
     setServerSettingsCache(name: string, serverSettings: CachedServerSettings): Promise<void>;
     deleteServerSettingsCache(name: string): Promise<void>;

package/api/Tools.d.ts

@@ -44,4 +44,17 @@ export declare namespace Tools {
     function sanitizeLibraryNames(libraries: string[]): string[];
     function parseMessages(output: string): IBMiMessages;
     function parseQSysPath(path: string): QsysPath;
+    /**
+     * We do this to find previously opened files with the same path, but different case OR readonly flags.
+     * Without this, it's possible for the same document to be opened twice simply due to the readonly flag.
+     */
+    function findExistingDocumentUri(uri: vscode.Uri): vscode.Uri;
+    /**
+     * Fixes an SQL statement to make it compatible with db2 CLI program QZDFMDB2.
+     * - Changes `@clCommand` statements into Call `QSYS2.QCMDEX('clCommand')` procedure calls
+     * - Makes sure each comment (`--`) starts on a new line
+     * @param statement the statement to fix
+     * @returns statement compatible with QZDFMDB2
+     */
+    function fixSQL(statement: string): string;
 }

package/api/local/git.d.ts

@@ -0,0 +1,3 @@
+import { ExtensionContext, WorkspaceFolder } from "vscode";
+export declare function getGitBranch(workspaceFolder: WorkspaceFolder): string;
+export declare function setupGitEventHandler(context: ExtensionContext): void;

package/package.json

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

package/typings.d.ts

@@ -85,10 +85,9 @@ export interface QsysPath {
 export interface IBMiObject extends QsysPath {
     type: string;
     text: string;
+    sourceFile?: boolean;
     attribute?: string;
-}
-export interface IBMiFile extends IBMiObject {
-    count?: number;
+    memberCount?: number;
 }
 export interface IBMiMember {
     library: string;
@@ -157,7 +156,7 @@ export interface ObjectItem extends FilteredItem, WithPath {
     object: IBMiObject;
 }
 export interface SourcePhysicalFileItem extends FilteredItem, WithPath {
-    sourceFile: IBMiFile;
+    sourceFile: IBMiObject;
 }
 export interface MemberItem extends FilteredItem, WithPath {
     member: IBMiMember;