@oneuptime/common 1.0.0

package/Types/Workflow/Components/BaseModel.ts

@@ -0,0 +1,590 @@
+import IconProp from '../../Icon/IconProp';
+import ComponentMetadata, {
+    ComponentInputType,
+    ComponentType,
+} from './../Component';
+import BaseModel from '../../../Models/BaseModel';
+import Text from '../../Text';
+
+export default class BaseModelComponent {
+    public static getComponents(model: BaseModel): Array<ComponentMetadata> {
+        const components: Array<ComponentMetadata> = [];
+
+        if (!model.enableWorkflowOn) {
+            return [];
+        }
+
+        if (model.enableWorkflowOn.read) {
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-find-one`,
+                title: `Find One ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `Database query to find one ${model.singularName}`,
+                iconProp: IconProp.ArrowCircleDown,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        type: ComponentInputType.Query,
+                        name: 'Query',
+                        description: `Query on ${model.singularName}`,
+                        required: true,
+                        id: 'query',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                    },
+                    {
+                        type: ComponentInputType.Select,
+                        name: 'Select Fields',
+                        description: `Select on ${model.singularName}`,
+                        required: true,
+                        id: 'select',
+                        placeholder: 'Example: {"columnName": true, ...}',
+                    },
+                ],
+                returnValues: [
+                    {
+                        id: 'model',
+                        name: `${model.singularName}`,
+                        description: `${model.singularName} fetched from the database`,
+                        type: ComponentInputType.BaseModel,
+                        required: false,
+                    },
+                ],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error fetching data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-find-many`,
+                title: `Find Many ${model.pluralName}`,
+                category: `${model.singularName}`,
+                description: `Database query to find many ${model.pluralName}`,
+                iconProp: IconProp.ArrowCircleDown,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        type: ComponentInputType.Query,
+                        name: 'Query',
+                        description: 'Please fill out this query',
+                        required: true,
+                        id: 'query',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                    },
+                    {
+                        type: ComponentInputType.Select,
+                        name: 'Select Fields',
+                        description: `Select on ${model.singularName}`,
+                        required: true,
+                        id: 'select',
+                        placeholder: 'Example: {"columnName": true, ...}',
+                    },
+                    {
+                        type: ComponentInputType.Number,
+                        name: 'Skip',
+                        description: `Skip the first X number of items. This can be helpful to implement pagination. Defaults to 0.`,
+                        required: false,
+                        id: 'skip',
+                    },
+                    {
+                        type: ComponentInputType.Number,
+                        name: 'Limit',
+                        description: `Limit to first X items. This can be helpful to implement pagination. Defaults to 10.`,
+                        required: false,
+                        id: 'limit',
+                    },
+                ],
+                returnValues: [
+                    {
+                        id: 'models',
+                        name: `${model.singularName}`,
+                        description: `${model.singularName} array fetched from the database`,
+                        type: ComponentInputType.BaseModelArray,
+                        required: false,
+                    },
+                ],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error fetching data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+        }
+
+        if (model.enableWorkflowOn.delete) {
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-on-delete`,
+                title: `On Delete ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `When the ${model.singularName} is deleted...`,
+                iconProp: IconProp.Bolt,
+                tableName: model.tableName!,
+                componentType: ComponentType.Trigger,
+                arguments: [],
+                returnValues: [
+                    {
+                        id: 'model',
+                        name: `${model.singularName}`,
+                        description: `${model.singularName} deleted in the database`,
+                        type: ComponentInputType.BaseModel,
+                        required: false,
+                    },
+                ],
+                inPorts: [],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-delete-one`,
+                title: `Delete One ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `Database query to delete one ${model.singularName}`,
+                iconProp: IconProp.Trash,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        type: ComponentInputType.Query,
+                        name: 'Delete by',
+                        description: 'Please fill out this query',
+                        required: true,
+                        id: 'query',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                    },
+                ],
+                returnValues: [],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error deleting data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-delete-many`,
+                title: `Delete Many ${model.pluralName}`,
+                category: `${model.singularName}`,
+                description: `Database query to find many ${model.pluralName}`,
+                iconProp: IconProp.Trash,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        type: ComponentInputType.Query,
+                        name: 'Delete by',
+                        description: 'Please fill out this query',
+                        required: true,
+                        id: 'query',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                    },
+                    {
+                        type: ComponentInputType.Number,
+                        name: 'Skip',
+                        description: `Skip the first X number of items. This can be helpful to implement pagination. Defaults to 0.`,
+                        required: false,
+                        id: 'skip',
+                    },
+                    {
+                        type: ComponentInputType.Number,
+                        name: 'Limit',
+                        description: `Limit to first X items. This can be helpful to implement pagination. Defaults to 10.`,
+                        required: false,
+                        id: 'limit',
+                    },
+                ],
+                returnValues: [],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error deleting data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+        }
+
+        if (model.enableWorkflowOn.create) {
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-on-create`,
+                title: `On Create ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `When the ${model.singularName} is created...`,
+                iconProp: IconProp.Bolt,
+                tableName: model.tableName!,
+                componentType: ComponentType.Trigger,
+                arguments: [
+                    {
+                        type: ComponentInputType.Select,
+                        name: 'Select Fields',
+                        description: `Select on ${model.singularName}`,
+                        required: true,
+                        id: 'select',
+                        placeholder: 'Example: {"columnName": true, ...}',
+                    },
+                ],
+                returnValues: [
+                    {
+                        id: 'model',
+                        name: `${model.singularName}`,
+                        description: `${model.singularName} created in the database`,
+                        type: ComponentInputType.BaseModel,
+                        required: false,
+                    },
+                ],
+                inPorts: [],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the model is created successfully.',
+                        id: 'success',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-create-one`,
+                title: `Create One ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `Database query to create one ${model.singularName}`,
+                iconProp: IconProp.Database,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        id: 'json',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                        name: 'JSON Object',
+                        description: `${model.singularName} represented as JSON`,
+                        type: ComponentInputType.JSON,
+                        required: true,
+                    },
+                ],
+                returnValues: [
+                    {
+                        id: 'model',
+                        name: `${model.singularName}`,
+                        description: `${model.singularName} created in the database`,
+                        type: ComponentInputType.JSON,
+                        required: false,
+                    },
+                ],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error creating data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-create-many`,
+                title: `Create Many ${model.pluralName}`,
+                category: `${model.singularName}`,
+                description: `Database query to create many ${model.pluralName}`,
+                iconProp: IconProp.Database,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        id: 'json-array',
+                        name: 'JSON Array',
+                        placeholder:
+                            'Example: [{"columnName": "value", ...}, {...}]',
+                        description: 'List of models represented as JSON array',
+                        type: ComponentInputType.JSONArray,
+                        required: true,
+                    },
+                ],
+                returnValues: [
+                    {
+                        id: 'models',
+                        name: `${model.pluralName}`,
+                        description: 'Models created in the database',
+                        type: ComponentInputType.BaseModel,
+                        required: false,
+                    },
+                ],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error creating data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+        }
+
+        if (model.enableWorkflowOn.update) {
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-on-update`,
+                title: `On Update ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `When the ${model.singularName} is updated...`,
+                iconProp: IconProp.Bolt,
+                tableName: model.tableName!,
+                componentType: ComponentType.Trigger,
+                arguments: [
+                    {
+                        type: ComponentInputType.Select,
+                        name: 'Listen on',
+                        description: `Workflow only executes when an upate happens to these fields on ${model.singularName}. If you leave this blank then the workflow will fire on any field that's updated on ${model.singularName}.`,
+                        required: false,
+                        id: 'listen-on',
+                        placeholder: 'Example: {"columnName": true, ...}',
+                    },
+                    {
+                        type: ComponentInputType.Select,
+                        name: 'Select Fields',
+                        description: `Select on ${model.singularName}`,
+                        required: true,
+                        id: 'select',
+                        placeholder: 'Example: {"columnName": true, ...}',
+                    },
+                ],
+                returnValues: [
+                    {
+                        id: 'model',
+                        name: `${model.singularName}`,
+                        description: `Updated ${model.singularName}`,
+                        type: ComponentInputType.BaseModel,
+                        required: true,
+                    },
+                ],
+                inPorts: [],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description: `This is executed when the ${model.singularName} is updated successfully.`,
+                        id: 'success',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-update-one`,
+                title: `Update One ${model.singularName}`,
+                category: `${model.singularName}`,
+                description: `Database query to update one ${model.singularName}`,
+                iconProp: IconProp.ArrowCircleUp,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        type: ComponentInputType.Query,
+                        name: 'Query',
+                        description: 'Please fill out this query',
+                        required: true,
+                        id: 'query',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                    },
+                    {
+                        id: 'data',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                        name: 'Data (JSON Object)',
+                        description: `${model.singularName} represented as JSON`,
+                        type: ComponentInputType.JSON,
+                        required: true,
+                    },
+                ],
+                returnValues: [],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error updating data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+
+            components.push({
+                id: `${Text.pascalCaseToDashes(model.tableName!)}-update-many`,
+                title: `Update Many ${model.pluralName}`,
+                category: `${model.singularName}`,
+                description: `Database query to update many ${model.pluralName}`,
+                iconProp: IconProp.ArrowCircleUp,
+                tableName: model.tableName!,
+                componentType: ComponentType.Component,
+                arguments: [
+                    {
+                        type: ComponentInputType.Query,
+                        name: 'Query',
+                        description: 'Please fill out this query',
+                        required: true,
+                        id: 'query',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                    },
+                    {
+                        id: 'data',
+                        name: 'Data (JSON Object)',
+                        placeholder: 'Example: {"columnName": "value", ...}',
+                        description: `${model.singularName} represented as JSON`,
+                        type: ComponentInputType.JSON,
+                        required: true,
+                    },
+                    {
+                        type: ComponentInputType.Number,
+                        name: 'Skip',
+                        description: `Skip the first X number of items. This can be helpful to implement pagination. Defaults to 0.`,
+                        required: false,
+                        id: 'skip',
+                    },
+                    {
+                        type: ComponentInputType.Number,
+                        name: 'Limit',
+                        description: `Limit to first X items. This can be helpful to implement pagination. Defaults to 10.`,
+                        required: false,
+                        id: 'limit',
+                    },
+                ],
+                returnValues: [],
+                inPorts: [
+                    {
+                        title: 'In',
+                        description:
+                            'Please connect components to this port for this component to work.',
+                        id: 'in',
+                    },
+                ],
+                outPorts: [
+                    {
+                        title: 'Success',
+                        description:
+                            'This is executed when the query executes successfully',
+                        id: 'success',
+                    },
+                    {
+                        title: 'Error',
+                        description:
+                            'This is executed when there is an error updating data from the database',
+                        id: 'error',
+                    },
+                ],
+            });
+        }
+
+        return components;
+    }
+}

package/Types/Workflow/Components/Condition.ts

@@ -0,0 +1,66 @@
+import IconProp from '../../Icon/IconProp';
+import ComponentID from '../ComponentID';
+import ComponentMetadata, {
+    ComponentInputType,
+    ComponentType,
+} from './../Component';
+
+const components: Array<ComponentMetadata> = [
+    {
+        id: ComponentID.IfElse,
+        title: 'If / Else',
+        category: 'Conditions',
+        description: 'Branch based on Inputs',
+        iconProp: IconProp.Condition,
+        componentType: ComponentType.Component,
+        arguments: [
+            {
+                type: ComponentInputType.Text,
+                name: 'Input 1',
+                description: 'Input 1',
+                placeholder: 'x',
+                required: true,
+                id: 'input-1',
+            },
+            {
+                type: ComponentInputType.Operator,
+                name: 'Operator',
+                description: 'Operator',
+                placeholder: 'Equal To',
+                required: true,
+                id: 'operator',
+            },
+            {
+                type: ComponentInputType.Text,
+                name: 'Input 2',
+                description: 'Input 2',
+                placeholder: 'x',
+                required: true,
+                id: 'input-2',
+            },
+        ],
+        returnValues: [],
+        inPorts: [
+            {
+                title: 'In',
+                description:
+                    'Please connect components to this port for this component to work.',
+                id: 'in',
+            },
+        ],
+        outPorts: [
+            {
+                title: 'Yes',
+                description: 'If, yes then this port will be executed',
+                id: 'yes',
+            },
+            {
+                title: 'No',
+                description: 'If, no then this port will be executed',
+                id: 'no',
+            },
+        ],
+    },
+];
+
+export default components;