@itentialopensource/adapter-nautobot_v2 0.4.0 → 0.5.1

package/PROPERTIES.md

@@ -29,7 +29,10 @@ This section defines **all** the properties that are available for the adapter,
         "auth_logging": false,
         "client_id": "",
         "client_secret": "",
-        "grant_type": ""
+        "grant_type": "",
+        "auth_request_datatype": "",
+        "auth_response_datatype": "",
+        "token_response_placement": ""
       },
       "healthcheck": {
         "type": "startup",
@@ -283,6 +286,18 @@ The following properties are used to define the authentication process to Nautob
     <td style="padding:15px">grant_type</td>
     <td style="padding:15px">Provide a grant type when needed, this is common on some types of OAuth.</td>
   </tr>
+  <tr>
+    <td style="padding:15px">auth_request_datatype</td>
+    <td style="padding:15px">Override the request data type for token authentication requests. When set, this overrides the schema's requestDatatype (JSON, JSON2XML, PLAIN, XML, URLENCODE, URLQUERY, FORM).</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">auth_response_datatype</td>
+    <td style="padding:15px">Override the response data type for token authentication requests. When set, this overrides the schema's responseDatatype (JSON, XML2JSON, PLAIN, XML, URLENCODE).</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">token_response_placement</td>
+    <td style="padding:15px">Override where to extract the token from the authentication response (HEADER or BODY). When set, this overrides the schema's token placement setting.</td>
+  </tr>
 </table>
 <br>
 

package/TAB2.md

@@ -96,6 +96,9 @@ Sample Properties can be used to help you configure the adapter in the Itential
       "client_id": "",
       "client_secret": "",
       "grant_type": "",
+      "auth_request_datatype": "",
+      "auth_response_datatype": "",
+      "token_response_placement": "",
       "sensitive": [],
       "sso": {
         "protocol": "",

package/adapterBase.js

@@ -1246,6 +1246,44 @@ class AdapterBase extends EventEmitterCl {
     return this.requestHandlerInst.iapGetDeviceCountAuth(callOptions, callback);
   }
 
+  /**
+   * @summary Parse and merge iapMetadata fields into reqObj
+   *
+   * @function parseIapMetadata
+   * @param {Object} reqObj - the request object to merge metadata into
+   * @param {Object} iapMetadata - the metadata object to parse and merge
+   */
+  parseIapMetadata(reqObj, iapMetadata) {
+    const reqFields = ['payload', 'uriPathVars', 'uriQuery', 'uriOptions', 'addlHeaders', 'authData', 'callProperties', 'filter', 'priority', 'event'];
+
+    const result = { ...reqObj };
+
+    // Merge and add new iapMetadata fields in result
+    Object.keys(iapMetadata).forEach((iapField) => {
+      if (reqFields.includes(iapField) && iapMetadata[iapField]) {
+        if (Array.isArray(result[iapField]) && Array.isArray(iapMetadata[iapField])) {
+          result[iapField] = result[iapField].concat(iapMetadata[iapField]); // Merge arrays
+        } else if (
+          result[iapField]
+          && iapMetadata[iapField]
+          && typeof result[iapField] === 'object'
+          && typeof iapMetadata[iapField] === 'object'
+          && !Array.isArray(result[iapField])
+          && !Array.isArray(iapMetadata[iapField])
+        ) {
+          result[iapField] = { ...result[iapField], ...iapMetadata[iapField] }; // Merge objects
+        } else {
+          // Otherwise, add new iapMetadata fields to result
+          result[iapField] = iapMetadata[iapField];
+        }
+      }
+    });
+    // Add iapMetadata to result for further work
+    result.iapMetadata = iapMetadata;
+
+    return result;
+  }
+
   /* ********************************************** */
   /*                                                */
   /*          EXPOSES GENERIC HANDLER               */

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-nautobot_v2",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "description": "This adapter integrates with system described as: Nautobot.",
   "main": "adapter.js",
   "systemName": "Nautobot",
-  "wizardVersion": "2.44.7",
-  "engineVersion": "1.71.2",
+  "wizardVersion": "3.8.0",
+  "engineVersion": "1.79.2",
   "adapterType": "http",
   "scripts": {
     "preinstall": "node utils/setup.js",
@@ -47,7 +47,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-nautobot_v2#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "6.0.2",
+    "@itentialopensource/adapter-utils": "6.0.3",
     "acorn": "8.14.1",
     "ajv": "8.17.1",
     "axios": "1.12.2",

package/propertiesSchema.json

@@ -77,7 +77,7 @@
     "protocol": {
       "type": "string",
       "description": "the protocol to use to connect to server",
-      "default": "http",
+      "default": "https",
       "enum": [
         "http",
         "https"
@@ -274,6 +274,44 @@
           "description": "The grant type for OAuth requests - can also provide in schema",
           "default": ""
         },
+        "auth_request_datatype": {
+          "type": "string",
+          "description": "Override the request data type for token authentication requests. When set, this overrides the schema's requestDatatype",
+          "default": "",
+          "enum": [
+            "",
+            "JSON",
+            "JSON2XML",
+            "PLAIN",
+            "XML",
+            "URLENCODE",
+            "URLQUERY",
+            "FORM"
+          ]
+        },
+        "auth_response_datatype": {
+          "type": "string",
+          "description": "Override the response data type for token authentication requests. When set, this overrides the schema's responseDatatype",
+          "default": "",
+          "enum": [
+            "",
+            "JSON",
+            "XML2JSON",
+            "PLAIN",
+            "XML",
+            "URLENCODE"
+          ]
+        },
+        "token_response_placement": {
+          "type": "string",
+          "description": "Override where to extract the token from the authentication response (HEADER or BODY). When set, this overrides the schema's token placement setting",
+          "default": "",
+          "enum": [
+            "",
+            "HEADER",
+            "BODY"
+          ]
+        },
         "sensitive": {
           "type": "array",
           "description": "List of sensitive keys to search and hide values from being logged",
@@ -692,7 +730,7 @@
         "protocol": {
           "type": "string",
           "description": "the protocol to use to connect to the proxy",
-          "default": "http",
+          "default": "https",
           "enum": [
             "http",
             "https",
@@ -1724,4 +1762,4 @@
       }
     }
   }
-}
+}