@itentialopensource/adapter-winston_syslog 1.4.1 → 1.5.0

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 Winsto
     <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/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-winston_syslog",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "This adapter integrates with winston_syslog and sends logs to any syslog server.",
   "main": "adapter.js",
   "systemName": "winston_syslog",
-  "wizardVersion": "2.44.7",
-  "engineVersion": "1.71.2",
+  "wizardVersion": "3.8.0",
+  "engineVersion": "1.79.2",
   "adapterType": "http",
   "scripts": {
     "preinstall": "node utils/setup.js",
@@ -50,7 +50,7 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-winston_syslog#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "5.10.25",
+    "@itentialopensource/adapter-utils": "6.0.2",
     "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"
@@ -313,6 +313,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",
@@ -729,7 +767,7 @@
         "protocol": {
           "type": "string",
           "description": "the protocol to use to connect to the proxy",
-          "default": "http",
+          "default": "https",
           "enum": [
             "http",
             "https",
@@ -1761,4 +1799,4 @@
       }
     }
   }
-}
+}

package/report/updateReport1764797404734.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": 15
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of development dependencies",
+      "value": 6
+    },
+    {
+      "owner": "packageJson",
+      "description": "Number of npm scripts",
+      "value": 17
+    },
+    {
+      "owner": "packageJson",
+      "description": "Runtime Library dependency",
+      "value": "6.0.2"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 85
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the README.md",
+      "value": 345
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the SUMMARY.md",
+      "value": 9
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the PROPERTIES.md",
+      "value": 677
+    },
+    {
+      "owner": "markdown",
+      "description": "Number of lines in the TROUBLESHOOT.md",
+      "value": 57
+    },
+    {
+      "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": 1536
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 72
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 463
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 10
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of lines of code in adapterBase.js",
+      "value": 1527
+    },
+    {
+      "owner": "staticFile",
+      "description": "Number of static files added",
+      "value": 37
+    },
+    {
+      "owner": "Overall",
+      "description": "Total lines of Code",
+      "value": 3526
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 82
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -29,6 +29,9 @@
       "client_id": "",
       "client_secret": "",
       "grant_type": "",
+      "auth_request_datatype": "",
+      "auth_response_datatype": "",
+      "token_response_placement": "",
       "sensitive": [],
       "sso": {
         "protocol": "",
@@ -260,4 +263,4 @@
   "brokers": [],
   "logLevel": "info",
   "timeout": 120000
-}
+}

package/test/unit/adapterBaseTestUnit.js

@@ -387,7 +387,7 @@ describe('[unit] Adapter Base Test', () => {
           'healthCheck', 'iapActivateTasks', 'iapDeactivateTasks', 'iapExpandedGenericAdapterRequest', 'iapFindAdapterPath', 'iapGetAdapterInventory', 'iapGetAdapterQueue',
           'iapGetAdapterWorkflowFunctions', 'iapGetDeviceCount', 'iapGetDeviceCountAuth', 'iapMoveAdapterEntitiesToDB', 'iapPopulateEntityCache', 'iapRetrieveEntitiesCache',
           'iapRunAdapterBasicGet', 'iapRunAdapterConnectivity', 'iapRunAdapterHealthcheck', 'iapRunAdapterLint', 'iapRunAdapterTests', 'iapSuspendAdapter', 'iapTroubleshootAdapter',
-          'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration', 'isAlive', 'isAliveAuth', 'refreshProperties', 'addListener', 'emit', 'eventNames', 'getMaxListeners',
+          'iapUnsuspendAdapter', 'iapUpdateAdapterConfiguration', 'isAlive', 'isAliveAuth', 'parseIapMetadata', 'refreshProperties', 'addListener', 'emit', 'eventNames', 'getMaxListeners',
           'listenerCount', 'listeners', 'off', 'on', 'once', 'prependListener', 'prependOnceListener', 'rawListeners', 'removeAllListeners', 'removeListener', 'setMaxListeners'];
         try {
           const expectedFunctions = a.getAllFunctions();

package/test/unit/adapterTestUnit.js

@@ -579,6 +579,9 @@ describe('[unit] WinstonSyslog Adapter Test', () => {
           assert.equal('string', propertiesDotJson.definitions.authentication.properties.client_id.type);
           assert.equal('string', propertiesDotJson.definitions.authentication.properties.client_secret.type);
           assert.equal('string', propertiesDotJson.definitions.authentication.properties.grant_type.type);
+          assert.equal('string', propertiesDotJson.definitions.authentication.properties.auth_request_datatype.type);
+          assert.equal('string', propertiesDotJson.definitions.authentication.properties.auth_response_datatype.type);
+          assert.equal('string', propertiesDotJson.definitions.authentication.properties.token_response_placement.type);
           assert.notEqual(undefined, propertiesDotJson.definitions.ssl);
           assert.notEqual(null, propertiesDotJson.definitions.ssl);
           assert.notEqual('', propertiesDotJson.definitions.ssl);
@@ -769,6 +772,9 @@ describe('[unit] WinstonSyslog Adapter Test', () => {
           assert.notEqual(undefined, sampleDotJson.properties.authentication.client_id);
           assert.notEqual(undefined, sampleDotJson.properties.authentication.client_secret);
           assert.notEqual(undefined, sampleDotJson.properties.authentication.grant_type);
+          assert.notEqual(undefined, sampleDotJson.properties.authentication.auth_request_datatype);
+          assert.notEqual(undefined, sampleDotJson.properties.authentication.auth_response_datatype);
+          assert.notEqual(undefined, sampleDotJson.properties.authentication.token_response_placement);
           assert.notEqual(undefined, sampleDotJson.properties.ssl);
           assert.notEqual(null, sampleDotJson.properties.ssl);
           assert.notEqual('', sampleDotJson.properties.ssl);