@oneuptime/common 8.0.5185 → 8.0.5201

package/Server/Types/Workflow/Components/MicrosoftTeams/SendMessageToChannel.ts

@@ -74,29 +74,32 @@ export default class SendMessageToChannel extends ComponentCode {
 
     try {
       // https://github.com/OfficeDev/Microsoft-Teams-Samples/blob/main/samples/incoming-webhook/nodejs/api/server/index.js#L28
-      apiResult = await API.post(args["webhook-url"] as URL, {
-        type: "message",
-        attachments: [
-          {
-            contentType: "application/vnd.microsoft.card.adaptive",
-            contentUrl: null,
-            content: {
-              $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
-              msteams: {
-                width: "Full",
-              },
-              type: "AdaptiveCard",
-              version: "1.2",
-              body: [
-                {
-                  type: "TextBlock",
-                  wrap: "true",
-                  text: `${args["text"]}`,
+      apiResult = await API.post({
+        url: args["webhook-url"] as URL,
+        data: {
+          type: "message",
+          attachments: [
+            {
+              contentType: "application/vnd.microsoft.card.adaptive",
+              contentUrl: null,
+              content: {
+                $schema: "http://adaptivecards.io/schemas/adaptive-card.json",
+                msteams: {
+                  width: "Full",
                 },
-              ],
+                type: "AdaptiveCard",
+                version: "1.2",
+                body: [
+                  {
+                    type: "TextBlock",
+                    wrap: "true",
+                    text: `${args["text"]}`,
+                  },
+                ],
+              },
             },
-          },
-        ],
+          ],
+        },
       });
 
       if (apiResult instanceof HTTPErrorResponse) {

package/Server/Utils/CodeRepository/GitHub/GitHub.ts

@@ -61,15 +61,15 @@ export default class GitHubUtil extends HostedCodeRepository {
       `https://api.github.com/repos/${data.organizationName}/${data.repositoryName}/pulls/${data.pullRequestId}`,
     );
 
-    const result: HTTPErrorResponse | HTTPResponse<JSONObject> = await API.get(
-      url,
-      {},
-      {
+    const result: HTTPErrorResponse | HTTPResponse<JSONObject> = await API.get({
+      url: url,
+      data: {},
+      headers: {
         Authorization: `Bearer ${gitHubToken}`,
         Accept: "application/vnd.github+json",
         "X-GitHub-Api-Version": "2022-11-28",
       },
-    );
+    });
 
     if (result instanceof HTTPErrorResponse) {
       throw result;
@@ -95,15 +95,15 @@ export default class GitHubUtil extends HostedCodeRepository {
       `https://api.github.com/repos/${data.organizationName}/${data.repositoryName}/pulls?base=${data.baseBranchName}&state=${data.pullRequestState}&per_page=100&page=${data.page}`,
     );
 
-    const result: HTTPErrorResponse | HTTPResponse<JSONArray> = await API.get(
-      url,
-      {},
-      {
+    const result: HTTPErrorResponse | HTTPResponse<JSONArray> = await API.get({
+      url: url,
+      data: {},
+      headers: {
         Authorization: `Bearer ${gitHubToken}`,
         Accept: "application/vnd.github+json",
         "X-GitHub-Api-Version": "2022-11-28",
       },
-    );
+    });
 
     if (result instanceof HTTPErrorResponse) {
       throw result;
@@ -219,17 +219,19 @@ export default class GitHubUtil extends HostedCodeRepository {
     );
 
     const result: HTTPErrorResponse | HTTPResponse<JSONObject> = await API.post(
-      url,
       {
-        base: data.baseBranchName,
-        head: data.headBranchName,
-        title: data.title,
-        body: data.body,
-      },
-      {
-        Authorization: `Bearer ${gitHubToken}`,
-        Accept: "application/vnd.github+json",
-        "X-GitHub-Api-Version": "2022-11-28",
+        url: url,
+        data: {
+          base: data.baseBranchName,
+          head: data.headBranchName,
+          title: data.title,
+          body: data.body,
+        },
+        headers: {
+          Authorization: `Bearer ${gitHubToken}`,
+          Accept: "application/vnd.github+json",
+          "X-GitHub-Api-Version": "2022-11-28",
+        },
       },
     );
 

package/Server/Utils/Errors.ts

@@ -2,6 +2,7 @@ export default {
   BillingService: {
     BILLING_NOT_ENABLED: "Billing is not enabled for this server.",
     CLIENT_SECRET_MISSING: "client_secret not returned by payment provider.",
+    CUSTOMER_NOT_FOUND: "Customer not found.",
     INVOICE_NOT_GENERATED: "Invoice not generated.",
     MIN_REQUIRED_PAYMENT_METHOD_NOT_MET:
       "There's only one payment method associated with this account. It cannot be deleted. To delete this payment method please add more payment methods to your account.",

package/Server/Utils/VM/VMAPI.ts

@@ -22,19 +22,19 @@ export default class VMUtil {
   }): Promise<ReturnResult> {
     const returnResultHttpResponse:
       | HTTPErrorResponse
-      | HTTPResponse<JSONObject> = await API.post<JSONObject>(
-      new URL(
+      | HTTPResponse<JSONObject> = await API.post<JSONObject>({
+      url: new URL(
         Protocol.HTTP,
         IsolatedVMHostname,
         new Route("/isolated-vm/run-code"),
       ),
-      {
+      data: {
         ...data,
       },
-      {
+      headers: {
         ...ClusterKeyAuthorization.getClusterKeyHeaders(),
       },
-    );
+    });
 
     if (returnResultHttpResponse instanceof HTTPErrorResponse) {
       throw returnResultHttpResponse;

package/Server/Utils/Workspace/MicrosoftTeams/MicrosoftTeams.ts

@@ -116,7 +116,10 @@ export default class MicrosoftTeams extends WorkspaceBase {
     const payload: JSONObject = this.buildMessageCardFromMarkdown(data.text);
 
     const apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null =
-      await API.post(data.url, payload);
+      await API.post({
+        url: data.url,
+        data: payload,
+      });
 
     if (!apiResult) {
       logger.error(

package/Server/Utils/Workspace/Slack/Slack.ts

@@ -53,20 +53,20 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
 
     const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-      await API.post<JSONObject>(
-        URL.fromString("https://slack.com/api/users.info"),
-        {
+      await API.post<JSONObject>({
+        url: URL.fromString("https://slack.com/api/users.info"),
+        data: {
           user: data.userId,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for getting user info:");
     logger.debug(response);
@@ -119,18 +119,20 @@ export default class SlackUtil extends WorkspaceBase {
 
     // use view.open API to show modal
     const result: HTTPErrorResponse | HTTPResponse<JSONObject> = await API.post(
-      URL.fromString("https://slack.com/api/views.open"),
-      {
-        trigger_id: data.triggerId,
-        view: modalJson,
-      },
-      {
-        Authorization: `Bearer ${data.authToken}`,
-        ["Content-Type"]: "application/json",
-      },
       {
-        retries: 3,
-        exponentialBackoff: true,
+        url: URL.fromString("https://slack.com/api/views.open"),
+        data: {
+          trigger_id: data.triggerId,
+          view: modalJson,
+        },
+        headers: {
+          Authorization: `Bearer ${data.authToken}`,
+          ["Content-Type"]: "application/json",
+        },
+        options: {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       },
     );
 
@@ -205,20 +207,20 @@ export default class SlackUtil extends WorkspaceBase {
 
     for (const channelId of data.channelIds) {
       const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-        await API.post(
-          URL.fromString("https://slack.com/api/conversations.archive"),
-          {
+        await API.post({
+          url: URL.fromString("https://slack.com/api/conversations.archive"),
+          data: {
             channel: channelId,
           },
-          {
+          headers: {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
-          {
+          options: {
             retries: 3,
             exponentialBackoff: true,
           },
-        );
+        });
 
       logger.debug("Response from Slack API for archiving channel:");
       logger.debug(response);
@@ -252,20 +254,20 @@ export default class SlackUtil extends WorkspaceBase {
 
     // Join channel
     const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-      await API.post(
-        URL.fromString("https://slack.com/api/conversations.join"),
-        {
+      await API.post({
+        url: URL.fromString("https://slack.com/api/conversations.join"),
+        data: {
           channel: data.channelId,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for joining channel:");
     logger.debug(response);
@@ -311,21 +313,21 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
 
     const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-      await API.post(
-        URL.fromString("https://slack.com/api/conversations.invite"),
-        {
+      await API.post({
+        url: URL.fromString("https://slack.com/api/conversations.invite"),
+        data: {
           channel: data.channelId,
           users: data.workspaceUserId,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for inviting user:");
     logger.debug(response);
@@ -465,20 +467,20 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
 
     const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-      await API.post<JSONObject>(
-        URL.fromString("https://slack.com/api/conversations.info"),
-        {
+      await API.post<JSONObject>({
+        url: URL.fromString("https://slack.com/api/conversations.info"),
+        data: {
           channel: data.channelId,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for getting channel info:");
     logger.debug(response);
@@ -546,18 +548,18 @@ export default class SlackUtil extends WorkspaceBase {
       }
 
       const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-        await API.post<JSONObject>(
-          URL.fromString("https://slack.com/api/conversations.list"),
-          requestBody,
-          {
+        await API.post<JSONObject>({
+          url: URL.fromString("https://slack.com/api/conversations.list"),
+          data: requestBody,
+          headers: {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
-          {
+          options: {
             retries: 3,
             exponentialBackoff: true,
           },
-        );
+        });
 
       if (response instanceof HTTPErrorResponse) {
         logger.error("Error response from Slack API:");
@@ -793,18 +795,18 @@ export default class SlackUtil extends WorkspaceBase {
       }
 
       const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-        await API.post<JSONObject>(
-          URL.fromString("https://slack.com/api/conversations.list"),
-          requestBody,
-          {
+        await API.post<JSONObject>({
+          url: URL.fromString("https://slack.com/api/conversations.list"),
+          data: requestBody,
+          headers: {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
-          {
+          options: {
             retries: 3,
             exponentialBackoff: true,
           },
-        );
+        });
 
       if (response instanceof HTTPErrorResponse) {
         logger.error("Error response from Slack API:");
@@ -1105,22 +1107,22 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(JSON.stringify(data, null, 2));
 
     const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-      await API.post(
-        URL.fromString("https://slack.com/api/chat.postMessage"),
-        {
+      await API.post({
+        url: URL.fromString("https://slack.com/api/chat.postMessage"),
+        data: {
           channel: data.workspaceChannel.id,
           blocks: data.blocks,
           unfurl_links: false,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/json",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for sending message:");
     logger.debug(response);
@@ -1186,20 +1188,20 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
 
     const response: HTTPResponse<JSONObject> | HTTPErrorResponse =
-      await API.post(
-        URL.fromString("https://slack.com/api/conversations.create"),
-        {
+      await API.post({
+        url: URL.fromString("https://slack.com/api/conversations.create"),
+        data: {
           name: data.channelName,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for creating channel:");
     logger.debug(response);
@@ -1590,20 +1592,20 @@ export default class SlackUtil extends WorkspaceBase {
   }): Promise<boolean> {
     // check of the user id is in the direct message channel id
     const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-      await API.post(
-        URL.fromString("https://slack.com/api/conversations.info"),
-        {
+      await API.post({
+        url: URL.fromString("https://slack.com/api/conversations.info"),
+        data: {
           channel: data.directMessageChannelId,
         },
-        {
+        headers: {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     if (response instanceof HTTPErrorResponse) {
       logger.error("Error response from Slack API:");
@@ -1660,18 +1662,18 @@ export default class SlackUtil extends WorkspaceBase {
       }
 
       const response: HTTPErrorResponse | HTTPResponse<JSONObject> =
-        await API.post<JSONObject>(
-          URL.fromString("https://slack.com/api/conversations.members"),
-          requestBody,
-          {
+        await API.post<JSONObject>({
+          url: URL.fromString("https://slack.com/api/conversations.members"),
+          data: requestBody,
+          headers: {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
-          {
+          options: {
             retries: 3,
             exponentialBackoff: true,
           },
-        );
+        });
 
       logger.debug("Response from Slack API for getting channel members:");
       logger.debug(response);
@@ -1747,9 +1749,9 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
 
     const apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null =
-      await API.post(
-        data.url,
-        {
+      await API.post({
+        url: data.url,
+        data: {
           blocks: [
             {
               type: "section",
@@ -1760,12 +1762,11 @@ export default class SlackUtil extends WorkspaceBase {
             },
           ],
         },
-        undefined,
-        {
+        options: {
           retries: 3,
           exponentialBackoff: true,
         },
-      );
+      });
 
     logger.debug("Response from Slack API for sending message via webhook:");
     logger.debug(apiResult);

package/Tests/Utils/API.test.ts

@@ -257,13 +257,13 @@ describe("fetch", () => {
 
     mockedAxios.mockResolvedValueOnce(mockedAxiosResponse);
 
-    const response: HTTPResponse<typeof responseData> = await API.fetch(
-      HTTPMethod.POST,
-      new URL(Protocol.HTTPS, "catfact.ninja", new Route("fact")),
-      requestData,
-      requestHeaders,
+    const response: HTTPResponse<typeof responseData> = await API.fetch({
+      method: HTTPMethod.POST,
+      url: new URL(Protocol.HTTPS, "catfact.ninja", new Route("fact")),
+      data: requestData,
+      headers: requestHeaders,
       params,
-    );
+    });
 
     // Check method, url (protocol, hostname, parameters), headers, request data
     expect(axios).toBeCalledWith({
@@ -295,10 +295,10 @@ describe("fetch", () => {
 
     mockedAxios.mockRejectedValueOnce(mockedAxiosError);
 
-    const httpErrorResponse: HTTPResponse<JSONObject> = await API.fetch(
-      HTTPMethod.GET,
-      new URL(Protocol.HTTPS, "catfact.ninja", new Route("fact")),
-    );
+    const httpErrorResponse: HTTPResponse<JSONObject> = await API.fetch({
+      method: HTTPMethod.GET,
+      url: new URL(Protocol.HTTPS, "catfact.ninja", new Route("fact")),
+    });
 
     expect(axios).toBeCalledWith({
       method: "GET",
@@ -316,10 +316,10 @@ describe("fetch", () => {
     });
 
     await expect(async () => {
-      await API.fetch(
-        HTTPMethod.GET,
-        new URL(Protocol.HTTPS, "catfact.ninja", new Route("fact")),
-      );
+      await API.fetch({
+        method: HTTPMethod.GET,
+        url: new URL(Protocol.HTTPS, "catfact.ninja", new Route("fact")),
+      });
     }).rejects.toThrowError(APIException);
   });
 });
@@ -376,11 +376,11 @@ describe.each(httpMethodTests)("$name", ({ name, method }: HTTPMethodType) => {
       "catfact.ninja",
       new Route("fact"),
     );
-    const got: HTTPResponse<JSONObject> = await API[name](
+    const got: HTTPResponse<JSONObject> = await (API as any)[name]({
       url,
-      requestData,
-      requestHeaders,
-    );
+      data: requestData,
+      headers: requestHeaders,
+    });
 
     // Check method, url, headers, request data
     expect(axios).toBeCalledWith(
@@ -403,11 +403,16 @@ describe.each(httpMethodTests)(".$name", ({ name, method }: HTTPMethodType) => {
 
     mockedAxios.mockResolvedValueOnce(createAxiosResponse());
 
-    const got: HTTPResponse<JSONObject> = await api[name](
-      new Route(route),
-      requestData,
-      requestHeaders,
+    const url: URL = new URL(
+      api.protocol,
+      api.hostname,
+      api.baseRoute.addRoute(route),
     );
+    const got: HTTPResponse<JSONObject> = await (api as any)[name]({
+      url,
+      data: requestData,
+      headers: requestHeaders,
+    });
 
     // Check method, url (protocol, hostname, route), headers, request data
     expect(axios).toBeCalledWith(