Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

9.6 KB
Raw Blame
import type { SchemaDefinitionItemResponse } from '@dify/contracts/api/console/spec/types.gen'
import type { TFunction } from 'i18next'
import type { NodeDefault, Var } from '../../types'
import type { Field, StructuredOutput } from '../llm/types'
import type { PluginTriggerNodeType } from './types'
import { BlockEnum, VarType } from '../../types'
import { genNodeMetaData } from '../../utils'
import { VarKindType } from '../_base/types'
import { Type } from '../llm/types'

const normalizeJsonSchemaType = (schema: any): string | undefined => {
  if (!schema) return undefined
  const { type, properties, items, oneOf, anyOf, allOf } = schema

  if (Array.isArray(type))
    return type.find((item: string | null) => item && item !== 'null') || type[0]

  if (typeof type === 'string') return type

  const compositeCandidates = [oneOf, anyOf, allOf]
    .filter((entry): entry is any[] => Array.isArray(entry))
    .flat()

  for (const candidate of compositeCandidates) {
    const normalized = normalizeJsonSchemaType(candidate)
    if (normalized) return normalized
  }

  if (properties) return 'object'

  if (items) return 'array'

  return undefined
}

const pickItemSchema = (schema: any) => {
  if (!schema || !schema.items) return undefined
  return Array.isArray(schema.items) ? schema.items[0] : schema.items
}

const extractSchemaType = (
  schema: any,
  _schemaTypeDefinitions?: SchemaDefinitionItemResponse[],
): string | undefined => {
  if (!schema) return undefined

  const schemaTypeFromSchema = schema.schema_type || schema.schemaType
  if (typeof schemaTypeFromSchema === 'string' && schemaTypeFromSchema.trim().length > 0)
    return schemaTypeFromSchema

  return undefined
}

const resolveVarType = (
  schema: any,
  schemaTypeDefinitions?: SchemaDefinitionItemResponse[],
): { type: VarType; schemaType?: string } => {
  const schemaType = extractSchemaType(schema, schemaTypeDefinitions)
  const normalizedType = normalizeJsonSchemaType(schema)

  switch (normalizedType) {
    case 'string':
      return { type: VarType.string, schemaType }
    case 'number':
      return { type: VarType.number, schemaType }
    case 'integer':
      return { type: VarType.integer, schemaType }
    case 'boolean':
      return { type: VarType.boolean, schemaType }
    case 'object':
      return { type: VarType.object, schemaType }
    case 'array': {
      const itemSchema = pickItemSchema(schema)
      if (!itemSchema) return { type: VarType.array, schemaType }

      const { type: itemType, schemaType: itemSchemaType } = resolveVarType(
        itemSchema,
        schemaTypeDefinitions,
      )
      const resolvedSchemaType = schemaType || itemSchemaType

      if (itemSchemaType === 'file')
        return { type: VarType.arrayFile, schemaType: resolvedSchemaType }

      switch (itemType) {
        case VarType.string:
          return { type: VarType.arrayString, schemaType: resolvedSchemaType }
        case VarType.number:
        case VarType.integer:
          return { type: VarType.arrayNumber, schemaType: resolvedSchemaType }
        case VarType.boolean:
          return { type: VarType.arrayBoolean, schemaType: resolvedSchemaType }
        case VarType.object:
          return { type: VarType.arrayObject, schemaType: resolvedSchemaType }
        case VarType.file:
          return { type: VarType.arrayFile, schemaType: resolvedSchemaType }
        default:
          return { type: VarType.array, schemaType: resolvedSchemaType }
      }
    }
    default:
      return { type: VarType.any, schemaType }
  }
}

const toFieldType = (normalizedType: string | undefined, schemaType?: string): Type => {
  if (schemaType === 'file') return normalizedType === 'array' ? Type.array : Type.file

  switch (normalizedType) {
    case 'number':
    case 'integer':
      return Type.number
    case 'boolean':
      return Type.boolean
    case 'object':
      return Type.object
    case 'array':
      return Type.array
    case 'string':
    default:
      return Type.string
  }
}

const toArrayItemType = (type: Type): Exclude<Type, typeof Type.array> => {
  if (type === Type.array) return Type.object
  return type
}

const convertJsonSchemaToField = (
  schema: any,
  schemaTypeDefinitions?: SchemaDefinitionItemResponse[],
): Field => {
  const schemaType = extractSchemaType(schema, schemaTypeDefinitions)
  const normalizedType = normalizeJsonSchemaType(schema)
  const fieldType = toFieldType(normalizedType, schemaType)

  const field: Field = {
    type: fieldType,
  }

  if (schema?.description) field.description = schema.description

  if (schemaType) field.schemaType = schemaType

  if (Array.isArray(schema?.enum)) field.enum = schema.enum

  if (fieldType === Type.object) {
    const properties = schema?.properties || {}
    field.properties = Object.entries(properties).reduce(
      (acc, [key, value]) => {
        acc[key] = convertJsonSchemaToField(value, schemaTypeDefinitions)
        return acc
      },
      {} as Record<string, Field>,
    )

    const required = Array.isArray(schema?.required) ? schema.required.filter(Boolean) : undefined
    field.required = required && required.length > 0 ? required : undefined
    field.additionalProperties = false
  }

  if (fieldType === Type.array) {
    const itemSchema = pickItemSchema(schema)
    if (itemSchema) {
      const itemField = convertJsonSchemaToField(itemSchema, schemaTypeDefinitions)
      const { type, ...rest } = itemField
      field.items = {
        ...rest,
        type: toArrayItemType(type),
      }
    }
  }

  return field
}

const buildOutputVars = (
  schema: Record<string, any>,
  schemaTypeDefinitions?: SchemaDefinitionItemResponse[],
): Var[] => {
  if (!schema || typeof schema !== 'object') return []

  const properties = schema.properties as Record<string, any> | undefined
  if (!properties) return []

  return Object.entries(properties).map(([name, propertySchema]) => {
    const { type, schemaType } = resolveVarType(propertySchema, schemaTypeDefinitions)
    const normalizedType = normalizeJsonSchemaType(propertySchema)

    const varItem: Var = {
      variable: name,
      type,
      des: propertySchema?.description,
      ...(schemaType ? { schemaType } : {}),
    }

    if (normalizedType === 'object') {
      const childProperties = propertySchema?.properties
        ? Object.entries(propertySchema.properties).reduce(
            (acc, [key, value]) => {
              acc[key] = convertJsonSchemaToField(value, schemaTypeDefinitions)
              return acc
            },
            {} as Record<string, Field>,
          )
        : {}

      const required = Array.isArray(propertySchema?.required)
        ? propertySchema.required.filter(Boolean)
        : undefined

      varItem.children = {
        schema: {
          type: Type.object,
          properties: childProperties,
          required: required && required.length > 0 ? required : undefined,
          additionalProperties: false,
        },
      } as StructuredOutput
    }

    return varItem
  })
}

const metaData = genNodeMetaData({
  sort: 1,
  type: BlockEnum.TriggerPlugin,
  helpLinkUri: 'trigger/plugin-trigger',
  isStart: true,
})

const nodeDefault: NodeDefault<PluginTriggerNodeType> = {
  metaData,
  defaultValue: {
    plugin_id: '',
    event_name: '',
    event_parameters: {},
    // event_type: '',
    config: {},
  },
  checkValid(
    payload: PluginTriggerNodeType,
    t: TFunction<['workflow']>,
    moreDataForCheckValid: {
      triggerInputsSchema?: Array<{
        variable: string
        label: string
        required?: boolean
      }>
      isReadyForCheckValid?: boolean
    } = {},
  ) {
    let errorMessage = ''

    if (!payload.subscription_id)
      errorMessage = t(($) => $['nodes.triggerPlugin.subscriptionRequired'], { ns: 'workflow' })

    const { triggerInputsSchema = [], isReadyForCheckValid = true } = moreDataForCheckValid || {}

    if (!errorMessage && isReadyForCheckValid) {
      triggerInputsSchema
        .filter((field) => field.required)
        .forEach((field) => {
          if (errorMessage) return

          const rawParam =
            payload.event_parameters?.[field.variable] ??
            (payload.config as Record<string, any> | undefined)?.[field.variable]
          if (!rawParam) {
            errorMessage = t(($) => $['errorMsg.fieldRequired'], {
              ns: 'workflow',
              field: field.label,
            })
            return
          }

          const targetParam =
            typeof rawParam === 'object' && rawParam !== null && 'type' in rawParam
              ? (rawParam as { type: VarKindType; value: any })
              : { type: VarKindType.constant, value: rawParam }

          const { type, value } = targetParam
          if (type === VarKindType.variable) {
            if (!value || (Array.isArray(value) && value.length === 0))
              errorMessage = t(($) => $['errorMsg.fieldRequired'], {
                ns: 'workflow',
                field: field.label,
              })
          } else {
            if (
              value === undefined ||
              value === null ||
              value === '' ||
              (Array.isArray(value) && value.length === 0)
            ) {
              errorMessage = t(($) => $['errorMsg.fieldRequired'], {
                ns: 'workflow',
                field: field.label,
              })
            }
          }
        })
    }

    return {
      isValid: !errorMessage,
      errorMessage,
    }
  },
  getOutputVars(
    payload,
    _allPluginInfoList,
    _ragVars,
    { schemaTypeDefinitions } = { schemaTypeDefinitions: [] },
  ) {
    const schema = payload.output_schema || {}
    return buildOutputVars(schema, schemaTypeDefinitions)
  },
}

export default nodeDefault