[Chore] Update app to use global proxy service (SC-167944, SC-180557, SC-183520, SC-180924)

SETUP.md

@@ -1,4 +1,8 @@
-# SurveyMonkey Instructions
+# SurveyMonkey Setup Instructions
+
+Follow these steps to install and configure the SurveyMonkey app using either an Access Token or OAuth credentials.
+
+## Using Access Token
 
 First, go to the SurveyMonkey developer website ([developer.surveymonkey.com](https://developer.surveymonkey.com), or [developer.eu.surveymonkey.com](https://developer.eu.surveymonkey.com/) if you are based in EU) and log in to your account.
 
@@ -17,3 +21,26 @@ While on the settings tab in the SurveyMonkey developer website, scroll down to
 [![](/docs/assets/setup/surveymonkey_setup_03.png)](/docs/assets/setup/surveymonkey_setup_03.png)
 
 Once you're happy with your settings, click the "Install" button to install the app.
+
+## Using OAuth
+
+First, go to the SurveyMonkey developer website ([developer.surveymonkey.com](https://developer.surveymonkey.com), or [developer.eu.surveymonkey.com](https://developer.eu.surveymonkey.com/) if you are based in EU) and log in to your account.
+
+[![](/docs/assets/setup/surveymonkey_setup_01.png)](/docs/assets/setup/surveymonkey_setup_01.png)
+
+Once you're logged in, click on the __"My Apps"__ tab at the top. After that click on __"Add a New App"__, and fill in the required fields, making sure to select Private App as the App Type.
+
+[![](/docs/assets/setup/surveymonkey_setup_02.png)](/docs/assets/setup/surveymonkey_setup_02.png)
+
+
+On the "Details" page copy the `Client ID` and `Secret` and input the credentials in the settings tab in Deskpro.
+
+[![](/docs/assets/setup/surveymonkey_setup_04.png)](/docs/assets/setup/surveymonkey_setup_04.png)
+
+Head over to the __Settings__ tab in the SurveyMonkey website, and enter the `Callback URL` from Deskpro in the "OAuth Redirect URL" field.
+
+While on the settings tab in the SurveyMonkey developer website, scroll down to scopes and set __View Response Details__, __View Contacts__, __View Surveys__, __View Collectors__, __View Users__, and __View Responses__ to "Required", and click on Update Scopes.
+
+[![](/docs/assets/setup/surveymonkey_setup_03.png)](/docs/assets/setup/surveymonkey_setup_03.png)
+
+Once you're happy with your settings, click the "Install" button to install the app.

jest.config.js

@@ -35,6 +35,7 @@ module.exports = {
     "^.+\\.mjs$": "@swc/jest",
   },
   moduleNameMapper: {
+    "^@/(.*)$": "<rootDir>/src/$1",
     "\\.(jpg|ico|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$":
       "<rootDir>/config/jest/fileTransform.js",
     "\\.(css|less)$": "<rootDir>/config/jest/fileTransform.js",

manifest.json

@@ -8,31 +8,101 @@
   "isSingleInstall": false,
   "hasDevMode": true,
   "serveUrl": "https://apps-cdn.deskpro-service.com/__name__/__version__",
-  "targets": [{ "target": "ticket_sidebar", "entrypoint": "index.html" }],
+  "secrets": "duigHU4j5LpEnl/z10+g9hlSrHOF6k2LIrpDyjiitWrP+9Axm1b7yofWi5PIAPzmUiwvP+SxlayYwmLGdc+Qq/qnsmzcZ4RVdd5gnqqhEv88w8skemjyFtk8/dMlrGfUY/prhhhm2Km3X5Y18+8cWVCCI0d36fKHuo33TgXdUg1QkezWeYflUj7PVCJgIARlXg6S/Rn65++O/6DMVXkxRP8r59Y0AhIUgJY9rxNRCneXUHG59cJ4Jx5OcHtbzIKNlpiWAfzsjzccNlveHSDGRzkiYraflh/YYMIWe1iheEa5+WvZpQidx4KAYqqrsYYkN1+1Nk5+Dh9C74pE+epoW5q+me4CcJR5CfAlMpMZnr32ecyJqkyWBmMk1swRnhlTNx7BEcmzy3xyAFscR/fhdJlQIkcbq9/YykRiIAKDAFmvLYhn4SbwVZMhlWTOvn2Ottt82HRr7lP6ZKZNkqaeuW63egzrowcJxR6KJRcDQqYrCQoLHOyK4wnqJ+XCU1DW4A2nAZJmTkykkgIwJt+eMKOmrErh9QArSibV+X6XBc14vUGRwed62GhzNoWZv/kU//gp8AZkwWRGhYbUQcxT+JPcN4HOqvJSPofJXTuDKZ6879oSO6S0mAuE87OzFWRKuGOhMgoXvwxzysXTnEDKsMOKZVsmlD3GWR/wReVk4q3OAGPpLo6z5f1Ly5PJtSA7KLhMUo37a+UEto6/H935oiSuHZQb1XYqvxT5Wm3k2EuFVMqqL9zxaUSKR6bbunX9mrL00lTRQTTNVjyj5bk6gcWc0oZFoZDlKbJCfS2al5pJMAsjZEFAdRtUi06WnHtKKpAYULbyBEFE+fSs9a7A9JuXyEXNYXha6c8biniO9yUr/XrKrOo0PAyaEFgRum7mHdPTlf3OJ5AQR1f+WgvpU9zm/tAou6gGJYtp0e/ePIBnaMT+cCTZPbxJcgR9iZ21RPwdiD5YTSehTuDjvpsEwKHJiGSW57BxLcJasUQ9CWjGQmBtm2YKtQ8g2/W03WuvOY8QwfZSpKyW3pHWtNSUVKjOjh4pldRXjwEjWSmRW/MH1zyQIBSGV9WF4pir9ny0tdE9cA/VQGzYZUYM7Rc+zw==",
+  "targets": [
+    {
+      "target": "ticket_sidebar",
+      "entrypoint": "index.html"
+    }
+  ],
   "settings": {
-    "api_key": {
-      "title": "API Key",
-      "description": "The API key can be obtained by following our setup guide",
+    "use_advanced_connect": {
+      "title": "Advanced Connect",
+      "description": "Follow the setup guide and use your credentials to connect the app to Deskpro.",
+      "type": "boolean",
+      "default": false,
+      "isRequired": false,
+      "isBackendOnly": false,
+      "order": 5
+    },
+    "use_access_token": {
+      "title": "Use Access Token",
+      "type": "boolean",
+      "isRequired": false,
+      "isBackendOnly": false,
+      "default": false,
+      "condition": "settings.use_advanced_connect != false",
+      "order": 10
+    },
+    "access_token": {
+      "title": "Access Token",
+      "description": "The access token can be obtained by following our setup guide",
       "type": "string",
-      "isRequired": true,
-      "isBackendOnly": true
+      "isRequired": false,
+      "isBackendOnly": true,
+      "condition": "settings.use_advanced_connect != false && settings.use_access_token == true",
+      "order": 20
     },
     "verify_settings": {
       "title": "",
       "type": "app_embedded",
-      "options": { "entrypoint": "#/admin/verify_settings" },
+      "options": {
+        "entrypoint": "#/admin/verify_settings",
+        "height": "30px"
+      },
       "isRequired": false,
       "isBackendOnly": true,
-      "order": 20
+      "condition": "settings.use_advanced_connect != false && settings.use_access_token == true",
+      "order": 30
+    },
+    "client_id": {
+      "title": "Client ID",
+      "type": "string",
+      "isRequired": false,
+      "isBackendOnly": false,
+      "condition": "settings.use_advanced_connect != false && settings.use_access_token != true",
+      "order": 40
+    },
+    "client_secret": {
+      "title": "Client Secret",
+      "type": "string",
+      "isRequired": false,
+      "isBackendOnly": true,
+      "condition": "settings.use_advanced_connect != false && settings.use_access_token != true",
+      "order": 50
+    },
+    "callback_url": {
+      "title": "Callback URL",
+      "type": "app_embedded",
+      "options": {
+        "entrypoint": "#/admin/callback"
+      },
+      "isRequired": false,
+      "isBackendOnly": true,
+      "condition": "settings.use_advanced_connect != false && settings.use_access_token != true",
+      "order": 60
     }
   },
   "proxy": {
     "whitelist": [
       {
+
         "url": "https://api.surveymonkey.net/v3/.*",
-        "methods": ["GET", "POST", "PATCH"],
+        "methods": [
+          "GET",
+          "POST",
+          "PATCH"
+        ],
+        "timeout": 20
+      },
+      {
+
+        "url": "https://api.surveymonkey.com/oauth/.*",
+        "methods": [
+          "POST"
+        ],
         "timeout": 20
       }
     ]
   }
-}
+}

package.json

@@ -14,7 +14,7 @@
     "bumpManifestVer": "node ./bin/bumpManifestVer.js"
   },
   "dependencies": {
-    "@deskpro/app-sdk": "^5.1.1",
+    "@deskpro/app-sdk": "^6.0.3",
     "@deskpro/deskpro-ui": "^8.2.0",
     "@heroicons/react": "1.0.6",
     "@tanstack/react-query": "^4.36.1",
@@ -53,6 +53,6 @@
     "styled-components": "^6.1.14",
     "ts-jest": "^27.1.5",
     "typescript": "^5.7.2",
-    "vite": "^6.0.11"
+    "vite": "^6.2.2"
   }
-}
+}