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.

6.9 KB
Raw Blame
import type { SchemaDefinitionItemResponse } from '@dify/contracts/api/console/spec/types.gen'
import type { FileUpload } from '../../base/features/types'
import type {
  BlockEnum,
  Node,
  NodeDefault,
  ValueSelector,
  WorkflowPluginCatalogs,
} from '@/app/components/workflow/types'
import type { IOtherOptions } from '@/service/base'
import type { EnvironmentVariablePatch } from '@/service/workflow'
import type { VarInInspect } from '@/types/workflow'
import { noop } from 'es-toolkit/function'
import { use } from 'react'
import { useStore as useZustandStore } from 'zustand'
import { createStore } from 'zustand/vanilla'
import { HooksStoreContext } from './provider'

export type AvailableNodesMetaData = {
  nodes: NodeDefault[]
  nodesMap?: Record<BlockEnum, NodeDefault<any>>
}
export type SyncDraftCallback = {
  onSuccess?: () => void
  onError?: () => void
  onSettled?: () => void
}

export type SyncDraftResult = {
  hash: string
  updatedAt: number
}

export type SyncDraftOptions = {
  environmentVariablePatch?: EnvironmentVariablePatch
  forceLocal?: boolean
}

export type WorkflowAccessControl = {
  canEdit: boolean
  canRun: boolean
  canImportExportDSL: boolean
  canReleaseAndVersion: boolean
}

export const fullWorkflowAccessControl: WorkflowAccessControl = {
  canEdit: true,
  canRun: true,
  canImportExportDSL: true,
  canReleaseAndVersion: true,
}

type CommonHooksFnMap = {
  doSyncWorkflowDraft: (
    notRefreshWhenSyncError?: boolean,
    callback?: SyncDraftCallback,
    options?: SyncDraftOptions,
  ) => Promise<SyncDraftResult | null | void>
  syncWorkflowDraftWhenPageClose: () => void
  handleRefreshWorkflowDraft: (notUpdateCanvas?: boolean) => void
  handleBackupDraft: () => void
  handleLoadBackupDraft: () => void
  handleRestoreFromPublishedWorkflow: (...args: any[]) => void
  handleRun: (params: any, callback?: IOtherOptions, options?: any) => void
  handleStopRun: (...args: any[]) => void
  handleStartWorkflowRun: () => void
  handleWorkflowStartRunInWorkflow: () => void
  handleWorkflowStartRunInChatflow: () => void
  handleWorkflowTriggerScheduleRunInWorkflow: (nodeId?: string) => void
  handleWorkflowTriggerWebhookRunInWorkflow: (params: { nodeId: string }) => void
  handleWorkflowTriggerPluginRunInWorkflow: (nodeId?: string) => void
  handleWorkflowRunAllTriggersInWorkflow: (nodeIds: string[]) => void
  availableNodesMetaData?: AvailableNodesMetaData
  getWorkflowRunAndTraceUrl: (runId?: string) => { runUrl: string; traceUrl: string }
  exportCheck?: () => Promise<void>
  handleExportDSL?: (include?: boolean, flowId?: string) => Promise<boolean>
  isExporting: boolean
  fetchInspectVars: (params: {
    passInVars?: boolean
    vars?: VarInInspect[]
    passedInAllPluginInfoList?: WorkflowPluginCatalogs
    passedInSchemaTypeDefinitions?: SchemaDefinitionItemResponse[]
  }) => Promise<void>
  hasNodeInspectVars: (nodeId: string) => boolean
  hasSetInspectVar: (
    nodeId: string,
    name: string,
    sysVars: VarInInspect[],
    conversationVars: VarInInspect[],
  ) => boolean
  fetchInspectVarValue: (
    selector: ValueSelector,
    schemaTypeDefinitions: SchemaDefinitionItemResponse[],
  ) => Promise<void>
  editInspectVarValue: (nodeId: string, varId: string, value: any) => Promise<void>
  renameInspectVarName: (nodeId: string, oldName: string, newName: string) => Promise<void>
  appendNodeInspectVars: (nodeId: string, payload: VarInInspect[], allNodes: Node[]) => void
  deleteInspectVar: (nodeId: string, varId: string) => Promise<void>
  deleteNodeInspectorVars: (nodeId: string) => Promise<void>
  deleteAllInspectorVars: () => Promise<void>
  isInspectVarEdited: (nodeId: string, name: string) => boolean
  resetToLastRunVar: (nodeId: string, varId: string) => Promise<void>
  invalidateSysVarValues: () => void
  resetConversationVar: (varId: string) => Promise<void>
  invalidateConversationVarValues: () => void
  accessControl: WorkflowAccessControl
  fileSettings?: FileUpload
}

export type Shape = {
  refreshAll: (props: Partial<CommonHooksFnMap>) => void
} & CommonHooksFnMap

export const createHooksStore = ({
  doSyncWorkflowDraft = async () => null,
  syncWorkflowDraftWhenPageClose = noop,
  handleRefreshWorkflowDraft = noop,
  handleBackupDraft = noop,
  handleLoadBackupDraft = noop,
  handleRestoreFromPublishedWorkflow = noop,
  handleRun = noop,
  handleStopRun = noop,
  handleStartWorkflowRun = noop,
  handleWorkflowStartRunInWorkflow = noop,
  handleWorkflowStartRunInChatflow = noop,
  handleWorkflowTriggerScheduleRunInWorkflow = noop,
  handleWorkflowTriggerWebhookRunInWorkflow = noop,
  handleWorkflowTriggerPluginRunInWorkflow = noop,
  handleWorkflowRunAllTriggersInWorkflow = noop,
  availableNodesMetaData = {
    nodes: [],
  },
  getWorkflowRunAndTraceUrl = () => ({
    runUrl: '',
    traceUrl: '',
  }),
  exportCheck = async () => noop(),
  handleExportDSL = async () => false,
  isExporting = false,
  fetchInspectVars = async () => noop(),
  hasNodeInspectVars = () => false,
  hasSetInspectVar = () => false,
  fetchInspectVarValue = async () => noop(),
  editInspectVarValue = async () => noop(),
  renameInspectVarName = async () => noop(),
  appendNodeInspectVars = () => noop(),
  deleteInspectVar = async () => noop(),
  deleteNodeInspectorVars = async () => noop(),
  deleteAllInspectorVars = async () => noop(),
  isInspectVarEdited = () => false,
  resetToLastRunVar = async () => noop(),
  invalidateSysVarValues = noop,
  resetConversationVar = async () => noop(),
  invalidateConversationVarValues = noop,
  fileSettings,
  accessControl = fullWorkflowAccessControl,
}: Partial<Shape>) => {
  return createStore<Shape>((set) => ({
    refreshAll: (props) => set((state) => ({ ...state, ...props })),
    doSyncWorkflowDraft,
    syncWorkflowDraftWhenPageClose,
    handleRefreshWorkflowDraft,
    handleBackupDraft,
    handleLoadBackupDraft,
    handleRestoreFromPublishedWorkflow,
    handleRun,
    handleStopRun,
    handleStartWorkflowRun,
    handleWorkflowStartRunInWorkflow,
    handleWorkflowStartRunInChatflow,
    handleWorkflowTriggerScheduleRunInWorkflow,
    handleWorkflowTriggerWebhookRunInWorkflow,
    handleWorkflowTriggerPluginRunInWorkflow,
    handleWorkflowRunAllTriggersInWorkflow,
    availableNodesMetaData,
    getWorkflowRunAndTraceUrl,
    exportCheck,
    handleExportDSL,
    isExporting,
    fetchInspectVars,
    hasNodeInspectVars,
    hasSetInspectVar,
    fetchInspectVarValue,
    editInspectVarValue,
    renameInspectVarName,
    appendNodeInspectVars,
    deleteInspectVar,
    deleteNodeInspectorVars,
    deleteAllInspectorVars,
    isInspectVarEdited,
    resetToLastRunVar,
    invalidateSysVarValues,
    resetConversationVar,
    invalidateConversationVarValues,
    fileSettings,
    accessControl,
  }))
}

export function useHooksStore<T>(selector: (state: Shape) => T): T {
  const store = use(HooksStoreContext)
  if (!store) throw new Error('Missing HooksStoreContext.Provider in the tree')

  return useZustandStore(store, selector)
}