@itentialopensource/adapter-salesforce 0.7.4 → 0.9.0

package/changelogs/changelog.md

@@ -0,0 +1,94 @@
+
+## 0.8.0 [05-25-2022]
+
+* Migration to the latest Adapter Foundation
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!8
+
+---
+
+## 0.7.4 [03-13-2021]
+
+- Migration to bring up to the latest foundation
+  - Change to .eslintignore (adapter_modification directory)
+  - Change to README.md (new properties, new scripts, new processes)
+  - Changes to adapterBase.js (new methods)
+  - Changes to package.json (new scripts, dependencies)
+  - Changes to propertiesSchema.json (new properties and changes to existing)
+  - Changes to the Unit test
+  - Adding several test files, utils files and .generic entity
+  - Fix order of scripts and dependencies in package.json
+  - Fix order of properties in propertiesSchema.json
+  - Update sampleProperties, unit and integration tests to have all new properties.
+  - Add all new calls to adapter.js and pronghorn.json
+  - Add suspend piece to older methods
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!7
+
+---
+
+## 0.7.3 [07-10-2020]
+
+- Update the adapter to the latest foundation
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!6
+
+---
+
+## 0.7.2 [01-14-2020]
+
+- Update the adapter to the latest foundation
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!5
+
+---
+
+## 0.7.1 [11-19-2019]
+
+- Update the healthcheck url to one that has been used in the lab
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!4
+
+---
+
+## 0.7.0 [11-08-2019]
+
+- Update the adapter to the latest adapter foundation.
+  - Updating to adapter-utils 4.24.3 (automatic)
+  - Add sample token schemas (manual)
+  - Adding placement property to getToken response schema (manual - before encrypt)
+  - Adding sso default into action.json for getToken (manual - before response object)
+  - Add new adapter properties for metrics & mock (save_metric, mongo and return_raw) (automatic - check place manual before stub)
+  - Update sample properties to include new properties (manual)
+  - Update integration test for raw mockdata (automatic)
+  - Update test properties (manual)
+  - Changes to artifactize (automatic)
+  - Update type in sampleProperties so it is correct for the adapter (manual)
+  - Update the readme (automatic)
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!3
+
+---
+
+## 0.6.0 [09-16-2019]
+
+- Update the adapter to the latest adapter foundation
+
+See merge request itentialopensource/adapters/itsm-testing/adapter-salesforce!2
+
+---
+## 0.5.0 [07-30-2019] & 0.4.0 [07-18-2019] & 0.3.0 [07-16-2019] & 0.2.0 [07-16-2019]
+
+- Updates to the adapter foundation
+
+See merge request itentialopensource/adapters/adapter-salesforce!1
+
+---
+
+## 0.1.1 [05-03-2019]
+
+- Initial Commit
+
+See commit e3e0165
+
+---

package/entities/.generic/action.json

@@ -4,7 +4,7 @@
       "name": "getGenerics",
       "protocol": "REST",
       "method": "GET",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -25,7 +25,7 @@
       "name": "createGeneric",
       "protocol": "REST",
       "method": "POST",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -46,7 +46,7 @@
       "name": "updateGeneric",
       "protocol": "REST",
       "method": "PUT",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -67,7 +67,7 @@
       "name": "patchGeneric",
       "protocol": "REST",
       "method": "PATCH",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,
@@ -88,7 +88,112 @@
       "name": "deleteGeneric",
       "protocol": "REST",
       "method": "DELETE",
-      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}?{query}",
+      "entitypath": "{base_path}/{version}/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "getGenericsNoBase",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "createGenericNoBase",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "updateGenericNoBase",
+      "protocol": "REST",
+      "method": "PUT",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "patchGenericNoBase",
+      "protocol": "REST",
+      "method": "PATCH",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "deleteGenericNoBase",
+      "protocol": "REST",
+      "method": "DELETE",
+      "entitypath": "/{pathv1}/{pathv2}/{pathv3}/{pathv4}/{pathv5}/{pathv6}/{pathv7}/{pathv8}/{pathv9}/{pathv10}/{pathv11}/{pathv12}/{pathv13}/{pathv14}/{pathv15}/{pathv16}/{pathv17}/{pathv18}/{pathv19}/{pathv20}?{query}",
       "requestSchema": "schema.json",
       "responseSchema": "schema.json",
       "timeout": 0,

package/entities/.generic/schema.json

@@ -14,7 +14,12 @@
         "createGeneric",
         "updateGeneric",
         "patchGeneric",
-        "deleteGeneric"
+        "deleteGeneric",
+        "getGenericsNoBase",
+        "createGenericNoBase",
+        "updateGenericNoBase",
+        "patchGenericNoBase",
+        "deleteGenericNoBase"
       ],
       "external_name": "ph_request_type"
     }

package/entities/.system/action.json

@@ -4,7 +4,7 @@
       "name": "getToken",
       "protocol": "REST",
       "method": "POST",
-      "entitypath": "{base_path}/{version}/login",
+      "entitypath": "/services/oath2/token",
       "requestSchema": "schemaTokenReq.json",
       "responseSchema": "schemaTokenResp.json",
       "timeout": 0,
@@ -14,9 +14,9 @@
       "responseDatatype": "JSON",
       "headers": {},
       "sso": {
-        "protocol": "",
-        "host": "",
-        "port": 0
+        "protocol": "https",
+        "host": "login.salesforce.com",
+        "port": 443
       },
       "responseObjects": [
         {

package/entities/.system/schemaTokenReq.json

@@ -34,11 +34,40 @@
         "key": ""
       },
       "external_name": "password"
+    },
+    "client_id": {
+      "type": "string",
+      "description": "client id to log in with",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "client_id"
+    },
+    "client_secret": {
+      "type": "string",
+      "description": "client secret to log in with",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "client_secret"
+    },
+    "grant_type": {
+      "type": "string",
+      "description": "grant type to log in with",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "grant_type"
     }
   },
-  "required": [
-    "username",
-    "password"
-  ],
   "definitions": {}
 }

package/entities/.system/schemaTokenResp.json

@@ -13,28 +13,6 @@
       ],
       "external_name": "ph_request_type"
     },
-    "code": {
-      "type": "number",
-      "description": "the https/http code",
-      "parse": false,
-      "encode": false,
-      "encrypt": {
-        "type": "AES",
-        "key": ""
-      },
-      "external_name": "code"
-    },
-    "success": {
-      "type": "boolean",
-      "description": "the api execution",
-      "parse": false,
-      "encode": false,
-      "encrypt": {
-        "type": "AES",
-        "key": ""
-      },
-      "external_name": "success"
-    },
     "token": {
       "type": "string",
       "description": "the token returned from system",
@@ -44,18 +22,7 @@
         "type": "AES",
         "key": ""
       },
-      "external_name": "data.token"
-    },
-    "expires": {
-      "type": "string",
-      "description": "the command being run on the device",
-      "parse": false,
-      "encode": false,
-      "encrypt": {
-        "type": "AES",
-        "key": ""
-      },
-      "external_name": "data.expires"
+      "external_name": "access_token"
     }
   },
   "definitions": {}

package/error.json

@@ -96,6 +96,12 @@
       "displayString": "Invalid properties: $VARIABLE$",
       "recommendation": "Verify the properties for the adapter"
     },
+    {
+      "key": "Missing Properties",
+      "icode": "AD.306",
+      "displayString": "Property $VARIABLE$ is required",
+      "recommendation": "Please provide the required property"
+    },
     {
       "key": "Query Not Translated",
       "icode": "AD.310",
@@ -168,6 +174,12 @@
       "displayString": "Failure response received for $VARIABLE$",
       "recommendation": "Check the reason for failure in the stack trace"
     },
+    {
+      "key": "Suspended Adapter",
+      "icode": "AD.600",
+      "displayString": "Adapter is suspended",
+      "recommendation": "Check if external system is functional and unsuspend if appropriate"
+    },
     {
       "key": "Caught Exception",
       "icode": "AD.900",

package/metadata.json

@@ -0,0 +1,49 @@
+{
+  "name": "adapter-salesforce",
+  "webName": "Adapter for Integration to Salesforce",
+  "vendor": "Salesforce",
+  "product": "Salesforce",
+  "osVersion": [],
+  "apiVersions": [],
+  "iapVersions": [
+    "2021.1.x",
+    "2021.2.x",
+    "2022.1.x",
+    "2023.1.x"
+  ],
+  "method": "REST",
+  "type": "Adapter",
+  "domains": [
+    "ITSM (Service Management)"
+  ],
+  "tags": [],
+  "useCases": [],
+  "deprecated": {
+    "isDeprecated": false
+  },
+  "brokerSince": "",
+  "documentation": {
+    "storeLink": "",
+    "npmLink": "https://www.npmjs.com/package/@itentialopensource/adapter-salesforce",
+    "repoLink": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-salesforce",
+    "docLink": "",
+    "demoLinks": [],
+    "trainingLinks": [],
+    "faqLink": "https://docs.itential.com/opensource/docs/troubleshooting-an-adapter",
+    "contributeLink": "https://gitlab.com/itentialopensource/adapters/contributing-guide",
+    "issueLink": "https://itential.atlassian.net/servicedesk/customer/portals",
+    "webLink": "https://www.itential.com/adapters/salesforce/",
+    "vendorLink": "",
+    "productLink": "",
+    "apiLinks": []
+  },
+  "assets": [],
+  "relatedItems": {
+    "adapters": [],
+    "integrations": [],
+    "ecosystemApplications": [],
+    "workflowProjects": [],
+    "transformationProjects": [],
+    "exampleProjects": []
+  }
+}

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@itentialopensource/adapter-salesforce",
-  "version": "0.7.4",
+  "version": "0.9.0",
   "description": "This adapter integrates with system Salesforce",
   "main": "adapter.js",
-  "wizardVersion": "2.43.12",
-  "engineVersion": "1.58.6",
+  "wizardVersion": "2.44.7",
+  "engineVersion": "1.67.14",
+  "adapterType": "http",
   "scripts": {
     "artifactize": "npm i && node utils/packModificationScript.js",
     "preinstall": "node utils/setup.js",
+    "deinstall": "node utils/removeHooks.js",
     "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
     "lint:errors": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js --quiet",
     "test:baseunit": "mocha test/unit/adapterBaseTestUnit.js --LOG=error",
@@ -15,17 +17,17 @@
     "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
     "test:cover": "nyc --reporter html --reporter text mocha --reporter dot test/*",
     "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
-    "adapter:install": "node utils/tbScript.js install",
+    "adapter:install": "npm i && node utils/tbScript.js install",
     "adapter:checkMigrate": "node utils/checkMigrate.js",
     "adapter:findPath": "node utils/findPath.js",
     "adapter:migrate": "node utils/modify.js -m",
     "adapter:update": "node utils/modify.js -u",
     "adapter:revert": "node utils/modify.js -r",
-    "troubleshoot": "node utils/tbScript.js",
+    "troubleshoot": "node utils/tbScript.js troubleshoot",
     "healthcheck": "node utils/tbScript.js healthcheck",
     "basicget": "node utils/tbScript.js basicget",
     "connectivity": "node utils/tbScript.js connectivity",
-    "deploy": "npm publish --registry=http://registry.npmjs.org --access=public",
+    "deploy": "npm publish --registry=https://registry.npmjs.org --access=public",
     "build": "npm run deploy"
   },
   "keywords": [
@@ -52,27 +54,31 @@
   "author": "Itential",
   "homepage": "https://gitlab.com/itentialopensource/adapters/itsm-testing/adapter-salesforce#readme",
   "dependencies": {
-    "@itentialopensource/adapter-utils": "^4.39.2",
-    "ajv": "^6.12.0",
-    "axios": "^0.21.0",
-    "commander": "^2.20.0",
-    "fs-extra": "^8.1.0",
-    "mocha": "^8.1.1",
+    "@itentialopensource/adapter-utils": "^5.3.0",
+    "acorn": "^8.10.0",
+    "ajv": "^8.12.0",
+    "axios": "^1.6.3",
+    "commander": "^11.0.0",
+    "dns-lookup-promise": "^1.0.4",
+    "fs-extra": "^11.1.1",
+    "json-query": "^2.2.2",
+    "mocha": "^10.2.0",
     "mocha-param": "^2.0.1",
-    "network-diagnostics": "^0.5.3",
+    "mongodb": "^4.16.0",
     "nyc": "^15.1.0",
+    "ping": "^0.4.4",
+    "prompts": "^2.4.2",
     "readline-sync": "^1.4.10",
-    "semver": "^7.3.2",
-    "winston": "^3.3.3"
+    "semver": "^7.5.3",
+    "winston": "^3.9.0"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^7.2.0",
-    "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.21.2",
-    "eslint-plugin-json": "^2.1.1",
-    "package-json-validator": "^0.6.3",
-    "testdouble": "^3.16.1"
+    "chai": "^4.3.7",
+    "eslint": "^8.44.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-json": "^3.1.0",
+    "testdouble": "^3.18.0"
   },
   "private": false
 }