Skip to content

feat: [CFISO-2747] add types for variables in workflow defintion and workflow #2767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

feat: [CFISO-2747] add types for variables in workflow defintion and workflow #2767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
298ab70
feat: add types for variables in workflow defintion and workflow
loweisz Sep 29, 2025
39976a9
fix: prettier
loweisz Sep 29, 2025
f153218
feat: export variable types
loweisz Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions lib/entities/workflow-definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,31 @@ export type WorkflowDefinitionSysProps = Pick<
isLocked: boolean
}

export type WorkflowVariablePresetValue = {
variable: Link<'WorkflowVariable'>
value: string | Link<'User'> | Link<'Team'>
}

export type WorkflowVariablePreset = {
id?: string
name: string
variableValues: WorkflowVariablePresetValue[]
}

export type WorkflowVariable = {
id: string
name: string
type: 'subject' | 'locale'
}

export type WorkflowDefinitionValidationLink = {
type: 'Link'
validations: Array<{
linkContentType: string[]
}>
linkType: 'Entry'
variables?: WorkflowVariable[]
variableValuePresets?: WorkflowVariablePreset[]
}

export type WorkflowDefinitionProps = {
Expand Down
2 changes: 2 additions & 0 deletions lib/entities/workflow.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export type WorkflowSysProps = Pick<
deletedAt?: string
entity: Link<'Entry'>
workflowDefinition: Link<'WorkflowDefinition'>
variableValuePreset?: Link<'WorkflowVariableValuePreset'>
}

export type WorkflowProps = {
Expand All @@ -36,6 +37,7 @@ export type WorkflowProps = {
export type CreateWorkflowProps = Omit<WorkflowProps, 'sys'> & {
entity: Link<'Entry'>
workflowDefinition: Link<'WorkflowDefinition'>
variableValuePreset?: Link<'WorkflowVariableValuePreset'>
}
export type UpdateWorkflowProps = Omit<WorkflowProps, 'sys'> & {
sys: Pick<WorkflowSysProps, 'version'>
Expand Down
3 changes: 3 additions & 0 deletions lib/export-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,9 @@ export type {
WorkflowDefinitionSysProps,
// Property: appliesTo
WorkflowDefinitionValidationLink,
WorkflowVariable,
WorkflowVariablePreset,
WorkflowVariablePresetValue,
// Property: step.actions
WorkflowStepAction,
WorkflowStepActionType,
Expand Down