@zowe/zosmf-for-zowe-sdk 7.0.0 → 7.1.0

package/lib/constants/Zosmf.constants.d.ts

@@ -1,6 +1,13 @@
+import { ICommandOptionDefinition } from "@zowe/imperative";
 /**
  * Constants to be used by the z/OSMF API
  */
 export declare const ZosmfConstants: {
     [key: string]: any;
 };
+/**
+ * Object containing all options to be used by the Download data set API
+ */
+export declare const ZosFilesOptions: {
+    [key: string]: ICommandOptionDefinition;
+};

package/lib/constants/Zosmf.constants.js

@@ -10,7 +10,7 @@
 *
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ZosmfConstants = void 0;
+exports.ZosFilesOptions = exports.ZosmfConstants = void 0;
 /**
  * Constants to be used by the z/OSMF API
  */
@@ -62,4 +62,23 @@ exports.ZosmfConstants = {
         UNABLE_TO_VERIFY_LEAF_SIGNATURE: "UNABLE_TO_VERIFY_LEAF_SIGNATURE"
     }
 };
+/**
+ * Object containing all options to be used by the Download data set API
+ */
+exports.ZosFilesOptions = {
+    /**
+     * The files timeout header value
+     * @type {ICommandOptionDefinition}
+     */
+    responseTimeout: {
+        name: "response-timeout",
+        aliases: ["rto"],
+        description: "The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response." +
+            " Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600",
+        type: "number",
+        defaultValue: undefined,
+        // eslint-disable-next-line @typescript-eslint/no-magic-numbers
+        numericValueRange: [5, 600]
+    }
+};
 //# sourceMappingURL=Zosmf.constants.js.map

package/lib/constants/Zosmf.constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"Zosmf.constants.js","sourceRoot":"","sources":["../../src/constants/Zosmf.constants.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;AAEF;;GAEG;AACU,QAAA,cAAc,GAA2B;IAClD;;;OAGG;IACH,QAAQ,EAAE,QAAQ;IAElB;;;OAGG;IACH,IAAI,EAAE,OAAO;IAEb;;;OAGG;IACH,QAAQ,EAAE,eAAe;IAEzB;;;OAGG;IACH,OAAO,EAAE,UAAU;IAEnB;;;OAGG;IACH,WAAW,EAAE;QACT;;;WAGG;QACH,aAAa,EAAE,WAAW;QAE1B;;;WAGG;QACH,QAAQ,EAAE,cAAc;QAExB;;;WAGG;QACH,yBAAyB,EAAE,2BAA2B;QAEtD;;;WAGG;QACH,+BAA+B,EAAE,iCAAiC;KACrE;CACJ,CAAC"}
+{"version":3,"file":"Zosmf.constants.js","sourceRoot":"","sources":["../../src/constants/Zosmf.constants.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;AAIF;;GAEG;AACU,QAAA,cAAc,GAA2B;IAClD;;;OAGG;IACH,QAAQ,EAAE,QAAQ;IAElB;;;OAGG;IACH,IAAI,EAAE,OAAO;IAEb;;;OAGG;IACH,QAAQ,EAAE,eAAe;IAEzB;;;OAGG;IACH,OAAO,EAAE,UAAU;IAEnB;;;OAGG;IACH,WAAW,EAAE;QACT;;;WAGG;QACH,aAAa,EAAE,WAAW;QAE1B;;;WAGG;QACH,QAAQ,EAAE,cAAc;QAExB;;;WAGG;QACH,yBAAyB,EAAE,2BAA2B;QAEtD;;;WAGG;QACH,+BAA+B,EAAE,iCAAiC;KACrE;CACJ,CAAC;AAGF;;GAEG;AACU,QAAA,eAAe,GAAgD;IACxE;;;OAGG;IACH,eAAe,EAAE;QACb,IAAI,EAAE,kBAAkB;QACxB,OAAO,EAAE,CAAC,KAAK,CAAC;QAChB,WAAW,EAAE,4GAA4G;YACzH,4GAA4G;QAC5G,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,SAAS;QACvB,+DAA+D;QAC/D,iBAAiB,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC;KAC9B;CACJ,CAAC"}

package/lib/constants/Zosmf.profile.d.ts

@@ -0,0 +1,7 @@
+import { ICommandProfileTypeConfiguration } from "@zowe/imperative";
+/**
+ * Profile configuration for ZOSMF profiles
+ * @type {ICommandProfileTypeConfiguration}
+ * @memberof ZosmfProfile
+ */
+export declare const ZosmfProfile: ICommandProfileTypeConfiguration;

package/lib/constants/Zosmf.profile.js

@@ -0,0 +1,123 @@
+"use strict";
+/*
+* This program and the accompanying materials are made available under the terms of the
+* Eclipse Public License v2.0 which accompanies this distribution, and is available at
+* https://www.eclipse.org/legal/epl-v20.html
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Copyright Contributors to the Zowe Project.
+*
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZosmfProfile = void 0;
+const ZosmfSession_1 = require("../ZosmfSession");
+const Zosmf_constants_1 = require("./Zosmf.constants");
+/**
+ * Profile configuration for ZOSMF profiles
+ * @type {ICommandProfileTypeConfiguration}
+ * @memberof ZosmfProfile
+ */
+exports.ZosmfProfile = {
+    type: "zosmf",
+    schema: {
+        type: "object",
+        title: "z/OSMF Profile",
+        description: "z/OSMF Profile",
+        properties: {
+            host: {
+                type: "string",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_HOST
+            },
+            port: {
+                type: "number",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_PORT,
+                includeInTemplate: true
+            },
+            user: {
+                type: "string",
+                secure: true,
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_USER
+            },
+            password: {
+                type: "string",
+                secure: true,
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_PASSWORD
+            },
+            rejectUnauthorized: {
+                type: "boolean",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_REJECT_UNAUTHORIZED
+            },
+            certFile: {
+                type: "string",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_CERT_FILE
+            },
+            certKeyFile: {
+                type: "string",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_CERT_KEY_FILE
+            },
+            // certFilePassphrase: {
+            //     type: "string",
+            //     secure: true,
+            //     optionDefinition: ZosmfSession.ZOSMF_OPTION_CERT_FILE_PASSPHRASE
+            // },
+            basePath: {
+                type: "string",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_BASE_PATH
+            },
+            protocol: {
+                type: "string",
+                optionDefinition: ZosmfSession_1.ZosmfSession.ZOSMF_OPTION_PROTOCOL
+            },
+            encoding: {
+                type: "string",
+                optionDefinition: {
+                    name: "encoding",
+                    aliases: ["ec"],
+                    description: "The encoding for download and upload of z/OS data set and USS files." +
+                        " The default encoding if not specified is IBM-1047.",
+                    type: "string"
+                }
+            },
+            responseTimeout: {
+                type: "number",
+                optionDefinition: Zosmf_constants_1.ZosFilesOptions.responseTimeout
+            }
+        },
+        required: []
+    },
+    createProfileExamples: [
+        {
+            options: "zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss",
+            description: "Create a zosmf profile called 'zos123' to connect to z/OSMF at host zos123 and port 1443"
+        },
+        {
+            options: "zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false",
+            description: "Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) " +
+                "and allow self-signed certificates"
+        },
+        {
+            options: "zos125 --host zos125 --port 1443",
+            description: "Create a zosmf profile called 'zos125' to connect to z/OSMF at the host zos125 and port 1443, " +
+                " not specifying a username or password so they are not stored on disk; these will need to be specified on every command"
+        },
+        {
+            options: "zos126 --reject-unauthorized false",
+            description: "Create a zosmf profile called 'zos126' to connect to z/OSMF on the default port 443 and allow self-signed " +
+                "certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be " +
+                "specified on every command"
+        },
+        {
+            options: "zosAPIML --host zosAPIML --port 2020 --user ibmuser --password myp4ss --reject-unauthorized false --base-path basePath",
+            description: "Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) " +
+                "and allow self-signed certificates"
+        }
+    ],
+    updateProfileExamples: [
+        {
+            options: "zos123 --user newuser --password newp4ss",
+            description: "Update a zosmf profile named 'zos123' with a new username and password"
+        }
+    ]
+};
+//# sourceMappingURL=Zosmf.profile.js.map

package/lib/constants/Zosmf.profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Zosmf.profile.js","sourceRoot":"","sources":["../../src/constants/Zosmf.profile.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;AAGF,kDAA+C;AAC/C,uDAAoD;AAEpD;;;;GAIG;AACU,QAAA,YAAY,GACzB;IACI,IAAI,EAAE,OAAO;IACb,MAAM,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,gBAAgB;QACvB,WAAW,EAAE,gBAAgB;QAC7B,UAAU,EAAE;YACR,IAAI,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,2BAAY,CAAC,iBAAiB;aACnD;YACD,IAAI,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,2BAAY,CAAC,iBAAiB;gBAChD,iBAAiB,EAAE,IAAI;aAC1B;YACD,IAAI,EAAE;gBACF,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,IAAI;gBACZ,gBAAgB,EAAE,2BAAY,CAAC,iBAAiB;aACnD;YACD,QAAQ,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,IAAI;gBACZ,gBAAgB,EAAE,2BAAY,CAAC,qBAAqB;aACvD;YACD,kBAAkB,EAAE;gBAChB,IAAI,EAAE,SAAS;gBACf,gBAAgB,EAAE,2BAAY,CAAC,gCAAgC;aAClE;YACD,QAAQ,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,2BAAY,CAAC,sBAAsB;aACxD;YACD,WAAW,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,2BAAY,CAAC,0BAA0B;aAC5D;YACD,wBAAwB;YACxB,sBAAsB;YACtB,oBAAoB;YACpB,uEAAuE;YACvE,KAAK;YACL,QAAQ,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,2BAAY,CAAC,sBAAsB;aACxD;YACD,QAAQ,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,2BAAY,CAAC,qBAAqB;aACvD;YACD,QAAQ,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE;oBACd,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE,CAAC,IAAI,CAAC;oBACf,WAAW,EAAE,sEAAsE;wBAC/E,qDAAqD;oBACzD,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,eAAe,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,gBAAgB,EAAE,iCAAe,CAAC,eAAe;aACpD;SACJ;QACD,QAAQ,EAAE,EAAE;KACf;IACD,qBAAqB,EAAE;QACnB;YACI,OAAO,EAAE,mEAAmE;YAC5E,WAAW,EAAE,0FAA0F;SAC1G;QACD;YACI,OAAO,EAAE,mFAAmF;YAC5F,WAAW,EAAE,sGAAsG;gBAC/G,oCAAoC;SAC3C;QACD;YACI,OAAO,EAAE,kCAAkC;YAC3C,WAAW,EAAE,gGAAgG;gBACzG,yHAAyH;SAChI;QACD;YACI,OAAO,EAAE,oCAAoC;YAC7C,WAAW,EAAE,4GAA4G;gBACrH,mHAAmH;gBACnH,4BAA4B;SACnC;QACD;YACI,OAAO,EAAE,wHAAwH;YACjI,WAAW,EAAE,sGAAsG;gBAC/G,oCAAoC;SAC3C;KACJ;IACD,qBAAqB,EAAE;QACnB;YACI,OAAO,EAAE,0CAA0C;YACnD,WAAW,EAAE,wEAAwE;SACxF;KACJ;CACJ,CAAC"}

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./constants/Zosmf.constants";
 export * from "./constants/Zosmf.messages";
+export * from "./constants/Zosmf.profile";
 export * from "./doc/IDefinedSystem";
 export * from "./doc/IZosmfInfoResponse";
 export * from "./doc/IZosmfListDefinedSystemsResponse";

package/lib/index.js

@@ -22,6 +22,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./constants/Zosmf.constants"), exports);
 __exportStar(require("./constants/Zosmf.messages"), exports);
+__exportStar(require("./constants/Zosmf.profile"), exports);
 __exportStar(require("./doc/IDefinedSystem"), exports);
 __exportStar(require("./doc/IZosmfInfoResponse"), exports);
 __exportStar(require("./doc/IZosmfListDefinedSystemsResponse"), exports);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;;AAEF,8DAA4C;AAC5C,6DAA2C;AAE3C,uDAAqC;AACrC,2DAAyC;AACzC,yEAAuD;AACvD,yDAAuC;AAEvC,gDAA8B;AAC9B,uDAAqC;AACrC,qDAAmC;AACnC,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;EASE;;;;;;;;;;;;AAEF,8DAA4C;AAC5C,6DAA2C;AAC3C,4DAA0C;AAE1C,uDAAqC;AACrC,2DAAyC;AACzC,yEAAuD;AACvD,yDAAuC;AAEvC,gDAA8B;AAC9B,uDAAqC;AACrC,qDAAmC;AACnC,iDAA+B"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@zowe/zosmf-for-zowe-sdk",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Zowe SDK to interact with the z/OS Management Facility",
-  "author": "Broadcom",
+  "author": "Zowe",
   "license": "EPL-2.0",
   "homepage": "https://github.com/zowe/zowe-cli/tree/master/packages/zosmf#readme",
   "bugs": {
@@ -44,9 +44,9 @@
   },
   "devDependencies": {
     "@types/node": "^12.12.24",
-    "@zowe/cli-test-utils": "7.0.0",
-    "@zowe/core-for-zowe-sdk": "7.0.0",
-    "@zowe/imperative": "5.0.0",
+    "@zowe/cli-test-utils": "7.1.0",
+    "@zowe/core-for-zowe-sdk": "7.1.0",
+    "@zowe/imperative": "5.1.0",
     "eslint": "^7.32.0",
     "madge": "^4.0.1",
     "rimraf": "^2.6.3",