V3 Conformance + zos-node-accessor update

.eslintrc.yaml

@@ -0,0 +1,51 @@
+env:
+    es2021: true
+    node: true
+extends:
+    - eslint:recommended
+    - plugin:@typescript-eslint/recommended
+ignorePatterns:
+    - "**/*.js"
+    - "**/*.d.ts"
+overrides:
+    - extends:
+        - "plugin:jest/recommended"
+      files:
+        - "**/__tests__/**/*.ts"
+      rules:
+        jest/expect-expect: ["warn", { "assertFunctionNames": ["expect*", "**.*expect*"] }]
+        jest/no-conditional-expect: off
+        jest/no-standalone-expect: off
+        jest/no-try-expect: off
+        unused-imports/no-unused-vars: off
+        "@typescript-eslint/no-explicit-any": off
+        "@typescript-eslint/no-magic-numbers": off
+parser: "@typescript-eslint/parser"
+parserOptions:
+    ecmaVersion: 12
+    sourceType: module
+plugins:
+    - "@typescript-eslint"
+    - jest
+    - unused-imports
+rules:
+    max-len: ["warn", 150]
+    no-console: error
+    no-multiple-empty-lines: warn
+    no-trailing-spaces: warn
+    "@typescript-eslint/ban-types": off
+    "@typescript-eslint/comma-dangle": ["warn", "only-multiline"]
+    "@typescript-eslint/explicit-module-boundary-types": off
+    "@typescript-eslint/indent": ["warn", 4]
+    "@typescript-eslint/no-explicit-any": warn
+    "@typescript-eslint/no-inferrable-types": off
+    "@typescript-eslint/no-magic-numbers": ["warn", {
+        "ignore": [-1, 0, 1, 2],
+        "ignoreDefaultValues": true,
+        "ignoreReadonlyClassProperties": true
+    }]
+    "@typescript-eslint/no-unused-vars": off
+    "@typescript-eslint/no-var-requires": off
+    "@typescript-eslint/semi": warn
+    "unused-imports/no-unused-imports": warn
+    "unused-imports/no-unused-vars": ["warn", { "args": "none" }]

CHANGELOG.md

@@ -2,6 +2,76 @@
 
 All notable changes to the z/OS FTP Plug-in for Zowe CLI will be documented in this file.
 
+## Recent Changes
+
+- Major: Zowe V3 release
+
+- **Enhancements**:
+  - The following properties, interfaces, and/or functions were added:
+    - `IListJobOption.jobName`
+    - `IListJobOption.jobId`
+    - `ITransferMode`
+      - For a full list of transfer modes, see [TransferMode by `zos-node-accessor`](https://github.com/IBM/zos-node-accessor/blob/faf55873f37cc40e927f1b1c19f697de8cf08b95/src/zosAccessor.ts#L67)
+    - `IConnectionOption`
+      - For a full list of transfer modes, see [ConnectionOption by `zos-node-accessor`](https://github.com/IBM/zos-node-accessor/blob/faf55873f37cc40e927f1b1c19f697de8cf08b95/src/interfaces/ConnectionOption.ts#L17)
+    - `IDatasetEntry`
+      - For a full list of transfer modes, see [DatasetEntry by `zos-node-accessor`](https://github.com/IBM/zos-node-accessor/blob/faf55873f37cc40e927f1b1c19f697de8cf08b95/src/interfaces/DatasetEntry.ts#L17)
+    - `IUSSEntry`
+      - For a full list of transfer modes, see [USSEntry by `zos-node-accessor`](https://github.com/IBM/zos-node-accessor/blob/faf55873f37cc40e927f1b1c19f697de8cf08b95/src/interfaces/USSEntry.ts#L19)
+- **Breaking**:
+  - Removed the following constants, interfaces, and other values:
+    - `IGetSpoolFileOption.jobName`
+    - `JobUtils.parseJobDetails`
+  - Added proper typing to the parameters of the following functions:
+    - `CoreUtils.addLowerCaseKeysToObject`
+      - Return type changed: `any --> IDatasetEntry`
+    - `CreateDataset.create`
+    - `DataSetUtils.listDataSets`
+    - `FTPConfig.connectFromArguments`
+      - Return type changed: `Promise<any> --> Promise<ZosAccessor>`
+    - `FTPConfig.createConfigFromArguments`
+      - Return type changed: `any --> IConnectionOption`
+    - `JobUtils.getSpoolFileContent`
+      - Return type changed: `Promise<Buffer> --> Promise<string>`
+    - `JobUtils.getSpoolFiles`
+    - `JobUtils.submitJob`
+    - `JobUtils.submitJobFromDataset`
+    - `JobUtils.findJobByID`
+    - `JobUtils.listJobs`
+    - `JobUtils.deleteJob`
+    - `UssUtils.listFiles`
+      - Return type changed: `Promise<any[]> --> Promise<IUSSEntry[]>`
+    - `UssUtils.makeDirectory`
+    - `UssUtils.renameFile`
+    - `UssUtils.deleteFile`
+    - `UssUtils.downloadFile`
+    - `UssUtils.uploadFile`
+    - `UssUtils.deleteDirectory`
+    - `DataSetUtils.listDataSets`
+      - Return type changed: `Promise<any[]> --> Promise<IDatasetEntry[]>`
+    - `DataSetUtils.listMembers`
+      - Return type changed: `Promise<any[]> --> Promise<IDatasetEntry[]>`
+    - `DataSetUtils.deleteDataSet`
+    - `DataSetUtils.renameDataSet`
+    - `DataSetUtils.downloadDataSet`
+    - `DataSetUtils.uploadDataSet`
+    - `DataSetUtils.allocateDataSet`
+    - `AbstractTemplatedJCL.getJcl`
+  - The properties in the interfaces below have changed:
+    - `IDownloadFileOption.transferType?: string` to `IDownloadFileOption.transferType?: ITransferMode`
+    - `IUploadFileOption.transferType?: string` to `IUploadFileOption.transferType?: ITransferMode`
+    - `IUploadDataSetOption.transferType?: string` to `IUploadDataSetOption.transferType?: ITransferMode`
+    - `ISpoolFile.id: string` to `ISpoolFile.id: number`
+    - `ISpoolFile.stepname: string` to `ISpoolFile.stepName: string`
+    - `ISpoolFile.procstep: string` to `ISpoolFile.procStep: string`
+    - `ISpoolFile.ddname: string` to `ISpoolFile.ddName: string`
+    - `ISpoolFile.ddname: string` to `ISpoolFile.ddName: string`
+    - `IJobStatus.jobname: string` to `IJobStatus.jobName: string`
+    - `IJobStatus.jobid: string` to `IJobStatus.jobId: string`
+    - `IJob.jobname: string` to `IJob.jobName: string`
+    - `IJob.jobid: string` to `IJob.jobId: string`
+    - `IGetSpoolFileOption.fileId: string` to `IGetSpoolFileOption.fileId: number`
+    -
 
 ## `2.1.8`
 

README.md

@@ -87,26 +87,27 @@ Before you install the plug-in, meet the following requirements:
 
 5.  [Create a user profile](#create-a-user-profile).
 
-## Create a User Profile
+## Creating a user profile
 
-You can create a `zftp` user profile to avoid typing your connection details on every command. A `zftp` profile contains the host, port, username, and password for the z/OS you will connect. You can create multiple profiles and switch between them as needed.
+After you install the plug-in, you create an FTP profile. An FTP profile is recommended to issue commands to via FTP. FTP profiles contain your host, port, user name, and password for connect to z/OS using FTP. You can create multiple profiles and switch between them as needed.
 
 **Follow these steps:**
-1.  Create a zftp profile:
+1.  Install the z/OS FTP Plug-in for Zowe CLI
+2.  Create an FTP profile:
 
     ```
-    zowe profiles create zftp <profile name> -H <host> -u <user> -p <password> -P <port> --secure-ftp true
+    zowe config init
     ```
+3.  If using a non-standard port, set the port number to your FTP connection:
 
-    The result of the command displays as a success or failure message. You can use your profile when you issue commands in the zftp command group.
-
-**Notice** The option `--secure-ftp true` is strongly recommended if FTPS (FTP over SSL) is enabled in z/OS FTP service. This is not the same as SFTP (FTP over SSH).
-
-**Tip:** For more information about the syntax, actions, and options, for a profiles create command, open Zowe CLI and issue the following command:
+    ```
+    zowe config set profiles.zftp.properties.port <port number>
+    ```
+4. If using a insecure connection, set the secureFtp value to false:
 
-```
-zowe profiles create zftp -h
-```
+    ```
+    zowe config set profiles.zftp.properties.secureFtp false
+    ```
 
 ## Running tests