@pipedream/slack 0.4.11 → 0.4.13

package/slack.app.mjs

@@ -1,51 +1,10 @@
 import { WebClient } from "@slack/web-api";
+import constants from "./common/constants.mjs";
 
 export default {
   type: "app",
   app: "slack",
   propDefinitions: {
-    publicChannel: {
-      type: "string",
-      label: "Channel",
-      description: "Select a public channel",
-      async options({ prevContext }) {
-        const { cursor } = prevContext;
-        const types = [
-          "public_channel",
-        ];
-        const resp = await this.availableConversations(types.join(), cursor);
-        return {
-          options: resp.conversations.map((c) => ({
-            label: `${c.name}`,
-            value: c.id,
-          })),
-          context: {
-            cursor: resp.cursor,
-          },
-        };
-      },
-    },
-    privateChannel: {
-      type: "string",
-      label: "Channel",
-      description: "Select a private channel",
-      async options({ prevContext }) {
-        const { cursor } = prevContext;
-        const types = [
-          "private_channel",
-        ];
-        const resp = await this.availableConversations(types.join(), cursor);
-        return {
-          options: resp.conversations.map((c) => ({
-            label: `${c.name}`,
-            value: c.id,
-          })),
-          context: {
-            cursor: resp.cursor,
-          },
-        };
-      },
-    },
     user: {
       type: "string",
       label: "User",
@@ -64,7 +23,7 @@ export default {
         return {
           options: conversationsResp.conversations.map((c) => ({
             label: `@${userNames[c.user]}`,
-            value: c.id,
+            value: c.user || c.id,
           })),
           context: {
             userNames,
@@ -117,8 +76,8 @@ export default {
       label: "User Group",
       description: "The encoded ID of the User Group.",
       async options() {
-        const resp = await this.userGroups();
-        return resp.map((c) => ({
+        const { usergroups } = await this.usergroupsList();
+        return usergroups.map((c) => ({
           label: c.name,
           value: c.id,
         }));
@@ -128,20 +87,12 @@ export default {
       type: "string",
       label: "Reminder",
       description: "Select a reminder",
-      async options({ prevContext }) {
-        let { cursor } = prevContext;
-        let resp = await this.getRemindersForTeam();
-        return {
-          options: resp.reminders.map((c) => {
-            return {
-              label: c.text,
-              value: c.id,
-            };
-          }),
-          context: {
-            cursor: cursor,
-          },
-        };
+      async options() {
+        const { reminders } = await this.remindersList();
+        return reminders.map((c) => ({
+          label: c.text,
+          value: c.id,
+        }));
       },
     },
     conversation: {
@@ -155,7 +106,7 @@ export default {
           userNames: userNamesOrPromise,
         } = prevContext;
         if (types == null) {
-          const scopes = await this.scopes();
+          const { response_metadata: { scopes } } = await this.authTest();
           types = [
             "public_channel",
           ];
@@ -206,23 +157,78 @@ export default {
         };
       },
     },
+    channelId: {
+      type: "string",
+      label: "Channel ID",
+      description: "Select the channel's id.",
+      async options({
+        prevContext, types = [], channelsFilter = (channel) => channel, excludeArchived = true,
+      }) {
+        const {
+          channels,
+          response_metadata: { next_cursor: cursor },
+        } = await this.conversationsList({
+          types: types.join(),
+          cursor: prevContext.cursor,
+          limit: constants.LIMIT,
+          exclude_archived: excludeArchived,
+        });
+
+        const resourcesInfo = await Promise.all(
+          channels
+            .filter(channelsFilter)
+            .map(async ({
+              id: channelId,
+              is_im: isIm,
+              user,
+            }) => ({
+              channelId,
+              resource: isIm
+                ? await this.usersInfo({
+                  user,
+                })
+                : await this.conversationsInfo({
+                  channel: channelId,
+                }),
+            })),
+        );
+
+        const options =
+          resourcesInfo.map(({
+            channelId, resource,
+          }) => ({
+            value: channelId,
+            label: this.getChannelLabel(resource),
+          }));
+
+        return {
+          options,
+          context: {
+            cursor,
+          },
+        };
+      },
+    },
     team: {
       type: "string",
       label: "Team",
       description: "Select a team.",
       async options({ prevContext }) {
-        let { cursor } = prevContext;
-
-        const resp = await this.getTeams(cursor);
+        const {
+          teams,
+          response_metadata: { next_cursor: cursor },
+        } = await this.authTeamsList({
+          cursor: prevContext.cursor,
+        });
 
         return {
-          options: resp.teams.map((team) => ({
+          options: teams.map((team) => ({
             label: team.name,
             value: team.id,
           })),
 
           context: {
-            cursor: resp.cursor,
+            cursor,
           },
         };
       },
@@ -334,6 +340,9 @@ export default {
       label: "Icon (emoji)",
       description: "Optionally provide an emoji to use as the icon for this message. E.g., `:fire:` Overrides `icon_url`.  Must be used in conjunction with `as_user` set to `false`, otherwise ignored.",
       optional: true,
+      async options() {
+        return await this.getCustomEmojis()
+      }
     },
     content: {
       label: "File Path",
@@ -439,30 +448,51 @@ export default {
     },
   },
   methods: {
+    getChannelLabel(resource) {
+      if (resource.user) {
+        return `Direct Messaging with: @${resource.user.name}`;
+      }
+
+      const {
+        is_private: isPrivate,
+        name,
+      } = resource.channel;
+
+      return `${isPrivate && "Private" || "Public"} channel #${name}`;
+    },
     mySlackId() {
       return this.$auth.oauth_uid;
     },
+    getToken() {
+      return this.$auth.oauth_access_token;
+    },
     /**
      * Returns a Slack Web Client object authenticated with the user's access
      * token
      */
     sdk() {
-      return new WebClient(this.$auth.oauth_access_token);
-    },
-    /**
-     * This method returns the list of OAuth scopes the current authenticated
-     * user has
-     *
-     * @returns the list of scopes
-     */
-    async scopes() {
-      const resp = await this.sdk().auth.test();
-      if (resp.ok) {
-        return resp.response_metadata.scopes;
-      } else {
-        console.log("Error getting scopes", resp.error);
-        throw (resp.error);
+      return new WebClient(this.getToken());
+    },
+    async makeRequest({
+      method = "", ...args
+    } = {}) {
+      let response;
+      const props = method.split(".");
+      const sdk = props.reduce((reduction, prop) =>
+        reduction[prop], this.sdk());
+
+      try {
+        response = await sdk(args);
+      } catch (error) {
+        console.log(`Error calling ${method}`, error);
+        throw error;
       }
+
+      if (!response.ok) {
+        console.log(`Error in response with method ${method}`, response.error);
+        throw response.error;
+      }
+      return response;
     },
     /**
      * Returns a list of channel-like conversations in a workspace. The
@@ -477,73 +507,19 @@ export default {
      * page of conversations
      */
     async availableConversations(types, cursor) {
-      const params = {
+      const {
+        channels: conversations,
+        response_metadata: { next_cursor: nextCursor },
+      } = await this.usersConversations({
         types,
         cursor,
-        limit: 200,
+        limit: constants.LIMIT,
         exclude_archived: true,
-        user: this.$auth.oauth_uid,
-      };
-      const resp = await this.sdk().users.conversations(params);
-      if (resp.ok) {
-        return {
-          cursor: resp.response_metadata.next_cursor,
-          conversations: resp.channels,
-        };
-      } else {
-        console.log("Error getting conversations", resp.error);
-        throw (resp.error);
-      }
-    },
-    /**
-     * This method lists reminders created by or for a given user
-     *
-     * @returns an object containing a list of reminders
-     */
-    async getRemindersForTeam() {
-      const resp = await this.sdk().reminders.list();
-      if (resp.ok) {
-        return {
-          reminders: resp.reminders,
-        };
-      } else {
-        throw (resp.error);
-      }
-    },
-    /**
-     * Returns a list of all users in the workspace. This includes
-     * deleted/deactivated users.
-     *
-     * @param {string} [cursor] - a cursor returned by the previous API call,
-     * used to paginate through collections of data
-     * @returns an object containing a list of users and the cursor for the next
-     * page of users
-     */
-    async users(cursor) {
-      const resp = await this.sdk().users.list({
-        cursor,
       });
-      if (resp.ok) {
-        return {
-          users: resp.members,
-          cursor: resp.response_metadata.next_cursor,
-        };
-      } else {
-        console.log("Error getting users", resp.error);
-        throw (resp.error);
-      }
-    },
-    /**
-     * Returns a list of all users groups in the workspace.
-     */
-    async userGroups() {
-      const resp = await this.sdk().usergroups.list();
-      if (resp.ok) {
-        return resp.usergroups;
-      } else {
-        console.log("Error getting user groups", resp.error);
-        throw (resp.error);
-      }
+      return {
+        cursor: nextCursor,
+        conversations,
+      };
     },
     /**
      * Returns a mapping from user ID to user name for all users in the workspace
@@ -555,30 +531,229 @@ export default {
       const userNames = {};
       do {
         const {
-          users,
-          cursor: nextCursor,
-        } = await this.users(cursor);
+          members: users,
+          response_metadata: { next_cursor: nextCursor },
+        } = await this.usersList({
+          cursor,
+        });
+
         for (const user of users) {
           userNames[user.id] = user.name;
         }
+
         cursor = nextCursor;
       } while (cursor);
       return userNames;
     },
-    async getTeams(cursor) {
-      const resp = await this.sdk().auth.teams.list({
-        cursor,
+    /**
+     * Checks authentication & identity.
+     * @param {*} args Arguments object
+     * @returns Promise
+     */
+    authTest(args = {}) {
+      return this.makeRequest({
+        method: "auth.test",
+        ...args,
+      });
+    },
+    /**
+     * Lists all reminders created by or for a given user.
+     * @param {*} args Arguments object
+     * @param {string} [args.team_id] Encoded team id, required if org token is passed.
+     * E.g. `T1234567890`
+     * @returns Promise
+     */
+    remindersList(args = {}) {
+      return this.makeRequest({
+        method: "reminders.list",
+        ...args,
+      });
+    },
+    /**
+     * List all User Groups for a team
+     * @param {*} args
+     * @returns Promise
+     */
+    usergroupsList(args = {}) {
+      return this.makeRequest({
+        method: "usergroups.list",
+        ...args,
+      });
+    },
+    authTeamsList(args = {}) {
+      return this.makeRequest({
+        method: "auth.teams.list",
+        ...args,
       });
+    },
+    /**
+     * List conversations the calling user may access.
+     * Bot Scopes: `channels:read` `groups:read` `im:read` `mpim:read`
+     * @param {UsersConversationsArguments}       args Arguments object
+     * @param {string}  [args.cursor] Pagination value e.g. (`dXNlcjpVMDYxTkZUVDI=`)
+     * @param {boolean} [args.exclude_archived] Set to `true` to exclude archived channels
+     * from the list. Defaults to `false`
+     * @param {number}  [args.limit] Pagination value. Defaults to `0`
+     * @param {string}  [args.team_id] Encoded team id to list users in,
+     * required if org token is used
+     * @param {string}  [args.types] Mix and match channel types by providing a
+     * comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
+     * Defaults to `public_channel`. E.g. `im,mpim`
+     * @param {string}  [args.user] Browse conversations by a specific
+     * user ID's membership. Non-public channels are restricted to those where the calling user
+     * shares membership. E.g `W0B2345D`
+     * @returns Promise
+     */
+    usersConversations(args = {}) {
+      return this.makeRequest({
+        method: "users.conversations",
+        user: this.$auth.oauth_uid,
+        ...args,
+      });
+    },
+    /**
+     * Lists all users in a Slack team.
+     * Bot Scopes: `users:read`
+     * @param {UsersListArguments}  args Arguments object
+     * @param {string}  [args.cursor] Pagination value e.g. (`dXNlcjpVMDYxTkZUVDI=`)
+     * @param {boolean} [args.include_locale] Set this to `true` to receive the locale
+     * for users. Defaults to `false`
+     * @param {number}  [args.limit] Pagination value. Defaults to `0`
+     * @param {string}  [args.team_id] Encoded team id to list users in,
+     * required if org token is used
+     * @returns Promise
+     */
+    usersList(args = {}) {
+      return this.makeRequest({
+        method: "users.list",
+        ...args,
+      });
+    },
+    /**
+     * Lists all channels in a Slack team.
+     * Bot Scopes: `channels:read` `groups:read` `im:read` `mpim:read`
+     * @param {ConversationsListArguments} args Arguments object
+     * @param {string}  [args.cursor] Pagination value e.g. (`dXNlcjpVMDYxTkZUVDI=`)
+     * @param {boolean} [args.exclude_archived] Set to `true` to exclude archived channels
+     * from the list. Defaults to `false`
+     * @param {number}  [args.limit] pagination value. Defaults to `0`
+     * @param {string}  [args.team_id] encoded team id to list users in,
+     * required if org token is used
+     * @param {string}  [args.types] Mix and match channel types by providing a
+     * comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
+     * Defaults to `public_channel`. E.g. `im,mpim`
+     * @returns Promise
+     */
+    conversationsList(args = {}) {
+      return this.makeRequest({
+        method: "conversations.list",
+        ...args,
+      });
+    },
+    /**
+     * Fetches a conversation's history of messages and events.
+     * Bot Scopes: `channels:history` `groups:history` `im:history` `mpim:history`
+     * @param {ConversationsHistoryArguments} args Arguments object
+     * @param {string}  args.channel Conversation ID to fetch history for. E.g. `C1234567890`
+     * @param {string}  [args.cursor] Pagination value e.g. (`dXNlcjpVMDYxTkZUVDI=`)
+     * @param {boolean} [args.include_all_metadata]
+     * @param {boolean} [args.inclusive]
+     * @param {string}  [args.latest]
+     * @param {number}  [args.limit]
+     * @param {string}  [args.oldest]
+     * @returns Promise
+     */
+    conversationsHistory(args = {}) {
+      return this.makeRequest({
+        method: "conversations.history",
+        ...args,
+      });
+    },
+    /**
+     * Retrieve information about a conversation.
+     * Bot Scopes: `channels:read` `groups:read` `im:read` `mpim:read`
+     * @param {ConversationsInfoArguments} args Arguments object
+     * @param {string}  args.channel Conversation ID to learn more about. E.g. `C1234567890`
+     * @param {boolean} [args.include_locale] Set this to `true` to receive the locale
+     * for users. Defaults to `false`
+     * @param {boolean} [args.include_num_members] Set to true to include the
+     * member count for the specified conversation. Defaults to `false`
+     * @returns Promise
+     */
+    conversationsInfo(args = {}) {
+      return this.makeRequest({
+        method: "conversations.info",
+        ...args,
+      });
+    },
+    /**
+     * Retrieve information about a conversation.
+     * Bot Scopes: `users:read`
+     * @param {UsersInfoArguments}       args arguments object
+     * @param {string}  args.user User to get info on. E.g. `W1234567890`
+     * @param {boolean} [args.include_locale] Set this to true to receive the locale
+     * for this user. Defaults to `false`
+     * @returns Promise
+     */
+    usersInfo(args = {}) {
+      return this.makeRequest({
+        method: "users.info",
+        ...args,
+      });
+    },
+    /**
+     * Searches for messages matching a query.
+     * User Scopes: `search:read`
+     * @param {SearchMessagesArguments} args Arguments object
+     * @param {string}  args.query Search query
+     * @param {number}  [args.count] Number of items to return per page. Default `20`
+     * @param {string}  [args.cursor] Use this when getting results with cursormark
+     * pagination. For first call send `*` for subsequent calls, send the value of
+     * `next_cursor` returned in the previous call's results
+     * @param {boolean} [args.highlight]
+     * @param {number}  [args.page]
+     * @param {string}  [args.sort]
+     * @param {string}  [args.sort_dir]
+     * @param {string}  [args.team_id] Encoded team id to search in,
+     * required if org token is used. E.g. `T1234567890`
+     * @returns Promise
+     */
+    searchMessages(args = {}) {
+      return this.makeRequest({
+        method: "search.messages",
+        ...args,
+      });
+    },
+    /**
+     * Lists reactions made by a user.
+     * User Scopes: `reactions:read`
+     * Bot Scopes: `reactions:read`
+     * @param {ReactionsListArguments} args Arguments object
+     * @param {number}  [args.count] Number of items to return per page. Default `100`
+     * @param {string}  [args.cursor] Parameter for pagination. Set cursor equal to the
+     * `next_cursor` attribute returned by the previous request's response_metadata.
+     * This parameter is optional, but pagination is mandatory: the default value simply
+     * fetches the first "page" of the collection.
+     * @param {boolean} [args.full] If true always return the complete reaction list.
+     * @param {number}  [args.limit] The maximum number of items to return.
+     * Fewer than the requested number of items may be returned, even if the end of the
+     * list hasn't been reached.
+     * @param {number}  [args.page] Page number of results to return. Defaults to `1`.
+     * @param {string}  [args.team_id] Encoded team id to list reactions in,
+     * required if org token is used
+     * @param {string}  [args.user] Show reactions made by this user. Defaults to the authed user.
+     * @returns Promise
+     */
+    reactionsList(args = {}) {
+      return this.makeRequest({
+        method: "reactions.list",
+        ...args,
+      });
+    },
+    async getCustomEmojis(cursor) {
+      const resp = await this.sdk().emoji.list();
 
-      if (resp.ok) {
-        return {
-          cursor: resp.response_metadata.next_cursor,
-          teams: resp.teams,
-        };
-      } else {
-        console.log("Error getting teams", resp.error);
-        throw (resp.error);
-      }
+      return Object.keys(resp.emoji)
     },
   },
 };

package/sources/common/constants.mjs

@@ -24,7 +24,18 @@ const eventsOptions = [
   },
 ];
 
-export {
+const SUBTYPE = {
+  NULL: null,
+  BOT_MESSAGE: "bot_message",
+  FILE_SHARE: "file_share",
+  PD_HISTORY_MESSAGE: "pd_history_message",
+};
+
+const ALLOWED_SUBTYPES = Object.values(SUBTYPE);
+
+export default {
   events,
   eventsOptions,
+  SUBTYPE,
+  ALLOWED_SUBTYPES,
 };

package/sources/new-direct-message/new-direct-message.mjs

@@ -4,7 +4,7 @@ export default {
   ...common,
   key: "slack-new-direct-message",
   name: "New Direct Message (Instant)",
-  version: "1.0.5",
+  version: "1.0.6",
   description: "Emit new event when a message was posted in a direct message channel",
   type: "source",
   dedupe: "unique",

package/sources/new-interaction-event-received/new-interaction-event-received.mjs

@@ -2,7 +2,7 @@ import common from "../common/base.mjs";
 
 export default {
   name: "New Interaction Events",
-  version: "0.0.2",
+  version: "0.0.3",
   key: "slack-new-interaction-event-received",
   description:
     "Emit new events on new Slack [interactivity events](https://api.slack.com/interactivity) sourced from [Block Kit interactive elements](https://api.slack.com/interactivity/components), [Slash commands](https://api.slack.com/interactivity/slash-commands), or [Shortcuts](https://api.slack.com/interactivity/shortcuts).",