@pipedream/twitter 0.3.2 → 0.3.5

package/actions/list-lists/list-lists.mjs

@@ -0,0 +1,69 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-lists",
+  name: "List Lists",
+  description: "Return all lists the authenticated or specified user subscribes to including their own. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    userId: {
+      propDefinition: [
+        common.props.twitter,
+        "userId",
+      ],
+      optional: true,
+    },
+    screenName: {
+      propDefinition: [
+        common.props.twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+    reverse: {
+      type: "boolean",
+      label: "Reverse",
+      description: "Set this to `true` if you would like owned lists to be returned first.",
+      optional: true,
+      default: false,
+    },
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      userId,
+      screenName,
+      reverse,
+      maxRequests,
+    } = this;
+
+    if (!userId && !screenName) {
+      throw new Error("This action requires either User ID or Screen Name. Please enter one or the other above.");
+    }
+
+    const params = {
+      $,
+      maxRequests,
+      params: {
+        user_id: userId,
+        screen_name: screenName,
+        reverse,
+      },
+    };
+    const lists = await this.paginate(this.twitter.getLists.bind(this), params);
+    const results = [];
+    for await (const list of lists) {
+      results.push(list);
+    }
+    $.export("$summary", "Successfully retrieved lists");
+    return results;
+  },
+};

package/actions/list-mentions/list-mentions.mjs

@@ -0,0 +1,55 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-mentions",
+  name: "List Mentions",
+  description: "Return the 20 most recent mentions for the authenticated user. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-mentions_timeline)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    count: {
+      propDefinition: [
+        common.props.twitter,
+        "count",
+      ],
+      description: "Specifies the number of records to retrieve. Must be less than or equal to `200`; defaults to `20`.",
+      optional: true,
+      default: 20,
+    },
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+    includeEntities: {
+      propDefinition: [
+        common.props.twitter,
+        "includeEntities",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      count,
+      maxRequests,
+      includeEntities,
+    } = this;
+
+    const params = {
+      $,
+      count,
+      maxRequests,
+      includeEntities,
+    };
+    const tweets = await this.paginate(this.twitter.getMentionsTimeline.bind(this), params);
+    const results = [];
+    for await (const tweet of tweets) {
+      results.push(tweet);
+    }
+    $.export("$summary", "Sucessfully retrieved mentions");
+    return results;
+  },
+};

package/actions/list-pending-followers/list-pending-followers.mjs

@@ -0,0 +1,32 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-pending-followers",
+  name: "List Pending Followers",
+  description: "Return a collection of numeric IDs for every user who has a pending request to follow the authenticated user. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { maxRequests } = this;
+    const followers = await this.paginate(this.twitter.getPendingFollowers.bind(this), {
+      $,
+      maxRequests,
+    }, "ids");
+    const results = [];
+    for await (const follower of followers) {
+      results.push(follower);
+    }
+    $.export("$summary", "Successfully retrieved pending followers");
+    return results;
+  },
+};

package/actions/list-retweets/list-retweets.mjs

@@ -0,0 +1,54 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-retweets",
+  name: "List Retweets",
+  description: "Return a collection of recent retweets of a tweet by ID parameter. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/get-statuses-retweets-id)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    id: {
+      propDefinition: [
+        common.props.twitter,
+        "tweetID",
+      ],
+    },
+    count: {
+      propDefinition: [
+        common.props.twitter,
+        "count",
+      ],
+      optional: true,
+      default: 20,
+    },
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      id,
+      count,
+      maxRequests,
+    } = this;
+
+    const params = {
+      $,
+      id,
+      count,
+      maxRequests,
+    };
+    const tweets = await this.paginate(this.twitter.getRetweets.bind(this), params);
+    const results = [];
+    for await (const tweet of tweets) {
+      results.push(tweet);
+    }
+    $.export("$summary", "Successfully retrieved retweets");
+    return results;
+  },
+};

package/actions/list-user-tweets/list-user-tweets.mjs

@@ -0,0 +1,80 @@
+import common from "../common.mjs";
+
+export default {
+  ...common,
+  key: "twitter-list-user-tweets",
+  name: "List User Tweets",
+  description: "Return a collection of the most recent tweets posted by a user. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-user_timeline)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    screenName: {
+      propDefinition: [
+        common.props.twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+    count: {
+      propDefinition: [
+        common.props.twitter,
+        "count",
+      ],
+      optional: true,
+      default: 20,
+    },
+    maxRequests: {
+      propDefinition: [
+        common.props.twitter,
+        "maxRequests",
+      ],
+    },
+    includeRetweets: {
+      propDefinition: [
+        common.props.twitter,
+        "includeRetweets",
+      ],
+    },
+    includeReplies: {
+      propDefinition: [
+        common.props.twitter,
+        "includeReplies",
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    shouldExcludeReplies(includeReplies) {
+      return includeReplies === "exclude";
+    },
+    shouldIncludeRetweets(includeRetweets) {
+      return includeRetweets !== "exclude";
+    },
+  },
+  async run({ $ }) {
+    const {
+      screenName,
+      count,
+      maxRequests,
+      includeRetweets,
+      includeReplies,
+    } = this;
+
+    const params = {
+      $,
+      screenName,
+      count,
+      maxRequests,
+      exclude_replies: this.shouldExcludeReplies(includeReplies),
+      include_rts: this.shouldIncludeRetweets(includeRetweets),
+    };
+    const tweets = await this.paginate(this.twitter.getUserTimeline.bind(this), params);
+    const results = [];
+    for await (const tweet of tweets) {
+      results.push(tweet);
+    }
+    $.export("$summary", "Successfully retrieved user tweets");
+    return results;
+  },
+};

package/actions/retweet/retweet.mjs

@@ -0,0 +1,27 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-retweet",
+  name: "Retweet a tweet",
+  description: "Retweets a specific tweet by ID. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-retweet-id)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    twitter,
+    tweetID: {
+      propDefinition: [
+        twitter,
+        "tweetID",
+      ],
+      description: "The numerical ID of the tweet you'd like to retweet",
+    },
+  },
+  async run({ $ }) {
+    const res = await this.twitter.retweet({
+      $,
+      tweetID: this.tweetID,
+    });
+    $.export("$summary", "Tweet successfully retweeted");
+    return res;
+  },
+};

package/actions/simple-search/simple-search.mjs

@@ -0,0 +1,62 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-simple-search",
+  name: "Simple Search",
+  description: "Return Tweets that matches your search criteria. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/search/api-reference/get-search-tweets)",
+  version: "0.0.7",
+  type: "action",
+  props: {
+    twitter,
+    q: {
+      propDefinition: [
+        twitter,
+        "q",
+      ],
+    },
+    resultType: {
+      propDefinition: [
+        twitter,
+        "resultType",
+      ],
+    },
+    includeRetweets: {
+      propDefinition: [
+        twitter,
+        "includeRetweets",
+      ],
+    },
+    includeReplies: {
+      propDefinition: [
+        twitter,
+        "includeReplies",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      resultType,
+      enrichTweets,
+      includeReplies,
+      includeRetweets,
+      maxRequests,
+      count,
+    } = this;
+    let q = this.q;
+
+    // run paginated search
+    const res = await this.twitter.paginatedSearch({
+      $,
+      q,
+      resultType,
+      enrichTweets,
+      includeReplies,
+      includeRetweets,
+      maxRequests,
+      count,
+      limitFirstPage: false,
+    });
+    $.export("$summary", "Search completed successfully");
+    return res;
+  },
+};

package/actions/simple-search-in-list/simple-search-in-list.mjs

@@ -0,0 +1,48 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-simple-search-in-list",
+  name: "Simple Search in List",
+  description: "Return Tweets that match your search criteria in a specific list. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-statuses)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    listId: {
+      propDefinition: [
+        twitter,
+        "list",
+      ],
+    },
+    query: {
+      propDefinition: [
+        twitter,
+        "q",
+      ],
+    },
+    includeRetweets: {
+      propDefinition: [
+        twitter,
+        "includeRetweets",
+      ],
+    },
+    includeEntities: {
+      type: "boolean",
+      label: "Entities",
+      description: "Include the 'entities' node, which offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags",
+      default: false,
+    },
+  },
+  async run({ $ }) {
+    let tweets = await this.twitter.getPaginateListTweets({
+      listId: this.listId,
+      includeEntities: this.includeEntities,
+      includeRetweets: this.includeRetweets !== "exclude",
+    });
+    tweets = tweets.filter((tweet) => tweet?.full_text?.includes(this.query));
+    $.export("$summary", `${tweets.length} search ${tweets.length === 1
+      ? "result has"
+      : "results have"} been found.`);
+    return tweets;
+  },
+};

package/actions/unfollow-user/unfollow-user.mjs

@@ -0,0 +1,48 @@
+import twitter from "../../twitter.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  key: "twitter-unfollow-user",
+  name: "Unfollow User",
+  description: "Unfollow the user specified by ID or screen name parameter. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    userId: {
+      propDefinition: [
+        twitter,
+        "userId",
+      ],
+      optional: true,
+    },
+    screenName: {
+      propDefinition: [
+        twitter,
+        "screenName",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      userId,
+      screenName,
+    } = this;
+
+    if (!userId && !screenName) {
+      throw new ConfigurationError("This action requires either User ID or Screen Name. Please enter one or the other above.");
+    }
+
+    const params = {
+      user_id: userId,
+      screen_name: screenName,
+    };
+    const response = await this.twitter.unfollowUser({
+      params,
+      $,
+    });
+    $.export("$summary", "Successfully unfollowed user");
+    return response;
+  },
+};

package/actions/unlike-tweet/unlike-tweet.mjs

@@ -0,0 +1,40 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  key: "twitter-unlike-tweet",
+  name: "Unike Tweet",
+  description: "Unike the tweet specified specified in the ID parameter. [See the docs here](https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-favorites-destroy)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    twitter,
+    id: {
+      propDefinition: [
+        twitter,
+        "tweetID",
+      ],
+    },
+    includeEntities: {
+      propDefinition: [
+        twitter,
+        "includeEntities",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      id,
+      includeEntities,
+    } = this;
+
+    const params = {
+      $,
+      id,
+      includeEntities,
+    };
+
+    const res = this.twitter.unlikeTweet(params);
+    $.export("$summary", "Successfully unliked tweet");
+    return res;
+  },
+};

package/package.json

@@ -1,22 +1,22 @@
 {
-    "name": "@pipedream/twitter",
-    "version": "0.3.2",
-    "description": "Pipedream Twitter Components",
-    "main": "twitter.app.js",
-    "keywords": [
-        "pipedream",
-        "twitter"
-    ],
-    "homepage": "https://pipedream.com/apps/twitter",
-    "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-    "license": "MIT",
-    "dependencies": {
-        "axios": "^0.21.1",
-        "moment": "^2.29.1",
-        "querystring": "^0.2.0"
-    },
-    "gitHead": "bf0e1cb3ad6da248c6125f9b512c59bfe35bf1fa",
-    "publishConfig": {
-        "access": "public"
-    }
-}
+  "name": "@pipedream/twitter",
+  "version": "0.3.5",
+  "description": "Pipedream Twitter Components",
+  "main": "twitter.app.mjs",
+  "keywords": [
+    "pipedream",
+    "twitter"
+  ],
+  "homepage": "https://pipedream.com/apps/twitter",
+  "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^0.21.1",
+    "moment": "^2.29.1",
+    "querystring": "^0.2.0"
+  },
+  "gitHead": "e12480b94cc03bed4808ebc6b13e7fdb3a1ba535",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -64,10 +64,6 @@ Pipedream is currently free, subject to the [limits noted below](https://docs.pi
 
 If you exceed any of these limits, please [reach out](https://docs.pipedream.com/support/).
 
-## Getting Support
-
-You can get help [on our public Slack](https://pipedream.com/community) or [reach out to our team directly](https://docs.pipedream.com/support/) with any questions or feedback. We'd love to hear from you!
-
 ## Found a Bug? Have a Feature to suggest?
 
 Before adding an issue, please search the [existing issues](https://github.com/PipedreamHQ/pipedream/issues) or [reach out to our team](https://docs.pipedream.com/support/) to see if a similar request already exists.

package/sources/common/followed.mjs

@@ -0,0 +1,37 @@
+import twitter from "../../twitter.app.mjs";
+
+export default {
+  props: {
+    twitter,
+    db: "$.service.db",
+    timer: {
+      label: "Polling interval",
+      description: "Pipedream will poll the Twitter API on this schedule",
+      type: "$.interface.timer",
+      default: {
+        intervalSeconds: 60 * 15,
+      },
+    },
+  },
+  methods: {
+    _getPreviousIds() {
+      return this.db.get("previousIds") || [];
+    },
+    _setPreviousIds(previousIds) {
+      this.db.set("previousIds", previousIds);
+    },
+  },
+  async run() {
+    const previousIds = this._getPreviousIds();
+    const followedItems = await this.getFollowed();
+    for (const item of followedItems.reverse()) {
+      if (previousIds.includes(item.id)) {
+        continue;
+      }
+      previousIds.push(item.id);
+      const meta = this.generateMeta(item);
+      this.$emit(item, meta);
+    }
+    this._setPreviousIds(previousIds);
+  },
+};