@itentialopensource/adapter-alkira 0.10.1 → 0.11.0

package/CHANGELOG.md

@@ -1,4 +1,12 @@
 
+## 0.11.0 [02-13-2026]
+
+* minor/auto-migrate/20260213-110414
+
+See merge request itentialopensource/adapters/adapter-alkira!39
+
+---
+
 ## 0.6.5 [10-15-2024]
 
 * Changes made at 2024.10.14_19:46PM

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@itentialopensource/adapter-alkira",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "This adapter integrates with system described as: alkiraApi.",
   "main": "adapter.js",
   "systemName": "Alkira",
-  "wizardVersion": "3.8.0",
-  "engineVersion": "1.80.0",
+  "wizardVersion": "3.12.1",
+  "engineVersion": "1.82.5",
   "adapterType": "http",
   "scripts": {
     "preinstall": "node utils/setup.js",
@@ -38,8 +38,8 @@
   ],
   "license": "Apache-2.0",
   "engines": {
-    "node": ">= 14.0.0",
-    "npm": ">= 6.0.0"
+    "node": ">= 18.18.0",
+    "npm": ">= 9.8.1"
   },
   "repository": {
     "type": "git",
@@ -48,14 +48,14 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-alkira#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "6.1.7",
+    "@itentialopensource/adapter-utils": "6.1.14",
     "acorn": "8.14.1",
     "ajv": "8.17.1",
-    "axios": "1.12.2",
+    "axios": "1.13.5",
     "commander": "11.1.0",
     "fs-extra": "11.3.0",
     "json-query": "2.2.2",
-    "mocha": "10.8.2",
+    "mocha": "11.3.0",
     "mocha-param": "2.0.1",
     "mongodb": "4.17.2",
     "ping": "0.4.4",

package/propertiesSchema.json

@@ -66,7 +66,7 @@
         "boolean",
         "string"
       ],
-      "description": "When true the metrics collected by the adapter will be stored in mongo or on the filesystem",
+      "description": "When true the metrics collected by the adapter will be stored in mongo or in the adapter. If a full path is provided, metrics will be saved in the path provided.",
       "default": false
     },
     "stub": {
@@ -460,7 +460,7 @@
           "type": "integer",
           "description": "How often the healthcheck should run (in milliseconds).",
           "default": 300000,
-          "minimum": 60000,
+          "minimum": 30000,
           "maximum": 3600000
         },
         "protocol": {
@@ -698,9 +698,10 @@
         },
         "keep_alive_interval": {
           "type": "integer",
-          "description": "TCP keep-alive interval in seconds for long-lived connections. Set to 0 to disable (default). Minimum 30 seconds when enabled.",
+          "description": "TCP keep-alive interval in milliseconds to prevent connection timeout during long-running requests. 0 = disabled (default). Minimum value when enabled is 30000ms (30 seconds). Values below 30000ms will be auto-corrected to 30000ms with a warning.",
           "default": 0,
-          "minimum": 0
+          "minimum": 0,
+          "maximum": 3600000
         }
       },
       "required": [
@@ -1112,7 +1113,7 @@
               },
               "requestFields": {
                 "type": "object",
-                "description": "The json object with response fields of the call to getDevice",
+                "description": "The json object with request fields of the call to getDevice",
                 "additionalProperties": {
                   "type": [
                     "string",
@@ -1255,7 +1256,7 @@
               },
               "requestFields": {
                 "type": "object",
-                "description": "The json object with response fields of the call to getDevice",
+                "description": "The json object with request fields of the call to getDevice",
                 "additionalProperties": {
                   "type": [
                     "string",
@@ -1366,7 +1367,7 @@
               },
               "requestFields": {
                 "type": "object",
-                "description": "The json object with response fields of the call to getDevice",
+                "description": "The json object with request fields of the call to getDevice",
                 "additionalProperties": {
                   "type": [
                     "string",
@@ -1462,7 +1463,7 @@
               },
               "requestFields": {
                 "type": "object",
-                "description": "The json object with response fields of the call to getDevice",
+                "description": "The json object with request fields of the call to getDevice",
                 "additionalProperties": {
                   "type": [
                     "string",
@@ -1547,7 +1548,7 @@
               },
               "requestFields": {
                 "type": "object",
-                "description": "The json object with response fields of the call to getDevice",
+                "description": "The json object with request fields of the call to getDevice",
                 "additionalProperties": {
                   "type": [
                     "string",
@@ -1630,12 +1631,12 @@
                   "properties": {
                     "path": {
                       "type": "string",
-                      "description": "The fully qualified path of the call to getDevice (e.g. /rest/api/device/{deviceid})",
+                      "description": "The fully qualified path of the call to populate the cache (e.g. /rest/api/devices)",
                       "default": ""
                     },
                     "method": {
                       "type": "string",
-                      "description": "The method of the call to getDevice",
+                      "description": "The method of the call to populate the cache",
                       "default": "GET"
                     },
                     "pagination": {
@@ -1672,7 +1673,7 @@
                     },
                     "query": {
                       "type": "object",
-                      "description": "The json object with query parameters of the call to getDevice",
+                      "description": "The json object with query parameters of the call to populate the cache",
                       "additionalProperties": {
                         "type": [
                           "string",
@@ -1682,7 +1683,7 @@
                     },
                     "body": {
                       "type": "object",
-                      "description": "The json object with body of the call to getDevice",
+                      "description": "The json object with body of the call to populate the cache",
                       "additionalProperties": {
                         "type": [
                           "string",
@@ -1692,7 +1693,7 @@
                     },
                     "headers": {
                       "type": "object",
-                      "description": "The json object with headers of the call to getDevice",
+                      "description": "The json object with headers of the call to populate the cache",
                       "additionalProperties": {
                         "type": [
                           "string",
@@ -1711,7 +1712,7 @@
                     },
                     "requestFields": {
                       "type": "object",
-                      "description": "The json object with response fields of the call to getDevice",
+                      "description": "The json object with request fields of the call to populate the cache",
                       "additionalProperties": {
                         "type": [
                           "string",
@@ -1727,7 +1728,7 @@
                     },
                     "responseFields": {
                       "type": "object",
-                      "description": "The json object with response fields of the call to getDevice",
+                      "description": "The json object with response fields of the call to populate the cache",
                       "additionalProperties": {
                         "type": [
                           "string",

package/report/updateReport1770998655721.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.1.14"
+    },
+    {
+      "owner": "propertiesSchemaJson",
+      "description": "Adapter properties defined in the propertiesSchema file",
+      "value": 83
+    },
+    {
+      "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": 682
+    },
+    {
+      "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": 19287
+    },
+    {
+      "owner": "unitTestJS",
+      "description": "Number of unit tests",
+      "value": 1245
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of lines of code in integration tests",
+      "value": 12507
+    },
+    {
+      "owner": "integrationTestJS",
+      "description": "Number of integration tests",
+      "value": 449
+    },
+    {
+      "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": 33321
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Tests",
+      "value": 1694
+    },
+    {
+      "owner": "Overall",
+      "description": "Total Files",
+      "value": 6
+    }
+  ]
+}

package/sampleProperties.json

@@ -284,4 +284,4 @@
   "brokers": [],
   "logLevel": "none",
   "timeout": 120000
-}
+}

package/test/unit/adapterTestUnit.js

@@ -280,10 +280,10 @@ describe('[unit] Alkira Adapter Test', () => {
           assert.notEqual(null, packageDotJson.dependencies);
           assert.notEqual('', packageDotJson.dependencies);
           assert.equal('8.17.1', packageDotJson.dependencies.ajv);
-          assert.equal('1.12.2', packageDotJson.dependencies.axios);
+          assert.equal('1.13.5', packageDotJson.dependencies.axios);
           assert.equal('11.1.0', packageDotJson.dependencies.commander);
           assert.equal('11.3.0', packageDotJson.dependencies['fs-extra']);
-          assert.equal('10.8.2', packageDotJson.dependencies.mocha);
+          assert.equal('11.3.0', packageDotJson.dependencies.mocha);
           assert.equal('2.0.1', packageDotJson.dependencies['mocha-param']);
           assert.equal('0.4.4', packageDotJson.dependencies.ping);
           assert.equal('1.4.10', packageDotJson.dependencies['readline-sync']);

package/utils/methodDocumentor.js

@@ -19,17 +19,14 @@ function createObjectForFunction(
   workflow
 ) {
   const funcObject = {};
-  // if the entity path is not set, then the object is not created.
-  if (entityPath !== undefined) {
-    funcObject.method_signature = `${funcName}(${funcArgs.join(', ')})`;
-    funcObject.path = entityPath;
-    if (description === undefined) {
-      funcObject.description = '';
-      funcObject.workflow = 'No';
-    } else {
-      funcObject.description = description;
-      funcObject.workflow = workflow;
-    }
+  funcObject.method_signature = `${funcName}(${funcArgs.join(', ')})`;
+  funcObject.path = entityPath !== undefined ? entityPath : '';
+  if (description === undefined) {
+    funcObject.description = '';
+    funcObject.workflow = 'No';
+  } else {
+    funcObject.description = description;
+    funcObject.workflow = workflow;
   }
   return funcObject;
 }
@@ -77,7 +74,8 @@ 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';
+  // Track all method names that can be called (identifyRequest + any proxy methods)
+  const allowedCallNames = new Set(['identifyRequest']);
   // Looping through all the declarations parsed:
   aFileFuncArgs.body.forEach((e) => {
     // Getting only the class declaration as it has our required functions.
@@ -103,9 +101,10 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
         method.value.body.body.forEach((statement) => {
           recurseCallExpressions(statement, callList);
         });
+        // Find calls to identifyRequest OR any discovered proxy methods
         const requests = [];
         for (let i = 0; i < callList.length; i += 1) {
-          if (callList[i].callee.property && callList[i].callee.property.name === callName) {
+          if (callList[i].callee.property && allowedCallNames.has(callList[i].callee.property.name)) {
             requests.push(callList[i]);
           }
         }
@@ -114,34 +113,60 @@ function readFileUsingLib(filename, descriptionObj, workflowObj, functionList) {
           if (expr.arguments.length < 2) {
             throw new Error(`Bad inputs in method ${funcName}`);
           }
-          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')) {
-            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}`);
+
+          const arg0Type = expr.arguments[0].type;
+          const arg1Type = expr.arguments[1].type;
+
+          let entityPath;
+
+          if (arg0Type === 'Literal' && arg1Type === 'Literal') {
+            const entity = expr.arguments[0].value;
+            const actionName = expr.arguments[1].value;
+            entityPath = getPathFromEntity(entity, actionName);
+          } else {
+            // Non-standard format: anything that's not both literals
+            // Special handling for proxy methods (both args are identifiers matching first 2 params)
+            if (arg0Type === 'Identifier' && arg1Type === 'Identifier') {
+              const param1 = method.value.params[0];
+              const param2 = method.value.params[1];
+              const arg0Name = expr.arguments[0].name;
+              const arg1Name = expr.arguments[1].name;
+
+              // Check if this is a valid proxy method
+              const isValidProxy = param1 && param2
+                  && param1.type === 'Identifier' && param2.type === 'Identifier'
+                  && param1.name === arg0Name && param2.name === arg1Name;
+
+              // Only process valid proxy methods
+              if (isValidProxy) {
+                const calledMethod = expr.callee.property.name;
+
+                // Skip nested proxies (proxies calling other proxies)
+                if (calledMethod !== 'identifyRequest') {
+                  console.log(`Skipping nested proxy method: ${funcName} (calls ${calledMethod})`);
+                  return;
+                }
+
+                // First-level proxy: calls identifyRequest directly
+                // Add this proxy to the set so other methods can call it
+                allowedCallNames.add(funcName);
+              }
             }
-            callName = funcName;
+
+            // All non-standard formats get documented without path
+            entityPath = undefined;
           }
-          const entityPath = getPathFromEntity(entity, actionName);
 
           // Creating and storing the object for the method.
-          if (entityPath !== undefined) {
-            functionList.push(
-              createObjectForFunction(
-                funcName,
-                funcArgs,
-                entityPath,
-                descriptionObj[funcName],
-                workflowObj[funcName]
-              )
-            );
-          }
+          functionList.push(
+            createObjectForFunction(
+              funcName,
+              funcArgs,
+              entityPath,
+              descriptionObj[funcName],
+              workflowObj[funcName]
+            )
+          );
         }
       });
     }