@itentialopensource/adapter-microsoft_graph 1.1.0 → 1.2.0

package/CALLS.md

@@ -628,6 +628,12 @@ Specific adapter calls are built based on the API of the Microsoft_graph. The Ad
     <td style="padding:15px">{base_path}/{version}/v1.0/me/sendMail?{query}</td>
     <td style="padding:15px">Yes</td>
   </tr>
+  <tr>
+    <td style="padding:15px">sendmailApplication(body, userId, callback)</td>
+    <td style="padding:15px">Send mail with client credentials</td>
+    <td style="padding:15px">{base_path}/{version}/v1.0/users/{pathv1}/sendMail?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
   <tr>
     <td style="padding:15px">getmailboxsettings(callback)</td>
     <td style="padding:15px">Get mailbox settings</td>

package/CHANGELOG.md

@@ -1,4 +1,20 @@
 
+## 1.2.0 [11-07-2023]
+
+* More Migration Changes
+
+See merge request itentialopensource/adapters/cloud/adapter-microsoft_graph!5
+
+---
+
+## 1.1.1 [10-11-2023]
+
+* Patch/adapt 2935
+
+See merge request itentialopensource/adapters/cloud/adapter-microsoft_graph!4
+
+---
+
 ## 1.1.0 [09-26-2023]
 
 * 2023 Adapter Migration

package/adapter.js

@@ -7039,6 +7039,95 @@ class MicrosoftGraph extends AdapterBaseCl {
     }
   }
 
+  /**
+   * @function sendmailApplication
+   * @pronghornType method
+   * @name sendmailApplication
+   * @summary Send mail
+   *
+   * @param {object} body - body param
+   * @param {string} userId - user id or userPrincipalName to sendmail from
+   * @param {getCallback} callback - a callback function to return the result
+   * @return {object} results - An object containing the response of the action
+   *
+   * @route {POST} /sendmailApplication
+   * @roles admin
+   * @task true
+   */
+  /* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
+  sendmailApplication(body, userId, callback) {
+    const meth = 'adapter-sendmailApplication';
+    const origin = `${this.id}-${meth}`;
+    log.trace(origin);
+
+    if (this.suspended && this.suspendMode === 'error') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'AD.600', [], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (body === undefined || body === null || body === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['body'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+    /* HERE IS WHERE YOU VALIDATE DATA */
+    if (userId === undefined || userId === null || userId === '') {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['userId'], null, null, null);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+
+    /* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
+    const queryParamsAvailable = {};
+    const queryParams = {};
+    const pathVars = [userId];
+    const bodyVars = body;
+
+    // loop in template. long callback arg name to avoid identifier conflicts
+    Object.keys(queryParamsAvailable).forEach((thisKeyInQueryParamsAvailable) => {
+      if (queryParamsAvailable[thisKeyInQueryParamsAvailable] !== undefined && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== null
+          && queryParamsAvailable[thisKeyInQueryParamsAvailable] !== '') {
+        queryParams[thisKeyInQueryParamsAvailable] = queryParamsAvailable[thisKeyInQueryParamsAvailable];
+      }
+    });
+
+    // set up the request object - payload, uriPathVars, uriQuery, uriOptions, addlHeaders, authData, callProperties, filter, priority, event
+    // see adapter code documentation for more information on the request object's fields
+    const reqObj = {
+      payload: bodyVars,
+      uriPathVars: pathVars,
+      uriQuery: queryParams
+    };
+
+    try {
+      // Make the call -
+      // identifyRequest(entity, action, requestObj, returnDataFlag, callback)
+      return this.requestHandlerInst.identifyRequest('Mail', 'sendmailApplication', reqObj, true, (irReturnData, irReturnError) => {
+        // if we received an error or their is no response on the results
+        // return an error
+        if (irReturnError) {
+          /* HERE IS WHERE YOU CAN ALTER THE ERROR MESSAGE */
+          return callback(null, irReturnError);
+        }
+        if (!Object.hasOwnProperty.call(irReturnData, 'response')) {
+          const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Invalid Response', ['sendmail'], null, null, null);
+          log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+          return callback(null, errorObj);
+        }
+
+        /* HERE IS WHERE YOU CAN ALTER THE RETURN DATA */
+        // return the response
+        return callback(irReturnData, null);
+      });
+    } catch (ex) {
+      const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, ex);
+      log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
+      return callback(null, errorObj);
+    }
+  }
+
   /**
    * @function getmailboxsettings
    * @pronghornType method

package/entities/Mail/action.json

@@ -125,6 +125,26 @@
         }
       ]
     },
+    {
+      "name": "sendmailApplication",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/v1.0/users/{pathv1}/sendMail?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
     {
       "name": "getmailboxsettings",
       "protocol": "REST",

package/entities/Mail/schema.json

@@ -16,6 +16,7 @@
         "getmymailboxrules",
         "getmycategories",
         "sendmail",
+        "sendmailApplication",
         "getmailboxsettings",
         "setautomaticreplies",
         "getauserSmessages",

package/metadata.json

@@ -15,9 +15,7 @@
   ],
   "method": "REST",
   "type": "Adapter",
-  "domains": [
-    "Cloud"
-  ],
+  "domains": [],
   "tags": [],
   "useCases": [],
   "deprecated": {
@@ -27,7 +25,7 @@
   "documentation": {
     "storeLink": "",
     "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-microsoft_graph",
-    "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-microsoft_graph.git",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-microsoft_graph",
     "docLink": "https://docs.itential.com/opensource/docs/microsoft-graph",
     "demoLinks": [],
     "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@itentialopensource/adapter-microsoft_graph",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "This adapter integrates with system described as: microsoftGraph.",
   "main": "adapter.js",
   "wizardVersion": "2.44.7",
-  "engineVersion": "1.67.8",
+  "engineVersion": "1.67.10",
   "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
@@ -54,7 +54,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/cloud/adapter-microsoft_graph#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

@@ -3819,6 +3819,80 @@
       },
       "task": true
     },
+    {
+      "name": "sendmailApplication",
+      "summary": "Send mail with client credentials",
+      "description": "Send mail with client credentials",
+      "input": [
+        {
+          "name": "body",
+          "type": "object",
+          "info": ": object",
+          "required": true,
+          "schema": {
+            "allOf": [
+              {
+                "type": "object"
+              },
+              {
+                "example": {
+                  "message": {
+                    "subject": "Meet for lunch?",
+                    "body": {
+                      "contentType": "Text",
+                      "content": "The new cafeteria is open."
+                    },
+                    "toRecipients": [
+                      {
+                        "emailAddress": {
+                          "address": "{{UserName}}"
+                        }
+                      }
+                    ],
+                    "ccRecipients": [
+                      {
+                        "emailAddress": {
+                          "address": "{{UserName}}"
+                        }
+                      }
+                    ]
+                  },
+                  "saveToSentItems": "false"
+                }
+              }
+            ],
+            "definitions": {}
+          }
+        },
+        {
+          "name": "userId",
+          "type": "string",
+          "info": ": string",
+          "required": true,
+          "schema": {
+            "title": "userId",
+            "type": "string"
+          }
+        }
+      ],
+      "output": {
+        "name": "result",
+        "type": "object",
+        "description": "A JSON Object containing status, code and the result",
+        "schema": {
+          "title": "result",
+          "type": "object"
+        }
+      },
+      "roles": [
+        "admin"
+      ],
+      "route": {
+        "verb": "POST",
+        "path": "/sendmailApplication"
+      },
+      "task": true
+    },
     {
       "name": "getmailboxsettings",
       "summary": "Get mailbox settings",

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,10 +1,10 @@
 {
-  "version": "1.0.2",
-  "configLines": 10828,
+  "version": "1.1.1",
+  "configLines": 10911,
   "scriptLines": 1783,
-  "codeLines": 20081,
+  "codeLines": 20170,
   "testLines": 15130,
   "testCases": 772,
-  "totalCodeLines": 36994,
-  "wfTasks": 227
+  "totalCodeLines": 37083,
+  "wfTasks": 228
 }

package/report/updateReport1698420412551.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": 7690
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 491
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 6188
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 211
+    },
+    {
+      "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": 15331
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 702
+    },
+    {
+      "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}`;