improvement(blocks): two-tier sunset schema (legacy amber / deprecated red) (#5793)

* improvement(blocks): two-tier sunset schema (legacy amber / deprecated red)

* fix(blocks): require replacedBy on legacy sunset blocks in registry check

* improvement(blocks): reword legacy badge tooltip

Author: TheodoreSpeaks

apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/workflow-block/workflow-block.tsx

@@ -81,39 +81,60 @@ const EMPTY_SUBBLOCK_VALUES = {} as Record<string, any>
 /** Stable empty map for rows that never resolve MCP tool names */
 const EMPTY_MCP_TOOL_NAMES: ReadonlyMap<string, string> = new Map()
 
-interface BlockDeprecation {
+interface BlockSunset {
+  status: 'legacy' | 'deprecated'
   kind: 'block' | 'model'
   tooltip: string
   prompt: string
 }
 
+/** Instruction for the agent to migrate a block instance to its successor. */
+function migrationPrompt(name: string, target: BlockConfig): string {
+  return `Migrate the "${name}" block to the current ${target.name} block: change the block type, then set the new block's required inputs as a separate edit (inputs are validated against the old type when sent in the same edit), or delete it and re-add ${target.name} and rewire the connections.`
+}
+
 /**
- * Deprecation state for a placed block: the block type itself (via
- * `config.deprecated.replacedBy`) or its selected model. `null` when neither
- * applies or in diff mode. Drives the canvas badge + click-to-fix prompt.
+ * Sunset state for a placed block: the block type itself (via `config.sunset`)
+ * or its selected model. `legacy` (amber) is superseded-but-supported and needs
+ * a resolvable successor; `deprecated` (red) is no longer supported and badges
+ * with or without one. `null` when neither applies or in diff mode.
  */
-function getBlockDeprecation(
+function getBlockSunset(
   config: BlockConfig,
   name: string,
   model: unknown,
   isDiffMode: boolean
-): BlockDeprecation | null {
+): BlockSunset | null {
   if (isDiffMode) return null
 
-  const replacedBy = config.deprecated?.replacedBy
-  if (replacedBy) {
-    const target = getBlock(replacedBy)
-    if (!target) return null
-    const hasModel = config.subBlocks?.some((sub) => sub.id === 'model')
+  const sunset = config.sunset
+  if (sunset) {
+    const target = sunset.replacedBy ? getBlock(sunset.replacedBy) : undefined
+
+    if (sunset.status === 'legacy') {
+      if (!target) return null
+      const hasModel = config.subBlocks?.some((sub) => sub.id === 'model')
+      return {
+        status: 'legacy',
+        kind: 'block',
+        tooltip: 'This is a legacy block. Click to upgrade',
+        prompt: `The "${name}" block is legacy. ${migrationPrompt(name, target)}${hasModel ? ' Also pick a current, non-deprecated model.' : ''}`,
+      }
+    }
+
     return {
+      status: 'deprecated',
       kind: 'block',
-      tooltip: 'This block is deprecated. Click to upgrade',
-      prompt: `The "${name}" block is deprecated. Migrate it to the current ${target.name} block: change the block type, then set the new block's required inputs as a separate edit (inputs are validated against the old type when sent in the same edit), or delete it and re-add ${target.name} and rewire the connections.${hasModel ? ' Also pick a current, non-deprecated model.' : ''}`,
+      tooltip: 'This block is no longer supported. Click to replace',
+      prompt: target
+        ? `The "${name}" block is no longer supported. ${migrationPrompt(name, target)}`
+        : `The "${name}" block is no longer supported and has no direct successor. Replace it with current blocks that achieve the same result and rewire the connections.`,
     }
   }
 
   if (typeof model === 'string' && isModelDeprecated(model)) {
     return {
+      status: 'legacy',
       kind: 'model',
       tooltip: `${model} is deprecated. Click to upgrade`,
       prompt: `The "${name}" block uses the deprecated model "${model}". Switch it to the latest equivalent model.`,
@@ -533,21 +554,16 @@ export const WorkflowBlock = memo(function WorkflowBlock({
 
   const posthog = usePostHog()
 
-  const deprecation = getBlockDeprecation(
-    config,
-    name,
-    blockSubBlockValues.model,
-    currentWorkflow.isDiffMode
-  )
+  const sunset = getBlockSunset(config, name, blockSubBlockValues.model, currentWorkflow.isDiffMode)
 
-  const onFixDeprecation = () => {
-    if (!deprecation) return
+  const onFixSunset = () => {
+    if (!sunset) return
     captureEvent(posthog, 'deprecated_block_fix_clicked', {
       block_type: type,
       workflow_id: currentWorkflowId,
-      kind: deprecation.kind,
+      kind: sunset.kind,
     })
-    sendMothershipMessage(deprecation.prompt, [
+    sendMothershipMessage(sunset.prompt, [
       { kind: 'workflow_block', workflowId: currentWorkflowId, blockId: id, label: name },
     ])
   }
@@ -871,9 +887,10 @@ export const WorkflowBlock = memo(function WorkflowBlock({
           deployChildWorkflow({ workflowId: childWorkflowId })
         }
       }}
-      deprecationTooltip={deprecation?.tooltip}
-      canFixDeprecation={canEditWorkflow}
-      onFixDeprecation={onFixDeprecation}
+      sunsetStatus={sunset?.status}
+      sunsetTooltip={sunset?.tooltip}
+      canFixSunset={canEditWorkflow}
+      onFixSunset={onFixSunset}
       shouldShowScheduleBadge={shouldShowScheduleBadge}
       scheduleIsDisabled={Boolean(scheduleInfo?.isDisabled)}
       onReactivateSchedule={() => {

apps/sim/blocks/blocks/api_trigger.ts

@@ -15,7 +15,7 @@ export const ApiTriggerBlock: BlockConfig = {
   `,
   category: 'triggers',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'start_trigger' },
+  sunset: { status: 'legacy', replacedBy: 'start_trigger' },
   bgColor: '#2F55FF',
   icon: ApiIcon,
   subBlocks: [

apps/sim/blocks/blocks/chat_trigger.ts

@@ -16,7 +16,7 @@ export const ChatTriggerBlock: BlockConfig = {
   `,
   category: 'triggers',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'start_trigger' },
+  sunset: { status: 'legacy', replacedBy: 'start_trigger' },
   bgColor: '#6F3DFA',
   icon: ChatTriggerIcon,
   subBlocks: [],

apps/sim/blocks/blocks/confluence.ts

@@ -12,7 +12,7 @@ export const ConfluenceBlock: BlockConfig<ConfluenceResponse> = {
   name: 'Confluence (Legacy)',
   description: 'Interact with Confluence',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'confluence_v2' },
+  sunset: { status: 'legacy', replacedBy: 'confluence_v2' },
   authMode: AuthMode.OAuth,
   longDescription:
     'Integrate Confluence into the workflow. Can read, create, update, delete pages, manage comments, attachments, labels, and search content.',
@@ -361,7 +361,7 @@ export const ConfluenceBlock: BlockConfig<ConfluenceResponse> = {
 
 export const ConfluenceV2Block: BlockConfig<ConfluenceResponse> = {
   ...ConfluenceBlock,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'confluence_v2',
   name: 'Confluence',
   hideFromToolbar: false,

apps/sim/blocks/blocks/cursor.ts

@@ -17,7 +17,7 @@ export const CursorBlock: BlockConfig<CursorResponse> = {
   icon: CursorIcon,
   authMode: AuthMode.ApiKey,
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'cursor_v2' },
+  sunset: { status: 'legacy', replacedBy: 'cursor_v2' },
   subBlocks: [
     {
       id: 'operation',
@@ -224,7 +224,7 @@ export const CursorBlock: BlockConfig<CursorResponse> = {
 
 export const CursorV2Block: BlockConfig<CursorResponse> = {
   ...CursorBlock,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'cursor_v2',
   name: 'Cursor',
   description: 'Launch and manage Cursor cloud agents to work on GitHub repositories',

apps/sim/blocks/blocks/extend.ts

@@ -14,7 +14,7 @@ export const ExtendBlock: BlockConfig<ExtendParserOutput> = {
   name: 'Extend',
   description: 'Parse and extract content from documents',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'extend_v2' },
+  sunset: { status: 'legacy', replacedBy: 'extend_v2' },
   authMode: AuthMode.ApiKey,
   longDescription:
     'Integrate Extend AI into the workflow. Parse and extract structured content from documents including PDFs, images, and Office files.',
@@ -166,7 +166,7 @@ const extendV2SubBlocks = (ExtendBlock.subBlocks || []).flatMap((subBlock) => {
 
 export const ExtendV2Block: BlockConfig<ExtendParserOutput> = {
   ...ExtendBlock,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'extend_v2',
   name: 'Extend',
   hideFromToolbar: false,

apps/sim/blocks/blocks/file.ts

@@ -78,7 +78,7 @@ export const FileBlock: BlockConfig<FileParserOutput> = {
   bgColor: '#40916C',
   icon: DocumentIcon,
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'file_v5' },
+  sunset: { status: 'legacy', replacedBy: 'file_v5' },
   subBlocks: [
     {
       id: 'inputMethod',
@@ -186,7 +186,7 @@ export const FileV2Block: BlockConfig<FileParserOutput> = {
   name: 'File (Legacy)',
   description: 'Read and parse multiple files',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'file_v5' },
+  sunset: { status: 'legacy', replacedBy: 'file_v5' },
   subBlocks: [
     {
       id: 'file',
@@ -280,7 +280,7 @@ export const FileV3Block: BlockConfig<FileParserV3Output> = {
   bgColor: '#40916C',
   icon: DocumentIcon,
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'file_v5' },
+  sunset: { status: 'legacy', replacedBy: 'file_v5' },
   subBlocks: [
     {
       id: 'operation',
@@ -571,7 +571,7 @@ export const FileV4Block: BlockConfig<FileParserV3Output> = {
   longDescription:
     'Read workspace files by picker or canonical ID, fetch and parse files from URLs with optional headers, write new workspace files, or append content to existing files.',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'file_v5' },
+  sunset: { status: 'legacy', replacedBy: 'file_v5' },
   bestPractices: `
   - Use Read when you need an existing workspace file object by picker selection or canonical file ID.
   - Use Fetch for external file URLs. Add headers for authenticated downloads, for example Slack private file URLs require an Authorization Bearer token.
@@ -824,7 +824,7 @@ export const FileV4Block: BlockConfig<FileParserV3Output> = {
 
 export const FileV5Block: BlockConfig<FileParserV3Output> = {
   ...FileV4Block,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'file_v5',
   name: 'File',
   description:

apps/sim/blocks/blocks/fireflies.ts

@@ -11,7 +11,7 @@ export const FirefliesBlock: BlockConfig<FirefliesResponse> = {
   name: 'Fireflies (Legacy)',
   description: 'Interact with Fireflies.ai meeting transcripts and recordings',
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'fireflies_v2' },
+  sunset: { status: 'legacy', replacedBy: 'fireflies_v2' },
   authMode: AuthMode.ApiKey,
   triggerAllowed: true,
   longDescription:
@@ -647,7 +647,7 @@ const firefliesV2Inputs = FirefliesBlock.inputs
 
 export const FirefliesV2Block: BlockConfig<FirefliesResponse> = {
   ...FirefliesBlock,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'fireflies_v2',
   name: 'Fireflies',
   description: 'Interact with Fireflies.ai meeting transcripts and recordings',

apps/sim/blocks/blocks/github.ts

@@ -20,7 +20,7 @@ export const GitHubBlock: BlockConfig<GitHubResponse> = {
   icon: GithubIcon,
   triggerAllowed: true,
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'github_v2' },
+  sunset: { status: 'legacy', replacedBy: 'github_v2' },
   subBlocks: [
     {
       id: 'operation',
@@ -2103,7 +2103,7 @@ Return ONLY the timestamp string - no explanations, no quotes, no extra text.`,
 
 export const GitHubV2Block: BlockConfig<GitHubResponse> = {
   ...GitHubBlock,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'github_v2',
   name: 'GitHub',
   hideFromToolbar: false,

apps/sim/blocks/blocks/gmail.ts

@@ -57,7 +57,7 @@ export const GmailBlock: BlockConfig<GmailToolResponse> = {
   bgColor: '#FFFFFF',
   icon: GmailIcon,
   hideFromToolbar: true,
-  deprecated: { replacedBy: 'gmail_v2' },
+  sunset: { status: 'legacy', replacedBy: 'gmail_v2' },
   triggerAllowed: true,
   subBlocks: [
     // Operation selector
@@ -576,7 +576,7 @@ Return ONLY the search query - no explanations, no extra text.`,
 
 export const GmailV2Block: BlockConfig<GmailToolResponse> = {
   ...GmailBlock,
-  deprecated: undefined,
+  sunset: undefined,
   type: 'gmail_v2',
   name: 'Gmail',
   hideFromToolbar: false,