@slack/bolt 3.8.0 → 3.8.1

package/dist/receivers/HTTPReceiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPReceiver.d.ts","sourceRoot":"","sources":["../../src/receivers/HTTPReceiver.ts"],"names":[],"mappings":";AACA,OAAO,EAAgB,MAAM,EAAE,aAAa,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAC7G,OAAO,EAAqC,MAAM,IAAI,WAAW,EAAE,aAAa,IAAI,kBAAkB,EAAE,MAAM,OAAO,CAAC;AACtH,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAiB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAG3G,OAAO,EAAqC,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE9F,OAAO,GAAG,MAAM,QAAQ,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAiB,MAAM,UAAU,CAAC;AAEnD,OAAO,EAKL,UAAU,EACX,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,WAAW,EAAiC,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAwCjD,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAChE,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,4BAA4B,CAAC;IAChD,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,aAAa,CAAC;IAEhF,oBAAoB,CAAC,EAAE,CAAC,IAAI,EAAE,oCAAoC,KAAK,IAAI,CAAC;IAC5E,wBAAwB,CAAC,EAAE,CAAC,IAAI,EAAE,wCAAwC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAEhG,uBAAuB,CAAC,EAAE,CAAC,IAAI,EAAE,uCAAuC,KAAK,IAAI,CAAC;IAClF,6BAA6B,CAAC,EAAE,MAAM,CAAC;CACxC;AAGD,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wBAAwB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;IAClD,iBAAiB,CAAC,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAChE,WAAW,CAAC,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;IACpD,aAAa,CAAC,EAAE,sBAAsB,CAAC,eAAe,CAAC,CAAC;IACxD,gBAAgB,CAAC,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;IAC9D,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACzC,UAAU,CAAC,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAC7C,eAAe,CAAC,EAAE,eAAe,CAAC;IAGlC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAID,MAAM,WAAW,oCAAoC;IACnD,KAAK,EAAE,KAAK,GAAG,UAAU,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAKD,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,oCAAoC,GAAG,IAAI,CAc5F;AAID,MAAM,WAAW,wCAAwC;IACvD,KAAK,EAAE,KAAK,GAAG,UAAU,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;IACzB,cAAc,EAAE,GAAG,CAAC;CACrB;AAID,wBAAsB,+BAA+B,CACnD,IAAI,EAAE,wCAAwC,GAC7C,OAAO,CAAC,OAAO,CAAC,CAiBlB;AAKD,MAAM,WAAW,uCAAuC;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,cAAc,CAAC;CAC1B;AAKD,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,uCAAuC,GAAG,IAAI,CAMlG;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ;IACnD,OAAO,CAAC,SAAS,CAAW;IAE5B,OAAO,CAAC,IAAI,CAAS;IAErB,OAAO,CAAC,MAAM,CAAiB;IAE/B,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,qBAAqB,CAAU;IAEvC,OAAO,CAAC,qBAAqB,CAAU;IAEvC,OAAO,CAAC,GAAG,CAAC,CAAM;IAEX,eAAe,EAAE,eAAe,CAAC;IAExC,OAAO,CAAC,MAAM,CAAC,CAAS;IAEjB,SAAS,CAAC,EAAE,eAAe,CAAC;IAEnC,OAAO,CAAC,WAAW,CAAC,CAAS;IAE7B,OAAO,CAAC,aAAa,CAAC,CAAU;IAEhC,OAAO,CAAC,wBAAwB,CAA0B;IAE1D,OAAO,CAAC,sBAAsB,CAAC,CAAS;IAExC,OAAO,CAAC,iBAAiB,CAAC,CAAoB;IAE9C,OAAO,CAAC,sBAAsB,CAAC,CAAkB;IAEjD,OAAO,CAAC,iBAAiB,CAAC,CAAU;IAEpC,OAAO,CAAC,MAAM,CAAS;IAEvB,OAAO,CAAC,yBAAyB,CAAsD;IAEvF,OAAO,CAAC,oBAAoB,CAAuD;IAEnF,OAAO,CAAC,wBAAwB,CAAuE;IAEvG,OAAO,CAAC,uBAAuB,CAA0D;IAEzF,OAAO,CAAC,6BAA6B,CAAS;gBAE3B,EACjB,aAAkB,EAClB,SAA6B,EAC7B,IAAW,EACX,YAAiB,EACjB,MAAkB,EAClB,QAAwB,EACxB,qBAA6B,EAC7B,qBAA4B,EAC5B,QAAoB,EACpB,YAAwB,EACxB,WAAuB,EACvB,WAAuB,EACvB,iBAA6B,EAC7B,MAAkB,EAClB,gBAAqB,EACrB,yBAA0C,EAC1C,oBAAkD,EAClD,wBAA0D,EAC1D,uBAAwD,EACxD,6BAAoC,GACrC,EAAE,mBAAmB;IAkEf,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAIpB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IACpC,KAAK,CAAC,mBAAmB,EAAE,MAAM,GAAG,aAAa,EAAE,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAClG,KAAK,CACV,mBAAmB,EAAE,MAAM,GAAG,aAAa,EAC3C,kBAAkB,CAAC,EAAE,kBAAkB,GACtC,OAAO,CAAC,WAAW,CAAC;IAiFhB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB5B,OAAO,CAAC,sBAAsB;IA8C9B,OAAO,CAAC,mBAAmB;IAqI3B,OAAO,CAAC,wBAAwB;IAyChC,OAAO,CAAC,4BAA4B;CAwBrC"}

package/dist/receivers/HTTPReceiver.js

@@ -0,0 +1,501 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultUnhandledRequestHandler = exports.defaultProcessEventErrorHandler = exports.defaultDispatchErrorHandler = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const http_1 = require("http");
+const https_1 = require("https");
+const querystring_1 = require("querystring");
+const logger_1 = require("@slack/logger");
+const oauth_1 = require("@slack/oauth");
+const url_1 = require("url");
+const verify_request_1 = require("./verify-request");
+const verify_redirect_opts_1 = require("./verify-redirect-opts");
+const render_html_for_install_path_1 = __importDefault(require("./render-html-for-install-path"));
+const errors_1 = require("../errors");
+const custom_routes_1 = require("./custom-routes");
+const http_utils_1 = require("./http-utils");
+// Option keys for tls.createServer() and tls.createSecureContext(), exclusive of those for http.createServer()
+const httpsOptionKeys = [
+    'ALPNProtocols',
+    'clientCertEngine',
+    'enableTrace',
+    'handshakeTimeout',
+    'rejectUnauthorized',
+    'requestCert',
+    'sessionTimeout',
+    'SNICallback',
+    'ticketKeys',
+    'pskCallback',
+    'pskIdentityHint',
+    'ca',
+    'cert',
+    'sigalgs',
+    'ciphers',
+    'clientCertEngine',
+    'crl',
+    'dhparam',
+    'ecdhCurve',
+    'honorCipherOrder',
+    'key',
+    'privateKeyEngine',
+    'privateKeyIdentifier',
+    'maxVersion',
+    'minVersion',
+    'passphrase',
+    'pfx',
+    'secureOptions',
+    'secureProtocol',
+    'sessionIdContext',
+];
+const missingServerErrorDescription = 'The receiver cannot be started because private state was mutated. Please report this to the maintainers.';
+// The default dispathErrorHandler implementation:
+// Developers can customize this behavior by passing dispatchErrorHandler to the constructor
+// Note that it was not possible to make this function async due to the limitation of http module
+function defaultDispatchErrorHandler(args) {
+    const { error, logger, request, response } = args;
+    if ('code' in error) {
+        if (error.code === errors_1.ErrorCode.HTTPReceiverDeferredRequestError) {
+            logger.info(`Unhandled HTTP request (${request.method}) made to ${request.url}`);
+            response.writeHead(404);
+            response.end();
+            return;
+        }
+    }
+    logger.error(`An unexpected error occurred during a request (${request.method}) made to ${request.url}`);
+    logger.debug(`Error details: ${error}`);
+    response.writeHead(500);
+    response.end();
+}
+exports.defaultDispatchErrorHandler = defaultDispatchErrorHandler;
+// The default processEventErrorHandler implementation:
+// Developers can customize this behavior by passing processEventErrorHandler to the constructor
+async function defaultProcessEventErrorHandler(args) {
+    const { error, response, logger, storedResponse } = args;
+    if ('code' in error) {
+        // CodedError has code: string
+        const errorCode = error.code;
+        if (errorCode === errors_1.ErrorCode.AuthorizationError) {
+            // authorize function threw an exception, which means there is no valid installation data
+            response.writeHead(401);
+            response.end();
+            return true;
+        }
+    }
+    logger.error('An unhandled error occurred while Bolt processed an event');
+    logger.debug(`Error details: ${error}, storedResponse: ${storedResponse}`);
+    response.writeHead(500);
+    response.end();
+    return false;
+}
+exports.defaultProcessEventErrorHandler = defaultProcessEventErrorHandler;
+// The default unhandledRequestHandler implementation:
+// Developers can customize this behavior by passing unhandledRequestHandler to the constructor
+// Note that this method cannot be an async function to align with the implementation using setTimeout
+function defaultUnhandledRequestHandler(args) {
+    const { logger } = args;
+    logger.error('An incoming event was not acknowledged within 3 seconds. ' +
+        'Ensure that the ack() argument is called in a listener.');
+}
+exports.defaultUnhandledRequestHandler = defaultUnhandledRequestHandler;
+/**
+ * Receives HTTP requests with Events, Slash Commands, and Actions
+ */
+class HTTPReceiver {
+    constructor({ signingSecret = '', endpoints = ['/slack/events'], port = 3000, customRoutes = [], logger = undefined, logLevel = logger_1.LogLevel.INFO, processBeforeResponse = false, signatureVerification = true, clientId = undefined, clientSecret = undefined, stateSecret = undefined, redirectUri = undefined, installationStore = undefined, scopes = undefined, installerOptions = {}, customPropertiesExtractor = (_req) => ({}), dispatchErrorHandler = defaultDispatchErrorHandler, processEventErrorHandler = defaultProcessEventErrorHandler, unhandledRequestHandler = defaultUnhandledRequestHandler, unhandledRequestTimeoutMillis = 3001, }) {
+        var _a, _b, _c;
+        // Initialize instance variables, substituting defaults for each value
+        this.signingSecret = signingSecret;
+        this.processBeforeResponse = processBeforeResponse;
+        this.signatureVerification = signatureVerification;
+        this.logger = logger !== null && logger !== void 0 ? logger : (() => {
+            const defaultLogger = new logger_1.ConsoleLogger();
+            defaultLogger.setLevel(logLevel);
+            return defaultLogger;
+        })();
+        this.endpoints = Array.isArray(endpoints) ? endpoints : [endpoints];
+        this.port = (installerOptions === null || installerOptions === void 0 ? void 0 : installerOptions.port) ? installerOptions.port : port;
+        this.routes = (0, custom_routes_1.prepareRoutes)(customRoutes);
+        // Verify redirect options if supplied, throws coded error if invalid
+        (0, verify_redirect_opts_1.verifyRedirectOpts)({ redirectUri, redirectUriPath: installerOptions.redirectUriPath });
+        this.stateVerification = installerOptions.stateVerification;
+        // Initialize InstallProvider when it's required options are provided
+        if (clientId !== undefined &&
+            clientSecret !== undefined &&
+            (this.stateVerification === false || // state store not needed
+                stateSecret !== undefined ||
+                installerOptions.stateStore !== undefined) // user provided state store
+        ) {
+            this.installer = new oauth_1.InstallProvider({
+                clientId,
+                clientSecret,
+                stateSecret,
+                installationStore,
+                logger,
+                logLevel,
+                stateStore: installerOptions.stateStore,
+                stateVerification: installerOptions.stateVerification,
+                authVersion: installerOptions.authVersion,
+                clientOptions: installerOptions.clientOptions,
+                authorizationUrl: installerOptions.authorizationUrl,
+            });
+            // Store the remaining instance variables that are related to using the InstallProvider
+            this.installPath = (_a = installerOptions.installPath) !== null && _a !== void 0 ? _a : '/slack/install';
+            this.directInstall = installerOptions.directInstall !== undefined && installerOptions.directInstall;
+            this.installRedirectUriPath = (_b = installerOptions.redirectUriPath) !== null && _b !== void 0 ? _b : '/slack/oauth_redirect';
+            this.installCallbackOptions = (_c = installerOptions.callbackOptions) !== null && _c !== void 0 ? _c : {};
+            this.installUrlOptions = {
+                scopes: scopes !== null && scopes !== void 0 ? scopes : [],
+                userScopes: installerOptions.userScopes,
+                metadata: installerOptions.metadata,
+                redirectUri,
+            };
+        }
+        this.renderHtmlForInstallPath = installerOptions.renderHtmlForInstallPath !== undefined ?
+            installerOptions.renderHtmlForInstallPath :
+            render_html_for_install_path_1.default;
+        this.customPropertiesExtractor = customPropertiesExtractor;
+        this.dispatchErrorHandler = dispatchErrorHandler;
+        this.processEventErrorHandler = processEventErrorHandler;
+        this.unhandledRequestHandler = unhandledRequestHandler;
+        this.unhandledRequestTimeoutMillis = unhandledRequestTimeoutMillis;
+        // Assign the requestListener property by binding the unboundRequestListener to this instance
+        this.requestListener = this.unboundRequestListener.bind(this);
+    }
+    init(app) {
+        this.app = app;
+    }
+    start(portOrListenOptions, serverOptions = {}) {
+        let createServerFn = http_1.createServer;
+        // Decide which kind of server, HTTP or HTTPS, by searching for any keys in the serverOptions that are exclusive
+        // to HTTPS
+        if (Object.keys(serverOptions).filter((k) => httpsOptionKeys.includes(k)).length > 0) {
+            createServerFn = https_1.createServer;
+        }
+        if (this.server !== undefined) {
+            return Promise.reject(new errors_1.ReceiverInconsistentStateError('The receiver cannot be started because it was already started.'));
+        }
+        this.server = createServerFn(serverOptions, (req, res) => {
+            try {
+                this.requestListener(req, res);
+            }
+            catch (error) {
+                // You may get an error here only when the requestListener failed
+                // to start processing incoming requests, or your app receives a request to an unexpected path.
+                this.dispatchErrorHandler({
+                    error: error,
+                    logger: this.logger,
+                    request: req,
+                    response: res,
+                });
+            }
+        });
+        return new Promise((resolve, reject) => {
+            if (this.server === undefined) {
+                throw new errors_1.ReceiverInconsistentStateError(missingServerErrorDescription);
+            }
+            this.server.on('error', (error) => {
+                if (this.server === undefined) {
+                    throw new errors_1.ReceiverInconsistentStateError(missingServerErrorDescription);
+                }
+                this.server.close();
+                // If the error event occurs before listening completes (like EADDRINUSE), this works well. However, if the
+                // error event happens some after the Promise is already resolved, the error would be silently swallowed up.
+                // The documentation doesn't describe any specific errors that can occur after listening has started, so this
+                // feels safe.
+                reject(error);
+            });
+            this.server.on('close', () => {
+                // Not removing all listeners because consumers could have added their own `close` event listener, and those
+                // should be called. If the consumer doesn't dispose of any references to the server properly, this would be
+                // a memory leak.
+                // this.server?.removeAllListeners();
+                this.server = undefined;
+            });
+            let listenOptions = this.port;
+            if (portOrListenOptions !== undefined) {
+                if (typeof portOrListenOptions === 'number') {
+                    listenOptions = portOrListenOptions;
+                }
+                else if (typeof portOrListenOptions === 'object') {
+                    listenOptions = portOrListenOptions;
+                }
+            }
+            this.server.listen(listenOptions, () => {
+                if (this.server === undefined) {
+                    return reject(new errors_1.ReceiverInconsistentStateError(missingServerErrorDescription));
+                }
+                return resolve(this.server);
+            });
+        });
+    }
+    // TODO: the arguments should be defined as the arguments to close() (which happen to be none), but for sake of
+    // generic types
+    stop() {
+        if (this.server === undefined) {
+            return Promise.reject(new errors_1.ReceiverInconsistentStateError('The receiver cannot be stopped because it was not started.'));
+        }
+        return new Promise((resolve, reject) => {
+            var _a;
+            (_a = this.server) === null || _a === void 0 ? void 0 : _a.close((error) => {
+                if (error !== undefined) {
+                    return reject(error);
+                }
+                this.server = undefined;
+                return resolve();
+            });
+        });
+    }
+    unboundRequestListener(req, res) {
+        // Route the request
+        // NOTE: the domain and scheme of the following URL object are not necessarily accurate. The URL object is only
+        // meant to be used to parse the path and query
+        const { pathname: path } = new url_1.URL(req.url, `http://${req.headers.host}`);
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const method = req.method.toUpperCase();
+        if (this.endpoints.includes(path) && method === 'POST') {
+            // Handle incoming ReceiverEvent
+            return this.handleIncomingEvent(req, res);
+        }
+        if (this.installer !== undefined && method === 'GET') {
+            // When installer is defined then installPath and installRedirectUriPath are always defined
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const [installPath, installRedirectUriPath] = [this.installPath, this.installRedirectUriPath];
+            // Visiting the installation endpoint
+            if (path === installPath) {
+                // Render installation path (containing Add to Slack button)
+                return this.handleInstallPathRequest(res);
+            }
+            // Installation has been initiated
+            if (path === installRedirectUriPath) {
+                // Handle OAuth callback request (to exchange authorization grant for a new access token)
+                return this.handleInstallRedirectRequest(req, res);
+            }
+        }
+        // Handle custom routes
+        if (Object.keys(this.routes).length) {
+            const match = this.routes[path] && this.routes[path][method] !== undefined;
+            if (match) {
+                return this.routes[path][method](req, res);
+            }
+        }
+        // If the request did not match the previous conditions, an error is thrown. The error can be caught by the
+        // the caller in order to defer to other routing logic (similar to calling `next()` in connect middleware).
+        // If you would like to customize the HTTP repsonse for this pattern,
+        // implement your own dispatchErrorHandler that handles an exception
+        // with ErrorCode.HTTPReceiverDeferredRequestError.
+        throw new errors_1.HTTPReceiverDeferredRequestError(`Unhandled HTTP request (${method}) made to ${path}`, req, res);
+    }
+    handleIncomingEvent(req, res) {
+        // Wrapped in an async closure for ease of using await
+        (async () => {
+            var _a;
+            let bufferedReq;
+            let body;
+            // Verify authenticity
+            try {
+                bufferedReq = await (0, verify_request_1.verify)({
+                    // If enabled: false, this method returns bufferredReq without verification
+                    enabled: this.signatureVerification,
+                    signingSecret: this.signingSecret,
+                }, req);
+            }
+            catch (err) {
+                const e = err;
+                this.logger.warn(`Request verification failed: ${e.message}`);
+                res.writeHead(401);
+                res.end();
+                return;
+            }
+            // Parse request body
+            // The object containing the parsed body is not exposed to the caller. It is preferred to reduce mutations to the
+            // req object, so that its as reusable as possible. Later, we should consider adding an option for assigning the
+            // parsed body to `req.body`, as this convention has been established by the popular `body-parser` package.
+            try {
+                body = parseBody(bufferedReq);
+            }
+            catch (err) {
+                const e = err;
+                this.logger.warn(`Malformed request body: ${e.message}`);
+                res.writeHead(400);
+                res.end();
+                return;
+            }
+            // Handle SSL checks
+            if (body.ssl_check) {
+                res.writeHead(200);
+                res.end();
+                return;
+            }
+            // Handle URL verification
+            if (body.type === 'url_verification') {
+                res.writeHead(200, { 'content-type': 'application/json' });
+                res.end(JSON.stringify({ challenge: body.challenge }));
+                return;
+            }
+            // Setup ack timeout warning
+            let isAcknowledged = false;
+            setTimeout(() => {
+                if (!isAcknowledged) {
+                    this.unhandledRequestHandler({
+                        logger: this.logger,
+                        request: req,
+                        response: res,
+                    });
+                }
+            }, this.unhandledRequestTimeoutMillis);
+            // Structure the ReceiverEvent
+            let storedResponse;
+            const event = {
+                body,
+                ack: async (response) => {
+                    this.logger.debug('ack() begin');
+                    if (isAcknowledged) {
+                        throw new errors_1.ReceiverMultipleAckError();
+                    }
+                    isAcknowledged = true;
+                    if (this.processBeforeResponse) {
+                        // In the case where processBeforeResponse: true is enabled, we don't send the HTTP response immediately.
+                        // We hold off until the listener execution is completed.
+                        if (!response) {
+                            storedResponse = '';
+                        }
+                        else {
+                            storedResponse = response;
+                        }
+                        this.logger.debug('ack() response stored');
+                    }
+                    else {
+                        if (!response) {
+                            res.writeHead(200);
+                            res.end();
+                        }
+                        else if (typeof response === 'string') {
+                            res.writeHead(200);
+                            res.end(response);
+                        }
+                        else {
+                            res.writeHead(200, { 'content-type': 'application/json' });
+                            res.end(JSON.stringify(response));
+                        }
+                        this.logger.debug('ack() response sent');
+                    }
+                },
+                retryNum: (0, http_utils_1.extractRetryNum)(req),
+                retryReason: (0, http_utils_1.extractRetryReason)(req),
+                customProperties: this.customPropertiesExtractor(bufferedReq),
+            };
+            // Send the event to the app for processing
+            try {
+                await ((_a = this.app) === null || _a === void 0 ? void 0 : _a.processEvent(event));
+                if (storedResponse !== undefined) {
+                    // in the case of processBeforeResponse: true
+                    if (typeof storedResponse === 'string') {
+                        res.writeHead(200);
+                        res.end(storedResponse);
+                    }
+                    else {
+                        res.writeHead(200, { 'content-type': 'application/json' });
+                        res.end(JSON.stringify(storedResponse));
+                    }
+                    this.logger.debug('stored response sent');
+                }
+            }
+            catch (error) {
+                const acknowledgedByHandler = await this.processEventErrorHandler({
+                    error: error,
+                    logger: this.logger,
+                    request: req,
+                    response: res,
+                    storedResponse,
+                });
+                if (acknowledgedByHandler) {
+                    // If the value is false, we don't touch the value as a race condition
+                    // with ack() call may occur especially when processBeforeResponse: false
+                    isAcknowledged = true;
+                }
+            }
+        })();
+    }
+    handleInstallPathRequest(res) {
+        // Wrapped in an async closure for ease of using await
+        (async () => {
+            // NOTE: Skipping some ceremony such as content negotiation, setting informative headers, etc. These may be nice
+            // to have for completeness, but there's no clear benefit to adding them, so just keeping things simple. If a
+            // user desires a more custom page, they can always call `App.installer.generateInstallUrl()` and render their
+            // own page instead of using this one.
+            try {
+                // This function is only called from within unboundRequestListener after checking that installer is defined, and
+                // when installer is defined then installUrlOptions is always defined too.
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                const [installer, installUrlOptions] = [this.installer, this.installUrlOptions];
+                // Generate the URL for the "Add to Slack" button.
+                const url = await installer.generateInstallUrl(installUrlOptions, this.stateVerification);
+                if (this.directInstall !== undefined && this.directInstall) {
+                    // If a Slack app sets "Direct Install URL" in the Slack app configruation,
+                    // the installation flow of the app should start with the Slack authorize URL.
+                    // See https://api.slack.com/start/distributing/directory#direct_install for more details.
+                    res.writeHead(302, { Location: url });
+                    res.end('');
+                }
+                else {
+                    // The installation starts from a landing page served by this app.
+                    // Generate HTML response body
+                    const body = this.renderHtmlForInstallPath(url);
+                    // Serve a basic HTML page including the "Add to Slack" button.
+                    // Regarding headers:
+                    // - Content-Type is usually automatically detected by browsers
+                    // - Content-Length is not used because Transfer-Encoding='chunked' is automatically used.
+                    res.writeHead(200);
+                    res.end(body);
+                }
+            }
+            catch (err) {
+                const e = err;
+                this.logger.error('An unhandled error occurred while Bolt processed a request to the installation path');
+                this.logger.debug(`Error details: ${e}`);
+            }
+        })();
+    }
+    handleInstallRedirectRequest(req, res) {
+        // This function is only called from within unboundRequestListener after checking that installer is defined, and
+        // when installer is defined then installCallbackOptions is always defined too.
+        /* eslint-disable @typescript-eslint/no-non-null-assertion */
+        const [installer, installCallbackOptions, installUrlOptions] = [
+            this.installer,
+            this.installCallbackOptions,
+            this.installUrlOptions,
+        ];
+        /* eslint-enable @typescript-eslint/no-non-null-assertion */
+        const errorHandler = (err) => {
+            this.logger.error('HTTPReceiver encountered an unexpected error while handling the OAuth install redirect. Please report to the maintainers.');
+            this.logger.debug(`Error details: ${err}`);
+        };
+        if (this.stateVerification === false) {
+            // when stateVerification is disabled pass install options directly to handler
+            // since they won't be encoded in the state param of the generated url
+            installer.handleCallback(req, res, installCallbackOptions, installUrlOptions).catch(errorHandler);
+        }
+        else {
+            installer.handleCallback(req, res, installCallbackOptions).catch(errorHandler);
+        }
+    }
+}
+exports.default = HTTPReceiver;
+// Helpers
+function parseBody(req) {
+    const bodyAsString = req.rawBody.toString();
+    const contentType = req.headers['content-type'];
+    if (contentType === 'application/x-www-form-urlencoded') {
+        const parsedQs = (0, querystring_1.parse)(bodyAsString);
+        const { payload } = parsedQs;
+        if (typeof payload === 'string') {
+            return JSON.parse(payload);
+        }
+        return parsedQs;
+    }
+    return JSON.parse(bodyAsString);
+}
+//# sourceMappingURL=HTTPReceiver.js.map

package/dist/receivers/HTTPReceiver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HTTPReceiver.js","sourceRoot":"","sources":["../../src/receivers/HTTPReceiver.ts"],"names":[],"mappings":";;;;;;AAAA,uDAAuD;AACvD,+BAA6G;AAC7G,iCAAsH;AAEtH,6CAA+C;AAC/C,0CAAgE;AAChE,wCAA2G;AAC3G,6BAA0B;AAE1B,qDAA8F;AAC9F,iEAA4D;AAG5D,kGAA6E;AAC7E,sCAMmB;AACnB,mDAA6E;AAE7E,6CAAmE;AAEnE,+GAA+G;AAC/G,MAAM,eAAe,GAAG;IACtB,eAAe;IACf,kBAAkB;IAClB,aAAa;IACb,kBAAkB;IAClB,oBAAoB;IACpB,aAAa;IACb,gBAAgB;IAChB,aAAa;IACb,YAAY;IACZ,aAAa;IACb,iBAAiB;IACjB,IAAI;IACJ,MAAM;IACN,SAAS;IACT,SAAS;IACT,kBAAkB;IAClB,KAAK;IACL,SAAS;IACT,WAAW;IACX,kBAAkB;IAClB,KAAK;IACL,kBAAkB;IAClB,sBAAsB;IACtB,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,KAAK;IACL,eAAe;IACf,gBAAgB;IAChB,kBAAkB;CACnB,CAAC;AAEF,MAAM,6BAA6B,GAAG,0GAA0G,CAAC;AAwDjJ,kDAAkD;AAClD,4FAA4F;AAC5F,iGAAiG;AACjG,SAAgB,2BAA2B,CAAC,IAA0C;IACpF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;IAClD,IAAI,MAAM,IAAI,KAAK,EAAE;QACnB,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAS,CAAC,gCAAgC,EAAE;YAC7D,MAAM,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,MAAM,aAAa,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;YACjF,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACxB,QAAQ,CAAC,GAAG,EAAE,CAAC;YACf,OAAO;SACR;KACF;IACD,MAAM,CAAC,KAAK,CAAC,kDAAkD,OAAO,CAAC,MAAM,aAAa,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACzG,MAAM,CAAC,KAAK,CAAC,kBAAkB,KAAK,EAAE,CAAC,CAAC;IACxC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,CAAC;AACjB,CAAC;AAdD,kEAcC;AAYD,uDAAuD;AACvD,gGAAgG;AACzF,KAAK,UAAU,+BAA+B,CACnD,IAA8C;IAE9C,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;IACzD,IAAI,MAAM,IAAI,KAAK,EAAE;QACnB,8BAA8B;QAC9B,MAAM,SAAS,GAAI,KAAoB,CAAC,IAAI,CAAC;QAC7C,IAAI,SAAS,KAAK,kBAAS,CAAC,kBAAkB,EAAE;YAC9C,yFAAyF;YACzF,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACxB,QAAQ,CAAC,GAAG,EAAE,CAAC;YACf,OAAO,IAAI,CAAC;SACb;KACF;IACD,MAAM,CAAC,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC1E,MAAM,CAAC,KAAK,CAAC,kBAAkB,KAAK,qBAAqB,cAAc,EAAE,CAAC,CAAC;IAC3E,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,CAAC;IACf,OAAO,KAAK,CAAC;AACf,CAAC;AAnBD,0EAmBC;AAWD,sDAAsD;AACtD,+FAA+F;AAC/F,sGAAsG;AACtG,SAAgB,8BAA8B,CAAC,IAA6C;IAC1F,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB,MAAM,CAAC,KAAK,CACV,2DAA2D;QACzD,yDAAyD,CAC5D,CAAC;AACJ,CAAC;AAND,wEAMC;AAED;;GAEG;AACH,MAAqB,YAAY;IA+C/B,YAAmB,EACjB,aAAa,GAAG,EAAE,EAClB,SAAS,GAAG,CAAC,eAAe,CAAC,EAC7B,IAAI,GAAG,IAAI,EACX,YAAY,GAAG,EAAE,EACjB,MAAM,GAAG,SAAS,EAClB,QAAQ,GAAG,iBAAQ,CAAC,IAAI,EACxB,qBAAqB,GAAG,KAAK,EAC7B,qBAAqB,GAAG,IAAI,EAC5B,QAAQ,GAAG,SAAS,EACpB,YAAY,GAAG,SAAS,EACxB,WAAW,GAAG,SAAS,EACvB,WAAW,GAAG,SAAS,EACvB,iBAAiB,GAAG,SAAS,EAC7B,MAAM,GAAG,SAAS,EAClB,gBAAgB,GAAG,EAAE,EACrB,yBAAyB,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAC1C,oBAAoB,GAAG,2BAA2B,EAClD,wBAAwB,GAAG,+BAA+B,EAC1D,uBAAuB,GAAG,8BAA8B,EACxD,6BAA6B,GAAG,IAAI,GAChB;;QACpB,sEAAsE;QACtE,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAClB,CAAC,GAAG,EAAE;YACJ,MAAM,aAAa,GAAG,IAAI,sBAAa,EAAE,CAAC;YAC1C,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACjC,OAAO,aAAa,CAAC;QACvB,CAAC,CAAC,EAAE,CAAC;QACP,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,IAAI,EAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAClE,IAAI,CAAC,MAAM,GAAG,IAAA,6BAAa,EAAC,YAAY,CAAC,CAAC;QAE1C,qEAAqE;QACrE,IAAA,yCAAkB,EAAC,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,CAAC,eAAe,EAAE,CAAC,CAAC;QAEvF,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,iBAAiB,CAAC;QAC5D,qEAAqE;QACrE,IACE,QAAQ,KAAK,SAAS;YACtB,YAAY,KAAK,SAAS;YACzB,CAAC,IAAI,CAAC,iBAAiB,KAAK,KAAK,IAAI,yBAAyB;gBAC5D,WAAW,KAAK,SAAS;gBACxB,gBAAgB,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,4BAA4B;UAC3E;YACA,IAAI,CAAC,SAAS,GAAG,IAAI,uBAAe,CAAC;gBACnC,QAAQ;gBACR,YAAY;gBACZ,WAAW;gBACX,iBAAiB;gBACjB,MAAM;gBACN,QAAQ;gBACR,UAAU,EAAE,gBAAgB,CAAC,UAAU;gBACvC,iBAAiB,EAAE,gBAAgB,CAAC,iBAAiB;gBACrD,WAAW,EAAE,gBAAgB,CAAC,WAAW;gBACzC,aAAa,EAAE,gBAAgB,CAAC,aAAa;gBAC7C,gBAAgB,EAAE,gBAAgB,CAAC,gBAAgB;aACpD,CAAC,CAAC;YAEH,uFAAuF;YACvF,IAAI,CAAC,WAAW,GAAG,MAAA,gBAAgB,CAAC,WAAW,mCAAI,gBAAgB,CAAC;YACpE,IAAI,CAAC,aAAa,GAAG,gBAAgB,CAAC,aAAa,KAAK,SAAS,IAAI,gBAAgB,CAAC,aAAa,CAAC;YACpG,IAAI,CAAC,sBAAsB,GAAG,MAAA,gBAAgB,CAAC,eAAe,mCAAI,uBAAuB,CAAC;YAC1F,IAAI,CAAC,sBAAsB,GAAG,MAAA,gBAAgB,CAAC,eAAe,mCAAI,EAAE,CAAC;YACrE,IAAI,CAAC,iBAAiB,GAAG;gBACvB,MAAM,EAAE,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE;gBACpB,UAAU,EAAE,gBAAgB,CAAC,UAAU;gBACvC,QAAQ,EAAE,gBAAgB,CAAC,QAAQ;gBACnC,WAAW;aACZ,CAAC;SACH;QACD,IAAI,CAAC,wBAAwB,GAAG,gBAAgB,CAAC,wBAAwB,KAAK,SAAS,CAAC,CAAC;YACvF,gBAAgB,CAAC,wBAAwB,CAAC,CAAC;YAC3C,sCAA+B,CAAC;QAClC,IAAI,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;QAC3D,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QACzD,IAAI,CAAC,uBAAuB,GAAG,uBAAuB,CAAC;QACvD,IAAI,CAAC,6BAA6B,GAAG,6BAA6B,CAAC;QAEnE,6FAA6F;QAC7F,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC;IAEM,IAAI,CAAC,GAAQ;QAClB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAQM,KAAK,CACV,mBAA2C,EAC3C,gBAAoD,EAAE;QAEtD,IAAI,cAAc,GAAmD,mBAAY,CAAC;QAElF,gHAAgH;QAChH,WAAW;QACX,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACpF,cAAc,GAAG,oBAAiB,CAAC;SACpC;QAED,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,uCAA8B,CAAC,gEAAgE,CAAC,CACrG,CAAC;SACH;QAED,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,aAAa,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACvD,IAAI;gBACF,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAChC;YAAC,OAAO,KAAK,EAAE;gBACd,iEAAiE;gBACjE,+FAA+F;gBAC/F,IAAI,CAAC,oBAAoB,CAAC;oBACxB,KAAK,EAAE,KAA2B;oBAClC,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,OAAO,EAAE,GAAG;oBACZ,QAAQ,EAAE,GAAG;iBACd,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;gBAC7B,MAAM,IAAI,uCAA8B,CAAC,6BAA6B,CAAC,CAAC;aACzE;YAED,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBAChC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;oBAC7B,MAAM,IAAI,uCAA8B,CAAC,6BAA6B,CAAC,CAAC;iBACzE;gBAED,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gBAEpB,2GAA2G;gBAC3G,4GAA4G;gBAC5G,6GAA6G;gBAC7G,cAAc;gBACd,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;gBAC3B,4GAA4G;gBAC5G,4GAA4G;gBAC5G,iBAAiB;gBACjB,qCAAqC;gBACrC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YAC1B,CAAC,CAAC,CAAC;YAEH,IAAI,aAAa,GAA2B,IAAI,CAAC,IAAI,CAAC;YACtD,IAAI,mBAAmB,KAAK,SAAS,EAAE;gBACrC,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;oBAC3C,aAAa,GAAG,mBAA6B,CAAC;iBAC/C;qBAAM,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;oBAClD,aAAa,GAAG,mBAAoC,CAAC;iBACtD;aACF;YACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,EAAE;gBACrC,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;oBAC7B,OAAO,MAAM,CAAC,IAAI,uCAA8B,CAAC,6BAA6B,CAAC,CAAC,CAAC;iBAClF;gBAED,OAAO,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,+GAA+G;IAC/G,gBAAgB;IACT,IAAI;QACT,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE;YAC7B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,uCAA8B,CAAC,4DAA4D,CAAC,CAAC,CAAC;SACzH;QACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;;YACrC,MAAA,IAAI,CAAC,MAAM,0CAAE,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC3B,IAAI,KAAK,KAAK,SAAS,EAAE;oBACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;iBACtB;gBAED,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;gBACxB,OAAO,OAAO,EAAE,CAAC;YACnB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,sBAAsB,CAAC,GAAoB,EAAE,GAAmB;QACtE,oBAAoB;QAEpB,+GAA+G;QAC/G,+CAA+C;QAC/C,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,SAAG,CAAC,GAAG,CAAC,GAAa,EAAE,UAAU,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QACpF,oEAAoE;QACpE,MAAM,MAAM,GAAG,GAAG,CAAC,MAAO,CAAC,WAAW,EAAE,CAAC;QAEzC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,MAAM,KAAK,MAAM,EAAE;YACtD,gCAAgC;YAChC,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;SAC3C;QAED,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,KAAK,KAAK,EAAE;YACpD,2FAA2F;YAC3F,oEAAoE;YACpE,MAAM,CAAC,WAAW,EAAE,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAY,EAAE,IAAI,CAAC,sBAAuB,CAAC,CAAC;YAEhG,qCAAqC;YACrC,IAAI,IAAI,KAAK,WAAW,EAAE;gBACxB,4DAA4D;gBAC5D,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;aAC3C;YAED,kCAAkC;YAClC,IAAI,IAAI,KAAK,sBAAsB,EAAE;gBACnC,yFAAyF;gBACzF,OAAO,IAAI,CAAC,4BAA4B,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aACpD;SACF;QAED,uBAAuB;QACvB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE;YACnC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;YAC3E,IAAI,KAAK,EAAE;gBAAE,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAAE;SAC3D;QAED,2GAA2G;QAC3G,2GAA2G;QAC3G,qEAAqE;QACrE,oEAAoE;QACpE,mDAAmD;QACnD,MAAM,IAAI,yCAAgC,CAAC,2BAA2B,MAAM,aAAa,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC7G,CAAC;IAEO,mBAAmB,CAAC,GAAoB,EAAE,GAAmB;QACnE,sDAAsD;QACtD,CAAC,KAAK,IAAI,EAAE;;YACV,IAAI,WAAoC,CAAC;YACzC,IAAI,IAAS,CAAC;YAEd,sBAAsB;YACtB,IAAI;gBACF,WAAW,GAAG,MAAM,IAAA,uBAAuB,EACzC;oBACE,2EAA2E;oBAC3E,OAAO,EAAE,IAAI,CAAC,qBAAqB;oBACnC,aAAa,EAAE,IAAI,CAAC,aAAa;iBAClC,EACD,GAAG,CACJ,CAAC;aACH;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,GAAU,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC9D,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,GAAG,EAAE,CAAC;gBACV,OAAO;aACR;YAED,qBAAqB;YACrB,iHAAiH;YACjH,gHAAgH;YAChH,2GAA2G;YAC3G,IAAI;gBACF,IAAI,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;aAC/B;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,GAAU,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBACzD,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,GAAG,EAAE,CAAC;gBACV,OAAO;aACR;YAED,oBAAoB;YACpB,IAAI,IAAI,CAAC,SAAS,EAAE;gBAClB,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACnB,GAAG,CAAC,GAAG,EAAE,CAAC;gBACV,OAAO;aACR;YAED,0BAA0B;YAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE;gBACpC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;gBAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;gBACvD,OAAO;aACR;YAED,4BAA4B;YAC5B,IAAI,cAAc,GAAG,KAAK,CAAC;YAC3B,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI,CAAC,cAAc,EAAE;oBACnB,IAAI,CAAC,uBAAuB,CAAC;wBAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;wBACnB,OAAO,EAAE,GAAG;wBACZ,QAAQ,EAAE,GAAG;qBACd,CAAC,CAAC;iBACJ;YACH,CAAC,EAAE,IAAI,CAAC,6BAA6B,CAAC,CAAC;YAEvC,8BAA8B;YAC9B,IAAI,cAAc,CAAC;YACnB,MAAM,KAAK,GAAkB;gBAC3B,IAAI;gBACJ,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;oBACtB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;oBACjC,IAAI,cAAc,EAAE;wBAClB,MAAM,IAAI,iCAAwB,EAAE,CAAC;qBACtC;oBACD,cAAc,GAAG,IAAI,CAAC;oBACtB,IAAI,IAAI,CAAC,qBAAqB,EAAE;wBAC9B,yGAAyG;wBACzG,yDAAyD;wBACzD,IAAI,CAAC,QAAQ,EAAE;4BACb,cAAc,GAAG,EAAE,CAAC;yBACrB;6BAAM;4BACL,cAAc,GAAG,QAAQ,CAAC;yBAC3B;wBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;qBAC5C;yBAAM;wBACL,IAAI,CAAC,QAAQ,EAAE;4BACb,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;4BACnB,GAAG,CAAC,GAAG,EAAE,CAAC;yBACX;6BAAM,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;4BACvC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;4BACnB,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;yBACnB;6BAAM;4BACL,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;4BAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;yBACnC;wBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;qBAC1C;gBACH,CAAC;gBACD,QAAQ,EAAE,IAAA,4BAAe,EAAC,GAAG,CAAC;gBAC9B,WAAW,EAAE,IAAA,+BAAkB,EAAC,GAAG,CAAC;gBACpC,gBAAgB,EAAE,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC;aAC9D,CAAC;YAEF,2CAA2C;YAC3C,IAAI;gBACF,MAAM,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,YAAY,CAAC,KAAK,CAAC,CAAA,CAAC;gBACpC,IAAI,cAAc,KAAK,SAAS,EAAE;oBAChC,6CAA6C;oBAC7C,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE;wBACtC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;wBACnB,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;qBACzB;yBAAM;wBACL,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,kBAAkB,EAAE,CAAC,CAAC;wBAC3D,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;qBACzC;oBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;iBAC3C;aACF;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,qBAAqB,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC;oBAChE,KAAK,EAAE,KAA2B;oBAClC,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,OAAO,EAAE,GAAG;oBACZ,QAAQ,EAAE,GAAG;oBACb,cAAc;iBACf,CAAC,CAAC;gBACH,IAAI,qBAAqB,EAAE;oBACzB,sEAAsE;oBACtE,yEAAyE;oBACzE,cAAc,GAAG,IAAI,CAAC;iBACvB;aACF;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC;IAEO,wBAAwB,CAAC,GAAmB;QAClD,sDAAsD;QACtD,CAAC,KAAK,IAAI,EAAE;YACV,gHAAgH;YAChH,6GAA6G;YAC7G,8GAA8G;YAC9G,sCAAsC;YACtC,IAAI;gBACF,gHAAgH;gBAChH,0EAA0E;gBAC1E,oEAAoE;gBACpE,MAAM,CAAC,SAAS,EAAE,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,SAAU,EAAE,IAAI,CAAC,iBAAkB,CAAC,CAAC;gBAClF,kDAAkD;gBAClD,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,kBAAkB,CAAC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;gBAE1F,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,aAAa,EAAE;oBAC1D,2EAA2E;oBAC3E,8EAA8E;oBAC9E,0FAA0F;oBAC1F,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;oBACtC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;iBACb;qBAAM;oBACL,kEAAkE;oBAClE,8BAA8B;oBAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;oBAEhD,+DAA+D;oBAC/D,qBAAqB;oBACrB,+DAA+D;oBAC/D,0FAA0F;oBAC1F,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;oBACnB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;iBACf;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,CAAC,GAAG,GAAU,CAAC;gBACrB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qFAAqF,CAAC,CAAC;gBACzG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;aAC1C;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC;IAEO,4BAA4B,CAAC,GAAoB,EAAE,GAAmB;QAC5E,gHAAgH;QAChH,+EAA+E;QAC/E,6DAA6D;QAC7D,MAAM,CAAC,SAAS,EAAE,sBAAsB,EAAE,iBAAiB,CAAC,GAAG;YAC7D,IAAI,CAAC,SAAU;YACf,IAAI,CAAC,sBAAuB;YAC5B,IAAI,CAAC,iBAAkB;SACxB,CAAC;QACF,4DAA4D;QAC5D,MAAM,YAAY,GAAG,CAAC,GAAU,EAAE,EAAE;YAClC,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,2HAA2H,CAC5H,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,GAAG,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC;QACF,IAAI,IAAI,CAAC,iBAAiB,KAAK,KAAK,EAAE;YACpC,8EAA8E;YAC9E,sEAAsE;YACtE,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,sBAAsB,EAAE,iBAAiB,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;SACnG;aAAM;YACL,SAAS,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,sBAAsB,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;SAChF;IACH,CAAC;CACF;AApeD,+BAoeC;AAED,UAAU;AAEV,SAAS,SAAS,CAAC,GAA4B;IAC7C,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC5C,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAChD,IAAI,WAAW,KAAK,mCAAmC,EAAE;QACvD,MAAM,QAAQ,GAAG,IAAA,mBAAO,EAAC,YAAY,CAAC,CAAC;QACvC,MAAM,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;QAC7B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;SAC5B;QACD,OAAO,QAAQ,CAAC;KACjB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;AAClC,CAAC"}

package/dist/receivers/SocketModeReceiver.d.ts

@@ -0,0 +1,61 @@
+/// <reference types="node" />
+import { SocketModeClient } from '@slack/socket-mode';
+import { IncomingMessage, ServerResponse } from 'http';
+import { Logger, LogLevel } from '@slack/logger';
+import { InstallProvider, CallbackOptions, InstallProviderOptions, InstallURLOptions } from '@slack/oauth';
+import { AppsConnectionsOpenResponse } from '@slack/web-api';
+import App from '../App';
+import { Receiver } from '../types';
+import { StringIndexed } from '../types/helpers';
+export interface SocketModeReceiverOptions {
+    logger?: Logger;
+    logLevel?: LogLevel;
+    clientId?: string;
+    clientSecret?: string;
+    stateSecret?: InstallProviderOptions['stateSecret'];
+    redirectUri?: string;
+    installationStore?: InstallProviderOptions['installationStore'];
+    scopes?: InstallURLOptions['scopes'];
+    installerOptions?: InstallerOptions;
+    appToken: string;
+    customRoutes?: CustomRoute[];
+    customPropertiesExtractor?: (args: any) => StringIndexed;
+}
+export interface CustomRoute {
+    path: string;
+    method: string | string[];
+    handler: (req: IncomingMessage, res: ServerResponse) => void;
+}
+interface InstallerOptions {
+    stateStore?: InstallProviderOptions['stateStore'];
+    stateVerification?: InstallProviderOptions['stateVerification'];
+    authVersion?: InstallProviderOptions['authVersion'];
+    metadata?: InstallURLOptions['metadata'];
+    installPath?: string;
+    directInstall?: boolean;
+    renderHtmlForInstallPath?: (url: string) => string;
+    redirectUriPath?: string;
+    callbackOptions?: CallbackOptions;
+    userScopes?: InstallURLOptions['userScopes'];
+    clientOptions?: InstallProviderOptions['clientOptions'];
+    authorizationUrl?: InstallProviderOptions['authorizationUrl'];
+    port?: number;
+}
+/**
+ * Receives Events, Slash Commands, and Actions of a web socket connection
+ */
+export default class SocketModeReceiver implements Receiver {
+    client: SocketModeClient;
+    private app;
+    private logger;
+    installer: InstallProvider | undefined;
+    private httpServer?;
+    private httpServerPort?;
+    private routes;
+    constructor({ appToken, logger, logLevel, clientId, clientSecret, stateSecret, redirectUri, installationStore, scopes, installerOptions, customRoutes, customPropertiesExtractor, }: SocketModeReceiverOptions);
+    init(app: App): void;
+    start(): Promise<AppsConnectionsOpenResponse>;
+    stop(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=SocketModeReceiver.d.ts.map

package/dist/receivers/SocketModeReceiver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketModeReceiver.d.ts","sourceRoot":"","sources":["../../src/receivers/SocketModeReceiver.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAgB,eAAe,EAAE,cAAc,EAAU,MAAM,MAAM,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAiB,QAAQ,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC3G,OAAO,EAAE,2BAA2B,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,GAAG,MAAM,QAAQ,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAiB,MAAM,UAAU,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAMjD,MAAM,WAAW,yBAAyB;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAChE,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,yBAAyB,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,aAAa,CAAC;CAC1D;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,KAAK,IAAI,CAAC;CAC9D;AAGD,UAAU,gBAAgB;IACxB,UAAU,CAAC,EAAE,sBAAsB,CAAC,YAAY,CAAC,CAAC;IAClD,iBAAiB,CAAC,EAAE,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAChE,WAAW,CAAC,EAAE,sBAAsB,CAAC,aAAa,CAAC,CAAC;IACpD,QAAQ,CAAC,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wBAAwB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,UAAU,CAAC,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAC7C,aAAa,CAAC,EAAE,sBAAsB,CAAC,eAAe,CAAC,CAAC;IACxD,gBAAgB,CAAC,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,kBAAmB,YAAW,QAAQ;IAElD,MAAM,EAAE,gBAAgB,CAAC;IAEhC,OAAO,CAAC,GAAG,CAAkB;IAE7B,OAAO,CAAC,MAAM,CAAS;IAEhB,SAAS,EAAE,eAAe,GAAG,SAAS,CAAa;IAE1D,OAAO,CAAC,UAAU,CAAC,CAAS;IAE5B,OAAO,CAAC,cAAc,CAAC,CAAS;IAEhC,OAAO,CAAC,MAAM,CAAiB;gBAEZ,EACjB,QAAQ,EACR,MAAkB,EAClB,QAAwB,EACxB,QAAoB,EACpB,YAAwB,EACxB,WAAuB,EACvB,WAAuB,EACvB,iBAA6B,EAC7B,MAAkB,EAClB,gBAAqB,EACrB,YAAiB,EACjB,yBAA2C,GAC5C,EAAE,yBAAyB;IAyIrB,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAIpB,KAAK,IAAI,OAAO,CAAC,2BAA2B,CAAC;IAS7C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAgB7B"}