@oneuptime/common 7.0.4395 → 7.0.4428

package/Models/AnalyticsModels/AnalyticsBaseModel/CommonModel.ts

@@ -76,7 +76,7 @@ export default class CommonModel {
       if (column.type === TableColumnType.JSON && typeof value === "string") {
         try {
           value = JSONFunctions.parse(value);
-        } catch (e) {
+        } catch {
           value = {};
         }
       }
@@ -91,7 +91,7 @@ export default class CommonModel {
           if (!Array.isArray(value)) {
             throw new BadDataException("Not an array");
           }
-        } catch (e) {
+        } catch {
           value = [];
         }
       }

package/Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel.ts

@@ -92,8 +92,9 @@ export default class DatabaseBaseModel extends BaseEntity {
 
   @TableColumn({
     title: "Version",
-    type: TableColumnType.Version,
+    type: TableColumnType.Number,
     description: "Object version",
+    hideColumnInDocumentation: true,
   })
   @VersionColumn()
   public version?: number = undefined;

package/Models/DatabaseModels/Project.ts

@@ -595,7 +595,10 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Number })
+  @TableColumn({
+    type: TableColumnType.Number,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.Number,
     nullable: true,
@@ -768,6 +771,7 @@ export default class Project extends TenantModel {
   @TableColumn({
     required: true,
     isDefaultValueColumn: true,
+    hideColumnInDocumentation: true,
     type: TableColumnType.Boolean,
     title: "Low Call and SMS Balance Notification Sent to Owners",
     description: "Low Call and SMS Balance Notification Sent to Owners",
@@ -788,6 +792,7 @@ export default class Project extends TenantModel {
     required: true,
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,
+    hideColumnInDocumentation: true,
     title: "Failed Call and SMS Balance Charge Notification Sent to Owners",
     description:
       "Failed Call and SMS Balance Charge Notification Sent to Owners",
@@ -808,6 +813,7 @@ export default class Project extends TenantModel {
   @TableColumn({
     required: true,
     isDefaultValueColumn: true,
+    hideColumnInDocumentation: true,
     type: TableColumnType.Boolean,
     title: "Failed Call and SMS Balance Charge Notification Sent to Owners",
     description:
@@ -838,6 +844,7 @@ export default class Project extends TenantModel {
     title: "Plan Name",
     description: "Name of the plan this project is subscribed to.",
     canReadOnRelationQuery: true,
+    hideColumnInDocumentation: true,
   })
   @Column({
     nullable: true,
@@ -865,7 +872,7 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Phone })
+  @TableColumn({ type: TableColumnType.Phone, hideColumnInDocumentation: true })
   @Column({
     type: ColumnType.Phone,
     length: ColumnLength.Phone,
@@ -880,7 +887,7 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Email })
+  @TableColumn({ type: TableColumnType.Email, hideColumnInDocumentation: true })
   @Column({
     type: ColumnType.Email,
     length: ColumnLength.Email,
@@ -895,7 +902,7 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.Name })
+  @TableColumn({ type: TableColumnType.Name, hideColumnInDocumentation: true })
   @Column({
     type: ColumnType.Name,
     length: ColumnLength.Name,
@@ -910,7 +917,10 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongText })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.LongText,
     length: ColumnLength.LongText,
@@ -924,7 +934,10 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongText })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.LongText,
     length: ColumnLength.LongText,
@@ -938,7 +951,10 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongText })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.LongText,
     length: ColumnLength.LongText,
@@ -952,7 +968,10 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongText })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.LongText,
     length: ColumnLength.LongText,
@@ -980,10 +999,14 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.LongText })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.LongText,
     length: ColumnLength.LongText,
+
     nullable: true,
     unique: false,
   })
@@ -994,9 +1017,13 @@ export default class Project extends TenantModel {
     read: [],
     update: [],
   })
-  @TableColumn({ type: TableColumnType.ShortText })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    hideColumnInDocumentation: true,
+  })
   @Column({
     type: ColumnType.ShortText,
+
     length: ColumnLength.ShortText,
     nullable: true,
     unique: false,
@@ -1011,6 +1038,7 @@ export default class Project extends TenantModel {
   @TableColumn({
     manyToOneRelationColumn: "resellerId",
     type: TableColumnType.Entity,
+    hideColumnInDocumentation: true,
     modelType: Reseller,
     title: "Reseller",
     description: "Relation to Reseller Resource in which this object belongs",
@@ -1046,6 +1074,7 @@ export default class Project extends TenantModel {
     type: TableColumnType.ObjectID,
     required: false,
     canReadOnRelationQuery: true,
+    hideColumnInDocumentation: true,
     title: "Reseller ID",
     description: "ID of your OneUptime Reseller in which this object belongs",
   })
@@ -1065,6 +1094,7 @@ export default class Project extends TenantModel {
     manyToOneRelationColumn: "ResellerPlanId",
     type: TableColumnType.Entity,
     modelType: ResellerPlan,
+    hideColumnInDocumentation: true,
     title: "ResellerPlan",
     description:
       "Relation to ResellerPlan Resource in which this object belongs",
@@ -1093,6 +1123,7 @@ export default class Project extends TenantModel {
     type: TableColumnType.ObjectID,
     required: false,
     canReadOnRelationQuery: true,
+    hideColumnInDocumentation: true,
     title: "Reseller Plan ID",
     description:
       "ID of your OneUptime Reseller Plan in which this object belongs",
@@ -1113,6 +1144,7 @@ export default class Project extends TenantModel {
     required: false,
     type: TableColumnType.ShortText,
     title: "License ID",
+    hideColumnInDocumentation: true,
     description: "License ID from a OneUptime Reseller",
     canReadOnRelationQuery: true,
   })
@@ -1132,6 +1164,7 @@ export default class Project extends TenantModel {
     required: false,
     type: TableColumnType.Number,
     title: "Enterprise Annual Contract Value",
+    hideColumnInDocumentation: true,
     description:
       "Annual contract value for this project (in USD). This field is only applicable for enterprise customers and is manually edited.",
   })
@@ -1156,6 +1189,7 @@ export default class Project extends TenantModel {
     required: false,
     type: TableColumnType.Boolean,
     title: "Let Customer Support Access Project",
+    hideColumnInDocumentation: true,
     description:
       "OneUptime customer support can access this project. This is used for debugging purposes.",
   })

package/Server/API/OpenAPI.ts

@@ -19,7 +19,7 @@ export default class OpenAPI {
   public static getRouter(): ExpressRouter {
     const router: ExpressRouter = Express.getRouter();
 
-    router.get("/openapi", (req: ExpressRequest, res: ExpressResponse) => {
+    router.get("/openapi/spec", (req: ExpressRequest, res: ExpressResponse) => {
       const openAPISpec: JSONObject = OpenAPIUtil.generateOpenAPISpec();
       return Response.sendJsonObjectResponse(req, res, openAPISpec);
     });

package/Server/API/StatusPageAPI.ts

@@ -142,6 +142,10 @@ export default class StatusPageAPI extends BaseAPI<
           try {
             statusPageId = new ObjectID(statusPageIdOrDomain);
           } catch (err) {
+            logger.error(
+              `Error converting statusPageIdOrDomain to ObjectID: ${statusPageIdOrDomain}`,
+            );
+            logger.error(err);
             return Response.sendErrorResponse(
               req,
               res,
@@ -224,6 +228,7 @@ export default class StatusPageAPI extends BaseAPI<
           try {
             statusPageId = new ObjectID(statusPageIdOrDomain);
           } catch (err) {
+            logger.error(err);
             return Response.sendErrorResponse(
               req,
               res,

package/Server/Middleware/NotificationMiddleware.ts

@@ -6,6 +6,7 @@ import {
 } from "../Utils/Express";
 import JSONWebToken from "../Utils/JsonWebToken";
 import Response from "../Utils/Response";
+import logger from "../Utils/Logger";
 import { OnCallInputRequest } from "../../Types/Call/CallRequest";
 import BadDataException from "../../Types/Exception/BadDataException";
 import JSONFunctions from "../../Types/JSONFunctions";
@@ -61,6 +62,7 @@ export default class NotificationMiddleware {
         JSONWebToken.decodeJsonPayload(token),
       );
     } catch (e) {
+      logger.error(e);
       return Response.sendErrorResponse(
         req,
         res,

package/Server/Middleware/ProjectAuthorization.ts

@@ -76,7 +76,9 @@ export default class ProjectMiddleware {
       }
 
       if (!apiKey) {
-        throw new BadDataException("ApiKey not found in the request");
+        throw new BadDataException(
+          "Api Key not found in the request header. Please provide a valid API Key in the request header.",
+        );
       }
 
       let apiKeyModel: ApiKey | null = null;
@@ -102,6 +104,8 @@ export default class ProjectMiddleware {
           );
         }
 
+        (req as OneUptimeRequest).tenantId = tenantId;
+
         if (apiKeyModel) {
           (req as OneUptimeRequest).userType = UserType.API;
           // TODO: Add API key permissions.
@@ -184,6 +188,11 @@ export default class ProjectMiddleware {
         }
       }
 
+      if (apiKey) {
+        // If we have an API key but no tenant ID, we throw an error.
+        throw new BadDataException("Invalid API Key");
+      }
+
       if (!tenantId) {
         throw new BadDataException(
           "ProjectID not found in the request header.",

package/Server/Middleware/UserAuthorization.ts

@@ -173,6 +173,7 @@ export default class UserMiddleware {
       oneuptimeRequest.userAuthorization = JSONWebToken.decode(accessToken);
     } catch (err) {
       // if the token is invalid or expired, it'll throw this error.
+      logger.error(err);
       oneuptimeRequest.userType = UserType.Public;
       return next();
     }

package/Server/Services/OpenTelemetryIngestService.ts

@@ -125,20 +125,20 @@ export default class OTelIngestService {
 
     const newDbMetric: Metric = Metric.fromJSON(
       dbMetric.toJSON(),
-      Metric
+      Metric,
     ) as Metric;
 
     if (datapoint["startTimeUnixNano"]) {
       newDbMetric.startTimeUnixNano = datapoint["startTimeUnixNano"] as number;
       newDbMetric.startTime = OneUptimeDate.fromUnixNano(
-        datapoint["startTimeUnixNano"] as number
+        datapoint["startTimeUnixNano"] as number,
       );
     }
 
     if (datapoint["timeUnixNano"]) {
       newDbMetric.timeUnixNano = datapoint["timeUnixNano"] as number;
       newDbMetric.time = OneUptimeDate.fromUnixNano(
-        datapoint["timeUnixNano"] as number
+        datapoint["timeUnixNano"] as number,
       );
     }
 

package/Server/Services/StatusPageDomainService.ts

@@ -237,6 +237,7 @@ export class Service extends DatabaseService<StatusPageDomain> {
 
       return true;
     } catch (err) {
+      logger.error(err);
       return false;
     }
   }

package/Server/Types/Database/QueryHelper.ts

@@ -271,7 +271,7 @@ export default class QueryHelper {
   @CaptureSpan()
   public static greaterThanEqualTo<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -280,13 +280,13 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static greaterThanEqualToOrNull<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -295,13 +295,13 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static lessThanEqualTo<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -310,13 +310,13 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static lessThanOrNull<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -325,13 +325,13 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static lessThanEqualToOrNull<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -340,13 +340,13 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static greaterThan<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<number | Date> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -355,13 +355,13 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static greaterThanOrNull<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -370,14 +370,14 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static inBetween<T extends number | Date>(
     startValue: T,
     endValue: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid1: string = Text.generateRandomText(10);
     const rid2: string = Text.generateRandomText(10);
     return Raw(
@@ -388,14 +388,14 @@ export default class QueryHelper {
         [rid1]: startValue,
         [rid2]: endValue,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static inBetweenOrNull<T extends number | Date>(
     startValue: T,
     endValue: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid1: string = Text.generateRandomText(10);
     const rid2: string = Text.generateRandomText(10);
     return Raw(
@@ -406,14 +406,14 @@ export default class QueryHelper {
         [rid1]: startValue,
         [rid2]: endValue,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
   public static notInBetween<T extends number | Date>(
     startValue: T,
     endValue: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid1: string = Text.generateRandomText(10);
     const rid2: string = Text.generateRandomText(10);
     return Raw(
@@ -424,7 +424,7 @@ export default class QueryHelper {
         [rid1]: startValue,
         [rid2]: endValue,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 
   @CaptureSpan()
@@ -481,7 +481,7 @@ export default class QueryHelper {
   @CaptureSpan()
   public static lessThan<T extends number | Date>(
     value: T,
-  ): FindWhereProperty<T> {
+  ): FindWhereProperty<any> {
     const rid: string = Text.generateRandomText(10);
     return Raw(
       (alias: string) => {
@@ -490,6 +490,6 @@ export default class QueryHelper {
       {
         [rid]: value,
       },
-    ) as FindWhereProperty<T>;
+    ) as FindWhereProperty<any>;
   }
 }

package/Server/Types/Workflow/Components/JSON/JsonToText.ts

@@ -2,6 +2,7 @@ import ComponentCode, { RunOptions, RunReturnType } from "../../ComponentCode";
 import BadDataException from "../../../../../Types/Exception/BadDataException";
 import { JSONObject } from "../../../../../Types/JSON";
 import JSONFunctions from "../../../../../Types/JSONFunctions";
+import logger from "../../../../Utils/Logger";
 import ComponentMetadata, {
   Port,
 } from "../../../../../Types/Workflow/Component";
@@ -74,6 +75,7 @@ export default class JsonToText extends ComponentCode {
         executePort: successPort,
       });
     } catch (err) {
+      logger.error(err);
       options.log("JSON is not in the correct format.");
       return Promise.resolve({
         returnValues: {},

package/Server/Types/Workflow/Components/JSON/TextToJson.ts

@@ -2,6 +2,7 @@ import ComponentCode, { RunOptions, RunReturnType } from "../../ComponentCode";
 import BadDataException from "../../../../../Types/Exception/BadDataException";
 import { JSONObject } from "../../../../../Types/JSON";
 import JSONFunctions from "../../../../../Types/JSONFunctions";
+import logger from "../../../../Utils/Logger";
 import ComponentMetadata, {
   Port,
 } from "../../../../../Types/Workflow/Component";
@@ -72,6 +73,7 @@ export default class TextToJSON extends ComponentCode {
         executePort: successPort,
       });
     } catch (err) {
+      logger.error(err);
       options.log("text is not in the correct format.");
       return Promise.resolve({
         returnValues: {},

package/Server/Utils/CronTab.ts

@@ -1,5 +1,6 @@
 import BadDataException from "../../Types/Exception/BadDataException";
 import CronParser, { CronExpression } from "cron-parser";
+import logger from "./Logger";
 import CaptureSpan from "./Telemetry/CaptureSpan";
 
 export default class CronTab {
@@ -10,6 +11,7 @@ export default class CronTab {
       const nextExecutionTime: Date = interval.next().toDate();
       return nextExecutionTime;
     } catch (error) {
+      logger.error(error);
       throw new BadDataException(`Invalid cron expression: ${crontab}`);
     }
   }

package/Server/Utils/JsonWebToken.ts

@@ -10,6 +10,7 @@ import Timezone from "../../Types/Timezone";
 import StatusPagePrivateUser from "../../Models/DatabaseModels/StatusPagePrivateUser";
 import User from "../../Models/DatabaseModels/User";
 import jwt from "jsonwebtoken";
+import logger from "./Logger";
 import CaptureSpan from "./Telemetry/CaptureSpan";
 
 class JSONWebToken {
@@ -119,6 +120,7 @@ class JSONWebToken {
         isGlobalLogin: Boolean(decoded["isGlobalLogin"]),
       };
     } catch (e) {
+      logger.error(e);
       throw new BadDataException("AccessToken is invalid or expired");
     }
   }

package/Server/Utils/Monitor/Criteria/CustomCodeMonitorCriteria.ts

@@ -4,6 +4,7 @@ import {
   CriteriaFilter,
 } from "../../../../Types/Monitor/CriteriaFilter";
 import CustomCodeMonitorResponse from "../../../../Types/Monitor/CustomCodeMonitor/CustomCodeMonitorResponse";
+import logger from "../../Logger";
 import CaptureSpan from "../../Telemetry/CaptureSpan";
 
 export default class CustomCodeMonitoringCriteria {
@@ -78,6 +79,7 @@ export default class CustomCodeMonitoringCriteria {
           thresholdAsNumber = parseFloat(threshold.toString());
         }
       } catch (err) {
+        logger.error(err);
         thresholdAsNumber = null;
       }
 

package/Server/Utils/Monitor/MonitorResource.ts

@@ -1244,6 +1244,7 @@ export default class MonitorResourceUtil {
               .responseBody as string) || "{}",
           );
         } catch (err) {
+          logger.error(err);
           responseBody = (input.dataToProcess as ProbeMonitorResponse)
             .responseBody as JSONObject;
         }