@oneuptime/common 7.0.3707 → 7.0.3708

package/Server/Utils/Workspace/WorkspaceBase.ts

@@ -21,6 +21,13 @@ export interface WorkspaceChannel {
 }
 
 export default class WorkspaceBase {
+  public static async joinChannel(_data: {
+    authToken: string;
+    channelId: string;
+  }): Promise<void> {
+    throw new NotImplementedException();
+  }
+
   public static async sendPayloadBlocksToChannel(_data: {
     authToken: string;
     channelId: string;
@@ -50,7 +57,7 @@ export default class WorkspaceBase {
     workspaceUserIds: Array<string>;
   }): Promise<void> {
     for (const userId of data.workspaceUserIds) {
-      await this.inviteUserToChannel({
+      await this.inviteUserToChannelByChannelName({
         authToken: data.authToken,
         channelName: data.channelName,
         workspaceUserId: userId,
@@ -58,7 +65,7 @@ export default class WorkspaceBase {
     }
   }
 
-  public static async inviteUserToChannel(_data: {
+  public static async inviteUserToChannelByChannelName(_data: {
     authToken: string;
     channelName: string;
     workspaceUserId: string;
@@ -66,6 +73,12 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  public static async inviteUserToChannelByChannelId(_data: {
+    authToken: string;
+    channelId: string;
+    workspaceUserId: string;
+  }): Promise<void> {}
+
   public static async createChannelsIfDoesNotExist(_data: {
     authToken: string;
     channelNames: Array<string>;
@@ -83,6 +96,7 @@ export default class WorkspaceBase {
   public static async sendMessage(_data: {
     workspaceMessagePayload: WorkspaceMessagePayload;
     authToken: string; // which auth token should we use to send.
+    userId: string;
   }): Promise<void> {
     throw new NotImplementedException();
   }
@@ -93,6 +107,13 @@ export default class WorkspaceBase {
     throw new NotImplementedException();
   }
 
+  public static async getWorkspaceChannelFromChannelName(_data: {
+    authToken: string;
+    channelName: string;
+  }): Promise<WorkspaceChannel> {
+    throw new NotImplementedException();
+  }
+
   public static async createChannel(_data: {
     authToken: string;
     channelName: string;
@@ -166,4 +187,12 @@ export default class WorkspaceBase {
   }): Promise<HTTPResponse<JSONObject> | HTTPErrorResponse> {
     throw new NotImplementedException();
   }
+
+  public static async isUserInChannel(_data: {
+    authToken: string;
+    channelId: string;
+    userId: string;
+  }): Promise<boolean> {
+    throw new NotImplementedException();
+  }
 }

package/Types/Workflow/Component.ts

@@ -90,6 +90,7 @@ export default interface ComponentMetadata {
   outPorts: Array<Port>;
   tableName?: string | undefined;
   documentationLink?: Route;
+  runWorkflowManuallyArguments?: Array<Argument> | undefined;
 }
 
 export interface ComponentCategory {

package/Types/Workflow/Components/BaseModel.ts

@@ -157,6 +157,16 @@ export default class BaseModelComponent {
         iconProp: IconProp.Bolt,
         tableName: model.tableName!,
         componentType: ComponentType.Trigger,
+        runWorkflowManuallyArguments: [
+          {
+            type: ComponentInputType.Text,
+            name: `${model.singularName} ID`,
+            description: `Please provide the ID of the ${model.singularName}, if you wish to run this workflow manually.`,
+            required: true,
+            id: "_id",
+            placeholder: `ID of the ${model.singularName}`,
+          },
+        ],
         arguments: [],
         returnValues: [
           {
@@ -288,6 +298,16 @@ export default class BaseModelComponent {
         iconProp: IconProp.Bolt,
         tableName: model.tableName!,
         componentType: ComponentType.Trigger,
+        runWorkflowManuallyArguments: [
+          {
+            type: ComponentInputType.Text,
+            name: `${model.singularName} ID`,
+            description: `Please provide the ID of the ${model.singularName}, if you wish to run this workflow manually.`,
+            required: true,
+            id: "_id",
+            placeholder: `ID of the ${model.singularName}`,
+          },
+        ],
         arguments: [
           {
             type: ComponentInputType.Select,
@@ -430,6 +450,16 @@ export default class BaseModelComponent {
         iconProp: IconProp.Bolt,
         tableName: model.tableName!,
         componentType: ComponentType.Trigger,
+        runWorkflowManuallyArguments: [
+          {
+            type: ComponentInputType.Text,
+            name: `${model.singularName} ID`,
+            description: `Please provide the ID of the ${model.singularName}, if you wish to run this workflow manually.`,
+            required: true,
+            id: "_id",
+            placeholder: `ID of the ${model.singularName}`,
+          },
+        ],
         arguments: [
           {
             type: ComponentInputType.Select,

package/Types/Workflow/Components/Manual.ts

@@ -14,6 +14,16 @@ const components: Array<ComponentMetadata> = [
     iconProp: IconProp.Play,
     componentType: ComponentType.Trigger,
     arguments: [],
+    runWorkflowManuallyArguments: [
+      {
+        type: ComponentInputType.JSON,
+        name: "JSON",
+        description: "Enter JSON value that you need to run this workflow",
+        required: false,
+        id: "value",
+        placeholder: '{"key1": "value1", "key2": "value2", ....}',
+      },
+    ],
     returnValues: [
       {
         type: ComponentInputType.JSON,

package/Types/Workflow/Components/Schedule.ts

@@ -13,6 +13,7 @@ const components: Array<ComponentMetadata> = [
     description: "Run this workflow on particular schedule",
     iconProp: IconProp.Clock,
     componentType: ComponentType.Trigger,
+    runWorkflowManuallyArguments: [],
     arguments: [
       {
         type: ComponentInputType.CronTab,

package/Types/Workflow/Components/Webhook.ts

@@ -17,6 +17,32 @@ const components: Array<ComponentMetadata> = [
     componentType: ComponentType.Trigger,
     documentationLink: Route.fromString("/workflow/docs/Webhook.md"),
     arguments: [],
+    runWorkflowManuallyArguments: [
+      {
+        id: "request-headers",
+        name: "Request Headers",
+        description: "Request Headers for this request",
+        type: ComponentInputType.StringDictionary,
+        required: false,
+        placeholder: '{"header1": "value1", "header2": "value2", ....}',
+      },
+      {
+        id: "request-params",
+        name: "Request Query Params",
+        description: "Request Query Params for this request",
+        type: ComponentInputType.StringDictionary,
+        required: false,
+        placeholder: '{"query1": "value1", "query2": "value2", ....}',
+      },
+      {
+        id: "request-body",
+        name: "Request Body",
+        description: "Request Body",
+        type: ComponentInputType.JSON,
+        required: false,
+        placeholder: '{"key1": "value1", "key2": "value2", ....}',
+      },
+    ],
     returnValues: [
       {
         id: "request-headers",

package/UI/Components/Workflow/RunForm.tsx

@@ -3,7 +3,7 @@ import BasicForm, { FormProps } from "../Forms/BasicForm";
 import FormValues from "../Forms/Types/FormValues";
 import { componentInputTypeToFormFieldType } from "./Utils";
 import { JSONObject } from "Common/Types/JSON";
-import { NodeDataProp, ReturnValue } from "Common/Types/Workflow/Component";
+import { Argument, NodeDataProp } from "Common/Types/Workflow/Component";
 import React, {
   FunctionComponent,
   ReactElement,
@@ -38,34 +38,32 @@ const RunForm: FunctionComponent<ComponentProps> = (
     <div className="mb-3 mt-3">
       <div className="mt-5 mb-5">
         <h2 className="text-base font-medium text-gray-500">
-          Return Values from Trigger
+          Run {component.metadata.title}
         </h2>
         <p className="text-sm font-medium text-gray-400 mb-5">
-          This workflow has a trigger to get it to run. Since this trigger
-          returns some values to work. You can pass these return values from
-          trigger manually and test this workflow.
+          {component.metadata.description}
         </p>
-        {component.metadata.returnValues &&
-          component.metadata.returnValues.length === 0 && (
+        {component.metadata.runWorkflowManuallyArguments &&
+          component.metadata.runWorkflowManuallyArguments.length === 0 && (
             <ErrorMessage
               message={
-                'This workflow trigger does not take any return values. You can run it by clicking the "Run" button below.'
+                'This workflow trigger does not take any values. You can run it by clicking the "Run" button below.'
               }
             />
           )}
-        {component.metadata.returnValues &&
-          component.metadata.returnValues.length > 0 && (
+        {component.metadata.runWorkflowManuallyArguments &&
+          component.metadata.runWorkflowManuallyArguments.length > 0 && (
             <BasicForm
               hideSubmitButton={true}
               ref={formRef}
               initialValues={{
-                ...(component.returnValues || {}),
+                ...(component.arguments || {}),
               }}
               onChange={(values: FormValues<JSONObject>) => {
                 setComponent({
                   ...component,
-                  returnValues: {
-                    ...((component.returnValues as JSONObject) || {}),
+                  arguments: {
+                    ...((component.arguments as JSONObject) || {}),
                     ...((values as JSONObject) || {}),
                   },
                 });
@@ -74,25 +72,25 @@ const RunForm: FunctionComponent<ComponentProps> = (
                 setHasFormValidationErrors(hasError);
               }}
               fields={
-                component.metadata.returnValues &&
-                component.metadata.returnValues.map(
-                  (returnValue: ReturnValue) => {
+                component.metadata.runWorkflowManuallyArguments &&
+                component.metadata.runWorkflowManuallyArguments.map(
+                  (argument: Argument) => {
                     return {
-                      title: `${returnValue.name}`,
+                      title: `${argument.name}`,
 
                       description: `${
-                        returnValue.required ? "Required" : "Optional"
-                      }. ${returnValue.description}`,
+                        argument.required ? "Required" : "Optional"
+                      }. ${argument.description}`,
                       field: {
-                        [returnValue.id]: true,
+                        [argument.id]: true,
                       },
-                      required: returnValue.required,
-                      placeholder: returnValue.placeholder,
+                      required: argument.required,
+                      placeholder: argument.placeholder,
                       ...componentInputTypeToFormFieldType(
-                        returnValue.type,
+                        argument.type,
                         component.returnValues &&
-                          component.returnValues[returnValue.id]
-                          ? component.returnValues[returnValue.id]
+                          component.returnValues[argument.id]
+                          ? component.returnValues[argument.id]
                           : null,
                       ),
                     };