@itentialopensource/adapter-jira 2.1.0 → 2.2.0

package/CALLS.md

@@ -14007,13 +14007,13 @@ The settings listed below adjust the [look and feel](https://confluence.atlassia
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">analyseExpression(check = syntax, body, callback)</td>
+    <td style="padding:15px">analyseExpression(check = 'syntax', body, callback)</td>
     <td style="padding:15px">Analyse Jira expression</td>
     <td style="padding:15px">{base_path}/{version}/expression/analyse?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getFieldsPaginated(startAt, maxResults, type, id, query, orderBy = contextsCount, expand, callback)</td>
+    <td style="padding:15px">getFieldsPaginated(startAt, maxResults, type, id, query, orderBy = 'contextsCount', expand, callback)</td>
     <td style="padding:15px">Get fields paginated</td>
     <td style="padding:15px">{base_path}/{version}/field/search?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -14445,7 +14445,7 @@ The settings listed below adjust the [look and feel](https://confluence.atlassia
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">parseJqlQueries(validation = strict, body, callback)</td>
+    <td style="padding:15px">parseJqlQueries(validation = 'strict', body, callback)</td>
     <td style="padding:15px">Parse JQL query</td>
     <td style="padding:15px">{base_path}/{version}/jql/parse?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -14547,19 +14547,19 @@ The settings listed below adjust the [look and feel](https://confluence.atlassia
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getAvatarImageByType(type = issuetype, size = xsmall, format = png, callback)</td>
+    <td style="padding:15px">getAvatarImageByType(type = 'issuetype', size = 'xsmall', format = 'png', callback)</td>
     <td style="padding:15px">Get avatar image by type</td>
     <td style="padding:15px">{base_path}/{version}/universal_avatar/view/type/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getAvatarImageByID(type = issuetype, id, size = xsmall, format = png, callback)</td>
+    <td style="padding:15px">getAvatarImageByID(type = 'issuetype', id, size = 'xsmall', format = 'png', callback)</td>
     <td style="padding:15px">Get avatar image by ID</td>
     <td style="padding:15px">{base_path}/{version}/universal_avatar/view/type/{pathv1}/avatar/{pathv2}?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getAvatarImageByOwner(type = issuetype, entityId, size = xsmall, format = png, callback)</td>
+    <td style="padding:15px">getAvatarImageByOwner(type = 'issuetype', entityId, size = 'xsmall', format = 'png', callback)</td>
     <td style="padding:15px">Get avatar image by owner</td>
     <td style="padding:15px">{base_path}/{version}/universal_avatar/view/type/{pathv1}/owner/{pathv2}?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -14625,7 +14625,7 @@ The settings listed below adjust the [look and feel](https://confluence.atlassia
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getWorkflowsPaginated(startAt, maxResults, workflowName, expand, queryString, orderBy = name, isActive, callback)</td>
+    <td style="padding:15px">getWorkflowsPaginated(startAt, maxResults, workflowName, expand, queryString, orderBy = 'name', isActive, callback)</td>
     <td style="padding:15px">Get workflows paginated</td>
     <td style="padding:15px">{base_path}/{version}/workflow/search?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -14721,7 +14721,7 @@ The settings listed below adjust the [look and feel](https://confluence.atlassia
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">getTrashedFieldsPaginated(startAt, maxResults, id, query, expand = name, orderBy, callback)</td>
+    <td style="padding:15px">getTrashedFieldsPaginated(startAt, maxResults, id, query, expand = 'name', orderBy, callback)</td>
     <td style="padding:15px">Get fields in trash paginated</td>
     <td style="padding:15px">{base_path}/{version}/field/search/trashed?{query}</td>
     <td style="padding:15px">Yes</td>
@@ -15063,7 +15063,7 @@ The settings listed below adjust the [look and feel](https://confluence.atlassia
     <td style="padding:15px">Yes</td>
   </tr>
   <tr>
-    <td style="padding:15px">migrationResourceUpdateEntityPropertiesValuePut(entityType = IssueProperty, body, callback)</td>
+    <td style="padding:15px">migrationResourceUpdateEntityPropertiesValuePut(entityType = 'IssueProperty', body, callback)</td>
     <td style="padding:15px">Bulk update entity properties</td>
     <td style="padding:15px">/rest/atlassian-connect/1/migration/properties/{pathv1}?{query}</td>
     <td style="padding:15px">Yes</td>

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 2.2.0 [11-07-2023]
+
+* More migration changes
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-jira!14
+
+---
+
 ## 2.1.0 [09-26-2023]
 
 * Adapter Engine has been updated and the changes are being migrated to the adapter

package/metadata.json

@@ -17,7 +17,7 @@
   "method": "REST",
   "type": "Adapter",
   "domains": [
-    "ITSM or Service Management"
+    "ITSM (Service Management)"
   ],
   "tags": [
     "Ticket/Issue Management"
@@ -32,7 +32,7 @@
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-jira",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira.git",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira",
     "docLink": "https://docs.itential.com/opensource/docs/jira",
     "demoLinks": [],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-jira",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "This adapter integrates with system Jira",
   "main": "adapter.js",
   "systemName": "Jira",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.8",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,9 +54,9 @@
     "url": "git@gitlab.com:itentialopensource/adapters/itsm-testing/adapter-jira.git"
   },
   "author": "Itential",
-  "homepage": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira.git",
+  "homepage": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-jira#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^5.1.7",
+    "@itentialopensource/adapter-utils": "^5.3.0",
     "acorn": "^8.10.0",
     "ajv": "^8.12.0",
     "axios": "^1.4.0",

package/pronghorn.json

@@ -42716,9 +42716,7 @@
             },
             "additionalProperties": false,
             "description": "Configuration of the announcement banner.",
-            "writeOnly": true,
-            "definitions": {}
-          }
+            "writeOnly": true          }
         }
       ],
       "output": {
@@ -42892,9 +42890,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "Details of the settings for a dashboard gadget.",
-            "definitions": {}
-          }
+            "description": "Details of the settings for a dashboard gadget."          }
         }
       ],
       "output": {
@@ -42980,9 +42976,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "The details of the gadget to update.",
-            "definitions": {}
-          }
+            "description": "The details of the gadget to update."          }
         }
       ],
       "output": {
@@ -43163,9 +43157,7 @@
             },
             "additionalProperties": false,
             "description": "The account ID of the new owner.",
-            "writeOnly": true,
-            "definitions": {}
-          }
+            "writeOnly": true          }
         }
       ],
       "output": {
@@ -43264,9 +43256,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Issue security scheme and it's details",
-            "definitions": {}
-          }
+            "description": "Issue security scheme and it's details"          }
         }
       ],
       "output": {
@@ -43403,9 +43393,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of new default levels.",
-            "definitions": {}
-          }
+            "description": "Details of new default levels."          }
         }
       ],
       "output": {
@@ -43669,9 +43657,7 @@
                 "description": "The name of the security scheme scheme. Must be unique."
               }
             },
-            "additionalProperties": false,
-            "definitions": {}
-          }
+            "additionalProperties": false          }
         }
       ],
       "output": {
@@ -43800,9 +43786,7 @@
                 }
               }
             },
-            "additionalProperties": false,
-            "definitions": {}
-          }
+            "additionalProperties": false          }
         }
       ],
       "output": {
@@ -43868,9 +43852,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of issue security scheme level.",
-            "definitions": {}
-          }
+            "description": "Details of issue security scheme level."          }
         }
       ],
       "output": {
@@ -44005,9 +43987,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "Details of issue security scheme level new members.",
-            "definitions": {}
-          }
+            "description": "Details of issue security scheme level new members."          }
         }
       ],
       "output": {
@@ -44126,9 +44106,7 @@
             },
             "additionalProperties": false,
             "description": "The list of JQL queries to sanitize for the given account IDs.",
-            "writeOnly": true,
-            "definitions": {}
-          }
+            "writeOnly": true          }
         }
       ],
       "output": {
@@ -44258,9 +44236,7 @@
             },
             "additionalProperties": false,
             "description": "List of pairs (id and value) for precomputation updates.",
-            "writeOnly": true,
-            "definitions": {}
-          }
+            "writeOnly": true          }
         }
       ],
       "output": {
@@ -44427,9 +44403,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of an notification scheme.",
-            "definitions": {}
-          }
+            "description": "Details of an notification scheme."          }
         }
       ],
       "output": {
@@ -44547,9 +44521,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of a notification scheme.",
-            "definitions": {}
-          }
+            "description": "Details of a notification scheme."          }
         }
       ],
       "output": {
@@ -44659,9 +44631,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of notifications which should be added to the notification scheme.",
-            "definitions": {}
-          }
+            "description": "Details of notifications which should be added to the notification scheme."          }
         }
       ],
       "output": {
@@ -44810,9 +44780,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of an issue priority.",
-            "definitions": {}
-          }
+            "description": "Details of an issue priority."          }
         }
       ],
       "output": {
@@ -44854,9 +44822,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "The new default issue priority.",
-            "definitions": {}
-          }
+            "description": "The new default issue priority."          }
         }
       ],
       "output": {
@@ -44911,9 +44877,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "Change the order of issue priorities.",
-            "definitions": {}
-          }
+            "description": "Change the order of issue priorities."          }
         }
       ],
       "output": {
@@ -45053,9 +45017,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of an issue priority.",
-            "definitions": {}
-          }
+            "description": "Details of an issue priority."          }
         }
       ],
       "output": {
@@ -45148,9 +45110,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of an issue resolution.",
-            "definitions": {}
-          }
+            "description": "Details of an issue resolution."          }
         }
       ],
       "output": {
@@ -45192,9 +45152,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "The new default issue resolution.",
-            "definitions": {}
-          }
+            "description": "The new default issue resolution."          }
         }
       ],
       "output": {
@@ -45249,9 +45207,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "Change the order of issue resolutions.",
-            "definitions": {}
-          }
+            "description": "Change the order of issue resolutions."          }
         }
       ],
       "output": {
@@ -45373,9 +45329,7 @@
               }
             },
             "additionalProperties": true,
-            "description": "Details of an issue resolution.",
-            "definitions": {}
-          }
+            "description": "Details of an issue resolution."          }
         }
       ],
       "output": {
@@ -45634,9 +45588,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "The list of statuses that will be updated.",
-            "definitions": {}
-          }
+            "description": "The list of statuses that will be updated."          }
         }
       ],
       "output": {
@@ -45742,9 +45694,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "Details of the statuses being created and their scope.",
-            "definitions": {}
-          }
+            "description": "Details of the statuses being created and their scope."          }
         }
       ],
       "output": {
@@ -46102,9 +46052,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "The details of a UI modification.",
-            "definitions": {}
-          }
+            "description": "The details of a UI modification."          }
         }
       ],
       "output": {
@@ -46200,9 +46148,7 @@
               }
             },
             "additionalProperties": false,
-            "description": "The details of a UI modification.",
-            "definitions": {}
-          }
+            "description": "The details of a UI modification."          }
         }
       ],
       "output": {
@@ -46364,7 +46310,8 @@
           "info": ": object",
           "required": true,
           "schema": {
-            "definitions": {}
+            "title": "body",
+            "type": "object"
           }
         }
       ],
@@ -46450,7 +46397,8 @@
           "info": ": object",
           "required": true,
           "schema": {
-            "definitions": {}
+            "title": "body",
+            "type": "object"
           }
         }
       ],
@@ -46611,9 +46559,7 @@
                   "key": "dynamic-select-field"
                 }
               ]
-            },
-            "definitions": {}
-          }
+            }          }
         }
       ],
       "output": {
@@ -46740,9 +46686,7 @@
             },
             "additionalProperties": false,
             "description": "Details of updates for a custom field.",
-            "writeOnly": true,
-            "definitions": {}
-          }
+            "writeOnly": true          }
         }
       ],
       "output": {
@@ -46789,9 +46733,7 @@
             "type": "array",
             "items": {
               "type": "object"
-            },
-            "definitions": {}
-          }
+            }          }
         }
       ],
       "output": {
@@ -46851,9 +46793,7 @@
                 "example": "a498d711-685d-428d-8c3e-bc03bb450ea7"
               }
             },
-            "description": "Details of the workflow and its transition rules.",
-            "definitions": {}
-          }
+            "description": "Details of the workflow and its transition rules."          }
         }
       ],
       "output": {

package/propertiesSchema.json

@@ -109,6 +109,14 @@
     },
     "cache": {
       "$ref": "#/definitions/cache"
+    },
+    "service": {
+      "type": "string",
+      "description": "Service we are integrating with -- used with AWS Authentication",
+      "examples": [
+        "ec2",
+        "route53"
+      ]
     }
   },
   "required": [
@@ -131,7 +139,8 @@
             "jwt_token",
             "request_token",
             "no_authentication",
-            "multi_step_authentication"
+            "multi_step_authentication",
+            "aws_authentication"
           ]
         },
         "username": {

package/report/adapterInfo.json

@@ -1,6 +1,6 @@
 {
-  "version": "2.0.1",
-  "configLines": 48719,
+  "version": "2.1.0",
+  "configLines": 48668,
   "scriptLines": 1783,
   "codeLines": 39944,
   "testLines": 37281,

package/report/updateReport1698421747424.json

@@ -0,0 +1,120 @@
+{
+  "errors": [],
+  "statistics": [
+    {
+      "owner": "errorJson",
+      "description": "New adapter errors available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors no longer available for use",
+      "value": 0
+    },
+    {
+      "owner": "errorJson",
+      "description": "Adapter errors that have been updated (e.g. recommendation changes)",
+      "value": 31
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of production dependencies",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 22
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "^5.3.0"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 77
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 347
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 642
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 48
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the ENHANCE.md",
+      "value": 70
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the BROKER.md",
+      "value": 70
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of lines of code in unit tests",
+      "value": 18316
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1162
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 17713
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 514
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1453
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 36
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 37482
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1676
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/utils/methodDocumentor.js

@@ -77,6 +77,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
   // parsing the file to get the function and class declarations.
   const aFileFuncArgs = acorn.parse(aFile, { ecmaVersion: 2020 });
 
+  let callName = 'identifyRequest';
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
     // Getting only the class declaration as it has our required functions.
@@ -89,8 +90,10 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         method.value.params.forEach((param) => {
           if (param.type === 'Identifier') {
             funcArgs.push(param.name);
+          } else if (param.type === 'RestElement') {
+            funcArgs.push(`...${param.argument.name}`);
           } else {
-            const args = `${param.left.name} = ${param.right.value}`;
+            const args = `${param.left.name} = ${param.right.raw}`;
             funcArgs.push(args);
           }
         });
@@ -102,7 +105,7 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         });
         const requests = [];
         for (let i = 0; i < callList.length; i += 1) {
-          if (callList[i].callee.property && callList[i].callee.property.name === 'identifyRequest') {
+          if (callList[i].callee.property && callList[i].callee.property.name === callName) {
             requests.push(callList[i]);
           }
         }
@@ -114,7 +117,16 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
           const entity = expr.arguments[0].value;
           const actionName = expr.arguments[1].value;
           if (expr !== undefined && (expr.arguments[0].type !== 'Literal' || expr.arguments[1].type !== 'Literal')) {
-            throw new Error(`Bad inputs in method ${funcName}`);
+            const param1 = method.value.params[0];
+            const param2 = method.value.params[1];
+            if (param1.type !== 'Identifier' || param2.type !== 'Identifier'
+                || expr.arguments[0].type !== 'Identifier' || expr.arguments[1].type !== 'Identifier'
+                || param1.name !== expr.arguments[0].name || param2.name !== expr.arguments[1].name) {
+              throw new Error(`identifyRequest proxy method ${funcName} unknown format`);
+            } else if (callName !== 'identifyRequest') {
+              throw new Error(`MethodDocumentor not yet programmed to handle multiple helper methods: 1) ${callName}, 2) ${funcName}`);
+            }
+            callName = funcName;
           }
           const entityPath = getPathFromEntity(entity, actionName);
 
@@ -197,6 +209,7 @@ function readMDFile(filename, functionList) {
   // Creating the tags for each method to be appended to the file.
   const tdBeginTag = '    <td style="padding:15px">';
   const tdEndTag = '</td>';
+
   functionList.forEach((func) => {
     const signCommand = `${tdBeginTag}${func.method_signature}${tdEndTag}`;
     const descCommand = `${tdBeginTag}${func.description}${tdEndTag}`;