@pega/custom-dx-components 0.0.1 → 0.23.1

package/src/constants.js

@@ -2,17 +2,93 @@
 export const TASKS_CONFIG_JSON_FILENAME = 'tasks.config.json';
 export const BUILD_CONFIG_JSON_FILENAME = 'build.config.json';
 export const COMPONENTS_DIRECTORY_PATH = 'components-directory-path';
+export const COMPONENTS_PATH = 'component'
 export const TOKEN_PATH = 'node_modules/@pega/custom-dx-components/.access_token';
+export const SERVICE_TOKEN_PATH = 'node_modules/@pega/custom-dx-components/.service_token';
 export const OOTB_COMPONENTS = 'node_modules/@pega/custom-dx-components/.ootb_components';
+export const AI_PROMPT_FILENAME = 'aiPrompt.txt.mustache';
 
 /* REST end points */
 export const PUBLISH_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/publish_component';
 export const LIST_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/list_component';
 export const OOTB_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/ootb_component';
 export const DELETE_COMPONENT_SERVICE_REST_ENDPOINT = 'PRRestService/dev/v1/delete_component';
-export const TOKEN_URL_V1 = 'PRRestService/oauth2/v1/token';
+export const BOOTSTRAP_SERVICE_REST_ENDPOINT = "PRRestService/application/v2/data_views/D_pxBootstrapConfig";
+export const SERVICES_AI_REST_ENDPOINT = 'generativeai';
+export const INF_TOKEN_URL_V1 = 'PRRestService/oauth2/v1/token';
+export const INF_AUTHORIZE_URL_V1 = 'PRRestService/oauth2/v1/authorize';
+export const LP_TOKEN_URL = 'uas/oauth/token';
+export const LP_AUTHORIZE_URL = 'uas/oauth/authorize';
+export const LP_LIST_COMPONENT_SERVICE_REST_ENDPOINT = 'pegalaunchpad/c11n/v103/app/appstudiox/componentslist';
+
+
+
+export const FIELD_PATH = '/field';
+export const TEMPLATE_PATH = '/template';
+export const WIDGET_PATH = '/widget';
+
+export const COMPONENT_PREFIX_FIELD_PATH = "field/";
+export const COMPONENT_PREFIX_TEMPLATE_PATH = "template/";
+export const COMPONENT_PREFIX_WIDGET_PATH = "widget/";
+
+export const CATEGORY_CONSTELLATION = "constellation";
+
+export const AUTHENTICATE_SCHEMA = {
+  serverType: [
+    {
+      name: 'Infinity',
+      value: 'infinity'
+    },
+    {
+      name: 'Launchpad',
+      value: 'launchpad'
+    }
+  ],
+  grantType: [
+    {
+      name: 'Authorization code',
+      value: 'authCode'
+    },
+    {
+      name: 'Password credentials',
+      value: 'passwordCreds'
+    },
+    {
+      name: 'Client credentials',
+      value: 'clientCreds'
+    }
+  ]
+};
 
 export const COMPONENT_SCHEMA = {
+  generationType: [
+    {
+      name: 'Constellation Design System',
+      value: 'CDS'
+    },
+    {
+      name: 'AI Generation',
+      value: 'AI'
+    }
+  ],
+  framework: [
+    {
+      name: 'Constellation',
+      value: 'Constellation'
+    },
+    {
+      name: 'SDK Angular',
+      value: 'SDK-Angular'
+    },
+    {
+      name: 'SDK React',
+      value: 'SDK-React'
+    },
+    {
+      name: 'SDK Web Components',
+      value: 'SDK-WebComponents'
+    }
+  ],
   type: [
     {
       name: 'Field',
@@ -33,21 +109,25 @@ export const COMPONENT_SCHEMA = {
         name: 'Text',
         value: 'Text'
       },
+      {
+        name: 'Text Input',
+        value: 'Text-Input'
+      },
       {
         name: 'Paragraph',
         value: 'Text-Paragraph'
       },
       {
         name: 'Email',
-        value: 'Email'
+        value: 'Text-Email'
       },
       {
         name: 'Phone',
-        value: 'Phone'
+        value: 'Text-Phone'
       },
       {
         name: 'URL',
-        value: 'URL'
+        value: 'Text-URL'
       },
       {
         name: 'Integer',
@@ -78,15 +158,49 @@ export const COMPONENT_SCHEMA = {
         value: 'DateTime'
       },
       {
-        name: 'TimeofDay',
-        value: 'TimeofDay'
+        name: 'TimeOfDay',
+        value: 'TimeOfDay'
       },
       {
         name: 'Picklist',
         value: 'Picklist'
       }
     ],
-    template: ['DETAILS', 'FORM', 'PAGE'],
-    widget: ['PAGE', 'CASE']
+    template: [
+      {
+        name: 'DETAILS',
+        value: 'DETAILS'
+      },
+      {
+        name: 'DETAILS region',
+        value: 'DETAILS-region'
+      },
+      {
+        name: 'FORM',
+        value: 'FORM'
+      },
+      {
+        name: 'FORM region',
+        value: 'FORM-region'
+      },
+      {
+        name: 'PAGE',
+        value: 'PAGE'
+      }
+    ],
+    widget: [
+      {
+        name: 'CASE',
+        value: 'CASE'
+      },
+      {
+        name: 'PAGE',
+        value: 'PAGE'
+      },
+      {
+        name: 'PAGE & CASE',
+        value: ['PAGE', 'CASE']
+      }
+    ]
   }
 };

package/src/tasks/authenticate/helper.js

@@ -1,24 +1,98 @@
 /* eslint-disable import/prefer-default-export */
 import { getPegaServerConfig } from '../../util.js';
 
-export const getAuthQuestions = async () => {
-  const defaultPegaConfig = await getPegaServerConfig();
+import { AUTHENTICATE_SCHEMA } from '../../constants.js';
+
+export const getAuthQuestions = async (dxcbConfig) => {
+  const defaultPegaConfig = dxcbConfig;
+  const aMustAsk = dxcbConfig['questions_askAlways'] ? dxcbConfig['questions_askAlways'].split(',') : [];
+  const aNeverAsk = dxcbConfig['questions_askNever'] ? dxcbConfig['questions_askNever'].split(',') : [];
+
+  const initAnswers = (answers) => {
+    // Setup default answers (if they are present and non-empty)
+    answers.serverType = defaultPegaConfig.serverType || "infinity";
+    answers.server = defaultPegaConfig.server || undefined;
+    answers.isolationId = defaultPegaConfig.isolationId || undefined;
+    answers.clientId = defaultPegaConfig.clientId || undefined;
+    answers.grantType = defaultPegaConfig.grantType || "authCode";
+    answers.clientSecret = defaultPegaConfig.clientSecret || undefined;
+    answers.user = defaultPegaConfig.user || undefined;
+    answers.password = defaultPegaConfig.password || undefined;
+  };
+
+  const fnStandardWhen = (prop, answers) => {
+    if (aNeverAsk.includes(prop)) {
+      return false;
+    }
+    return aMustAsk.includes(prop) || !answers[prop];
+  };
 
   return [
+    {
+      name: 'serverType',
+      type: 'rawlist',
+      message: 'Enter Pega server type',
+      default: answers => {
+        return defaultPegaConfig.serverType;
+      },
+      choices: AUTHENTICATE_SCHEMA.serverType,
+      validate: value => {
+        if (value.trim()) {
+          return true;
+        }
+        return 'Pega server type cannot be empty';
+      },
+      when: answers => {
+        initAnswers(answers);
+        return fnStandardWhen('serverType', answers);
+      }
+    },
     {
       name: 'server',
       message: 'Enter pega server url',
-      default: defaultPegaConfig.server
+      default: defaultPegaConfig.server,
+      when: answers => {
+        return fnStandardWhen('server', answers);
+      }
+    },
+    {
+      name: 'isolationId',
+      message: 'Enter isolation id',
+      default: defaultPegaConfig.isolationId,
+      when: answers => {
+        return answers.serverType === "launchpad" && fnStandardWhen('isolationId', answers);
+      }
+    },
+    {
+      name: 'grantType',
+      type: 'rawlist',
+      message: 'Enter OAuth 2.0 grant type',
+      default: defaultPegaConfig.grantType,
+      choices: answers => {
+        return AUTHENTICATE_SCHEMA.grantType.filter(gt => !(answers.serverType === "launchpad" && gt.value === "passwordCreds"));
+      },
+      validate: value => {
+        if (value.trim()) {
+          return true;
+        }
+        return 'Grant type cannot be empty';
+      },
+      when: answers => {
+        return fnStandardWhen('grantType', answers);
+      }
     },
     {
       name: 'user',
       message: 'Enter user id',
       default: defaultPegaConfig.user,
-      validate: value => {
-        if (value.trim()) {
+      validate: (value, answers) => {
+        if (value.trim() || answers.grantType === "authCode") {
           return true;
         }
         return 'Username cannot be empty';
+      },
+      when: answers => {
+        return (answers.serverType === "infinity" && answers.grantType === "passwordCreds") && fnStandardWhen('user', answers);
       }
     },
     {
@@ -26,11 +100,14 @@ export const getAuthQuestions = async () => {
       type: 'password',
       message: 'Enter password',
       default: defaultPegaConfig.password,
-      validate: value => {
-        if (value.trim()) {
+      validate: (value, answers) => {
+        if (value.trim() || answers.grantType === "authCode") {
           return true;
         }
         return 'Password cannot be empty';
+      },
+      when: answers => {
+        return (answers.user && (answers.serverType === "infinity" && answers.grantType === "passwordCreds") && fnStandardWhen('password', answers));
       }
     },
     {
@@ -42,6 +119,9 @@ export const getAuthQuestions = async () => {
           return true;
         }
         return 'clientId cannot be empty';
+      },
+      when: answers => {
+        return fnStandardWhen('clientId', answers);
       }
     },
     {
@@ -49,11 +129,14 @@ export const getAuthQuestions = async () => {
       type: 'password',
       message: 'Enter clientSecret',
       default: defaultPegaConfig.clientSecret,
-      validate: value => {
+      validate: (value, answers) => {
         if (value.trim()) {
           return true;
         }
         return 'clientSecret cannot be empty';
+      },
+      when: answers => {
+        return (answers.grantType !== "authCode" && fnStandardWhen('clientSecret', answers));
       }
     }
   ];

package/src/tasks/authenticate/index.js

@@ -1,75 +1,195 @@
 import path from 'path';
-import fs from 'fs';
-import https from 'https';
+import fs from 'node:fs';
 
 import chalk from 'chalk';
 import inquirer from 'inquirer';
-import fetch from 'node-fetch';
 
-import { checkPathAccess, getTokenUrl } from '../../util.js';
-import { TOKEN_PATH } from '../../constants.js';
+import { checkPathAccess, showVersion, storeServicesToken } from '../../util.js';
+import { TOKEN_PATH, INF_TOKEN_URL_V1, INF_AUTHORIZE_URL_V1, LP_TOKEN_URL, LP_AUTHORIZE_URL } from '../../constants.js';
 
 import { getAuthQuestions } from './helper.js';
+import PegaAuth from '../../auth.js';
 
 export const TASKS_CONFIG_JSON_FILENAME = 'tasks.config.json';
 
 const pegaConfigJsonPath = path.join(path.resolve(), TASKS_CONFIG_JSON_FILENAME);
+let server = null;
 
 const generateAccessToken = async config => {
-  const formData = new URLSearchParams();
-  formData.append('client_id', config.clientId);
-  formData.append('client_secret', config.clientSecret);
-  formData.append('username', config.user);
-  formData.append('password', config.password);
-  formData.append('grant_type', 'password');
-
-  const accessTokenUri = await getTokenUrl(config.server);
-  fetch(accessTokenUri, {
-    agent: new https.Agent({ rejectUnauthorized: false }),
-    method: 'POST',
-    headers: { 'content-type': 'application/x-www-form-urlencoded' },
-    body: formData.toString()
-  })
-    .then(response => response.json())
-    .then(data => {
-      if (data && data.errors) {
-        const errMessages = data.errors;
-        errMessages.forEach(msgArr => {
-          throw new Error(`Failed with error - ${JSON.stringify(msgArr.message)}`);
-        });
+
+  let authSuccess = false;
+  const { serverType, authService, isolationId, grantType, clientId, clientSecret, user, password } = config;
+  // Try to gracefully deal with missing trailing slashes for server (and later conditionally for redirectUri)
+  const server = config.server.endsWith('/') ? config.server : `${config.server}/`;
+
+  return new Promise((resolve, reject) => {
+    const sTokenUri = `${server}${serverType === 'infinity' ? INF_TOKEN_URL_V1 : LP_TOKEN_URL}`;
+    const sAuthorizeUri = `${server}${serverType === 'infinity' ? INF_AUTHORIZE_URL_V1 : LP_AUTHORIZE_URL}`;
+    // console.log(`grantType: ${config.grantType}`);
+    const browserAuthSuccessMarkup = `<div style="width: 300px; padding: 10px;">
+    <svg xmlns="http://www. w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 311 68" version="1.1">
+    <title>Logo</title>
+    <defs/>
+    <g id="Symbols" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Logo">
+            <g id="pega_logo_horizontal_positive_rgb">
+                <path d="M136.36,17.098 L136.173,17.009 C136.154,16.998 133.96,16.01 132.245,17.815 L132.026,18.046 L135.539,19.768 L136.36,17.098 Z M152.441,36.389 C152.441,36.389 150.91,39.13 150.224,40.143 C149.535,41.164 147.38,41.798 145.517,40.908 C144.665,40.503 136.694,35.854 133.644,36.12 C118.205,37.466 113.999,31.105 113.503,30.527 C113.005,29.949 112.077,30.218 112.74,31.355 C116.127,37.163 126.15,39.856 126.15,39.856 C128.771,46.172 129.085,50.597 129.085,50.597 C126.489,48.574 123.687,46.869 120.714,45.453 C112.768,40.121 100.329,33.518 83.207,29.379 C84.191,15.797 91.044,-3.837 123.092,0.806 C123.092,0.806 129.522,1.86 133.809,4.824 C133.809,4.824 132.779,5.904 131.425,7.256 C130.071,8.605 131.569,9.471 131.569,9.471 L138.338,14.792 C138.417,17.607 138.533,18.396 140.651,20.944 C142.769,23.487 151.004,32.112 152.081,33.266 C153.329,34.6 152.441,36.389 152.441,36.389 Z M78.633,9.915 C76.938,16.897 77.068,23.049 77.939,28.221 C76.33,27.901 74.697,27.594 73.014,27.32 C37.94,21.612 27.361,38.899 31.455,52.916 C19.86,57.274 8.963,62.263 0.214,67.162 C13.98,34.146 43.896,5.087 69.145,1.268 C77.389,0.181 79.708,5.529 78.633,9.915 L78.633,9.915 Z" id="Fill-1" fill="#1F2555"/>
+                <path d="M83.492,40.09 C97.157,39.01 110.054,40.381 120.713,45.453 C112.768,40.121 100.329,33.518 83.206,29.379 C82.864,34.111 83.23,38.107 83.492,40.09 Z M81.52,40.262 C66.209,41.723 48.105,46.663 31.455,52.916 C27.361,38.899 37.941,21.612 73.014,27.32 C74.697,27.594 76.33,27.901 77.938,28.221 C78.77,33.166 80.276,37.228 81.52,40.262 L81.52,40.262 Z" id="Fill-2" fill="#00A6A7"/>
+                <path d="M286.63,35.039 L291.379,23.446 L296.129,35.039 L286.63,35.039 Z M287.854,14 L272.536,50 L280.553,50 L283.819,41.985 L298.938,41.985 L302.204,50 L310.427,50 L295.108,14 L287.854,14 Z M188.647,26.704 C188.647,29.787 186.335,32.153 182.375,32.153 L176.1,32.153 L176.1,21.149 L182.219,21.149 C186.181,21.149 188.647,23.052 188.647,26.601 L188.647,26.704 Z M182.889,14 L168.18,14 L168.18,50 L176.1,50 L176.1,39.2 L182.115,39.2 C190.19,39.2 196.673,34.878 196.673,26.547 L196.673,26.444 C196.673,19.09 191.48,14 182.889,14 Z M239.764,18.02 C235.989,21.708 234.075,26.376 234.075,31.896 C234.075,37.421 235.953,42.054 239.663,45.675 C243.366,49.292 248.022,51.123 253.503,51.123 C259.992,51.123 265.064,49.159 268.587,45.284 L268.769,45.08 L268.769,28.556 L253.112,28.556 L253.112,35.244 L261.279,35.244 L261.279,41.993 C259.164,43.252 256.525,43.891 253.429,43.891 C250.221,43.891 247.454,42.792 245.203,40.62 C242.958,38.458 241.819,35.527 241.819,31.926 C241.819,28.322 242.992,25.379 245.304,23.18 C247.624,20.972 250.538,19.852 253.966,19.852 C255.769,19.852 257.366,20.074 258.711,20.512 C259.973,20.922 261.251,21.667 262.517,22.712 L266.897,17.183 C264.586,15.147 260.427,12.467 253.503,12.467 C248.162,12.467 243.539,14.336 239.764,18.02 Z M210.336,35.604 L225.842,35.604 L225.842,28.556 L210.336,28.556 L210.336,21.042 L229.623,21.042 L229.623,14 L202.466,14 L202.466,50 L229.879,50 L229.879,42.955 L210.336,42.955 L210.336,35.604 L210.336,35.604 Z" id="Fill-3" fill="#1F2555"/>
+            </g>
+        </g>
+    </g>
+    </svg>
+    </div>
+    <div style="font-size: 2em; font-family: Arial; padding: 10px">
+    Authentication is complete!!
+    </div>
+    <div style="font-size: 13m; font-family: Arial; padding: 10px">
+    This browser tab or window may be closed.
+    </div>
+    <div style="padding: 10px;">
+    </div>`;
+
+    const authCodeConfig = grantType === 'authCode' ? {
+      authorizeUri: sAuthorizeUri,
+      redirectUri: config.redirectUri.endsWith('/') ? config.redirectUri : `${config.redirectUri}/`,
+      cert: config.cert,
+      key: config.key,
+      winTitle: 'DX Component Dev',
+      winBodyHtml: browserAuthSuccessMarkup
+    } : {};
+
+    // Build auth config structure
+    const authConfig = {
+      serverType: serverType,
+      authService: authService,
+      grantType: grantType,
+      tokenUri: sTokenUri,
+      clientId: clientId,
+      clientSecret: clientSecret,
+      ignoreInvalidCerts: true,
+      ...authCodeConfig
+    };
+    if (serverType === 'infinity') {
+      if (grantType !== 'clientCreds' && user && password) {
+        authConfig.userIdentifier = user;
+        authConfig.password = Buffer.from(password).toString('base64');
       }
-      if (data.token_type) {
-        fs.writeFile(TOKEN_PATH, JSON.stringify(data), err => {
-          if (err) {
-            console.error(err);
+    }
+    if (serverType === 'launchpad') {
+      authConfig.isolationId = isolationId;
+      authConfig.noPKCE = true;
+    }
+
+    try {
+      const auth = new PegaAuth(authConfig);
+      if (grantType === 'authCode') {
+        console.log(`${chalk.green('Awaiting authorization to complete (Ctrl-C to exit).  You may need to enter credentials within your default browser.')}`);
+      }
+      // console.log(`authConfig: ${JSON.stringify(authConfig)}`);
+
+      auth.login()
+        .then((token) => {
+          if (token?.token_type) {
+            fs.writeFile(TOKEN_PATH, JSON.stringify(token), err => {
+              if (err) {
+                console.error(err);
+                return reject(authSuccess);
+              }
+              console.log(`${chalk.bold.green('Authenticated successfully !!')}`);
+              authSuccess = true;
+              return resolve(authSuccess);
+            });
+          } else {
+            console.log(`${chalk.bold.red('Authentication failed:' + JSON.stringify(token.errors ? token.errors : token))}`);
+            return reject(authSuccess);
           }
-          console.log(`${chalk.bold.green('Authenticated successfully !!')}`);
+        })
+        .catch((e) => {
+          console.log(`${chalk.bold.red('Authentication failed:' + e)}`);
+          return reject(authSuccess);
         });
-      }
-    })
-    .catch(e => console.log(`${chalk.bold.red(e)}`));
+
+    } catch (e) {
+      console.log(`Authentication failed: Problem initializing OAuth library`);
+      return reject(authSuccess);
+    }
+
+  });
 };
 
 export default async options => {
+
+  let authOK = false;
+
+  showVersion();
+
   await checkPathAccess(pegaConfigJsonPath);
 
-  let data = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
-  data = data && JSON.parse(data);
+  let cfgData = fs.readFileSync(pegaConfigJsonPath, { encoding: 'utf8' });
+  let data = null;
+  if (cfgData) {
+    try {
+      data = JSON.parse(cfgData);
+    } catch (e) {
+      console.log(`${chalk.red('Invalid JSON within tasks.config.json')}`);
+      process.exit(1);
+    }
+  }
 
   const serverConfig = data['server-config'];
-  const params = options.params;
+  const isPwdNonEmpty = serverConfig['password'] ? true : false;
 
-  const questions = await getAuthQuestions(params);
+  // console.log(`serverConfig: ${JSON.stringify(serverConfig)}`);
+  const questions = await getAuthQuestions(serverConfig);
+  // console.log(`questions: ${JSON.stringify(questions)}`);
   const answers = await inquirer.prompt(questions);
-  serverConfig.server = answers.server;
-  serverConfig.user = answers.user;
-  serverConfig.password = answers.password;
-  serverConfig.clientId = answers.clientId;
-  serverConfig.clientSecret = answers.clientSecret;
-  await generateAccessToken(serverConfig);
-
-  data = JSON.stringify(data, null, 2);
-  fs.writeFile(pegaConfigJsonPath, data, err => {
-    if (err) throw err;
-  });
+  const aProps = ['serverType', 'server', 'isolationId', 'clientId', 'grantType', 'clientSecret', 'user', 'password'];
+  serverConfig.authService = serverConfig.authService || 'pega';
+  const isLaunchPad = answers.serverType === "launchpad";
+  let bWriteUpdate = false;
+  for (let i = 0; i < aProps.length; i += 1) {
+    const prop = aProps[i];
+    const configValue = serverConfig[prop];
+    const answerValue = answers[prop];
+    // Treat an empty serverConfig property value as same as an undefined answer response
+    if (configValue !== answerValue && !(configValue === '' && answerValue === undefined)) {
+      // console.log(`property ${prop} changed from ${configValue} to ${answerValue}`);
+      serverConfig[prop] = answerValue;
+      if (prop !== 'password' || isPwdNonEmpty) {
+        bWriteUpdate = true;
+      }
+    }
+  }
+
+  try {
+    // console.log(`serverConfig: ${JSON.stringify(serverConfig)}`);
+    authOK = await generateAccessToken(serverConfig);
+  } catch (e) {
+    console.log(`${chalk.bold.red('Authentication failed:' + JSON.stringify(e))}`);
+  }
+
+  if (authOK) {
+    await storeServicesToken();
+  }
+
+  if (authOK & bWriteUpdate) {
+    // Don't write password value (unless it already had a value)
+    if (!isPwdNonEmpty) {
+      serverConfig['password'] = '';
+    }
+    console.log(`${chalk.green('Writing updated config...')}`);
+    let updCfg = null;
+    try {
+      updCfg = JSON.stringify(data, null, 2);
+      // console.log(`updated config: ${updCfg}`);
+      fs.writeFileSync(pegaConfigJsonPath, updCfg, err => {
+        if (err) throw err;
+      });
+    } catch (e) {
+
+    }
+  }
+
+  process.exit(1);
 };