@slack/bolt 3.7.0 → 3.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -2
- package/dist/package.json +88 -0
- package/package.json +4 -4
- package/dist/App.d.ts +0 -159
- package/dist/App.d.ts.map +0 -1
- package/dist/App.js +0 -758
- package/dist/App.js.map +0 -1
- package/dist/WorkflowStep.d.ts +0 -106
- package/dist/WorkflowStep.d.ts.map +0 -1
- package/dist/WorkflowStep.js +0 -198
- package/dist/WorkflowStep.js.map +0 -1
- package/dist/conversation-store.d.ts +0 -31
- package/dist/conversation-store.d.ts.map +0 -1
- package/dist/conversation-store.js +0 -74
- package/dist/conversation-store.js.map +0 -1
- package/dist/errors.d.ts +0 -75
- package/dist/errors.d.ts.map +0 -1
- package/dist/errors.js +0 -112
- package/dist/errors.js.map +0 -1
- package/dist/helpers.d.ts +0 -24
- package/dist/helpers.d.ts.map +0 -1
- package/dist/helpers.js +0 -100
- package/dist/helpers.js.map +0 -1
- package/dist/index.d.ts +0 -13
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js +0 -43
- package/dist/index.js.map +0 -1
- package/dist/middleware/builtin.d.ts +0 -52
- package/dist/middleware/builtin.d.ts.map +0 -1
- package/dist/middleware/builtin.js +0 -337
- package/dist/middleware/builtin.js.map +0 -1
- package/dist/middleware/process.d.ts +0 -5
- package/dist/middleware/process.d.ts.map +0 -1
- package/dist/middleware/process.js +0 -25
- package/dist/middleware/process.js.map +0 -1
- package/dist/receivers/AwsLambdaReceiver.d.ts +0 -50
- package/dist/receivers/AwsLambdaReceiver.d.ts.map +0 -1
- package/dist/receivers/AwsLambdaReceiver.js +0 -184
- package/dist/receivers/AwsLambdaReceiver.js.map +0 -1
- package/dist/receivers/ExpressReceiver.d.ts +0 -74
- package/dist/receivers/ExpressReceiver.d.ts.map +0 -1
- package/dist/receivers/ExpressReceiver.js +0 -440
- package/dist/receivers/ExpressReceiver.js.map +0 -1
- package/dist/receivers/HTTPReceiver.d.ts +0 -72
- package/dist/receivers/HTTPReceiver.d.ts.map +0 -1
- package/dist/receivers/HTTPReceiver.js +0 -431
- package/dist/receivers/HTTPReceiver.js.map +0 -1
- package/dist/receivers/SocketModeReceiver.d.ts +0 -57
- package/dist/receivers/SocketModeReceiver.d.ts.map +0 -1
- package/dist/receivers/SocketModeReceiver.js +0 -163
- package/dist/receivers/SocketModeReceiver.js.map +0 -1
- package/dist/receivers/custom-routes.d.ts +0 -14
- package/dist/receivers/custom-routes.d.ts.map +0 -1
- package/dist/receivers/custom-routes.js +0 -33
- package/dist/receivers/custom-routes.js.map +0 -1
- package/dist/receivers/render-html-for-install-path.d.ts +0 -3
- package/dist/receivers/render-html-for-install-path.d.ts.map +0 -1
- package/dist/receivers/render-html-for-install-path.js +0 -25
- package/dist/receivers/render-html-for-install-path.js.map +0 -1
- package/dist/receivers/verify-redirect-opts.d.ts +0 -7
- package/dist/receivers/verify-redirect-opts.d.ts.map +0 -1
- package/dist/receivers/verify-redirect-opts.js +0 -23
- package/dist/receivers/verify-redirect-opts.js.map +0 -1
- package/dist/receivers/verify-request.d.ts +0 -41
- package/dist/receivers/verify-request.d.ts.map +0 -1
- package/dist/receivers/verify-request.js +0 -98
- package/dist/receivers/verify-request.js.map +0 -1
- package/dist/types/actions/block-action.d.ts +0 -224
- package/dist/types/actions/block-action.d.ts.map +0 -1
- package/dist/types/actions/block-action.js +0 -3
- package/dist/types/actions/block-action.js.map +0 -1
- package/dist/types/actions/dialog-action.d.ts +0 -47
- package/dist/types/actions/dialog-action.d.ts.map +0 -1
- package/dist/types/actions/dialog-action.js +0 -3
- package/dist/types/actions/dialog-action.js.map +0 -1
- package/dist/types/actions/index.d.ts +0 -46
- package/dist/types/actions/index.d.ts.map +0 -1
- package/dist/types/actions/index.js +0 -17
- package/dist/types/actions/index.js.map +0 -1
- package/dist/types/actions/interactive-message.d.ts +0 -66
- package/dist/types/actions/interactive-message.d.ts.map +0 -1
- package/dist/types/actions/interactive-message.js +0 -3
- package/dist/types/actions/interactive-message.js.map +0 -1
- package/dist/types/actions/workflow-step-edit.d.ts +0 -49
- package/dist/types/actions/workflow-step-edit.d.ts.map +0 -1
- package/dist/types/actions/workflow-step-edit.js +0 -3
- package/dist/types/actions/workflow-step-edit.js.map +0 -1
- package/dist/types/command/index.d.ts +0 -36
- package/dist/types/command/index.d.ts.map +0 -1
- package/dist/types/command/index.js +0 -3
- package/dist/types/command/index.js.map +0 -1
- package/dist/types/events/base-events.d.ts +0 -699
- package/dist/types/events/base-events.d.ts.map +0 -1
- package/dist/types/events/base-events.js +0 -5
- package/dist/types/events/base-events.js.map +0 -1
- package/dist/types/events/index.d.ts +0 -63
- package/dist/types/events/index.d.ts.map +0 -1
- package/dist/types/events/index.js +0 -14
- package/dist/types/events/index.js.map +0 -1
- package/dist/types/events/message-events.d.ts +0 -312
- package/dist/types/events/message-events.d.ts.map +0 -1
- package/dist/types/events/message-events.js +0 -3
- package/dist/types/events/message-events.js.map +0 -1
- package/dist/types/helpers.d.ts +0 -17
- package/dist/types/helpers.d.ts.map +0 -1
- package/dist/types/helpers.js +0 -3
- package/dist/types/helpers.js.map +0 -1
- package/dist/types/index.d.ts +0 -10
- package/dist/types/index.d.ts.map +0 -1
- package/dist/types/index.js +0 -22
- package/dist/types/index.js.map +0 -1
- package/dist/types/middleware.d.ts +0 -56
- package/dist/types/middleware.d.ts.map +0 -1
- package/dist/types/middleware.js +0 -3
- package/dist/types/middleware.js.map +0 -1
- package/dist/types/options/index.d.ts +0 -192
- package/dist/types/options/index.d.ts.map +0 -1
- package/dist/types/options/index.js +0 -3
- package/dist/types/options/index.js.map +0 -1
- package/dist/types/receiver.d.ts +0 -13
- package/dist/types/receiver.d.ts.map +0 -1
- package/dist/types/receiver.js +0 -3
- package/dist/types/receiver.js.map +0 -1
- package/dist/types/shortcuts/global-shortcut.d.ts +0 -29
- package/dist/types/shortcuts/global-shortcut.d.ts.map +0 -1
- package/dist/types/shortcuts/global-shortcut.js +0 -3
- package/dist/types/shortcuts/global-shortcut.js.map +0 -1
- package/dist/types/shortcuts/index.d.ts +0 -23
- package/dist/types/shortcuts/index.d.ts.map +0 -1
- package/dist/types/shortcuts/index.js +0 -16
- package/dist/types/shortcuts/index.js.map +0 -1
- package/dist/types/shortcuts/message-shortcut.d.ts +0 -43
- package/dist/types/shortcuts/message-shortcut.d.ts.map +0 -1
- package/dist/types/shortcuts/message-shortcut.js +0 -3
- package/dist/types/shortcuts/message-shortcut.js.map +0 -1
- package/dist/types/utilities.d.ts +0 -23
- package/dist/types/utilities.d.ts.map +0 -1
- package/dist/types/utilities.js +0 -3
- package/dist/types/utilities.js.map +0 -1
- package/dist/types/view/index.d.ts +0 -175
- package/dist/types/view/index.d.ts.map +0 -1
- package/dist/types/view/index.js +0 -3
- package/dist/types/view/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -35,10 +35,12 @@ const app = new App({
|
|
|
35
35
|
})();
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
> ⚙️ By default, Bolt listens to the `/slack/events` endpoint for *all* incoming requests (whether shortcuts, events, or actions payloads). When configuring Request URLs in your app configuration, they should all have `/slack/events` appended. The default behavior be modified using the constructor's `endpoints` parameter.
|
|
39
|
-
|
|
40
38
|
## Listening for events
|
|
41
39
|
|
|
40
|
+
The Slack **Request URL** for a Bolt app must have the path set to `/slack/events`.
|
|
41
|
+
For example: `https://my-slack-app.example.com/slack/events`.
|
|
42
|
+
Otherwise, all incoming requests from Slack won't be handled.
|
|
43
|
+
|
|
42
44
|
Apps typically react to a collection of incoming events, which can correspond [Events API events](https://api.slack.com/events-api), [actions](https://api.slack.com/interactivity/components), [shortcuts](https://api.slack.com/interactivity/shortcuts), [slash commands](https://api.slack.com/interactivity/slash-commands) or [options requests](https://api.slack.com/reference/block-kit/block-elements#external_select). For each type of
|
|
43
45
|
request, there's a method to build a listener function.
|
|
44
46
|
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@slack/bolt",
|
|
3
|
+
"version": "3.5.0",
|
|
4
|
+
"description": "A framework for building Slack apps, fast.",
|
|
5
|
+
"author": "Slack Technologies, Inc.",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"keywords": [
|
|
8
|
+
"slack",
|
|
9
|
+
"bot",
|
|
10
|
+
"events-api",
|
|
11
|
+
"slash-commands",
|
|
12
|
+
"interactive-components",
|
|
13
|
+
"api",
|
|
14
|
+
"chatops",
|
|
15
|
+
"integration",
|
|
16
|
+
"slack-app"
|
|
17
|
+
],
|
|
18
|
+
"main": "./dist/index.js",
|
|
19
|
+
"types": "./dist/index.d.ts",
|
|
20
|
+
"files": [
|
|
21
|
+
"dist/**/*"
|
|
22
|
+
],
|
|
23
|
+
"engines": {
|
|
24
|
+
"node": ">=12.13.0",
|
|
25
|
+
"npm": ">=6.12.0"
|
|
26
|
+
},
|
|
27
|
+
"scripts": {
|
|
28
|
+
"prepare": "npm run build",
|
|
29
|
+
"build": "npm run build:clean && tsc",
|
|
30
|
+
"build:clean": "shx rm -rf ./dist ./coverage ./.nyc_output",
|
|
31
|
+
"lint": "eslint --ext .ts src",
|
|
32
|
+
"mocha": "TS_NODE_PROJECT=tsconfig.json nyc mocha --config .mocharc.json \"src/**/*.spec.ts\"",
|
|
33
|
+
"test": "npm run lint && npm run mocha && npm run test:types",
|
|
34
|
+
"test:types": "tsd",
|
|
35
|
+
"coverage": "codecov",
|
|
36
|
+
"watch": "npx nodemon --watch 'src' --ext 'ts' --exec npm run build"
|
|
37
|
+
},
|
|
38
|
+
"repository": "slackapi/bolt",
|
|
39
|
+
"homepage": "https://slack.dev/bolt-js",
|
|
40
|
+
"bugs": {
|
|
41
|
+
"url": "https://github.com/slackapi/bolt-js/issues"
|
|
42
|
+
},
|
|
43
|
+
"dependencies": {
|
|
44
|
+
"@slack/logger": "^3.0.0",
|
|
45
|
+
"@slack/oauth": "^2.2.0",
|
|
46
|
+
"@slack/socket-mode": "^1.1.0",
|
|
47
|
+
"@slack/types": "^2.0.0",
|
|
48
|
+
"@slack/web-api": "^6.3.0",
|
|
49
|
+
"@types/express": "^4.16.1",
|
|
50
|
+
"@types/node": ">=12",
|
|
51
|
+
"@types/promise.allsettled": "^1.0.3",
|
|
52
|
+
"@types/tsscmp": "^1.0.0",
|
|
53
|
+
"axios": "^0.21.1",
|
|
54
|
+
"eslint-config-airbnb-base": "^14.2.1",
|
|
55
|
+
"express": "^4.16.4",
|
|
56
|
+
"please-upgrade-node": "^3.2.0",
|
|
57
|
+
"promise.allsettled": "^1.0.2",
|
|
58
|
+
"raw-body": "^2.3.3",
|
|
59
|
+
"read-pkg-up": "^7.0.1",
|
|
60
|
+
"tsscmp": "^1.0.6"
|
|
61
|
+
},
|
|
62
|
+
"devDependencies": {
|
|
63
|
+
"@types/chai": "^4.1.7",
|
|
64
|
+
"@types/mocha": "^5.2.6",
|
|
65
|
+
"@types/sinon": "^7.0.11",
|
|
66
|
+
"@typescript-eslint/eslint-plugin": "^4.4.1",
|
|
67
|
+
"@typescript-eslint/parser": "^4.4.0",
|
|
68
|
+
"chai": "^4.2.0",
|
|
69
|
+
"codecov": "^3.2.0",
|
|
70
|
+
"eslint": "^7.26.0",
|
|
71
|
+
"eslint-config-airbnb-typescript": "^12.3.1",
|
|
72
|
+
"eslint-plugin-import": "^2.22.1",
|
|
73
|
+
"eslint-plugin-jsdoc": "^30.6.1",
|
|
74
|
+
"eslint-plugin-node": "^11.1.0",
|
|
75
|
+
"mocha": "^6.1.4",
|
|
76
|
+
"nyc": "^14.0.0",
|
|
77
|
+
"rewiremock": "^3.13.4",
|
|
78
|
+
"shx": "^0.3.2",
|
|
79
|
+
"sinon": "^7.3.1",
|
|
80
|
+
"source-map-support": "^0.5.12",
|
|
81
|
+
"ts-node": "^8.1.0",
|
|
82
|
+
"tsd": "^0.13.1",
|
|
83
|
+
"typescript": "^4.1.0"
|
|
84
|
+
},
|
|
85
|
+
"tsd": {
|
|
86
|
+
"directory": "types-tests"
|
|
87
|
+
}
|
|
88
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@slack/bolt",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.8.0",
|
|
4
4
|
"description": "A framework for building Slack apps, fast.",
|
|
5
5
|
"author": "Slack Technologies, LLC",
|
|
6
6
|
"license": "MIT",
|
|
@@ -43,14 +43,14 @@
|
|
|
43
43
|
"dependencies": {
|
|
44
44
|
"@slack/logger": "^3.0.0",
|
|
45
45
|
"@slack/oauth": "^2.3.0",
|
|
46
|
-
"@slack/socket-mode": "^1.
|
|
46
|
+
"@slack/socket-mode": "^1.2.0",
|
|
47
47
|
"@slack/types": "^2.2.0",
|
|
48
48
|
"@slack/web-api": "^6.4.0",
|
|
49
49
|
"@types/express": "^4.16.1",
|
|
50
50
|
"@types/node": ">=12",
|
|
51
51
|
"@types/promise.allsettled": "^1.0.3",
|
|
52
52
|
"@types/tsscmp": "^1.0.0",
|
|
53
|
-
"axios": "^0.21.
|
|
53
|
+
"axios": "^0.21.4",
|
|
54
54
|
"express": "^4.16.4",
|
|
55
55
|
"please-upgrade-node": "^3.2.0",
|
|
56
56
|
"promise.allsettled": "^1.0.2",
|
|
@@ -71,7 +71,7 @@
|
|
|
71
71
|
"eslint-plugin-import": "^2.22.1",
|
|
72
72
|
"eslint-plugin-jsdoc": "^30.6.1",
|
|
73
73
|
"eslint-plugin-node": "^11.1.0",
|
|
74
|
-
"mocha": "^
|
|
74
|
+
"mocha": "^9.1.3",
|
|
75
75
|
"nyc": "^14.0.0",
|
|
76
76
|
"rewiremock": "^3.13.4",
|
|
77
77
|
"shx": "^0.3.2",
|
package/dist/App.d.ts
DELETED
|
@@ -1,159 +0,0 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
|
-
import { Agent } from 'http';
|
|
3
|
-
import { SecureContextOptions } from 'tls';
|
|
4
|
-
import { WebClient, WebClientOptions } from '@slack/web-api';
|
|
5
|
-
import { Logger, LogLevel } from '@slack/logger';
|
|
6
|
-
import SocketModeReceiver from './receivers/SocketModeReceiver';
|
|
7
|
-
import HTTPReceiver, { HTTPReceiverOptions } from './receivers/HTTPReceiver';
|
|
8
|
-
import { ConversationStore } from './conversation-store';
|
|
9
|
-
import { WorkflowStep } from './WorkflowStep';
|
|
10
|
-
import { Middleware, AnyMiddlewareArgs, SlackActionMiddlewareArgs, SlackCommandMiddlewareArgs, SlackEventMiddlewareArgs, SlackOptionsMiddlewareArgs, SlackShortcutMiddlewareArgs, SlackViewMiddlewareArgs, SlackAction, SlackShortcut, OptionsSource, BlockAction, SlackViewAction, Receiver, ReceiverEvent } from './types';
|
|
11
|
-
import { CodedError } from './errors';
|
|
12
|
-
/** App initialization options */
|
|
13
|
-
export interface AppOptions {
|
|
14
|
-
signingSecret?: HTTPReceiverOptions['signingSecret'];
|
|
15
|
-
endpoints?: HTTPReceiverOptions['endpoints'];
|
|
16
|
-
customRoutes?: HTTPReceiverOptions['customRoutes'];
|
|
17
|
-
processBeforeResponse?: HTTPReceiverOptions['processBeforeResponse'];
|
|
18
|
-
signatureVerification?: HTTPReceiverOptions['signatureVerification'];
|
|
19
|
-
clientId?: HTTPReceiverOptions['clientId'];
|
|
20
|
-
clientSecret?: HTTPReceiverOptions['clientSecret'];
|
|
21
|
-
stateSecret?: HTTPReceiverOptions['stateSecret'];
|
|
22
|
-
redirectUri?: HTTPReceiverOptions['redirectUri'];
|
|
23
|
-
installationStore?: HTTPReceiverOptions['installationStore'];
|
|
24
|
-
scopes?: HTTPReceiverOptions['scopes'];
|
|
25
|
-
installerOptions?: HTTPReceiverOptions['installerOptions'];
|
|
26
|
-
agent?: Agent;
|
|
27
|
-
clientTls?: Pick<SecureContextOptions, 'pfx' | 'key' | 'passphrase' | 'cert' | 'ca'>;
|
|
28
|
-
convoStore?: ConversationStore | false;
|
|
29
|
-
token?: AuthorizeResult['botToken'];
|
|
30
|
-
appToken?: string;
|
|
31
|
-
botId?: AuthorizeResult['botId'];
|
|
32
|
-
botUserId?: AuthorizeResult['botUserId'];
|
|
33
|
-
authorize?: Authorize<boolean>;
|
|
34
|
-
receiver?: Receiver;
|
|
35
|
-
logger?: Logger;
|
|
36
|
-
logLevel?: LogLevel;
|
|
37
|
-
ignoreSelf?: boolean;
|
|
38
|
-
clientOptions?: Pick<WebClientOptions, 'slackApiUrl'>;
|
|
39
|
-
socketMode?: boolean;
|
|
40
|
-
developerMode?: boolean;
|
|
41
|
-
tokenVerificationEnabled?: boolean;
|
|
42
|
-
}
|
|
43
|
-
export { LogLevel, Logger } from '@slack/logger';
|
|
44
|
-
/** Authorization function - seeds the middleware processing and listeners with an authorization context */
|
|
45
|
-
export interface Authorize<IsEnterpriseInstall extends boolean = false> {
|
|
46
|
-
(source: AuthorizeSourceData<IsEnterpriseInstall>, body?: AnyMiddlewareArgs['body']): Promise<AuthorizeResult>;
|
|
47
|
-
}
|
|
48
|
-
/** Authorization function inputs - authenticated data about an event for the authorization function */
|
|
49
|
-
export interface AuthorizeSourceData<IsEnterpriseInstall extends boolean = false> {
|
|
50
|
-
teamId: IsEnterpriseInstall extends true ? string | undefined : string;
|
|
51
|
-
enterpriseId: IsEnterpriseInstall extends true ? string : string | undefined;
|
|
52
|
-
userId?: string;
|
|
53
|
-
conversationId?: string;
|
|
54
|
-
isEnterpriseInstall: IsEnterpriseInstall;
|
|
55
|
-
}
|
|
56
|
-
/** Authorization function outputs - data that will be available as part of event processing */
|
|
57
|
-
export interface AuthorizeResult {
|
|
58
|
-
botToken?: string;
|
|
59
|
-
userToken?: string;
|
|
60
|
-
botId?: string;
|
|
61
|
-
botUserId?: string;
|
|
62
|
-
teamId?: string;
|
|
63
|
-
enterpriseId?: string;
|
|
64
|
-
[key: string]: any;
|
|
65
|
-
}
|
|
66
|
-
export interface ActionConstraints<A extends SlackAction = SlackAction> {
|
|
67
|
-
type?: A['type'];
|
|
68
|
-
block_id?: A extends BlockAction ? string | RegExp : never;
|
|
69
|
-
action_id?: A extends BlockAction ? string | RegExp : never;
|
|
70
|
-
callback_id?: Extract<A, {
|
|
71
|
-
callback_id?: string;
|
|
72
|
-
}> extends any ? string | RegExp : never;
|
|
73
|
-
}
|
|
74
|
-
export interface ShortcutConstraints<S extends SlackShortcut = SlackShortcut> {
|
|
75
|
-
type?: S['type'];
|
|
76
|
-
callback_id?: string | RegExp;
|
|
77
|
-
}
|
|
78
|
-
export interface ViewConstraints {
|
|
79
|
-
callback_id?: string | RegExp;
|
|
80
|
-
type?: 'view_closed' | 'view_submission';
|
|
81
|
-
}
|
|
82
|
-
export interface ErrorHandler {
|
|
83
|
-
(error: CodedError): Promise<void>;
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* A Slack App
|
|
87
|
-
*/
|
|
88
|
-
export default class App {
|
|
89
|
-
/** Slack Web API client */
|
|
90
|
-
client: WebClient;
|
|
91
|
-
private clientOptions;
|
|
92
|
-
private clients;
|
|
93
|
-
/** Receiver - ingests events from the Slack platform */
|
|
94
|
-
private receiver;
|
|
95
|
-
/** Logger */
|
|
96
|
-
private logger;
|
|
97
|
-
/** Log Level */
|
|
98
|
-
private logLevel;
|
|
99
|
-
/** Authorize */
|
|
100
|
-
private authorize;
|
|
101
|
-
/** Global middleware chain */
|
|
102
|
-
private middleware;
|
|
103
|
-
/** Listener middleware chains */
|
|
104
|
-
private listeners;
|
|
105
|
-
private errorHandler;
|
|
106
|
-
private axios;
|
|
107
|
-
private installerOptions;
|
|
108
|
-
private socketMode;
|
|
109
|
-
private developerMode;
|
|
110
|
-
constructor({ signingSecret, endpoints, customRoutes, agent, clientTls, receiver, convoStore, token, appToken, botId, botUserId, authorize, logger, logLevel, ignoreSelf, clientOptions, processBeforeResponse, signatureVerification, clientId, clientSecret, stateSecret, redirectUri, installationStore, scopes, installerOptions, socketMode, developerMode, tokenVerificationEnabled, }?: AppOptions);
|
|
111
|
-
/**
|
|
112
|
-
* Register a new middleware, processed in the order registered.
|
|
113
|
-
*
|
|
114
|
-
* @param m global middleware function
|
|
115
|
-
*/
|
|
116
|
-
use(m: Middleware<AnyMiddlewareArgs>): this;
|
|
117
|
-
/**
|
|
118
|
-
* Register WorkflowStep middleware
|
|
119
|
-
*
|
|
120
|
-
* @param workflowStep global workflow step middleware function
|
|
121
|
-
*/
|
|
122
|
-
step(workflowStep: WorkflowStep): this;
|
|
123
|
-
/**
|
|
124
|
-
* Convenience method to call start on the receiver
|
|
125
|
-
*
|
|
126
|
-
* TODO: should replace HTTPReceiver in type definition with a generic that is constrained to Receiver
|
|
127
|
-
*
|
|
128
|
-
* @param args receiver-specific start arguments
|
|
129
|
-
*/
|
|
130
|
-
start(...args: Parameters<HTTPReceiver['start'] | SocketModeReceiver['start']>): ReturnType<HTTPReceiver['start']>;
|
|
131
|
-
stop(...args: any[]): Promise<unknown>;
|
|
132
|
-
event<EventType extends string = string>(eventName: EventType, ...listeners: Middleware<SlackEventMiddlewareArgs<EventType>>[]): void;
|
|
133
|
-
event<EventType extends RegExp = RegExp>(eventName: EventType, ...listeners: Middleware<SlackEventMiddlewareArgs<string>>[]): void;
|
|
134
|
-
message(...listeners: Middleware<SlackEventMiddlewareArgs<'message'>>[]): void;
|
|
135
|
-
message(pattern: string | RegExp, ...listeners: Middleware<SlackEventMiddlewareArgs<'message'>>[]): void;
|
|
136
|
-
shortcut<Shortcut extends SlackShortcut = SlackShortcut>(callbackId: string | RegExp, ...listeners: Middleware<SlackShortcutMiddlewareArgs<Shortcut>>[]): void;
|
|
137
|
-
shortcut<Shortcut extends SlackShortcut = SlackShortcut, Constraints extends ShortcutConstraints<Shortcut> = ShortcutConstraints<Shortcut>>(constraints: Constraints, ...listeners: Middleware<SlackShortcutMiddlewareArgs<Extract<Shortcut, {
|
|
138
|
-
type: Constraints['type'];
|
|
139
|
-
}>>>[]): void;
|
|
140
|
-
action<Action extends SlackAction = SlackAction>(actionId: string | RegExp, ...listeners: Middleware<SlackActionMiddlewareArgs<Action>>[]): void;
|
|
141
|
-
action<Action extends SlackAction = SlackAction, Constraints extends ActionConstraints<Action> = ActionConstraints<Action>>(constraints: Constraints, ...listeners: Middleware<SlackActionMiddlewareArgs<Extract<Action, {
|
|
142
|
-
type: Constraints['type'];
|
|
143
|
-
}>>>[]): void;
|
|
144
|
-
command(commandName: string | RegExp, ...listeners: Middleware<SlackCommandMiddlewareArgs>[]): void;
|
|
145
|
-
options<Source extends OptionsSource = 'block_suggestion'>(actionId: string | RegExp, ...listeners: Middleware<SlackOptionsMiddlewareArgs<Source>>[]): void;
|
|
146
|
-
options<Source extends OptionsSource = OptionsSource>(constraints: ActionConstraints, ...listeners: Middleware<SlackOptionsMiddlewareArgs<Source>>[]): void;
|
|
147
|
-
view<ViewActionType extends SlackViewAction = SlackViewAction>(callbackId: string | RegExp, ...listeners: Middleware<SlackViewMiddlewareArgs<ViewActionType>>[]): void;
|
|
148
|
-
view<ViewActionType extends SlackViewAction = SlackViewAction>(constraints: ViewConstraints, ...listeners: Middleware<SlackViewMiddlewareArgs<ViewActionType>>[]): void;
|
|
149
|
-
error(errorHandler: ErrorHandler): void;
|
|
150
|
-
/**
|
|
151
|
-
* Handles events from the receiver
|
|
152
|
-
*/
|
|
153
|
-
processEvent(event: ReceiverEvent): Promise<void>;
|
|
154
|
-
/**
|
|
155
|
-
* Global error handler. The final destination for all errors (hopefully).
|
|
156
|
-
*/
|
|
157
|
-
private handleError;
|
|
158
|
-
}
|
|
159
|
-
//# sourceMappingURL=App.d.ts.map
|
package/dist/App.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../src/App.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,KAAK,CAAC;AAE3C,OAAO,EAAE,SAAS,EAA4C,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvG,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAiB,MAAM,eAAe,CAAC;AAEhE,OAAO,kBAAkB,MAAM,gCAAgC,CAAC;AAChE,OAAO,YAAY,EAAE,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAe7E,OAAO,EAAE,iBAAiB,EAAoC,MAAM,sBAAsB,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,yBAAyB,EACzB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC3B,uBAAuB,EACvB,WAAW,EAEX,aAAa,EAKb,aAAa,EACb,WAAW,EAEX,eAAe,EACf,QAAQ,EACR,aAAa,EAUd,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,UAAU,EAA0E,MAAM,UAAU,CAAC;AAiB9G,iCAAiC;AACjC,MAAM,WAAW,UAAU;IACzB,aAAa,CAAC,EAAE,mBAAmB,CAAC,eAAe,CAAC,CAAC;IACrD,SAAS,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC7C,YAAY,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACnD,qBAAqB,CAAC,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;IACrE,qBAAqB,CAAC,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;IACrE,QAAQ,CAAC,EAAE,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC3C,YAAY,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACnD,WAAW,CAAC,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAC;IACjD,WAAW,CAAC,EAAE,mBAAmB,CAAC,aAAa,CAAC,CAAA;IAChD,iBAAiB,CAAC,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;IAC7D,MAAM,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IACvC,gBAAgB,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;IAC3D,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,SAAS,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,KAAK,GAAG,KAAK,GAAG,YAAY,GAAG,MAAM,GAAG,IAAI,CAAC,CAAC;IACrF,UAAU,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC;IACvC,KAAK,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACzC,SAAS,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC,CAAC;IAC/B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;IACtD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEjD,2GAA2G;AAC3G,MAAM,WAAW,SAAS,CAAC,mBAAmB,SAAS,OAAO,GAAG,KAAK;IACpE,CAAC,MAAM,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,EAAE,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAChH;AAED,uGAAuG;AACvG,MAAM,WAAW,mBAAmB,CAAC,mBAAmB,SAAS,OAAO,GAAG,KAAK;IAC9E,MAAM,EAAE,mBAAmB,SAAS,IAAI,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC;IACvE,YAAY,EAAE,mBAAmB,SAAS,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,mBAAmB,CAAC;CAC1C;AAED,+FAA+F;AAC/F,MAAM,WAAW,eAAe;IAE9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IAGtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IACpE,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,QAAQ,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;IAC3D,SAAS,CAAC,EAAE,CAAC,SAAS,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;IAE5D,WAAW,CAAC,EAAE,OAAO,CAAC,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,SAAS,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;CAC1F;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,aAAa,GAAG,aAAa;IAC1E,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B,IAAI,CAAC,EAAE,aAAa,GAAG,iBAAiB,CAAC;CAC1C;AAED,MAAM,WAAW,YAAY;IAC3B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpC;AAgBD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,GAAG;IACtB,2BAA2B;IACpB,MAAM,EAAE,SAAS,CAAC;IAEzB,OAAO,CAAC,aAAa,CAAmB;IAGxC,OAAO,CAAC,OAAO,CAAuD;IAEtE,wDAAwD;IACxD,OAAO,CAAC,QAAQ,CAAW;IAE3B,aAAa;IACb,OAAO,CAAC,MAAM,CAAS;IAEvB,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAW;IAE3B,gBAAgB;IAChB,OAAO,CAAC,SAAS,CAAsB;IAEvC,8BAA8B;IAC9B,OAAO,CAAC,UAAU,CAAkC;IAEpD,iCAAiC;IACjC,OAAO,CAAC,SAAS,CAAoC;IAErD,OAAO,CAAC,YAAY,CAAe;IAEnC,OAAO,CAAC,KAAK,CAAgB;IAE7B,OAAO,CAAC,gBAAgB,CAA0C;IAElE,OAAO,CAAC,UAAU,CAAU;IAE5B,OAAO,CAAC,aAAa,CAAU;gBAEZ,EACjB,aAAyB,EACzB,SAAqB,EACrB,YAAwB,EACxB,KAAiB,EACjB,SAAqB,EACrB,QAAoB,EACpB,UAAsB,EACtB,KAAiB,EACjB,QAAoB,EACpB,KAAiB,EACjB,SAAqB,EACrB,SAAqB,EACrB,MAAkB,EAClB,QAAoB,EACpB,UAAiB,EACjB,aAAyB,EACzB,qBAA6B,EAC7B,qBAA4B,EAC5B,QAAoB,EACpB,YAAwB,EACxB,WAAuB,EACvB,WAAuB,EACvB,iBAA6B,EAC7B,MAAkB,EAClB,gBAA4B,EAC5B,UAAsB,EACtB,aAAqB,EACrB,wBAA+B,GAChC,GAAE,UAAe;IAqMlB;;;;OAIG;IACI,GAAG,CAAC,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,IAAI;IAKlD;;;;OAIG;IACI,IAAI,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAM7C;;;;;;OAMG;IACI,KAAK,CACV,GAAG,IAAI,EAAE,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC,GACvE,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAM7B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAItC,KAAK,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,EAC5C,SAAS,EAAE,SAAS,EACpB,GAAG,SAAS,EAAE,UAAU,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,EAAE,GAC9D,IAAI;IACA,KAAK,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,EAC5C,SAAS,EAAE,SAAS,EACpB,GAAG,SAAS,EAAE,UAAU,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,EAAE,GAC3D,IAAI;IA6BA,OAAO,CAAC,GAAG,SAAS,EAAE,UAAU,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,IAAI;IAC9E,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,EAAE,UAAU,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,IAAI;IAgBxG,QAAQ,CAAC,QAAQ,SAAS,aAAa,GAAG,aAAa,EAC5D,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,GAAG,SAAS,EAAE,UAAU,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,EAAE,GAChE,IAAI;IACA,QAAQ,CACb,QAAQ,SAAS,aAAa,GAAG,aAAa,EAC9C,WAAW,SAAS,mBAAmB,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,QAAQ,CAAC,EAEjF,WAAW,EAAE,WAAW,EACxB,GAAG,SAAS,EAAE,UAAU,CAAC,2BAA2B,CAAC,OAAO,CAAC,QAAQ,EAAE;QAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CAAC,CAAC,EAAE,GACxG,IAAI;IA8BA,MAAM,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,EACpD,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,GAAG,SAAS,EAAE,UAAU,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,EAAE,GAC5D,IAAI;IACA,MAAM,CACX,MAAM,SAAS,WAAW,GAAG,WAAW,EACxC,WAAW,SAAS,iBAAiB,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,EAEzE,WAAW,EAAE,WAAW,EAExB,GAAG,SAAS,EAAE,UAAU,CAAC,yBAAyB,CAAC,OAAO,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;KAAE,CAAC,CAAC,CAAC,EAAE,GACpG,IAAI;IA2BA,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,EAAE,UAAU,CAAC,0BAA0B,CAAC,EAAE,GAAG,IAAI;IAInG,OAAO,CAAC,MAAM,SAAS,aAAa,GAAG,kBAAkB,EAC9D,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,GAAG,SAAS,EAAE,UAAU,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,EAAE,GAC7D,IAAI;IAEA,OAAO,CAAC,MAAM,SAAS,aAAa,GAAG,aAAa,EACzD,WAAW,EAAE,iBAAiB,EAC9B,GAAG,SAAS,EAAE,UAAU,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC,EAAE,GAC7D,IAAI;IAaA,IAAI,CAAC,cAAc,SAAS,eAAe,GAAG,eAAe,EAClE,UAAU,EAAE,MAAM,GAAG,MAAM,EAC3B,GAAG,SAAS,EAAE,UAAU,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC,EAAE,GAClE,IAAI;IACA,IAAI,CAAC,cAAc,SAAS,eAAe,GAAG,eAAe,EAClE,WAAW,EAAE,eAAe,EAC5B,GAAG,SAAS,EAAE,UAAU,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC,EAAE,GAClE,IAAI;IA6BA,KAAK,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAI9C;;OAEG;IACU,YAAY,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAsP9D;;OAEG;IACH,OAAO,CAAC,WAAW;CAGpB"}
|