slack.ts 0.0.10 → 0.0.11
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/dist/src/api/index.d.ts +14 -3
- package/dist/src/api/index.d.ts.map +1 -1
- package/dist/src/api/index.js +1 -0
- package/dist/src/api/web/users.d.ts +29 -1
- package/dist/src/api/web/users.d.ts.map +1 -1
- package/dist/src/client.d.ts +12 -8
- package/dist/src/client.d.ts.map +1 -1
- package/dist/src/client.js +17 -1
- package/dist/src/utils/paginate.d.ts.map +1 -1
- package/dist/src/utils/paginate.js +3 -6
- package/package.json +2 -1
package/dist/src/api/index.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { SlackApiMap } from "slack-undoc-client";
|
|
1
2
|
import type { CursorPaginationResponse } from "./types/api.js";
|
|
2
3
|
import type { AppsConnectionsOpenParams, AppsConnectionsOpenResponse, AppsManifestCreateParams, AppsManifestCreateResponse, AppsManifestDeleteParams, AppsManifestDeleteResponse, AppsManifestExportParams, AppsManifestExportResponse, AppsManifestUpdateParams, AppsManifestUpdateResponse, AppsManifestValidateParams, AppsManifestValidateResponse, AppsUninstallParams, AppsUninstallResponse } from "./web/apps.js";
|
|
3
4
|
import type { AuthRevokeParams, AuthRevokeResponse, AuthTeamsListParams, AuthTeamsListResponse, AuthTestParams, AuthTestResponse } from "./web/auth.js";
|
|
@@ -5,9 +6,13 @@ import type { BotsInfoParams, BotsInfoResponse } from "./web/bots.js";
|
|
|
5
6
|
import type { ChatPostEphemeralParams, ChatPostEphemeralResponse, ChatPostMessageParams, ChatPostMessageResponse } from "./web/chat.js";
|
|
6
7
|
import type { ConversationsHistoryParams, ConversationsHistoryResponse, ConversationsInfoParams, ConversationsInfoResponse, ConversationsListParams, ConversationsListResponse, ConversationsRepliesParams, ConversationsRepliesResponse } from "./web/conversations.js";
|
|
7
8
|
import type { FilesCompleteUploadExternalParams, FilesCompleteUploadExternalResponse, FilesGetUploadURLExternalParams, FilesGetUploadURLExternalResponse } from "./web/files.js";
|
|
8
|
-
import type { UsersInfoParams, UsersInfoResponse } from "./web/users.js";
|
|
9
|
+
import type { UsersInfoParams, UsersInfoResponse, UsersProfileSetParams, UsersProfileSetResponse } from "./web/users.js";
|
|
9
10
|
import type { ViewsOpenParams, ViewsOpenResponse } from "./web/views.js";
|
|
10
|
-
|
|
11
|
+
interface SlackWebAPIMapInternal {
|
|
12
|
+
"users.profile.set": {
|
|
13
|
+
params: UsersProfileSetParams;
|
|
14
|
+
response: UsersProfileSetResponse;
|
|
15
|
+
};
|
|
11
16
|
"bots.info": {
|
|
12
17
|
params: BotsInfoParams;
|
|
13
18
|
response: BotsInfoResponse;
|
|
@@ -93,12 +98,17 @@ export interface SlackWebAPIMap {
|
|
|
93
98
|
response: ViewsOpenResponse;
|
|
94
99
|
};
|
|
95
100
|
}
|
|
101
|
+
export interface SlackWebAPIMap extends SlackWebAPIMapInternal, Omit<SlackApiMap, keyof SlackWebAPIMapInternal> {
|
|
102
|
+
}
|
|
96
103
|
export type SlackAPIMethod = keyof SlackWebAPIMap;
|
|
97
104
|
export type SlackPaginatingAPIMethod = {
|
|
98
105
|
[K in SlackAPIMethod]: SlackWebAPIMap[K]["response"] extends CursorPaginationResponse ? K : never;
|
|
99
106
|
}[SlackAPIMethod];
|
|
100
107
|
export type SlackAPIParams<Method extends SlackAPIMethod> = SlackWebAPIMap[Method]["params"] & {
|
|
101
|
-
token?: string
|
|
108
|
+
token?: string | {
|
|
109
|
+
cookie: string;
|
|
110
|
+
token: string;
|
|
111
|
+
};
|
|
102
112
|
};
|
|
103
113
|
export type SlackAPIResponse<Method extends SlackAPIMethod> = {
|
|
104
114
|
ok: false;
|
|
@@ -107,4 +117,5 @@ export type SlackAPIResponse<Method extends SlackAPIMethod> = {
|
|
|
107
117
|
ok: true;
|
|
108
118
|
} & SlackWebAPIMap[Method]["response"]);
|
|
109
119
|
export declare const POST_METHODS: SlackAPIMethod[];
|
|
120
|
+
export {};
|
|
110
121
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EACX,yBAAyB,EACzB,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACX,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EAChB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,KAAK,EACX,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACX,0BAA0B,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EACX,iCAAiC,EACjC,mCAAmC,EACnC,+BAA+B,EAC/B,iCAAiC,EACjC,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EACX,yBAAyB,EACzB,2BAA2B,EAC3B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,wBAAwB,EACxB,0BAA0B,EAC1B,0BAA0B,EAC1B,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACX,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EAChB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAClE,OAAO,KAAK,EACX,uBAAuB,EACvB,yBAAyB,EACzB,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EACX,0BAA0B,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,KAAK,EACX,iCAAiC,EACjC,mCAAmC,EACnC,+BAA+B,EAC/B,iCAAiC,EACjC,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EACX,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAErE,UAAU,sBAAsB;IAC/B,mBAAmB,EAAE;QACpB,MAAM,EAAE,qBAAqB,CAAA;QAC7B,QAAQ,EAAE,uBAAuB,CAAA;KACjC,CAAA;IACD,WAAW,EAAE;QACZ,MAAM,EAAE,cAAc,CAAA;QACtB,QAAQ,EAAE,gBAAgB,CAAA;KAC1B,CAAA;IACD,iBAAiB,EAAE;QAClB,MAAM,EAAE,mBAAmB,CAAA;QAC3B,QAAQ,EAAE,qBAAqB,CAAA;KAC/B,CAAA;IACD,aAAa,EAAE;QACd,MAAM,EAAE,gBAAgB,CAAA;QACxB,QAAQ,EAAE,kBAAkB,CAAA;KAC5B,CAAA;IAED,uBAAuB,EAAE;QACxB,MAAM,EAAE,yBAAyB,CAAA;QACjC,QAAQ,EAAE,2BAA2B,CAAA;KACrC,CAAA;IACD,sBAAsB,EAAE;QACvB,MAAM,EAAE,wBAAwB,CAAA;QAChC,QAAQ,EAAE,0BAA0B,CAAA;KACpC,CAAA;IACD,sBAAsB,EAAE;QACvB,MAAM,EAAE,wBAAwB,CAAA;QAChC,QAAQ,EAAE,0BAA0B,CAAA;KACpC,CAAA;IACD,sBAAsB,EAAE;QACvB,MAAM,EAAE,wBAAwB,CAAA;QAChC,QAAQ,EAAE,0BAA0B,CAAA;KACpC,CAAA;IACD,sBAAsB,EAAE;QACvB,MAAM,EAAE,wBAAwB,CAAA;QAChC,QAAQ,EAAE,0BAA0B,CAAA;KACpC,CAAA;IACD,wBAAwB,EAAE;QACzB,MAAM,EAAE,0BAA0B,CAAA;QAClC,QAAQ,EAAE,4BAA4B,CAAA;KACtC,CAAA;IACD,gBAAgB,EAAE;QACjB,MAAM,EAAE,mBAAmB,CAAA;QAC3B,QAAQ,EAAE,qBAAqB,CAAA;KAC/B,CAAA;IACD,WAAW,EAAE;QACZ,MAAM,EAAE,cAAc,CAAA;QACtB,QAAQ,EAAE,gBAAgB,CAAA;KAC1B,CAAA;IACD,oBAAoB,EAAE;QACrB,MAAM,EAAE,uBAAuB,CAAA;QAC/B,QAAQ,EAAE,yBAAyB,CAAA;KACnC,CAAA;IACD,kBAAkB,EAAE;QACnB,MAAM,EAAE,qBAAqB,CAAA;QAC7B,QAAQ,EAAE,uBAAuB,CAAA;KACjC,CAAA;IACD,uBAAuB,EAAE;QACxB,MAAM,EAAE,0BAA0B,CAAA;QAClC,QAAQ,EAAE,4BAA4B,CAAA;KACtC,CAAA;IACD,oBAAoB,EAAE;QACrB,MAAM,EAAE,uBAAuB,CAAA;QAC/B,QAAQ,EAAE,yBAAyB,CAAA;KACnC,CAAA;IACD,oBAAoB,EAAE;QACrB,MAAM,EAAE,uBAAuB,CAAA;QAC/B,QAAQ,EAAE,yBAAyB,CAAA;KACnC,CAAA;IACD,uBAAuB,EAAE;QACxB,MAAM,EAAE,0BAA0B,CAAA;QAClC,QAAQ,EAAE,4BAA4B,CAAA;KACtC,CAAA;IACD,8BAA8B,EAAE;QAC/B,MAAM,EAAE,iCAAiC,CAAA;QACzC,QAAQ,EAAE,mCAAmC,CAAA;KAC7C,CAAA;IACD,4BAA4B,EAAE;QAC7B,MAAM,EAAE,+BAA+B,CAAA;QACvC,QAAQ,EAAE,iCAAiC,CAAA;KAC3C,CAAA;IACD,YAAY,EAAE;QACb,MAAM,EAAE,eAAe,CAAA;QACvB,QAAQ,EAAE,iBAAiB,CAAA;KAC3B,CAAA;IACD,YAAY,EAAE;QACb,MAAM,EAAE,eAAe,CAAA;QACvB,QAAQ,EAAE,iBAAiB,CAAA;KAC3B,CAAA;CACD;AAED,MAAM,WAAW,cAChB,SAAQ,sBAAsB,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,sBAAsB,CAAC;CAAG;AAEnF,MAAM,MAAM,cAAc,GAAG,MAAM,cAAc,CAAA;AACjD,MAAM,MAAM,wBAAwB,GAAG;KACrC,CAAC,IAAI,cAAc,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,wBAAwB,GAAG,CAAC,GAAG,KAAK;CACjG,CAAC,cAAc,CAAC,CAAA;AACjB,MAAM,MAAM,cAAc,CAAC,MAAM,SAAS,cAAc,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG;IAC9F,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAClD,CAAA;AACD,MAAM,MAAM,gBAAgB,CAAC,MAAM,SAAS,cAAc,IACvD;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC5B,CAAC;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtD,eAAO,MAAM,YAAY,EAAE,cAAc,EAcxC,CAAA"}
|
package/dist/src/api/index.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { User } from "../types/user.js";
|
|
1
|
+
import type { User, UserProfile } from "../types/user.js";
|
|
2
2
|
export interface UsersInfoParams {
|
|
3
3
|
/** User to get info on */
|
|
4
4
|
user: string;
|
|
@@ -8,4 +8,32 @@ export interface UsersInfoParams {
|
|
|
8
8
|
export interface UsersInfoResponse {
|
|
9
9
|
user: User;
|
|
10
10
|
}
|
|
11
|
+
interface ProfileUpdate {
|
|
12
|
+
display_name?: string;
|
|
13
|
+
email?: string;
|
|
14
|
+
first_name?: string;
|
|
15
|
+
last_name?: string;
|
|
16
|
+
phone?: string;
|
|
17
|
+
pronouns?: string;
|
|
18
|
+
real_name?: string;
|
|
19
|
+
start_date?: string;
|
|
20
|
+
title?: string;
|
|
21
|
+
fields?: Record<string, {
|
|
22
|
+
value: string;
|
|
23
|
+
alt?: string;
|
|
24
|
+
}>;
|
|
25
|
+
}
|
|
26
|
+
export type UsersProfileSetParams = {} & ({
|
|
27
|
+
name: string;
|
|
28
|
+
value: string;
|
|
29
|
+
profile?: never;
|
|
30
|
+
} | {
|
|
31
|
+
name?: never;
|
|
32
|
+
value?: never;
|
|
33
|
+
profile: ProfileUpdate;
|
|
34
|
+
});
|
|
35
|
+
export interface UsersProfileSetResponse {
|
|
36
|
+
profile: UserProfile;
|
|
37
|
+
}
|
|
38
|
+
export {};
|
|
11
39
|
//# sourceMappingURL=users.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../../src/api/web/users.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../../src/api/web/users.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEtD,MAAM,WAAW,eAAe;IAC/B,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;IAEZ,kFAAkF;IAClF,cAAc,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,iBAAiB;IACjC,IAAI,EAAE,IAAI,CAAA;CACV;AAED,UAAU,aAAa;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CACxD;AAED,MAAM,MAAM,qBAAqB,GAAG,EAAE,GAAG,CACtC;IACA,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;CACd,GACD;IACA,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,EAAE,aAAa,CAAA;CACrB,CACH,CAAA;AAED,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,WAAW,CAAA;CACpB"}
|
package/dist/src/client.d.ts
CHANGED
|
@@ -25,7 +25,10 @@ type ReceiverOptions = ({
|
|
|
25
25
|
options?: never;
|
|
26
26
|
};
|
|
27
27
|
interface AppOptions {
|
|
28
|
-
token?: string
|
|
28
|
+
token?: string | {
|
|
29
|
+
cookie: string;
|
|
30
|
+
token: string;
|
|
31
|
+
};
|
|
29
32
|
receiver?: ReceiverOptions;
|
|
30
33
|
}
|
|
31
34
|
export type MessageCallbackData = {
|
|
@@ -87,16 +90,17 @@ export declare class App extends EventEmitter<AppEventMap> {
|
|
|
87
90
|
*/
|
|
88
91
|
channel(id: string): ChannelRef;
|
|
89
92
|
channels<Types extends ("public_channel" | "private_channel" | "mpim" | "im")[]>(...types: Types): AsyncGenerator<Channel<ChannelTypeMap[Types[number]]>>;
|
|
90
|
-
/**
|
|
91
|
-
* Makes a Slack Web API request.
|
|
92
|
-
*
|
|
93
|
-
* @param method The Slack Web API method to call
|
|
94
|
-
* @param params The parameters for the method
|
|
95
|
-
* @returns The response from the API call
|
|
96
|
-
*/
|
|
97
93
|
request<Method extends SlackAPIMethod>(method: Method, params: SlackAPIParams<Method>): Promise<Extract<SlackAPIResponse<Method>, {
|
|
98
94
|
ok: true;
|
|
99
95
|
}>>;
|
|
96
|
+
request<Method extends string>(method: Method extends SlackAPIMethod ? never : Method, params: Record<string, unknown> & {
|
|
97
|
+
token?: string | {
|
|
98
|
+
cookie: string;
|
|
99
|
+
token: string;
|
|
100
|
+
};
|
|
101
|
+
}): Promise<{
|
|
102
|
+
ok: true;
|
|
103
|
+
} & Record<string, unknown>>;
|
|
100
104
|
}
|
|
101
105
|
type AppEventMap = {
|
|
102
106
|
event: [
|
package/dist/src/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAA;AACjC,OAAO,EAEN,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,MAAM,OAAO,CAAA;AACd,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACzF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGpE,OAAO,EAAwB,KAAK,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAC3F,OAAO,EAAsB,KAAK,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AACrF,OAAO,EAAqB,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAA;AACpF,OAAO,EAAE,MAAM,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,EAAW,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGtD,OAAO,EAAgB,KAAK,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,KAAK,EAEX,EAAE,EACF,IAAI,EACJ,cAAc,EACd,aAAa,EACb,MAAM,0BAA0B,CAAA;AAGjC,KAAK,eAAe,GACjB,CAAC;IACD,IAAI,EAAE,QAAQ,CAAA;CACb,GAAG,gBAAgB,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC,GAC5D,CAAC;IACD,IAAI,EAAE,MAAM,CAAA;CACX,GAAG,gBAAgB,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC,GAC1D,CAAC;IACD,IAAI,EAAE,OAAO,CAAA;CACZ,GAAG,gBAAgB,CAAC,wBAAwB,EAAE,QAAQ,CAAC,CAAC,GACzD;IACA,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAEJ,UAAU,UAAU;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAA;AACjC,OAAO,EAEN,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,MAAM,OAAO,CAAA;AACd,OAAO,KAAK,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACzF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EACX,WAAW,EACX,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,MAAM,iCAAiC,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAGpE,OAAO,EAAwB,KAAK,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAC3F,OAAO,EAAsB,KAAK,yBAAyB,EAAE,MAAM,kBAAkB,CAAA;AACrF,OAAO,EAAqB,KAAK,wBAAwB,EAAE,MAAM,mBAAmB,CAAA;AACpF,OAAO,EAAE,MAAM,EAAE,KAAK,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,EAAW,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAGtD,OAAO,EAAgB,KAAK,oBAAoB,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,KAAK,EAEX,EAAE,EACF,IAAI,EACJ,cAAc,EACd,aAAa,EACb,MAAM,0BAA0B,CAAA;AAGjC,KAAK,eAAe,GACjB,CAAC;IACD,IAAI,EAAE,QAAQ,CAAA;CACb,GAAG,gBAAgB,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC,GAC5D,CAAC;IACD,IAAI,EAAE,MAAM,CAAA;CACX,GAAG,gBAAgB,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC,GAC1D,CAAC;IACD,IAAI,EAAE,OAAO,CAAA;CACZ,GAAG,gBAAgB,CAAC,wBAAwB,EAAE,QAAQ,CAAC,CAAC,GACzD;IACA,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAEJ,UAAU,UAAU;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAClD,QAAQ,CAAC,EAAE,eAAe,CAAA;CAC1B;AAED,MAAM,MAAM,mBAAmB,GAAG;IACjC,OAAO,EAAE,eAAe,CAAA;IACxB,MAAM,EAAE,GAAG,CAAA;IACX,KAAK,EAAE,YAAY,CAAC,YAAY,CAAC,CAAA;CACjC,CAAA;AACD,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,OAAO,CAAA;AAEpE,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,SAAS,IAAI;IACxD,MAAM,EAAE,GAAG,CAAA;IACX,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,CAAA;CAC1B,CAAA;AACD,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,SAAS,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,CAAC,KAAK,OAAO,CAAA;AAEhG,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,WAAW,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,OAAO,CAAA;AAE3F,KAAK,cAAc,GAAG;IACrB,cAAc,EAAE,aAAa,CAAA;IAC7B,eAAe,EAAE,cAAc,CAAA;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,EAAE,EAAE,EAAE,CAAA;CACN,CAAA;AAED,qBAAa,GAAI,SAAQ,YAAY,CAAC,WAAW,CAAC;;gBAIrC,EAAE,KAAK,EAAE,QAA4B,EAAE,GAAE,UAAe;IAsEpE;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,eAAe;IAejC;;;;;;OAMG;IACH,KAAK,CAAC,KAAK,SAAS,SAAS,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC;IAMlF;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,SAAS,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAMxF;;;OAGG;IACG,KAAK;IAIX;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM;IAIX,QAAQ,CAAC,KAAK,SAAS,CAAC,gBAAgB,GAAG,iBAAiB,GAAG,MAAM,GAAG,IAAI,CAAC,EAAE,EACrF,GAAG,KAAK,EAAE,KAAK,GACb,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAMnD,OAAO,CAAC,MAAM,SAAS,cAAc,EAC1C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,GAC5B,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IAErD,OAAO,CAAC,MAAM,SAAS,MAAM,EAClC,MAAM,EAAE,MAAM,SAAS,cAAc,GAAG,KAAK,GAAG,MAAM,EACtD,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QACjC,KAAK,CAAC,EAAE,MAAM,GAAG;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAA;KAClD,GACC,OAAO,CAAC;QAAE,EAAE,EAAE,IAAI,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAgElD;AAED,KAAK,WAAW,GAAG;IAClB,KAAK,EAAE,CAAC,YAAY,CAAC,CAAA;IACrB,OAAO,EAAE,CAAC,YAAY,CAAC,CAAA;IACvB,MAAM,EAAE,CAAC,cAAc,CAAC,CAAA;IACxB,MAAM,EAAE,CAAC,cAAc,CAAC,CAAA;IACxB,OAAO,EAAE,CAAC,eAAe,CAAC,CAAA;IAC1B,gBAAgB,EAAE,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,CAAA;IAClD,KAAK,EAAE,CAAC,oBAAoB,CAAC,CAAA;CAC7B,GAAG;KACF,CAAC,IAAI,aAAa,IAAI,SAAS,CAAC,EAAE,GAAG;QACrC;YAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;YAAC,KAAK,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;SAAE;KACpE;CACD,GAAG;KACF,CAAC,IAAI,gBAAgB,IAAI,UAAU,CAAC,EAAE,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7E,GAAG;KACF,CAAC,IAAI,UAAU,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC;CAC3C,GAAG;KACF,CAAC,IAAI,gBAAgB,IAAI,UAAU,CAAC,IAAI,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CACvF,GAAG;KACF,CAAC,IAAI,UAAU,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC;CAC3C,GAAG;KACF,CAAC,IAAI,WAAW,MAAM,EAAE,GAAG,CAAC,eAAe,CAAC;CAC7C,GAAG;KACF,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,IAAI,WAAW,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;CAClG,GAAG;KACF,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,IAAI,WAAW,CAAC,CAAC,SAAS,CAAC,IAAI,MAAM,EAAE,GAAG;QACvF,eAAe,CAAC,CAAC,CAAC;KAClB;CACD,GAAG;KACF,CAAC,IAAI,kBAAkB,MAAM,EAAE,GAAG,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;CACnE,GAAG;KACF,CAAC,IAAI,IAAI,MAAM,EAAE,GAAG,CAAC,oBAAoB,CAAC;CAC3C,CAAA"}
|
package/dist/src/client.js
CHANGED
|
@@ -133,6 +133,15 @@ export class App extends EventEmitter {
|
|
|
133
133
|
/**
|
|
134
134
|
* Makes a Slack Web API request.
|
|
135
135
|
*
|
|
136
|
+
* This method can be used to call undocumented Slack API methods. Most of these methods require
|
|
137
|
+
* an `xoxd-` cookie and an `xoxc-` token, rather than the normal `xoxb-` and `xoxp-` tokens. You
|
|
138
|
+
* can obtain this cookie and token from a Slack browser session. Then, pass them in an object of
|
|
139
|
+
* the form `{ cookie: string; token: string }` to the `token` parameter.
|
|
140
|
+
*
|
|
141
|
+
* This method contains typings for some Slack API methods (broader support to come), as well as
|
|
142
|
+
* some undocumented methods (provided by the `slack-undoc-client` library). Use the undocumented
|
|
143
|
+
* endpoints at your own risk since they may break at any time.
|
|
144
|
+
*
|
|
136
145
|
* @param method The Slack Web API method to call
|
|
137
146
|
* @param params The parameters for the method
|
|
138
147
|
* @returns The response from the API call
|
|
@@ -158,7 +167,14 @@ export class App extends EventEmitter {
|
|
|
158
167
|
headers.append("Content-Type", "application/json; charset=utf-8");
|
|
159
168
|
}
|
|
160
169
|
if (params.token || this.#token) {
|
|
161
|
-
|
|
170
|
+
const token = params.token || this.#token;
|
|
171
|
+
if (typeof token === "string") {
|
|
172
|
+
headers.set("Authorization", `Bearer ${params.token || this.#token}`);
|
|
173
|
+
}
|
|
174
|
+
else if (token?.cookie && token?.token) {
|
|
175
|
+
headers.set("Cookie", `d=${token.cookie}`);
|
|
176
|
+
headers.set("Authorization", `Bearer ${token.token}`);
|
|
177
|
+
}
|
|
162
178
|
}
|
|
163
179
|
const res = await request(url.toString(), {
|
|
164
180
|
method: httpMethod,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paginate.d.ts","sourceRoot":"","sources":["../../../src/utils/paginate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAA;
|
|
1
|
+
{"version":3,"file":"paginate.d.ts","sourceRoot":"","sources":["../../../src/utils/paginate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAA;AAExF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AACpC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,wBAAuB,QAAQ,CAAC,MAAM,SAAS,wBAAwB,EAAE,CAAC,EACzE,MAAM,EAAE,GAAG,EACX,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG;IACtE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACd,EACD,SAAS,EAAE,CACV,QAAQ,EAAE,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;IAAE,EAAE,EAAE,IAAI,CAAA;CAAE,CAAC,KACrD,QAAQ,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,6CAgBnC"}
|
|
@@ -4,12 +4,9 @@ export async function* paginate(client, method, params, converter) {
|
|
|
4
4
|
if (remaining <= 0)
|
|
5
5
|
return;
|
|
6
6
|
while (true) {
|
|
7
|
-
const batch
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
limit: params.batch ?? undefined,
|
|
11
|
-
batch: undefined,
|
|
12
|
-
});
|
|
7
|
+
const { batch: _, ...payload } = params;
|
|
8
|
+
const body = { ...payload, cursor, limit: params.batch ?? undefined };
|
|
9
|
+
const batch = await client.request(method, body);
|
|
13
10
|
for await (const item of converter(batch)) {
|
|
14
11
|
yield item;
|
|
15
12
|
if (--remaining <= 0)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "slack.ts",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.11",
|
|
4
4
|
"description": "A fully-typed, opinionated Slack API library",
|
|
5
5
|
"author": "@jollyroger182",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,6 +46,7 @@
|
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"@slack/types": "^2.20.1",
|
|
49
|
+
"slack-undoc-client": "1.1.1",
|
|
49
50
|
"ws": "^8.20.0"
|
|
50
51
|
}
|
|
51
52
|
}
|