@oneuptime/common 7.0.4453 → 7.0.4518

package/Models/DatabaseModels/Alert.ts

@@ -217,7 +217,7 @@ export default class Alert extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Description",
     description:
-      "Short description of this alert. This is in markdown and will be visible on the status page.",
+      "Short description of this alert. This will be visible on the status page. This is in markdown.",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/AlertCustomField.ts

@@ -218,7 +218,7 @@ export default class AlertCustomField extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: CustomFieldType = undefined;
+  public customFieldType?: CustomFieldType = undefined;
 
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/BillingPaymentMethod.ts

@@ -234,7 +234,7 @@ export default class BillingPaymentMethod extends BaseModel {
     nullable: false,
     unique: false,
   })
-  public type?: string = undefined;
+  public paymentMethodType?: string = undefined;
 
   @ColumnAccessControl({
     create: [],

package/Models/DatabaseModels/DatabaseBaseModel/FileModel.ts

@@ -70,7 +70,7 @@ export default class FileModel extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: MimeType = undefined;
+  public fileType?: MimeType = undefined;
 
   @ColumnAccessControl({
     create: [Permission.CurrentUser],

package/Models/DatabaseModels/IncidentCustomField.ts

@@ -218,7 +218,7 @@ export default class IncidentCustomField extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: CustomFieldType = undefined;
+  public customFieldType?: CustomFieldType = undefined;
 
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/MonitorCustomField.ts

@@ -218,7 +218,7 @@ export default class MonitorCustomField extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: CustomFieldType = undefined;
+  public customFieldType?: CustomFieldType = undefined;
 
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/OnCallDutyPolicyCustomField.ts

@@ -218,7 +218,7 @@ export default class OnCallDutyPolicyCustomField extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: CustomFieldType = undefined;
+  public customFieldType?: CustomFieldType = undefined;
 
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/ScheduledMaintenanceCustomField.ts

@@ -218,7 +218,7 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: CustomFieldType = undefined;
+  public customFieldType?: CustomFieldType = undefined;
 
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/ScheduledMaintenanceTemplate.ts

@@ -287,7 +287,7 @@ export default class ScheduledMaintenanceTemplate extends BaseModel {
     type: TableColumnType.Markdown,
     title: "Description",
     description:
-      "Description of this scheduled event that will show up on Status Page. This is in markdown.",
+      "Description of this scheduled event that will show up on Status Page. This is a markdown field.",
   })
   @Column({
     nullable: true,

package/Models/DatabaseModels/StatusPageAnnouncement.ts

@@ -318,7 +318,7 @@ export default class StatusPageAnnouncement extends BaseModel {
     required: true,
     type: TableColumnType.Markdown,
     title: "Announcement Description",
-    description: "Text of the announcement. This is in Markdown.",
+    description: "Text of the announcement. This can be in Markdown format.",
   })
   @Column({
     nullable: false,

package/Models/DatabaseModels/StatusPageCustomField.ts

@@ -218,7 +218,7 @@ export default class StatusPageCustomField extends BaseModel {
     type: ColumnType.ShortText,
     length: ColumnLength.ShortText,
   })
-  public type?: CustomFieldType = undefined;
+  public customFieldType?: CustomFieldType = undefined;
 
   @ColumnAccessControl({
     create: [

package/Server/API/FileAPI.ts

@@ -31,11 +31,11 @@ export default class FileAPI extends BaseAPI<File, FileServiceType> {
           },
           select: {
             file: true,
-            type: true,
+            fileType: true,
           },
         });
 
-        if (!file || !file.file || !file.type) {
+        if (!file || !file.file || !file.fileType) {
           return Response.sendErrorResponse(
             req,
             res,

package/Server/API/StatusPageAPI.ts

@@ -246,7 +246,7 @@ export default class StatusPageAPI extends BaseAPI<
               faviconFile: {
                 file: true,
                 _id: true,
-                type: true,
+                fileType: true,
                 name: true,
               },
             },
@@ -510,19 +510,19 @@ export default class StatusPageAPI extends BaseAPI<
             coverImageFile: {
               file: true,
               _id: true,
-              type: true,
+              fileType: true,
               name: true,
             },
             faviconFile: {
               file: true,
               _id: true,
-              type: true,
+              fileType: true,
               name: true,
             },
             logoFile: {
               file: true,
               _id: true,
-              type: true,
+              fileType: true,
               name: true,
             },
             showIncidentsOnStatusPage: true,

package/Server/Infrastructure/Postgres/SchemaMigrations/1750250435756-MigrationName.ts

@@ -0,0 +1,59 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationName1750250435756 implements MigrationInterface {
+  public name = "MigrationName1750250435756";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "File" RENAME COLUMN "type" TO "fileType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "BillingPaymentMethod" RENAME COLUMN "type" TO "paymentMethodType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "IncidentCustomField" RENAME COLUMN "type" TO "customFieldType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "MonitorCustomField" RENAME COLUMN "type" TO "customFieldType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "OnCallDutyPolicyCustomField" RENAME COLUMN "type" TO "customFieldType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "ScheduledMaintenanceCustomField" RENAME COLUMN "type" TO "customFieldType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "StatusPageCustomField" RENAME COLUMN "type" TO "customFieldType"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "AlertCustomField" RENAME COLUMN "type" TO "customFieldType"`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(
+      `ALTER TABLE "AlertCustomField" RENAME COLUMN "customFieldType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "StatusPageCustomField" RENAME COLUMN "customFieldType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "ScheduledMaintenanceCustomField" RENAME COLUMN "customFieldType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "OnCallDutyPolicyCustomField" RENAME COLUMN "customFieldType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "MonitorCustomField" RENAME COLUMN "customFieldType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "IncidentCustomField" RENAME COLUMN "customFieldType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "BillingPaymentMethod" RENAME COLUMN "paymentMethodType" TO "type"`,
+    );
+    await queryRunner.query(
+      `ALTER TABLE "File" RENAME COLUMN "fileType" TO "type"`,
+    );
+  }
+}

package/Server/Infrastructure/Postgres/SchemaMigrations/Index.ts

@@ -137,6 +137,7 @@ import { MigrationName1748456937826 } from "./1748456937826-MigrationName";
 import { MigrationName1749065784320 } from "./1749065784320-MigrationName";
 import { MigrationName1749133333893 } from "./1749133333893-MigrationName";
 import { MigrationName1749813704371 } from "./1749813704371-MigrationName";
+import { MigrationName1750250435756 } from "./1750250435756-MigrationName";
 
 export default [
   InitialMigration,
@@ -278,4 +279,5 @@ export default [
   MigrationName1749065784320,
   MigrationName1749133333893,
   MigrationName1749813704371,
+  MigrationName1750250435756,
 ];

package/Server/Services/BillingPaymentMethodService.ts

@@ -64,7 +64,7 @@ export class Service extends DatabaseService<Model> {
 
       billingPaymentMethod.projectId = project.id!;
 
-      billingPaymentMethod.type = paymentMethod.type;
+      billingPaymentMethod.paymentMethodType = paymentMethod.type;
       billingPaymentMethod.last4Digits = paymentMethod.last4Digits;
       billingPaymentMethod.isDefault = paymentMethod.isDefault;
       billingPaymentMethod.paymentProviderPaymentMethodId = paymentMethod.id;

package/Server/Utils/Response.ts

@@ -75,7 +75,7 @@ export default class Response {
     const oneUptimeResponse: OneUptimeResponse = res as OneUptimeResponse;
 
     /** Set the proper content type */
-    oneUptimeResponse.set("Content-Type", file.type);
+    oneUptimeResponse.set("Content-Type", file.fileType);
     oneUptimeResponse.status(200);
     /** Return response */
     // readstream.pipe(res);

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

@@ -60,6 +60,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     logger.debug("Response from Slack API for getting user info:");
@@ -122,6 +126,10 @@ export default class SlackUtil extends WorkspaceBase {
         Authorization: `Bearer ${data.authToken}`,
         ["Content-Type"]: "application/json",
       },
+      {
+        retries: 3,
+        exponentialBackoff: true,
+      },
     );
 
     if (result instanceof HTTPErrorResponse) {
@@ -202,6 +210,10 @@ export default class SlackUtil extends WorkspaceBase {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
+          {
+            retries: 3,
+            exponentialBackoff: true,
+          },
         );
 
       logger.debug("Response from Slack API for archiving channel:");
@@ -245,6 +257,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     logger.debug("Response from Slack API for joining channel:");
@@ -301,6 +317,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     logger.debug("Response from Slack API for inviting user:");
@@ -449,6 +469,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     logger.debug("Response from Slack API for getting channel info:");
@@ -519,6 +543,10 @@ export default class SlackUtil extends WorkspaceBase {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
+          {
+            retries: 3,
+            exponentialBackoff: true,
+          },
         );
 
       logger.debug("Response from Slack API for getting all channels:");
@@ -779,6 +807,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/json",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     logger.debug("Response from Slack API for sending message:");
@@ -853,6 +885,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     logger.debug("Response from Slack API for creating channel:");
@@ -1233,6 +1269,10 @@ export default class SlackUtil extends WorkspaceBase {
           Authorization: `Bearer ${data.authToken}`,
           ["Content-Type"]: "application/x-www-form-urlencoded",
         },
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
       );
 
     if (response instanceof HTTPErrorResponse) {
@@ -1297,6 +1337,10 @@ export default class SlackUtil extends WorkspaceBase {
             Authorization: `Bearer ${data.authToken}`,
             ["Content-Type"]: "application/x-www-form-urlencoded",
           },
+          {
+            retries: 3,
+            exponentialBackoff: true,
+          },
         );
 
       logger.debug("Response from Slack API for getting channel members:");
@@ -1373,17 +1417,25 @@ export default class SlackUtil extends WorkspaceBase {
     logger.debug(data);
 
     const apiResult: HTTPResponse<JSONObject> | HTTPErrorResponse | null =
-      await API.post(data.url, {
-        blocks: [
-          {
-            type: "section",
-            text: {
-              type: "mrkdwn",
-              text: `${data.text}`,
+      await API.post(
+        data.url,
+        {
+          blocks: [
+            {
+              type: "section",
+              text: {
+                type: "mrkdwn",
+                text: `${data.text}`,
+              },
             },
-          },
-        ],
-      });
+          ],
+        },
+        undefined,
+        {
+          retries: 3,
+          exponentialBackoff: true,
+        },
+      );
 
     logger.debug("Response from Slack API for sending message via webhook:");
     logger.debug(apiResult);

package/Tests/UI/Components/FilePicker.test.tsx

@@ -60,7 +60,7 @@ const mockCreateResponse: MockCreateResponseFunction = async (
     {
       file: (await file.arrayBuffer()) as Buffer,
       name: file.name,
-      type: file.type,
+      type: file.type as MimeType,
       slug: file.name,
       isPublic: true,
     },
@@ -75,7 +75,7 @@ const mockFileModel: MockFileModelFunction = async (
 ): Promise<FileModel> => {
   const fileModel: FileModel = new FileModel(new ObjectID("123"));
   fileModel.name = file.name;
-  fileModel.type = file.type as MimeType;
+  fileModel.fileType = file.type as MimeType;
   fileModel.slug = file.name;
   fileModel.isPublic = true;
   fileModel.file = (await file.arrayBuffer()) as Buffer;

package/UI/Components/Checkbox/Checkbox.tsx

@@ -4,7 +4,7 @@ export type CategoryCheckboxValue = string | number | boolean;
 
 export interface CategoryProps {
   title?: string | ReactElement | undefined;
-  description?: string | undefined;
+  description?: string | ReactElement | undefined;
   initialValue?: undefined | boolean;
   onChange?: undefined | ((value: boolean, interminate?: boolean) => void);
   value?: boolean | undefined;

package/UI/Components/CodeEditor/CodeEditor.tsx

@@ -1,5 +1,6 @@
 import Editor from "@monaco-editor/react";
 import CodeType from "../../../Types/Code/CodeType";
+import MarkdownUtil from "../../Utils/Markdown";
 import React, {
   FunctionComponent,
   ReactElement,
@@ -32,7 +33,7 @@ const CodeEditor: FunctionComponent<ComponentProps> = (
   let className: string = "";
 
   const [placeholder, setPlaceholder] = useState<string>("");
-  const [helpText, setHelpText] = useState<string>("");
+  const [helpText, setHelpText] = useState<string | ReactElement>("");
   const editorRef: React.MutableRefObject<any> = useRef<any>(null);
 
   useEffect(() => {
@@ -48,7 +49,7 @@ const CodeEditor: FunctionComponent<ComponentProps> = (
   useEffect(() => {
     if (props.placeholder) {
       if (props.type === CodeType.Markdown) {
-        setHelpText(`${props.placeholder}. This is in Markdown`);
+        setHelpText(MarkdownUtil.getMarkdownCheatsheet(props.placeholder));
       }
 
       if (props.type === CodeType.HTML) {

package/UI/Components/CustomFields/CustomFieldsDetail.tsx

@@ -51,7 +51,7 @@ const CustomFieldsDetail: FunctionComponent<ComponentProps> = (
           skip: 0,
           select: {
             name: true,
-            type: true,
+            customFieldType: true,
             description: true,
           } as any,
           sort: {},
@@ -134,7 +134,7 @@ const CustomFieldsDetail: FunctionComponent<ComponentProps> = (
                 key: (schemaItem as any).name,
                 title: (schemaItem as any).name,
                 description: (schemaItem as any).description,
-                fieldType: (schemaItem as any).type,
+                fieldType: (schemaItem as any).customFieldType,
                 placeholder: "No data entered",
               };
             })}
@@ -160,7 +160,7 @@ const CustomFieldsDetail: FunctionComponent<ComponentProps> = (
                   },
                   title: (schemaItem as any).name,
                   description: (schemaItem as any).description,
-                  fieldType: (schemaItem as any).type,
+                  fieldType: (schemaItem as any).customFieldType,
                   required: false,
                   placeholder: "",
                 };

package/UI/Components/Detail/Detail.tsx

@@ -230,12 +230,13 @@ const Detail: DetailFunction = <T extends GenericObject>(
       if (
         props.item[fieldKey] &&
         (props.item[fieldKey] as unknown as FileModel).file &&
-        (props.item[fieldKey] as unknown as FileModel).type
+        (props.item[fieldKey] as unknown as FileModel).fileType
       ) {
         const blob: Blob = new Blob(
           [(props.item[fieldKey] as unknown as FileModel).file as Uint8Array],
           {
-            type: (props.item[fieldKey] as unknown as FileModel).type as string,
+            type: (props.item[fieldKey] as unknown as FileModel)
+              .fileType as string,
           },
         );
 

package/UI/Components/Detail/Field.ts

@@ -15,7 +15,7 @@ export interface DetailSideLink {
 
 export interface FieldBase<T> {
   title?: string;
-  description?: string;
+  description?: string | ReactElement;
   fieldTitleSize?: Size | undefined;
   fieldType?: FieldType;
   dropdownOptions?: Array<DropdownOption> | undefined;

package/UI/Components/Detail/FieldLabel.tsx

@@ -10,7 +10,7 @@ export enum Size {
 
 export interface ComponentProps {
   title?: string | undefined;
-  description?: string | undefined;
+  description?: string | ReactElement | undefined;
   alignClassName?: string | undefined;
   sideLink?: DetailSideLink | undefined;
   size?: Size | undefined;

package/UI/Components/FilePicker/FilePicker.tsx

@@ -99,7 +99,7 @@ const FilePicker: FunctionComponent<ComponentProps> = (
           const fileBuffer: Uint8Array = new Uint8Array(arrayBuffer);
           fileModel.file = Buffer.from(fileBuffer);
           fileModel.isPublic = false;
-          fileModel.type = acceptedFile.type as MimeType;
+          fileModel.fileType = acceptedFile.type as MimeType;
 
           const result: HTTPResponse<FileModel> =
             (await ModelAPI.create<FileModel>({
@@ -132,7 +132,7 @@ const FilePicker: FunctionComponent<ComponentProps> = (
       }
 
       const blob: Blob = new Blob([file.file as Uint8Array], {
-        type: file.type as string,
+        type: file.fileType as string,
       });
       const url: string = URL.createObjectURL(blob);
 

package/UI/Components/Forms/Fields/FormField.tsx

@@ -198,7 +198,8 @@ const FormField: <T extends GenericObject>(
       codeType = CodeType.JavaScript;
     }
 
-    let fieldDescription: string | undefined = props.field.description;
+    let fieldDescription: string | ReactElement | undefined =
+      props.field.description;
 
     if (
       props.field.fieldType === FormFieldSchemaType.DateTime ||

package/UI/Components/Forms/ModelForm.tsx

@@ -159,7 +159,7 @@ const ModelForm: <TBaseModel extends BaseModel>(
           (relationSelect as JSONObject)[key] = {
             file: true,
             _id: true,
-            type: true,
+            fileType: true,
             name: true,
           };
         } else if (key && model.isEntityColumn(key)) {

package/UI/Components/Forms/Types/Field.ts

@@ -42,7 +42,7 @@ export interface CategoryCheckboxProps {
 export default interface Field<TEntity> {
   name?: string; // form field name, should be unique in thr form. If not provided, the field will be auto generated.
   title?: string;
-  description?: string;
+  description?: string | ReactElement;
   field?: SelectFormFields<TEntity> | undefined;
   placeholder?: string;
   showEvenIfPermissionDoesNotExist?: boolean; // show this field even if user does not have permissions to view.

package/UI/Components/Image/Image.tsx

@@ -19,7 +19,7 @@ export interface ComponentProps {
 export class ImageFunctions {
   public static getImageURL(file: File): string {
     const blob: Blob = new Blob([file.file as Uint8Array], {
-      type: (file as File).type as string,
+      type: (file as File).fileType as string,
     });
 
     const url: string = URL.createObjectURL(blob);
@@ -54,7 +54,7 @@ const Image: FunctionComponent<ComponentProps> = (
     return getImageElement(props.imageUrl.toString());
   }
 
-  if (props.file && props.file.file && props.file.type) {
+  if (props.file && props.file.file && props.file.fileType) {
     const url: string = ImageFunctions.getImageURL(props.file);
     return getImageElement(url);
   }

package/UI/Components/ModelDetail/ModelDetail.tsx

@@ -94,7 +94,7 @@ const ModelDetail: <TBaseModel extends BaseModel>(
           (relationSelect as JSONObject)[key] = {
             file: true,
             _id: true,
-            type: true,
+            fileType: true,
             name: true,
           };
         } else if (key && new props.modelType()?.isEntityColumn(key)) {

package/UI/Components/ModelTable/BaseModelTable.tsx

@@ -424,7 +424,7 @@ const BaseModelTable: <TBaseModel extends BaseModel | AnalyticsBaseModel>(
           (relationSelect as JSONObject)[key] = {
             file: true,
             _id: true,
-            type: true,
+            fileType: true,
             name: true,
           };
         } else if (key && model.isEntityColumn(key)) {

package/UI/Utils/Markdown.tsx

@@ -0,0 +1,22 @@
+import React, { ReactElement } from "react";
+import Link from "../Components/Link/Link";
+import URL from "../../Types/API/URL";
+
+export default class MarkdownUtil {
+  public static getMarkdownCheatsheet(prefix?: string): ReactElement {
+    const prefixText: string = prefix ? `${prefix}. ` : "";
+    return (
+      <p>
+        {prefixText}This is in Markdown.{" "}
+        <Link
+          to={URL.fromString("https://www.markdownguide.org/cheat-sheet/")}
+          openInNewTab={true}
+          className="underline text-blue-500 hover:text-blue-700"
+        >
+          Learn more about Markdown syntax
+        </Link>
+        .
+      </p>
+    );
+  }
+}

package/build/dist/Models/DatabaseModels/Alert.js

@@ -197,7 +197,7 @@ __decorate([
         required: false,
         type: TableColumnType.Markdown,
         title: "Description",
-        description: "Short description of this alert. This is in markdown and will be visible on the status page.",
+        description: "Short description of this alert. This will be visible on the status page. This is in markdown.",
     }),
     Column({
         nullable: true,