@pipedream/twitter 2.2.4 → 2.3.1

package/README.md

@@ -1,3 +1,8 @@
+# Overview
+
+The Twitter API on Pipedream enables you to automate interactions with Twitter, from posting tweets to analyzing social media trends. Pipedream's serverless platform provides the tools to create workflows that trigger on specific Twitter activities, process data, and connect with countless other apps for extensive automation scenarios. With Pipedream's integration, you can listen for events such as new tweets, mentions, or followers, and execute actions like tweeting, retweeting, or even leveraging sentiment analysis to gauge public perception.
+
+
 # Getting Started
 In order to connect your Twitter account to Pipedream, you'll need to create a developer project and app.
 1. First, visit Twitter's [developer dashboard](https://developer.twitter.com/en/portal/dashboard) and sign in
@@ -19,6 +24,14 @@ In order to connect your Twitter account to Pipedream, you'll need to create a d
 
 ![Consumer API key](https://res.cloudinary.com/dpenc2lit/image/upload/v1684365722/Screenshot_2023-05-17_at_4.19.52_PM_jlvbvw.png)
 
+# Example Use Cases
+
+- **Automated Tweeting of Curated Content:** Create a workflow that monitors RSS feeds or other content sources. When new items are detected, format the content and automatically post it to your Twitter account, keeping your followers engaged with fresh and relevant content.
+
+- **Twitter Sentiment Analysis:** Set up a workflow that triggers on new mentions of your username on Twitter. Pass the tweet text to a sentiment analysis service like Google's Natural Language API to determine the emotion conveyed. Use this data to respond appropriately or to gather insights on public perception.
+
+- **Customer Support Ticketing:** Develop a workflow that starts when your company's Twitter account receives a direct message. Automatically create a ticket in a customer support platform like Zendesk or HubSpot, ensuring that your team promptly addresses customer inquiries and issues mentioned on Twitter.
+
 # Troubleshooting
 Below are some of the most common issues we see.
 

package/dist/actions/add-user-to-list/add-user-to-list.mjs

@@ -8,7 +8,7 @@ export default defineAction({
     key: "twitter-add-user-to-list",
     name: "Add User To List",
     description: `Add a member to a list owned by the user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/create-tweet/create-tweet.d.ts

@@ -13,7 +13,7 @@ declare const _default: import("@pipedream/types").Action<unknown, {
         getListTweets({ listId, ...args }: import("../../common/types/requestParams.js").GetListTweetsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
         getTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").GetTweetParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
         getAuthenticatedUser(args: import("../../common/types/requestParams.js").GetAuthenticatedUserParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").User>>;
-        getAuthenticatedUserId(): Promise<string>;
+        getAuthenticatedUserId(): Promise<import("../../common/types/responseSchemas.js").User["id"]>;
         getDirectMessages(args: import("../../common/types/requestParams.js").GetDirectMessagesParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").DirectMessage>>;
         getUserLikedTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserLikedTweetParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
         getUserOwnedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserOwnedListsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").List>>;
@@ -24,8 +24,8 @@ declare const _default: import("@pipedream/types").Action<unknown, {
         getUser({ userId, ...args }: import("../../common/types/requestParams.js").GetUserParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").User>>;
         likeTweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
         getUserFollowers({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
-        getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
-        retweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+        getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowingParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
+        retweet(args: import("../../common/types/requestParams.js").RetweetParams): Promise<object>;
         searchTweets(args: import("../../common/types/requestParams.js").SearchTweetsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
         sendMessage({ userId, ...args }: import("../../common/types/requestParams.js").SendMessageParams): Promise<object>;
         unfollowUser({ userId, ...args }: import("../../common/types/requestParams.js").UnfollowUserParams): Promise<object>;

package/dist/actions/create-tweet/create-tweet.mjs

@@ -6,7 +6,7 @@ export default defineAction({
     key: "twitter-create-tweet",
     name: "Create Tweet",
     description: `Create a new tweet. [See the documentation](${DOCS_LINK})`,
-    version: "2.1.5",
+    version: "2.1.6",
     type: "action",
     props: {
         app,

package/dist/actions/delete-tweet/delete-tweet.mjs

@@ -7,7 +7,7 @@ export default defineAction({
     key: "twitter-delete-tweet",
     name: "Delete Tweet",
     description: `Remove a posted tweet. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/follow-user/follow-user.mjs

@@ -8,7 +8,7 @@ export default defineAction({
     key: "twitter-follow-user",
     name: "Follow User",
     description: `Follow a user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/get-tweet/get-tweet.mjs

@@ -8,7 +8,7 @@ export default defineAction({
     key: "twitter-get-tweet",
     name: "Get Tweet",
     description: `Return a single tweet specified by ID. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/get-user/get-user.mjs

@@ -8,7 +8,7 @@ export default defineAction({
     key: "twitter-get-user",
     name: "Get User",
     description: `Get information about a user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/like-tweet/like-tweet.mjs

@@ -7,7 +7,7 @@ export default defineAction({
     key: "twitter-like-tweet",
     name: "Like Tweet",
     description: `Like a tweet specified by its ID. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/list-favorites/list-favorites.mjs

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-list-favorites",
     name: "List Liked Tweets",
     description: `Return the most recent tweets liked by you or the specified user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

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

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-list-followers",
     name: "List Followers",
     description: `Return a collection of user objects for users following the specified user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

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

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-list-lists",
     name: "List Lists",
     description: `Get all lists owned by a user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

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

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-list-mentions",
     name: "List Mentions",
     description: `Return the most recent mentions for the specified user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.8",
+    version: "2.0.9",
     type: "action",
     props: {
         ...common.props,

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

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-list-user-tweets",
     name: "List User Tweets",
     description: `Return a collection of the most recent tweets posted by a user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/retweet/retweet.mjs

@@ -7,7 +7,7 @@ export default defineAction({
     key: "twitter-retweet",
     name: "Retweet a tweet",
     description: `Retweet a tweet specified by ID. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/send-dm/send-dm.mjs

@@ -8,7 +8,7 @@ export default defineAction({
     key: "twitter-send-dm",
     name: "Send Direct Message (DM)",
     description: `Send a message to a user. [See the documentation](${DOCS_LINK})`,
-    version: "1.0.5",
+    version: "1.0.6",
     type: "action",
     props: {
         ...common.props,

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

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-simple-search",
     name: "Search Tweets",
     description: `Retrieve Tweets from the last seven days that match a query. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

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

@@ -11,7 +11,7 @@ export default defineAction({
     key: "twitter-simple-search-in-list",
     name: "Search Tweets in List",
     description: `Search Tweets by text in a list. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

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

@@ -8,7 +8,7 @@ export default defineAction({
     key: "twitter-unfollow-user",
     name: "Unfollow User",
     description: `Unfollow a user. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

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

@@ -7,7 +7,7 @@ export default defineAction({
     key: "twitter-unlike-tweet",
     name: "Unlike Tweet",
     description: `Unlike a tweet specified by its ID. [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.0.8",
     type: "action",
     props: {
         ...common.props,

package/dist/actions/upload-media/upload-media.mjs

@@ -2,8 +2,7 @@ import common from "../../common/appValidation.mjs";
 import { ACTION_ERROR_MESSAGE } from "../../common/errorMessage.mjs";
 import { defineAction } from "@pipedream/types";
 import constants from "../../common/constants.mjs";
-import fs from "fs";
-import { axios } from "@pipedream/platform";
+import { getFileStreamAndMetadata } from "@pipedream/platform";
 import FormData from "form-data";
 const DOCS_LINK = "https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload";
 export default defineAction({
@@ -11,15 +10,14 @@ export default defineAction({
     key: "twitter-upload-media",
     name: "Upload Media",
     description: `Upload new media. [See the documentation](${DOCS_LINK})`,
-    version: "0.0.11",
+    version: "0.0.13",
     type: "action",
     props: {
         ...common.props,
         filePath: {
             type: "string",
-            label: "File Path",
-            description: "A file URL or a file path in the `/tmp` directory. [See the documentation on working with files.](https://pipedream.com/docs/code/nodejs/working-with-files/)",
-            optional: false,
+            label: "File Path or URL",
+            description: "Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf).",
         },
         media_category: {
             type: "string",
@@ -30,29 +28,22 @@ export default defineAction({
         },
     },
     async run({ $ }) {
-        const isLocalFile = this.filePath?.startsWith("/tmp");
-        let content;
+        let content, meta;
         try {
-            content = isLocalFile
-                ? fs.createReadStream(this.filePath, {
-                    encoding: "base64",
-                })
-                : await axios($, {
-                    url: this.filePath,
-                    responseType: "arraybuffer",
-                });
+            const { stream, metadata, } = await getFileStreamAndMetadata(this.filePath);
+            content = stream;
+            meta = metadata;
         }
         catch (err) {
             $.export("error", err);
             throw new Error(ACTION_ERROR_MESSAGE);
         }
         const data = new FormData();
-        if (isLocalFile) {
-            data.append("media_data", content);
-        }
-        else {
-            data.append("media", content);
-        }
+        data.append("media_data", content, {
+            contentType: meta.contentType,
+            knownLength: meta.size,
+            filename: meta.name,
+        });
         const response = await this.app.uploadMedia({
             $,
             data,

package/dist/common/addObjIncludes.d.ts

@@ -0,0 +1,9 @@
+import { IncludesIdCollectionFlattened } from "./types/includeMapping.js";
+import { DirectMessage, List, ResponseIncludes, Tweet, TwitterEntity, User } from "./types/responseSchemas.js";
+export declare function getDirectMessageIncludeIds(obj: DirectMessage): IncludesIdCollectionFlattened;
+export declare function getListIncludeIds(obj: List): IncludesIdCollectionFlattened;
+export declare function getUserIncludeIds(obj: User): IncludesIdCollectionFlattened;
+export declare function getTweetIncludeIds(obj: Tweet): IncludesIdCollectionFlattened;
+export declare function getObjIncludes(obj: TwitterEntity, includes: ResponseIncludes, getIncludeIds: (o: TwitterEntity) => IncludesIdCollectionFlattened): {
+    [k: string]: any;
+};

package/dist/common/addObjIncludes.mjs

@@ -0,0 +1,70 @@
+// https://developer.twitter.com/en/docs/twitter-api/expansions
+function flatClearIncludeIds(obj) {
+    return Object.fromEntries(Object.entries(obj).map(([key, value,]) => [
+        key,
+        value.filter((e) => e !== undefined).flat(),
+    ]));
+}
+export function getDirectMessageIncludeIds(obj) {
+    return flatClearIncludeIds({
+        userIds: [
+            obj.sender_id,
+            obj.participant_ids,
+        ],
+        mediaKeys: [
+            obj.attachments?.media_keys,
+        ],
+        tweetIds: [
+            obj.referenced_tweets?.map(({ id }) => id),
+        ],
+    });
+}
+export function getListIncludeIds(obj) {
+    return flatClearIncludeIds({
+        userIds: [
+            obj.owner_id,
+        ],
+    });
+}
+export function getUserIncludeIds(obj) {
+    return flatClearIncludeIds({
+        tweetIds: [
+            obj.pinned_tweet_id,
+        ],
+    });
+}
+export function getTweetIncludeIds(obj) {
+    return flatClearIncludeIds({
+        userIds: [
+            obj.author_id,
+            obj.in_reply_to_user_id,
+        ],
+        userNames: [
+            obj.entities?.mentions?.map(({ username }) => username),
+        ],
+        tweetIds: [
+            obj.edit_history_tweet_ids,
+            obj.referenced_tweets?.map(({ id }) => id),
+        ],
+        pollIds: [
+            obj.attachments?.poll_ids,
+        ],
+        placeIds: [
+            obj.geo?.place_id,
+        ],
+        mediaKeys: [
+            obj.attachments?.media_keys,
+        ],
+    });
+}
+export function getObjIncludes(obj, includes = {}, getIncludeIds) {
+    const { userIds, userNames, tweetIds, pollIds, placeIds, mediaKeys, } = getIncludeIds(obj);
+    const result = {
+        media: includes.media?.filter((item) => mediaKeys?.includes(item.media_key)),
+        users: includes.users?.filter((item) => userIds?.includes(item.id) || userNames?.includes(item.username)),
+        places: includes.places?.filter((item) => placeIds?.includes(item.id)),
+        polls: includes.polls?.filter((item) => pollIds?.includes(item.id)),
+        tweets: includes.tweets?.filter((item) => tweetIds?.includes(item.id)),
+    };
+    return Object.fromEntries(Object.entries(result).filter(([, value,]) => value?.length > 0));
+}

package/dist/common/additionalProps.mjs

@@ -8,12 +8,12 @@ import {
   POLL_FIELD_OPTIONS,
   TWEET_FIELD_OPTIONS,
   USER_FIELD_OPTIONS,
-} from "./dataFields.mjs";
+} from "./dataFields";
 import {
   LIST_EXPANSION_OPTIONS,
   TWEET_EXPANSION_OPTIONS,
   USER_EXPANSION_OPTIONS,
-} from "./expansions.mjs";
+} from "./expansions";
 
 // These cannot be propDefinitions in the app file, because additionalProps() needs them to be primitives
 const listExpansions = {

package/dist/common/appValidation.d.ts

@@ -51,7 +51,7 @@ declare const _default: {
                 getListTweets({ listId, ...args }: import("./types/requestParams.js").GetListTweetsParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 getTweet({ tweetId, ...args }: import("./types/requestParams.js").GetTweetParams): Promise<import("./types/responseSchemas.js").ResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 getAuthenticatedUser(args: import("./types/requestParams.js").GetAuthenticatedUserParams): Promise<import("./types/responseSchemas.js").ResponseObject<import("./types/responseSchemas.js").User>>;
-                getAuthenticatedUserId(): Promise<string>;
+                getAuthenticatedUserId(): Promise<import("./types/responseSchemas.js").User["id"]>;
                 getDirectMessages(args: import("./types/requestParams.js").GetDirectMessagesParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").DirectMessage>>;
                 getUserLikedTweets({ userId, ...args }: import("./types/requestParams.js").GetUserLikedTweetParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 getUserOwnedLists({ userId, ...args }: import("./types/requestParams.js").GetUserOwnedListsParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").List>>;
@@ -62,8 +62,8 @@ declare const _default: {
                 getUser({ userId, ...args }: import("./types/requestParams.js").GetUserParams): Promise<import("./types/responseSchemas.js").ResponseObject<import("./types/responseSchemas.js").User>>;
                 likeTweet(args: import("./types/requestParams.js").LikeTweetParams): Promise<object>;
                 getUserFollowers({ userId, ...args }: import("./types/requestParams.js").GetUserFollowersParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").User>>;
-                getUserFollowing({ userId, ...args }: import("./types/requestParams.js").GetUserFollowersParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").User>>;
-                retweet(args: import("./types/requestParams.js").LikeTweetParams): Promise<object>;
+                getUserFollowing({ userId, ...args }: import("./types/requestParams.js").GetUserFollowingParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").User>>;
+                retweet(args: import("./types/requestParams.js").RetweetParams): Promise<object>;
                 searchTweets(args: import("./types/requestParams.js").SearchTweetsParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 sendMessage({ userId, ...args }: import("./types/requestParams.js").SendMessageParams): Promise<object>;
                 unfollowUser({ userId, ...args }: import("./types/requestParams.js").UnfollowUserParams): Promise<object>;
@@ -82,7 +82,7 @@ declare const _default: {
                 getListTweets({ listId, ...args }: import("./types/requestParams.js").GetListTweetsParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 getTweet({ tweetId, ...args }: import("./types/requestParams.js").GetTweetParams): Promise<import("./types/responseSchemas.js").ResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 getAuthenticatedUser(args: import("./types/requestParams.js").GetAuthenticatedUserParams): Promise<import("./types/responseSchemas.js").ResponseObject<import("./types/responseSchemas.js").User>>;
-                getAuthenticatedUserId(): Promise<string>;
+                getAuthenticatedUserId(): Promise<import("./types/responseSchemas.js").User["id"]>;
                 getDirectMessages(args: import("./types/requestParams.js").GetDirectMessagesParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").DirectMessage>>;
                 getUserLikedTweets({ userId, ...args }: import("./types/requestParams.js").GetUserLikedTweetParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 getUserOwnedLists({ userId, ...args }: import("./types/requestParams.js").GetUserOwnedListsParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").List>>;
@@ -93,8 +93,8 @@ declare const _default: {
                 getUser({ userId, ...args }: import("./types/requestParams.js").GetUserParams): Promise<import("./types/responseSchemas.js").ResponseObject<import("./types/responseSchemas.js").User>>;
                 likeTweet(args: import("./types/requestParams.js").LikeTweetParams): Promise<object>;
                 getUserFollowers({ userId, ...args }: import("./types/requestParams.js").GetUserFollowersParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").User>>;
-                getUserFollowing({ userId, ...args }: import("./types/requestParams.js").GetUserFollowersParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").User>>;
-                retweet(args: import("./types/requestParams.js").LikeTweetParams): Promise<object>;
+                getUserFollowing({ userId, ...args }: import("./types/requestParams.js").GetUserFollowingParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").User>>;
+                retweet(args: import("./types/requestParams.js").RetweetParams): Promise<object>;
                 searchTweets(args: import("./types/requestParams.js").SearchTweetsParams): Promise<import("./types/responseSchemas.js").PaginatedResponseObject<import("./types/responseSchemas.js").Tweet>>;
                 sendMessage({ userId, ...args }: import("./types/requestParams.js").SendMessageParams): Promise<object>;
                 unfollowUser({ userId, ...args }: import("./types/requestParams.js").UnfollowUserParams): Promise<object>;

package/dist/common/types/includeMapping.d.ts

@@ -0,0 +1,11 @@
+type IncludesIdMap<T> = {
+    mediaKeys?: T;
+    placeIds?: T;
+    pollIds?: T;
+    tweetIds?: T;
+    userIds?: T;
+    userNames?: T;
+};
+export type IncludesIdCollection = IncludesIdMap<(string | string[])[]>;
+export type IncludesIdCollectionFlattened = IncludesIdMap<string[]>;
+export {};

package/dist/common/types/includeMapping.mjs

@@ -0,0 +1 @@
+export {};

package/dist/common/types/responseSchemas.d.ts

@@ -2,12 +2,15 @@ export interface TwitterEntity {
     id: string;
 }
 export type TwitterEntityMap = Record<string, object>;
-export interface DirectMessage extends TwitterEntity {
+export interface DirectMessage extends TwitterEntity, HasMediaAttachments, HasReferencedTweets {
     event_type: "MessageCreate";
     text: string;
+    sender_id?: string;
+    participant_ids?: string[];
 }
 export interface List extends TwitterEntity {
     name: string;
+    owner_id?: string;
 }
 interface MetricsFields {
     public_metrics?: string;
@@ -15,10 +18,28 @@ interface MetricsFields {
     organic_metrics?: string;
     promoted_metrics?: string;
 }
-export interface Tweet extends TwitterEntity, MetricsFields {
-    text: string;
-    edit_history_tweet_ids: string[];
+interface HasReferencedTweets {
     referenced_tweets?: ReferencedTweet[];
+}
+interface HasMediaAttachments {
+    attachments?: {
+        media_keys?: string[];
+    };
+}
+export interface Tweet extends TwitterEntity, MetricsFields, HasReferencedTweets {
+    text: string;
+    author_id?: string;
+    edit_history_tweet_ids?: string[];
+    in_reply_to_user_id?: string;
+    attachments?: HasMediaAttachments["attachments"] & {
+        poll_ids: string[];
+    };
+    geo?: {
+        place_id: string;
+    };
+    entities?: {
+        mentions?: User[];
+    };
     includes?: {
         tweets?: Tweet[];
     };
@@ -30,10 +51,16 @@ export interface ReferencedTweet {
 export interface User extends TwitterEntity {
     name: string;
     username: string;
+    pinned_tweet_id?: string;
 }
-interface ResponseIncludes {
+type Poll = TwitterEntity;
+type Place = TwitterEntity;
+export interface ResponseIncludes {
+    places?: Place[];
+    polls?: Poll[];
     users?: User[];
     tweets?: Tweet[];
+    media?: MediaItem[];
 }
 interface ResponseBase {
     includes?: ResponseIncludes;
@@ -49,4 +76,7 @@ export type PaginatedResponseObject<T extends TwitterEntity> = ResponseBase & {
         result_count: number;
     };
 };
+interface MediaItem {
+    media_key: string;
+}
 export {};

package/dist/sources/common/base.d.ts

@@ -59,7 +59,7 @@ declare const _default: {
                 getListTweets({ listId, ...args }: import("../../common/types/requestParams.js").GetListTweetsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 getTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").GetTweetParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 getAuthenticatedUser(args: import("../../common/types/requestParams.js").GetAuthenticatedUserParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").User>>;
-                getAuthenticatedUserId(): Promise<string>;
+                getAuthenticatedUserId(): Promise<import("../../common/types/responseSchemas.js").User["id"]>;
                 getDirectMessages(args: import("../../common/types/requestParams.js").GetDirectMessagesParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").DirectMessage>>;
                 getUserLikedTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserLikedTweetParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 getUserOwnedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserOwnedListsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").List>>;
@@ -70,8 +70,8 @@ declare const _default: {
                 getUser({ userId, ...args }: import("../../common/types/requestParams.js").GetUserParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").User>>;
                 likeTweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
                 getUserFollowers({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
-                getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
-                retweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+                getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowingParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
+                retweet(args: import("../../common/types/requestParams.js").RetweetParams): Promise<object>;
                 searchTweets(args: import("../../common/types/requestParams.js").SearchTweetsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 sendMessage({ userId, ...args }: import("../../common/types/requestParams.js").SendMessageParams): Promise<object>;
                 unfollowUser({ userId, ...args }: import("../../common/types/requestParams.js").UnfollowUserParams): Promise<object>;
@@ -90,7 +90,7 @@ declare const _default: {
                 getListTweets({ listId, ...args }: import("../../common/types/requestParams.js").GetListTweetsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 getTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").GetTweetParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 getAuthenticatedUser(args: import("../../common/types/requestParams.js").GetAuthenticatedUserParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").User>>;
-                getAuthenticatedUserId(): Promise<string>;
+                getAuthenticatedUserId(): Promise<import("../../common/types/responseSchemas.js").User["id"]>;
                 getDirectMessages(args: import("../../common/types/requestParams.js").GetDirectMessagesParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").DirectMessage>>;
                 getUserLikedTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserLikedTweetParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 getUserOwnedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserOwnedListsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").List>>;
@@ -101,8 +101,8 @@ declare const _default: {
                 getUser({ userId, ...args }: import("../../common/types/requestParams.js").GetUserParams): Promise<import("../../common/types/responseSchemas.js").ResponseObject<import("../../common/types/responseSchemas.js").User>>;
                 likeTweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
                 getUserFollowers({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
-                getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
-                retweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+                getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowingParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").User>>;
+                retweet(args: import("../../common/types/requestParams.js").RetweetParams): Promise<object>;
                 searchTweets(args: import("../../common/types/requestParams.js").SearchTweetsParams): Promise<import("../../common/types/responseSchemas.js").PaginatedResponseObject<import("../../common/types/responseSchemas.js").Tweet>>;
                 sendMessage({ userId, ...args }: import("../../common/types/requestParams.js").SendMessageParams): Promise<object>;
                 unfollowUser({ userId, ...args }: import("../../common/types/requestParams.js").UnfollowUserParams): Promise<object>;

package/dist/sources/new-follower-of-user/new-follower-of-user.mjs

@@ -4,12 +4,13 @@ import { getUserSummary as getItemSummary } from "../common/getItemSummary.mjs";
 import { getUserFields } from "../../common/methods.mjs";
 import { DOCS_LINK, MAX_RESULTS_PER_PAGE, } from "../../actions/list-followers/list-followers.mjs";
 import cacheUserId from "../common/cacheUserId.mjs";
+import { getObjIncludes, getUserIncludeIds, } from "../../common/addObjIncludes.mjs";
 export default defineSource({
     ...common,
     key: "twitter-new-follower-of-user",
     name: "New Follower Received by User",
     description: `Emit new event when the specified User receives a Follower [See the documentation](${DOCS_LINK})`,
-    version: "2.0.7",
+    version: "2.1.0",
     type: "source",
     props: {
         ...common.props,
@@ -37,7 +38,8 @@ export default defineSource({
                 params: this.getUserFields(),
                 userId,
             };
-            const { data } = await this.app.getUserFollowers(params);
+            const { data, includes, } = await this.app.getUserFollowers(params);
+            data.forEach((user) => user.includes = getObjIncludes(user, includes, getUserIncludeIds));
             return data;
         },
     },