standardise cics profile definition for CLI and VSCE

Signed-off-by: Andrew Twydell <[email protected]>

Author: AndrewTwydell

packages/cli/src/imperative.ts

@@ -11,8 +11,8 @@
 
 // Imperative version of Zowe CLI
 import { IImperativeConfig } from "@zowe/imperative";
-import { CicsSession } from "./CicsSession";
 import { PluginConstants } from "./PluginConstants";
+import { getCICSProfileDefinition } from "@zowe/cics-for-zowe-sdk";
 
 const config: IImperativeConfig = {
   commandModuleGlobs: ["*/*.definition!(.d).*s"],
@@ -27,85 +27,7 @@ const config: IImperativeConfig = {
   //     }
   // ],
   profiles: [
-    {
-      type: "cics",
-      schema: {
-        type: "object",
-        title: "CICS Profile",
-        description:
-          "A cics profile is required to issue commands in the cics command group that interact with " +
-          "CICS regions. The cics profile contains your host, port, user name, and password " +
-          "for the IBM CICS management client interface (CMCI) server of your choice.",
-        properties: {
-          host: {
-            type: "string",
-            optionDefinition: {
-              name: "host",
-              aliases: ["H"],
-              description: "The CMCI server host name",
-              type: "string",
-            },
-          },
-          port: {
-            type: "number",
-            optionDefinition: {
-              name: "port",
-              aliases: ["P"],
-              description: "The CMCI server port",
-              type: "number",
-              defaultValue: 1490,
-            },
-          },
-          user: {
-            type: "string",
-            secure: true,
-            optionDefinition: {
-              name: "user",
-              aliases: ["u"],
-              description: "Your username to connect to CICS",
-              type: "string",
-              implies: ["password"],
-            },
-          },
-          password: {
-            type: "string",
-            secure: true,
-            optionDefinition: {
-              name: "password",
-              aliases: ["p"],
-              description: "Your password to connect to CICS",
-              type: "string",
-              implies: ["user"],
-            },
-          },
-          regionName: {
-            type: "string",
-            optionDefinition: {
-              name: "region-name",
-              description: "The name of the CICS region name to interact with",
-              type: "string",
-            },
-          },
-          cicsPlex: {
-            type: "string",
-            optionDefinition: {
-              name: "cics-plex",
-              description: "The name of the CICSPlex to interact with",
-              type: "string",
-            },
-          },
-          rejectUnauthorized: {
-            type: "boolean",
-            optionDefinition: CicsSession.CICS_OPTION_REJECT_UNAUTHORIZED,
-          },
-          protocol: {
-            type: "string",
-            optionDefinition: CicsSession.CICS_OPTION_PROTOCOL,
-          },
-        },
-        required: [],
-      },
-    },
+    getCICSProfileDefinition(),
   ],
 };
 

packages/vsce/src/utils/profileDefinition.ts packages/sdk/src/constants/CICSProfileDefinition.ts

@@ -11,8 +11,8 @@
 
 import { imperative } from "@zowe/zowe-explorer-api";
 
-const cicsProfileMeta: imperative.ICommandProfileTypeConfiguration[] = [
-  {
+export const getCICSProfileDefinition = (): imperative.ICommandProfileTypeConfiguration => {
+  return {
     type: "cics",
     schema: {
       type: "object",
@@ -105,7 +105,5 @@ const cicsProfileMeta: imperative.ICommandProfileTypeConfiguration[] = [
       },
       required: [],
     },
-  },
-];
-
-export default cicsProfileMeta;
+  };
+};

packages/sdk/src/constants/index.ts

@@ -11,3 +11,4 @@
 
 export * from "./CicsCmci.constants";
 export * from "./CicsCmci.messages";
+export * from "./CICSProfileDefinition";

packages/vsce/src/utils/profileManagement.ts

@@ -9,14 +9,13 @@
  *
  */
 
-import { CicsCmciConstants, CicsCmciRestError, getCache } from "@zowe/cics-for-zowe-sdk";
+import { CicsCmciConstants, CicsCmciRestError, getCache, getCICSProfileDefinition } from "@zowe/cics-for-zowe-sdk";
 import { Session } from "@zowe/imperative";
 import { Gui, MessageSeverity, Types, ZoweVsCodeExtension, imperative } from "@zowe/zowe-explorer-api";
 import { CICSPlexTree } from "../trees/CICSPlexTree";
 import { toArray } from "./commandUtils";
 import constants from "./constants";
 import { getBestCICSplexes } from "./plexUtils";
-import cicsProfileMeta from "./profileDefinition";
 import { runGetResource } from "./resourceUtils";
 
 export class ProfileManagement {
@@ -33,7 +32,7 @@ export class ProfileManagement {
   }
 
   public static async registerCICSProfiles() {
-    await ProfileManagement.zoweExplorerAPI.getExplorerExtenderApi().initForZowe("cics", cicsProfileMeta);
+    await ProfileManagement.zoweExplorerAPI.getExplorerExtenderApi().initForZowe("cics", [getCICSProfileDefinition()]);
   }
 
   public static getExplorerApis() {