adding deprecation notices to Steps from Apps stuff, and dropping reminder removal todos for eventual removal

Author: Filip Maj

src/App.ts

@@ -522,6 +522,8 @@ export default class App<AppCustomContext extends StringIndexed = StringIndexed>
    * Register WorkflowStep middleware
    *
    * @param workflowStep global workflow step middleware function
+   * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+   * version.
    */
   public step(workflowStep: WorkflowStep): this {
     const m = workflowStep.getMiddleware();
@@ -997,6 +999,7 @@ export default class App<AppCustomContext extends StringIndexed = StringIndexed>
 
     // Set body and payload
     // TODO: this value should eventually conform to AnyMiddlewareArgs
+    // TODO: remove workflow step stuff in bolt v5
     let payload: DialogSubmitAction | WorkflowStepEdit | SlackShortcut | KnownEventFromType<string> | SlashCommand
     | KnownOptionsPayloadFromType<string> | BlockElementAction | ViewOutput | InteractiveAction;
     // TODO: can we instead use type predicates in these switch cases to allow for narrowing of the body simultaneously? we have isEvent, isView, isShortcut, isAction already in types/utilities / helpers

src/WorkflowStep.ts

@@ -24,13 +24,19 @@ import { WorkflowStepInitializationError } from './errors';
 
 /** Interfaces */
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepConfigureArguments {
   blocks: (KnownBlock | Block)[];
   private_metadata?: string;
   submit_disabled?: boolean;
   external_id?: string;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepUpdateArguments {
   inputs?: {
     [key: string]: {
@@ -50,50 +56,80 @@ export interface StepUpdateArguments {
   step_image_url?: string;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepCompleteArguments {
   outputs?: {
     [key: string]: any;
   };
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepFailArguments {
   error: {
     message: string;
   };
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepConfigureFn {
   (params: StepConfigureArguments): Promise<ViewsOpenResponse>;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepUpdateFn {
   (params?: StepUpdateArguments): Promise<WorkflowsUpdateStepResponse>;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepCompleteFn {
   (params?: StepCompleteArguments): Promise<WorkflowsStepCompletedResponse>;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface StepFailFn {
   (params: StepFailArguments): Promise<WorkflowsStepFailedResponse>;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface WorkflowStepConfig {
   edit: WorkflowStepEditMiddleware | WorkflowStepEditMiddleware[];
   save: WorkflowStepSaveMiddleware | WorkflowStepSaveMiddleware[];
   execute: WorkflowStepExecuteMiddleware | WorkflowStepExecuteMiddleware[];
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface WorkflowStepEditMiddlewareArgs extends SlackActionMiddlewareArgs<WorkflowStepEdit> {
   step: WorkflowStepEdit['workflow_step'];
   configure: StepConfigureFn;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface WorkflowStepSaveMiddlewareArgs extends SlackViewMiddlewareArgs<ViewWorkflowStepSubmitAction> {
   step: ViewWorkflowStepSubmitAction['workflow_step'];
   update: StepUpdateFn;
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export interface WorkflowStepExecuteMiddlewareArgs extends SlackEventMiddlewareArgs<'workflow_step_execute'> {
   step: WorkflowStepExecuteEvent['workflow_step'];
   complete: StepCompleteFn;
@@ -102,29 +138,48 @@ export interface WorkflowStepExecuteMiddlewareArgs extends SlackEventMiddlewareA
 
 /** Types */
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export type SlackWorkflowStepMiddlewareArgs =
   | WorkflowStepEditMiddlewareArgs
   | WorkflowStepSaveMiddlewareArgs
   | WorkflowStepExecuteMiddlewareArgs;
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export type WorkflowStepEditMiddleware = Middleware<WorkflowStepEditMiddlewareArgs>;
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export type WorkflowStepSaveMiddleware = Middleware<WorkflowStepSaveMiddlewareArgs>;
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export type WorkflowStepExecuteMiddleware = Middleware<WorkflowStepExecuteMiddlewareArgs>;
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export type WorkflowStepMiddleware =
   | WorkflowStepEditMiddleware[]
   | WorkflowStepSaveMiddleware[]
   | WorkflowStepExecuteMiddleware[];
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export type AllWorkflowStepMiddlewareArgs<T extends SlackWorkflowStepMiddlewareArgs = SlackWorkflowStepMiddlewareArgs> =
   T & AllMiddlewareArgs;
 
 /** Constants */
 
 const VALID_PAYLOAD_TYPES = new Set(['workflow_step_edit', 'workflow_step', 'workflow_step_execute']);
 
-/** Class */
-
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export class WorkflowStep {
   /** Step callback_id */
   private callbackId: string;
@@ -185,6 +240,9 @@ export class WorkflowStep {
 
 /** Helper Functions */
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export function validate(callbackId: string, config: WorkflowStepConfig): void {
   // Ensure callbackId is valid
   if (typeof callbackId !== 'string') {
@@ -224,6 +282,8 @@ export function validate(callbackId: string, config: WorkflowStepConfig): void {
 
 /**
  * `processStepMiddleware()` invokes each callback for lifecycle event
+ * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
  * @param args workflow_step_edit action
  */
 export async function processStepMiddleware(
@@ -243,6 +303,9 @@ export async function processStepMiddleware(
   }
 }
 
+/** @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export function isStepEvent(args: AnyMiddlewareArgs): args is AllWorkflowStepMiddlewareArgs {
   return VALID_PAYLOAD_TYPES.has(args.payload.type);
 }
@@ -345,8 +408,9 @@ function createStepFail(args: AllWorkflowStepMiddlewareArgs<WorkflowStepExecuteM
  *  1. removes the next() passed in from App-level middleware processing
  *    - events will *not* continue down global middleware chain to subsequent listeners
  *  2. augments args with step lifecycle-specific properties/utilities
- * */
-// TODO :: refactor to incorporate a generic parameter
+ * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export function prepareStepArgs(args: any): AllWorkflowStepMiddlewareArgs {
   const { next: _next, ...stepArgs } = args;
   const preparedArgs: any = { ...stepArgs };

src/errors.ts

@@ -38,6 +38,7 @@ export enum ErrorCode {
    */
   UnknownError = 'slack_bolt_unknown_error',
 
+  // TODO: remove workflow step stuff in bolt v5
   WorkflowStepInitializationError = 'slack_bolt_workflow_step_initialization_error',
 
   CustomFunctionInitializationError = 'slack_bolt_custom_function_initialization_error',
@@ -143,7 +144,10 @@ export class MultipleListenerError extends Error implements CodedError {
     this.originals = originals;
   }
 }
-
+/**
+ * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
+ */
 export class WorkflowStepInitializationError extends Error implements CodedError {
   public code = ErrorCode.WorkflowStepInitializationError;
 }

src/helpers.ts

@@ -81,6 +81,7 @@ export function getTypeAndConversation(body: any): { type?: IncomingEventType; c
       conversationId: optionsBody.channel !== undefined ? optionsBody.channel.id : undefined,
     };
   }
+  // TODO: remove workflow_step stuff in v5
   if (body.actions !== undefined || body.type === 'dialog_submission' || body.type === 'workflow_step_edit') {
     const actionBody = body as SlackActionMiddlewareArgs<SlackAction>['body'];
     return {

src/types/actions/index.ts

@@ -9,6 +9,7 @@ import { FunctionInputs } from '../events';
 export * from './block-action';
 export * from './interactive-message';
 export * from './dialog-action';
+// TODO: remove workflow step stuff in bolt v5
 export * from './workflow-step-edit';
 
 /**
@@ -25,6 +26,7 @@ export * from './workflow-step-edit';
  * offered when no generic parameter is bound would be limited to BasicElementAction rather than the union of known
  * actions - ElementAction.
  */
+// TODO: remove workflow step stuff in bolt v5
 export type SlackAction = BlockAction | InteractiveMessage | DialogSubmitAction | WorkflowStepEdit;
 
 /**
@@ -54,6 +56,7 @@ export type SlackActionMiddlewareArgs<Action extends SlackAction = SlackAction>
   complete?: FunctionCompleteFn;
   fail?: FunctionFailFn;
   inputs?: FunctionInputs;
+// TODO: remove workflow step stuff in bolt v5
 } & (Action extends Exclude<SlackAction, DialogSubmitAction | WorkflowStepEdit>
   // all action types except dialog submission and steps from apps have a channel context
   ? { say: SayFn }

src/types/actions/workflow-step-edit.ts

@@ -2,6 +2,8 @@
  * A Slack step from app action wrapped in the standard metadata.
  *
  * This describes the entire JSON-encoded body of a request from Slack step from app actions.
+ * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
  */
 export interface WorkflowStepEdit {
   type: 'workflow_step_edit';

src/types/view/index.ts

@@ -7,7 +7,7 @@ import { AckFn, RespondFn } from '../utilities';
 export type SlackViewAction =
   | ViewSubmitAction
   | ViewClosedAction
-  | ViewWorkflowStepSubmitAction
+  | ViewWorkflowStepSubmitAction // TODO: remove workflow step stuff in bolt v5
   | ViewWorkflowStepClosedAction;
 // <ViewAction extends SlackViewAction = ViewSubmitAction>
 /**
@@ -101,8 +101,9 @@ export interface ViewClosedAction {
  * A Slack view_submission step from app event
  *
  * This describes the additional JSON-encoded body details for a step's view_submission event
+ * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
  */
-
 export interface ViewWorkflowStepSubmitAction extends ViewSubmitAction {
   trigger_id: string;
   response_urls?: ViewResponseUrl[];
@@ -117,6 +118,8 @@ export interface ViewWorkflowStepSubmitAction extends ViewSubmitAction {
  * A Slack view_closed step from app event
  *
  * This describes the additional JSON-encoded body details for a step's view_closed event
+ * @deprecated Steps from Apps are no longer supported and support for them will be removed in the next major bolt-js
+ * version.
  */
 export interface ViewWorkflowStepClosedAction extends ViewClosedAction {
   workflow_step: {
@@ -131,6 +134,7 @@ export interface ViewStateSelectedOption {
   value: string;
 }
 
+// TODO: this should probably exist in @slack/types
 export interface UploadedFile {
   id: string;
   created: number;