feat: workflow ui (#24190)

* feat: workflow ui

* wip

* wip

* wip

* pr feedback

* refactor: picker field

* use showDialog directly

* better test

* refactor step selection modal

* move enable button to info form

* use  for Props

* pr feedback

* refactor ActionItem

* refactor ActionItem

* more refactor

* fix: new schemaformfield has value of the same type

* chore: clean up

server/src/controllers/plugin.controller.ts

@@ -1,7 +1,7 @@
 import { Controller, Get, Param } from '@nestjs/common';
 import { ApiTags } from '@nestjs/swagger';
 import { Endpoint, HistoryBuilder } from 'src/decorators';
-import { PluginResponseDto } from 'src/dtos/plugin.dto';
+import { PluginResponseDto, PluginTriggerResponseDto } from 'src/dtos/plugin.dto';
 import { Permission } from 'src/enum';
 import { Authenticated } from 'src/middleware/auth.guard';
 import { PluginService } from 'src/services/plugin.service';
@@ -12,6 +12,17 @@ import { UUIDParamDto } from 'src/validation';
 export class PluginController {
   constructor(private service: PluginService) {}
 
+  @Get('triggers')
+  @Authenticated({ permission: Permission.PluginRead })
+  @Endpoint({
+    summary: 'List all plugin triggers',
+    description: 'Retrieve a list of all available plugin triggers.',
+    history: new HistoryBuilder().added('v2.3.0').alpha('v2.3.0'),
+  })
+  getPluginTriggers(): PluginTriggerResponseDto[] {
+    return this.service.getTriggers();
+  }
+
   @Get()
   @Authenticated({ permission: Permission.PluginRead })
   @Endpoint({

server/src/dtos/plugin.dto.ts

@@ -1,9 +1,16 @@
 import { IsNotEmpty, IsString } from 'class-validator';
 import { PluginAction, PluginFilter } from 'src/database';
-import { PluginContext } from 'src/enum';
+import { PluginContext as PluginContextType, PluginTriggerType } from 'src/enum';
 import type { JSONSchema } from 'src/types/plugin-schema.types';
 import { ValidateEnum } from 'src/validation';
 
+export class PluginTriggerResponseDto {
+  @ValidateEnum({ enum: PluginTriggerType, name: 'PluginTriggerType' })
+  type!: PluginTriggerType;
+  @ValidateEnum({ enum: PluginContextType, name: 'PluginContextType' })
+  contextType!: PluginContextType;
+}
+
 export class PluginResponseDto {
   id!: string;
   name!: string;
@@ -24,8 +31,8 @@ export class PluginFilterResponseDto {
   title!: string;
   description!: string;
 
-  @ValidateEnum({ enum: PluginContext, name: 'PluginContext' })
-  supportedContexts!: PluginContext[];
+  @ValidateEnum({ enum: PluginContextType, name: 'PluginContextType' })
+  supportedContexts!: PluginContextType[];
   schema!: JSONSchema | null;
 }
 
@@ -36,8 +43,8 @@ export class PluginActionResponseDto {
   title!: string;
   description!: string;
 
-  @ValidateEnum({ enum: PluginContext, name: 'PluginContext' })
-  supportedContexts!: PluginContext[];
+  @ValidateEnum({ enum: PluginContextType, name: 'PluginContextType' })
+  supportedContexts!: PluginContextType[];
   schema!: JSONSchema | null;
 }
 

server/src/dtos/workflow.dto.ts

@@ -48,6 +48,9 @@ export class WorkflowCreateDto {
 }
 
 export class WorkflowUpdateDto {
+  @ValidateEnum({ enum: PluginTriggerType, name: 'PluginTriggerType', optional: true })
+  triggerType?: PluginTriggerType;
+
   @IsString()
   @IsNotEmpty()
   @Optional()
@@ -74,6 +77,7 @@ export class WorkflowUpdateDto {
 export class WorkflowResponseDto {
   id!: string;
   ownerId!: string;
+  @ValidateEnum({ enum: PluginTriggerType, name: 'PluginTriggerType' })
   triggerType!: PluginTriggerType;
   name!: string | null;
   description!: string;

server/src/plugins.ts

@@ -1,37 +1,17 @@
 import { PluginContext, PluginTriggerType } from 'src/enum';
-import { JSONSchema } from 'src/types/plugin-schema.types';
 
 export type PluginTrigger = {
-  name: string;
   type: PluginTriggerType;
-  description: string;
-  context: PluginContext;
-  schema: JSONSchema | null;
+  contextType: PluginContext;
 };
 
 export const pluginTriggers: PluginTrigger[] = [
   {
-    name: 'Asset Uploaded',
     type: PluginTriggerType.AssetCreate,
-    description: 'Triggered when a new asset is uploaded',
-    context: PluginContext.Asset,
-    schema: {
-      type: 'object',
-      properties: {
-        assetType: {
-          type: 'string',
-          description: 'Type of the asset',
-          default: 'ALL',
-          enum: ['Image', 'Video', 'All'],
-        },
-      },
-    },
+    contextType: PluginContext.Asset,
   },
   {
-    name: 'Person Recognized',
     type: PluginTriggerType.PersonRecognized,
-    description: 'Triggered when a person is detected in an asset',
-    context: PluginContext.Person,
-    schema: null,
+    contextType: PluginContext.Person,
   },
 ];

server/src/queries/workflow.repository.sql

@@ -7,6 +7,8 @@ from
   "workflow"
 where
   "id" = $1
+order by
+  "createdAt" desc
 
 -- WorkflowRepository.getWorkflowsByOwner
 select
@@ -16,7 +18,7 @@ from
 where
   "ownerId" = $1
 order by
-  "name"
+  "createdAt" desc
 
 -- WorkflowRepository.getWorkflowsByTrigger
 select

server/src/repositories/workflow.repository.ts

@@ -12,12 +12,22 @@ export class WorkflowRepository {
 
   @GenerateSql({ params: [DummyValue.UUID] })
   getWorkflow(id: string) {
-    return this.db.selectFrom('workflow').selectAll().where('id', '=', id).executeTakeFirst();
+    return this.db
+      .selectFrom('workflow')
+      .selectAll()
+      .where('id', '=', id)
+      .orderBy('createdAt', 'desc')
+      .executeTakeFirst();
   }
 
   @GenerateSql({ params: [DummyValue.UUID] })
   getWorkflowsByOwner(ownerId: string) {
-    return this.db.selectFrom('workflow').selectAll().where('ownerId', '=', ownerId).orderBy('name').execute();
+    return this.db
+      .selectFrom('workflow')
+      .selectAll()
+      .where('ownerId', '=', ownerId)
+      .orderBy('createdAt', 'desc')
+      .execute();
   }
 
   @GenerateSql({ params: [PluginTriggerType.AssetCreate] })

server/src/services/plugin.service.ts

@@ -6,8 +6,9 @@ import { join } from 'node:path';
 import { Asset, WorkflowAction, WorkflowFilter } from 'src/database';
 import { OnEvent, OnJob } from 'src/decorators';
 import { PluginManifestDto } from 'src/dtos/plugin-manifest.dto';
-import { mapPlugin, PluginResponseDto } from 'src/dtos/plugin.dto';
+import { mapPlugin, PluginResponseDto, PluginTriggerResponseDto } from 'src/dtos/plugin.dto';
 import { JobName, JobStatus, PluginTriggerType, QueueName } from 'src/enum';
+import { pluginTriggers } from 'src/plugins';
 import { ArgOf } from 'src/repositories/event.repository';
 import { BaseService } from 'src/services/base.service';
 import { PluginHostFunctions } from 'src/services/plugin-host.functions';
@@ -50,6 +51,10 @@ export class PluginService extends BaseService {
     await this.loadPlugins();
   }
 
+  getTriggers(): PluginTriggerResponseDto[] {
+    return pluginTriggers;
+  }
+
   //
   // CRUD operations for plugins
   //

server/src/services/workflow.service.ts

@@ -16,10 +16,10 @@ import { BaseService } from 'src/services/base.service';
 @Injectable()
 export class WorkflowService extends BaseService {
   async create(auth: AuthDto, dto: WorkflowCreateDto): Promise<WorkflowResponseDto> {
-    const trigger = this.getTriggerOrFail(dto.triggerType);
+    const context = this.getContextForTrigger(dto.triggerType);
 
-    const filterInserts = await this.validateAndMapFilters(dto.filters, trigger.context);
-    const actionInserts = await this.validateAndMapActions(dto.actions, trigger.context);
+    const filterInserts = await this.validateAndMapFilters(dto.filters, context);
+    const actionInserts = await this.validateAndMapActions(dto.actions, context);
 
     const workflow = await this.workflowRepository.createWorkflow(
       {
@@ -56,11 +56,11 @@ export class WorkflowService extends BaseService {
     }
 
     const workflow = await this.findOrFail(id);
-    const trigger = this.getTriggerOrFail(workflow.triggerType);
+    const context = this.getContextForTrigger(dto.triggerType ?? workflow.triggerType);
 
     const { filters, actions, ...workflowUpdate } = dto;
-    const filterInserts = filters && (await this.validateAndMapFilters(filters, trigger.context));
-    const actionInserts = actions && (await this.validateAndMapActions(actions, trigger.context));
+    const filterInserts = filters && (await this.validateAndMapFilters(filters, context));
+    const actionInserts = actions && (await this.validateAndMapActions(actions, context));
 
     const updatedWorkflow = await this.workflowRepository.updateWorkflow(
       id,
@@ -124,12 +124,12 @@ export class WorkflowService extends BaseService {
     }));
   }
 
-  private getTriggerOrFail(triggerType: PluginTriggerType) {
-    const trigger = pluginTriggers.find((t) => t.type === triggerType);
+  private getContextForTrigger(type: PluginTriggerType) {
+    const trigger = pluginTriggers.find((t) => t.type === type);
     if (!trigger) {
-      throw new BadRequestException(`Invalid trigger type: ${triggerType}`);
+      throw new BadRequestException(`Invalid trigger type: ${type}`);
     }
-    return trigger;
+    return trigger.contextType;
   }
 
   private async findOrFail(id: string) {