@slack/bolt 3.17.2-rc.1 → 3.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@slack/bolt",
-  "version": "3.17.2-rc.1",
+  "version": "3.18.0",
   "description": "A framework for building Slack apps, fast.",
   "author": "Slack Technologies, LLC",
   "license": "MIT",
@@ -42,7 +42,7 @@
   "dependencies": {
     "@slack/logger": "^4.0.0",
     "@slack/oauth": "^2.6.2",
-    "@slack/socket-mode": "^1.3.5-rc.1",
+    "@slack/socket-mode": "^1.3.3",
     "@slack/types": "^2.11.0",
     "@slack/web-api": "^6.11.2",
     "@types/express": "^4.16.1",

package/dist/WorkflowFunction.d.ts

@@ -1,63 +0,0 @@
-import { FunctionsCompleteErrorResponse, FunctionsCompleteSuccessResponse } from '@slack/web-api';
-import { Middleware, AllMiddlewareArgs, AnyMiddlewareArgs, SlackEventMiddlewareArgs } from './types';
-/** Interfaces */
-export interface FunctionCompleteArguments {
-    outputs?: {
-        [key: string]: any;
-    };
-}
-export interface FunctionFailArguments {
-    error: string;
-}
-export interface FunctionCompleteFn {
-    (params?: FunctionCompleteArguments): Promise<FunctionsCompleteSuccessResponse>;
-}
-export interface FunctionFailFn {
-    (params: FunctionFailArguments): Promise<FunctionsCompleteErrorResponse>;
-}
-export interface WorkflowFunctionExecuteMiddlewareArgs extends SlackEventMiddlewareArgs<'function_executed'> {
-    complete: FunctionCompleteFn;
-    fail: FunctionFailFn;
-}
-/** Types */
-export declare type SlackWorkflowFunctionMiddlewareArgs = WorkflowFunctionExecuteMiddlewareArgs;
-export declare type WorkflowFunctionExecuteMiddleware = Middleware<WorkflowFunctionExecuteMiddlewareArgs>;
-export declare type WorkflowFunctionMiddleware = WorkflowFunctionExecuteMiddleware[];
-export declare type AllWorkflowFunctionMiddlewareArgs<T extends SlackWorkflowFunctionMiddlewareArgs = SlackWorkflowFunctionMiddlewareArgs> = T & AllMiddlewareArgs;
-/** Class */
-export declare class WorkflowFunction {
-    /** Function callback_id */
-    callbackId: string;
-    private middleware;
-    constructor(callbackId: string, middleware: WorkflowFunctionMiddleware);
-    getMiddleware(): Middleware<AnyMiddlewareArgs>;
-    private matchesConstraints;
-    private processEvent;
-    private getStepMiddleware;
-}
-/** Helper Functions */
-export declare function validate(callbackId: string, listeners: WorkflowFunctionMiddleware): void;
-/**
- * `processStepMiddleware()` invokes each callback for lifecycle event
- * @param args workflow_step_edit action
- */
-export declare function processStepMiddleware(args: AllWorkflowFunctionMiddlewareArgs, middleware: WorkflowFunctionMiddleware): Promise<void>;
-export declare function isFunctionEvent(args: AnyMiddlewareArgs): args is AllWorkflowFunctionMiddlewareArgs;
-/**
- * Factory for `complete()` utility
- * @param args function_executed event
- */
-export declare function createFunctionComplete(args: AllWorkflowFunctionMiddlewareArgs<WorkflowFunctionExecuteMiddlewareArgs>): FunctionCompleteFn;
-/**
- * Factory for `fail()` utility
- * @param args function_executed event
- */
-export declare function createFunctionFail(args: AllWorkflowFunctionMiddlewareArgs<WorkflowFunctionExecuteMiddlewareArgs>): FunctionFailFn;
-/**
- * `prepareFunctionArgs()` takes in a function's args and:
- *  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
- * */
-export declare function prepareFunctionArgs(args: any): AllWorkflowFunctionMiddlewareArgs;
-//# sourceMappingURL=WorkflowFunction.d.ts.map

package/dist/WorkflowFunction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"WorkflowFunction.d.ts","sourceRoot":"","sources":["../src/WorkflowFunction.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EAEzB,MAAM,SAAS,CAAC;AAIjB,iBAAiB;AAEjB,MAAM,WAAW,yBAAyB;IACxC,OAAO,CAAC,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;CACH;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,CAAC,MAAM,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,gCAAgC,CAAC,CAAC;CACjF;AAED,MAAM,WAAW,cAAc;IAC7B,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,8BAA8B,CAAC,CAAC;CAC1E;AAED,MAAM,WAAW,qCAAsC,SAAQ,wBAAwB,CAAC,mBAAmB,CAAC;IAC1G,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,YAAY;AAEZ,oBAAY,mCAAmC,GAAG,qCAAqC,CAAC;AAExF,oBAAY,iCAAiC,GAAG,UAAU,CAAC,qCAAqC,CAAC,CAAC;AAElG,oBAAY,0BAA0B,GAAG,iCAAiC,EAAE,CAAC;AAE7E,oBAAY,iCAAiC,CAC1C,CAAC,SAAS,mCAAmC,GAAG,mCAAmC,IAAI,CAAC,GAAG,iBAAiB,CAAC;AAMhH,YAAY;AAEZ,qBAAa,gBAAgB;IAC3B,2BAA2B;IACpB,UAAU,EAAE,MAAM,CAAC;IAE1B,OAAO,CAAC,UAAU,CAA6B;gBAG7C,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,0BAA0B;IAQjC,aAAa,IAAI,UAAU,CAAC,iBAAiB,CAAC;IASrD,OAAO,CAAC,kBAAkB;YAIZ,YAAY;IAM1B,OAAO,CAAC,iBAAiB;CAG1B;AAED,uBAAuB;AAEvB,wBAAgB,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,0BAA0B,GAAG,IAAI,CAcxF;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,IAAI,EAAE,iCAAiC,EACvC,UAAU,EAAE,0BAA0B,GACrC,OAAO,CAAC,IAAI,CAAC,CAWf;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,IAAI,iCAAiC,CAElG;AAOD;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,iCAAiC,CAAC,qCAAqC,CAAC,GAC7E,kBAAkB,CAapB;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,iCAAiC,CAAC,qCAAqC,CAAC,GAC7E,cAAc,CAiBhB;AAED;;;;;KAKK;AACL,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,GAAG,GAAG,iCAAiC,CAgBhF"}

package/dist/WorkflowFunction.js

@@ -1,130 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prepareFunctionArgs = exports.createFunctionFail = exports.createFunctionComplete = exports.isFunctionEvent = exports.processStepMiddleware = exports.validate = exports.WorkflowFunction = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const web_api_1 = require("@slack/web-api");
-const process_1 = __importDefault(require("./middleware/process"));
-const errors_1 = require("./errors");
-/** Constants */
-const VALID_PAYLOAD_TYPES = new Set(['function_executed']);
-/** Class */
-class WorkflowFunction {
-    constructor(callbackId, middleware) {
-        validate(callbackId, middleware);
-        this.callbackId = callbackId;
-        this.middleware = middleware;
-    }
-    getMiddleware() {
-        return async (args) => {
-            if (isFunctionEvent(args) && this.matchesConstraints(args)) {
-                return this.processEvent(args);
-            }
-            return args.next();
-        };
-    }
-    matchesConstraints(args) {
-        return args.payload.function.callback_id === this.callbackId;
-    }
-    async processEvent(args) {
-        const functionArgs = prepareFunctionArgs(args);
-        const stepMiddleware = this.getStepMiddleware();
-        return processStepMiddleware(functionArgs, stepMiddleware);
-    }
-    getStepMiddleware() {
-        return this.middleware;
-    }
-}
-exports.WorkflowFunction = WorkflowFunction;
-/** Helper Functions */
-function validate(callbackId, listeners) {
-    // Ensure callbackId is valid
-    if (typeof callbackId !== 'string') {
-        const errorMsg = 'WorkflowFunction expects a callback_id as the first argument';
-        throw new errors_1.WorkflowFunctionInitializationError(errorMsg);
-    }
-    // Ensure all listeners are functions
-    listeners.forEach((listener) => {
-        if (!(listener instanceof Function)) {
-            const errorMsg = 'All WorkflowFunction listeners must be functions';
-            throw new errors_1.WorkflowFunctionInitializationError(errorMsg);
-        }
-    });
-}
-exports.validate = validate;
-/**
- * `processStepMiddleware()` invokes each callback for lifecycle event
- * @param args workflow_step_edit action
- */
-async function processStepMiddleware(args, middleware) {
-    const { context, client, logger } = args;
-    const callbacks = [...middleware];
-    const lastCallback = callbacks.pop();
-    if (lastCallback !== undefined) {
-        await (0, process_1.default)(callbacks, args, context, client, logger, async () => lastCallback({ ...args, context, client, logger }));
-    }
-}
-exports.processStepMiddleware = processStepMiddleware;
-function isFunctionEvent(args) {
-    return VALID_PAYLOAD_TYPES.has(args.payload.type);
-}
-exports.isFunctionEvent = isFunctionEvent;
-function selectToken(context) {
-    // If attachFunctionToken = false, fallback to botToken or userToken
-    return context.functionBotToken ? context.functionBotToken : context.botToken || context.userToken;
-}
-/**
- * Factory for `complete()` utility
- * @param args function_executed event
- */
-function createFunctionComplete(args) {
-    const { context, client, payload: { function_execution_id }, } = args;
-    const token = selectToken(context);
-    return (params = {}) => client.functions.completeSuccess({
-        token,
-        outputs: params.outputs || {},
-        function_execution_id,
-    });
-}
-exports.createFunctionComplete = createFunctionComplete;
-/**
- * Factory for `fail()` utility
- * @param args function_executed event
- */
-function createFunctionFail(args) {
-    const { context, client, payload: { function_execution_id }, } = args;
-    const token = selectToken(context);
-    return (params) => {
-        const { error } = params !== null && params !== void 0 ? params : {};
-        return client.functions.completeError({
-            token,
-            error,
-            function_execution_id,
-        });
-    };
-}
-exports.createFunctionFail = createFunctionFail;
-/**
- * `prepareFunctionArgs()` takes in a function's args and:
- *  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
- * */
-function prepareFunctionArgs(args) {
-    const { next: _next, ...functionArgs } = args;
-    const preparedArgs = { ...functionArgs };
-    const token = selectToken(functionArgs.context);
-    // Making calls with a functionBotToken establishes continuity between
-    // a function_executed event and subsequent interactive events (actions)
-    const client = new web_api_1.WebClient(token, { ...functionArgs.client });
-    preparedArgs.client = client;
-    // Utility args
-    preparedArgs.inputs = preparedArgs.event.inputs;
-    preparedArgs.complete = createFunctionComplete(preparedArgs);
-    preparedArgs.fail = createFunctionFail(preparedArgs);
-    return preparedArgs;
-}
-exports.prepareFunctionArgs = prepareFunctionArgs;
-//# sourceMappingURL=WorkflowFunction.js.map

package/dist/WorkflowFunction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WorkflowFunction.js","sourceRoot":"","sources":["../src/WorkflowFunction.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAuD;AACvD,4CAIwB;AAQxB,mEAAqD;AACrD,qCAA+D;AAsC/D,gBAAgB;AAEhB,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC;AAE3D,YAAY;AAEZ,MAAa,gBAAgB;IAM3B,YACE,UAAkB,EAClB,UAAsC;QAEtC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAEM,aAAa;QAClB,OAAO,KAAK,EAAE,IAAI,EAAgB,EAAE;YAClC,IAAI,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE;gBAC1D,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;aAChC;YACD,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,IAAyC;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,KAAK,IAAI,CAAC,UAAU,CAAC;IAC/D,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAuC;QAChE,MAAM,YAAY,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAChD,OAAO,qBAAqB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAC7D,CAAC;IAEO,iBAAiB;QACvB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAtCD,4CAsCC;AAED,uBAAuB;AAEvB,SAAgB,QAAQ,CAAC,UAAkB,EAAE,SAAqC;IAChF,6BAA6B;IAC7B,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,MAAM,QAAQ,GAAG,8DAA8D,CAAC;QAChF,MAAM,IAAI,4CAAmC,CAAC,QAAQ,CAAC,CAAC;KACzD;IAED,qCAAqC;IACrC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,IAAI,CAAC,CAAC,QAAQ,YAAY,QAAQ,CAAC,EAAE;YACnC,MAAM,QAAQ,GAAG,kDAAkD,CAAC;YACpE,MAAM,IAAI,4CAAmC,CAAC,QAAQ,CAAC,CAAC;SACzD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,4BAcC;AAED;;;GAGG;AACI,KAAK,UAAU,qBAAqB,CACzC,IAAuC,EACvC,UAAsC;IAEtC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACzC,MAAM,SAAS,GAAG,CAAC,GAAG,UAAU,CAAoC,CAAC;IACrE,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC;IAErC,IAAI,YAAY,KAAK,SAAS,EAAE;QAC9B,MAAM,IAAA,iBAAiB,EACrB,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EACxC,KAAK,IAAI,EAAE,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAC/D,CAAC;KACH;AACH,CAAC;AAdD,sDAcC;AAED,SAAgB,eAAe,CAAC,IAAuB;IACrD,OAAO,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AACpD,CAAC;AAFD,0CAEC;AAED,SAAS,WAAW,CAAC,OAAgB;IACnC,oEAAoE;IACpE,OAAO,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,SAAS,CAAC;AACrG,CAAC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CACpC,IAA8E;IAE9E,MAAM,EACJ,OAAO,EACP,MAAM,EACN,OAAO,EAAE,EAAE,qBAAqB,EAAE,GACnC,GAAG,IAAI,CAAC;IACT,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEnC,OAAO,CAAC,SAA4C,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC;QAC1F,KAAK;QACL,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE;QAC7B,qBAAqB;KACtB,CAAC,CAAC;AACL,CAAC;AAfD,wDAeC;AAED;;;GAGG;AACH,SAAgB,kBAAkB,CAChC,IAA8E;IAE9E,MAAM,EACJ,OAAO,EACP,MAAM,EACN,OAAO,EAAE,EAAE,qBAAqB,EAAE,GACnC,GAAG,IAAI,CAAC;IACT,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEnC,OAAO,CAAC,MAAqC,EAAE,EAAE;QAC/C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;QAE/B,OAAO,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC;YACpC,KAAK;YACL,KAAK;YACL,qBAAqB;SACtB,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAnBD,gDAmBC;AAED;;;;;KAKK;AACL,SAAgB,mBAAmB,CAAC,IAAS;IAC3C,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC;IAC9C,MAAM,YAAY,GAAQ,EAAE,GAAG,YAAY,EAAE,CAAC;IAC9C,MAAM,KAAK,GAAG,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAEhD,sEAAsE;IACtE,wEAAwE;IACxE,MAAM,MAAM,GAAG,IAAI,mBAAS,CAAC,KAAK,EAAE,EAAE,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,CAAC;IAChE,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC;IAE7B,eAAe;IACf,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC;IAChD,YAAY,CAAC,QAAQ,GAAG,sBAAsB,CAAC,YAAY,CAAC,CAAC;IAC7D,YAAY,CAAC,IAAI,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAErD,OAAO,YAAY,CAAC;AACtB,CAAC;AAhBD,kDAgBC"}