Merging pull request #15508

* Added actions

* Done requests changes

* Done requests changes

Author: lcaresia

components/zulip/.gitignore

@@ -0,0 +1,76 @@
+import app from "../../zulip.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "zulip-send-message",
+  name: "Send Message",
+  description: "Send a direct or channel message. [See the documentation](https://zulip.com/api/send-message)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    type: {
+      propDefinition: [
+        app,
+        "type",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        app,
+        "userId",
+      ],
+    },
+    channelId: {
+      propDefinition: [
+        app,
+        "channelId",
+      ],
+    },
+    topic: {
+      propDefinition: [
+        app,
+        "topic",
+        (c) => ({
+          channelId: c.channelId,
+        }),
+      ],
+    },
+    content: {
+      propDefinition: [
+        app,
+        "content",
+      ],
+    },
+  },
+
+  async run({ $ }) {
+    const isDirect = this.type === "direct" || this.type === "private";
+    const isChannel = this.type === "channel" || this.type === "stream";
+
+    if (isDirect && (!this.userId || this.userId.length === 0)) {
+      throw new ConfigurationError("You must provide at least one User ID when the type is 'direct' or 'private'.");
+    }
+
+    if (isChannel && !this.channelId) {
+      throw new ConfigurationError("You must provide a Channel ID when the type is 'channel' or 'stream'.");
+    }
+
+    if ((isDirect && this.channelId) || (isChannel && this.userId?.length > 0)) {
+      throw new ConfigurationError(`Invalid input: '${this.type}' messages require only ${isDirect
+        ? "User ID(s)"
+        : "a Channel ID"}.`);
+    }
+    const response = await this.app.sendMessage({
+      $,
+      params: {
+        type: this.type,
+        to: this.channelId || `[${this.userId.join(",")}]`,
+        topic: this.topic,
+        content: this.content,
+      },
+    });
+    $.export("$summary", `Sucessfully sent message with ID ${response.id}`);
+    return response;
+  },
+};

components/zulip/actions/send-message/send-message.mjs

@@ -0,0 +1,8 @@
+export default {
+  TYPE_OPTIONS: [
+    "direct",
+    "channel",
+    "stream",
+    "private",
+  ],
+};

components/zulip/app/zulip.app.ts

@@ -1,16 +1,18 @@
 {
   "name": "@pipedream/zulip",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Pipedream Zulip Components",
-  "main": "dist/app/zulip.app.mjs",
+  "main": "zulip.app.mjs",
   "keywords": [
     "pipedream",
     "zulip"
   ],
-  "files": ["dist"],
   "homepage": "https://pipedream.com/apps/zulip",
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }

components/zulip/common/constants.mjs

@@ -0,0 +1,117 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
+export default {
+  type: "app",
+  app: "zulip",
+  propDefinitions: {
+    type: {
+      type: "string",
+      label: "Type",
+      description: "The type of message to be sent",
+      options: constants.TYPE_OPTIONS,
+    },
+    userId: {
+      type: "integer[]",
+      label: "User ID",
+      description: "ID of the Users recipients of the message. Required when type is `direct` or `private`",
+      optional: true,
+      async options() {
+        const response = await this.getUsers();
+        const usersIds = response.members;
+        return usersIds.map(({
+          user_id, full_name,
+        }) => ({
+          label: full_name,
+          value: user_id,
+        }));
+      },
+    },
+    channelId: {
+      type: "integer",
+      label: "Channel ID",
+      description: "ID of the Channel recipient of the message. Required when type is `channel` or `stream`",
+      optional: true,
+      async options() {
+        const response = await this.getChannels();
+        const channelsIds = response.streams;
+        return channelsIds.map(({
+          stream_id, name,
+        }) => ({
+          label: name,
+          value: stream_id,
+        }));
+      },
+    },
+    topic: {
+      type: "string",
+      label: "Topic",
+      description: "The topic of the message. Required when type is `channel` or `stream`",
+      optional: true,
+      async options({ channelId }) {
+        const response = await this.getTopics({
+          channelId,
+        });
+        const topics = response.topics;
+        return topics.map(({ name }) => ({
+          label: name,
+          value: name,
+        }));
+      },
+    },
+    content: {
+      type: "string",
+      label: "Content",
+      description: "The content of the message",
+    },
+  },
+  methods: {
+    _baseUrl() {
+      return `https://${this.$auth.domain}.zulipchat.com/api/v1`;
+    },
+    async _makeRequest(opts = {}) {
+      const {
+        $ = this,
+        path,
+        auth,
+        ...otherOpts
+      } = opts;
+      return axios($, {
+        ...otherOpts,
+        url: this._baseUrl() + path,
+        auth: {
+          username: `${this.$auth.email}`,
+          password: `${this.$auth.api_key}`,
+          ...auth,
+        },
+      });
+    },
+    async getUsers(args = {}) {
+      return this._makeRequest({
+        path: "/users",
+        ...args,
+      });
+    },
+    async getChannels(args = {}) {
+      return this._makeRequest({
+        path: "/streams",
+        ...args,
+      });
+    },
+    async getTopics({
+      channelId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/users/me/${channelId}/topics`,
+        ...args,
+      });
+    },
+    async sendMessage(args = {}) {
+      return this._makeRequest({
+        path: "/messages",
+        method: "post",
+        ...args,
+      });
+    },
+  },
+};