apn-app-manager 1.4.1 → 1.5.0

package/README.md

@@ -12,7 +12,7 @@ The functionality provided by this tool is not supported, nor endorsed by Appian
 
 Importing an application export modified by this tool should be done at your own discretion.
 
-Latest compatible Appian platform version tested against: **22.3**.
+Latest compatible Appian platform version tested against: **23.3**.
 
 ## Installation
 
@@ -43,6 +43,7 @@ Used to duplicate all objects of an application, which replaces the namespace of
 1. Enter your current namespace.
    - For example, an application with objects such as `SMP APP Artifacts` and `SMP_APP_displayUser` would have a namespace of `SMP_APP`
 1. Enter your new namespace.
+1. Do advanced options if necessary.
 1. Access your cloned application in the generated `/out/` folder.
 
 #### Notes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apn-app-manager",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Appian App Manager",
   "license": "Apache-2.0",
   "preferGlobal": true,

package/src/actions/cloneAction.js

@@ -14,6 +14,11 @@ const obExtract = require("../handlers/objectExtractHandler");
 const obMapsUpdates = require("../handlers/objectMapsUpdateHandler");
 const obModify = require("../handlers/objectModifyHandler");
 
+// Options
+const options = {
+  renameDbTables: true,
+};
+
 // Entry-point
 function main(callback) {
   util.delFile(cons.outDir);
@@ -24,7 +29,16 @@ function main(callback) {
         promptNamespace("What is your new namespace?", function (newNamespace) {
           const namespaceMap = {};
           namespaceMap[curNamespace] = { newNamespace: newNamespace };
-          executeClone(appZipPath, icfPath, namespaceMap, callback);
+          prompt.promptList("Advanced options?", ["No", "Yes"], function (enhancedOptions) {
+            if (enhancedOptions == "Yes") {
+              prompt.promptList("Rename database tables?", ["Yes", "No"], function (renameDbTables) {
+                options["renameDbTables"] = renameDbTables == "Yes";
+                executeClone(appZipPath, icfPath, namespaceMap, options, callback);
+              });
+            } else {
+              executeClone(appZipPath, icfPath, namespaceMap, options, callback);
+            }
+          });
         });
       });
     });
@@ -32,7 +46,7 @@ function main(callback) {
 }
 
 // Executes all the steps of the clone
-function executeClone(appZipPath, icfPath, namespaceMap, callback) {
+function executeClone(appZipPath, icfPath, namespaceMap, options, callback) {
   // Initialize output variables
   const outZipPath = path.resolve(cons.outDir, path.basename(appZipPath));
   const outIcfPath = icfPath ? path.resolve(cons.outDir, path.basename(icfPath)) : null;
@@ -53,7 +67,7 @@ function executeClone(appZipPath, icfPath, namespaceMap, callback) {
 
   // Update the object maps we are cloning based on the application prefix
   util.print(`Cloning the objects files...`);
-  obMapsUpdates.renameObjectMaps(objectMaps, uuidCollector, namespaceMap, obProps.usageTypes.CLONE);
+  obMapsUpdates.renameObjectMaps(objectMaps, uuidCollector, namespaceMap, options, obProps.usageTypes.CLONE);
 
   // These output files are helpful for debugging
   util.writeJson(path.resolve(cons.outDir, `objects.json`), objectMaps);

package/src/handlers/objectExtractHandler.js

@@ -64,7 +64,22 @@ function extractObProps(objectMaps, uuidCollector, fileCount, obPath, usageType)
           const xpath = util.replaceKeys(haulField.xpath, { "{OBTYPE}": obType });
           let result = util.xpath(xpath, fileContent, haulField.isArray, obProps.xmlNamespaces);
           if (!util.isBlank(haulField.extractRegex) && !util.isBlank(result)) {
-            result = util.firstMatch(result, haulField.extractRegex, "");
+            if (!haulField.isArray) {
+              result = util.firstMatch(result, haulField.extractRegex, "");
+            } else {
+              if (!Array.isArray(result)) {
+                result = util.regexMatches(result, haulField.extractRegex);
+              } else {
+                console.log("i did this");
+                result = result
+                  .map(function (thisResult) {
+                    return util.firstMatch(thisResult, haulField.extractRegex, "");
+                  })
+                  .filter(function (thisResult) {
+                    return thisResult != "";
+                  });
+              }
+            }
           }
           builder[haulField.fieldName] = result;
         }

package/src/handlers/objectMapsUpdateHandler.js

@@ -11,9 +11,9 @@ const { remove } = require("fs-extra");
 // Exports
 module.exports = {
   // Goes through all of the objectMaps and creates new name, uuid, etc.
-  renameObjectMaps: function (objectMaps, uuidCollector, namespaceMap, usageType) {
+  renameObjectMaps: function (objectMaps, uuidCollector, namespaceMap, options, usageType) {
     // Update all objectMaps with new names
-    renameObjectMaps(objectMaps, uuidCollector, namespaceMap, usageType);
+    renameObjectMaps(objectMaps, uuidCollector, namespaceMap, options, usageType);
   },
 };
 
@@ -22,7 +22,7 @@ module.exports = {
 // ---------------------------------------------------
 
 // Goes through all of the objectMaps and creates new name, uuid, etc.
-function renameObjectMaps(objectMaps, uuidCollector, namespaceMap, usageType) {
+function renameObjectMaps(objectMaps, uuidCollector, namespaceMap, options, usageType) {
   obProps.haulTypes.forEach(haulType => {
     objectMaps[haulType.haulName].forEach(function (objectMap, objectMapIndex) {
       let curNamespaceForObject = findNamespaceForObject(objectMap["current"][obProps.fieldNames.NAME], namespaceMap);
@@ -44,16 +44,20 @@ function renameObjectMaps(objectMaps, uuidCollector, namespaceMap, usageType) {
             let newValue;
             let curValue = objectMap["current"][haulField.fieldName];
             removeFoundUuids(uuidCollector, haulField, curValue);
-            if (haulField.isArray) {
-              let newValueArray = [];
-              curValue.forEach(curValueIter => {
-                newValueArray.push(renameObjectProp(curValueIter, haulField, curNamespaceForObject, newNamespaceForObject));
-              });
-              newValue = newValueArray;
+            if (haulField.fieldName == obProps.fieldNames.DB_TABLE && !options.renameDbTables) {
+              newValue = curValue;
             } else {
-              newValue = renameObjectProp(curValue, haulField, curNamespaceForObject, newNamespaceForObject);
+              if (haulField.isArray) {
+                let newValueArray = [];
+                curValue.forEach(curValueIter => {
+                  newValueArray.push(renameObjectProp(curValueIter, haulField, curNamespaceForObject, newNamespaceForObject));
+                });
+                newValue = newValueArray;
+              } else {
+                newValue = renameObjectProp(curValue, haulField, curNamespaceForObject, newNamespaceForObject);
+              }
+              objectMaps[haulType.haulName][objectMapIndex]["new"][haulField.fieldName] = newValue;
             }
-            objectMaps[haulType.haulName][objectMapIndex]["new"][haulField.fieldName] = newValue;
           }
         });
       }

package/src/objectProps.js

@@ -17,11 +17,13 @@ const obTypes = {
   APPLICATION: "application",
   REPORT: "tempoReport",
   SITE: "site",
+  PORTAL: "portal",
   WEBAPI: "webApi",
   GROUP: "group",
   GROUPTYPE: "groupType",
   PROCESSMODELFOLDER: "processModelFolder",
   CONNECTEDSYSTEM: "connectedSystem",
+  AISKILL: "aiSkill",
   CONTENT: "content", // obTypes.CONTENT contains: [rule, document, rulesFolder, constant, folder, communityKnowledgeCenter, decision, outboundIntegration, report (process report)]
 };
 
@@ -32,6 +34,7 @@ const fieldNames = {
   INPUT_DESCRIPTION: "inputDescription",
   VERSION: "version",
   CACHE_VERSION: "cacheVersionKey",
+  MODEL_IDS: "modelIds",
   HISTORY_UUIDS: "historyUuids",
   CDT_NAMESPACE: "cdtNamespace",
   CDT_UUID_ENCODED: "cdtUuidEncoded",
@@ -41,7 +44,7 @@ const fieldNames = {
   NODE_UUIDS: "nodeUuids",
   PM_PERSISTENT_UUIDS: "pmPersistentUuids",
   URL_STUB: "urlStub",
-  SITE_PAGE_UUIDS: "sitePageUuids",
+  PAGE_UUIDS: "pageUuids",
   APP_PREFIX: "appPrefix",
   RECORD_ACTION_UUIDS: "recordActionUuids",
   RECORD_ACTION_REF_IDS: "recordActionRefIds",
@@ -396,8 +399,8 @@ const haulTypes = [
     ],
   },
   {
-    haulName: "Reports, Sites, and Web APIs",
-    obs: [obTypes.REPORT, obTypes.SITE, obTypes.WEBAPI],
+    haulName: "Reports, Sites, Portals, and Web APIs",
+    obs: [obTypes.REPORT, obTypes.SITE, obTypes.WEBAPI, obTypes.PORTAL],
     fields: [
       {
         fieldName: fieldNames.UUID,
@@ -438,8 +441,8 @@ const haulTypes = [
         usage: [usageTypes.CLONE, usageTypes.BUILD],
       },
       {
-        fieldName: fieldNames.SITE_PAGE_UUIDS,
-        xpath: `siteHaul/site/page/@a:uuid`,
+        fieldName: fieldNames.PAGE_UUIDS,
+        xpath: `siteHaul/site/page/@a:uuid | portalHaul/portal/navigationNode/@a:uuid`,
         type: propTypes.UUID,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
         isArray: true,
@@ -448,31 +451,35 @@ const haulTypes = [
   },
   {
     haulName: "Everything Else",
-    obs: [obTypes.GROUP, obTypes.GROUPTYPE, obTypes.PROCESSMODELFOLDER, obTypes.CONNECTEDSYSTEM, obTypes.CONTENT],
+    obs: [obTypes.GROUP, obTypes.GROUPTYPE, obTypes.PROCESSMODELFOLDER, obTypes.CONNECTEDSYSTEM, obTypes.AISKILL, obTypes.CONTENT],
     // obTypes.CONTENT contains: [rule, document, rulesFolder, constant, folder, communityKnowledgeCenter, decision, outboundIntegration, report (process report)]
+    /*
+    Note, that the leading xpath for almost every object type is `{OBTYPE}Haul` (e.g. "groupHaul"), however for AI skills it's actually "aiSkillRemoteHaul"
+    Therefore, what should be `{OBTYPE}Haul/` is now replaced with ``*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/`
+    */
     fields: [
       {
         fieldName: fieldNames.UUID,
-        xpath: `{OBTYPE}Haul/*[contains(name(), '')]/uuid/node()`,
+        xpath: `*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/*[contains(name(), '')]/uuid/node()`,
         type: propTypes.UUID,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
       },
       {
         fieldName: fieldNames.NAME,
-        xpath: `{OBTYPE}Haul/*[contains(name(), '')]/name/node()`,
+        xpath: `*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/*[contains(name(), '')]/name/node()`,
         type: propTypes.NAME,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
       },
       {
         fieldName: fieldNames.DESCRIPTION,
-        xpath: `{OBTYPE}Haul/*[contains(name(), '')]/description/node()`,
+        xpath: `*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/*[contains(name(), '')]/description/node()`,
         type: propTypes.TEXT,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
         replaceFormat: "description>{VALUE}</",
       },
       {
         fieldName: fieldNames.INPUT_DESCRIPTION,
-        xpath: `{OBTYPE}Haul/*[contains(name(), '')]/namedTypedValue/description/node()`,
+        xpath: `*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/*[contains(name(), '')]/namedTypedValue/description/node()`,
         type: propTypes.TEXT,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
         replaceFormat: "description>{VALUE}</",
@@ -480,13 +487,13 @@ const haulTypes = [
       },
       {
         fieldName: fieldNames.VERSION,
-        xpath: `{OBTYPE}Haul/versionUuid/node()`,
+        xpath: `*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/versionUuid/node()`,
         type: propTypes.UUID,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
       },
       {
         fieldName: fieldNames.HISTORY_UUIDS,
-        xpath: `{OBTYPE}Haul/history/historyInfo/@versionUuid`,
+        xpath: `*[starts-with(name(), '{OBTYPE}') and contains(name(), 'Haul')]/history/historyInfo/@versionUuid`,
         type: propTypes.UUID,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
         isArray: true,
@@ -494,7 +501,7 @@ const haulTypes = [
       // Only used in documents
       {
         fieldName: fieldNames.DOCUMENT_RAW_NAME,
-        xpath: `{OBTYPE}Haul/document/name/node()`,
+        xpath: `contentHaul/document/name/node()`,
         extractRegex: /.*(?=_default)/g,
         type: propTypes.TEXT,
         usage: [usageTypes.CLONE, usageTypes.BUILD, usageTypes.RENAME],
@@ -502,7 +509,7 @@ const haulTypes = [
       // Only used in documents
       {
         fieldName: fieldNames.DOCUMENT_EXTENSION,
-        xpath: `{OBTYPE}Haul/file/node()`,
+        xpath: `contentHaul/file/node()`,
         extractRegex: /(?<=\.).*/g,
         type: propTypes.TEXT,
         usage: [usageTypes.BUILD],
@@ -510,11 +517,20 @@ const haulTypes = [
       // Only used in decision objects
       {
         fieldName: fieldNames.CACHE_VERSION,
-        xpath: `{OBTYPE}Haul/*[contains(name(), '')]/definition/node()`,
+        xpath: `contentHaul/*[contains(name(), '')]/definition/node()`,
         extractRegex: /(?<=versionKey: ")[A-Za-z0-9-_]{10,}[0-9][A-Za-z0-9-_]{1,}-[A-Za-z0-9-_]{10,}(?=")/g,
         type: propTypes.UUID,
         usage: [usageTypes.CLONE, usageTypes.BUILD],
       },
+      // Only used in aiSkills
+      {
+        fieldName: fieldNames.MODEL_IDS,
+        xpath: `aiSkillRemoteHaul/*[contains(name(), '')]/content/node()`,
+        extractRegex: /(?<="models":.*"id":")[A-Za-z0-9-_]{10,}[0-9][A-Za-z0-9-_]{1,}-[A-Za-z0-9-_]{10,}(?=")/g,
+        type: propTypes.UUID,
+        usage: [usageTypes.CLONE, usageTypes.BUILD],
+        isArray: true,
+      },
     ],
   },
 ];