@pipedream/twitter 0.3.11 → 1.0.0

package/dist/common/propGroups.mjs

@@ -0,0 +1,82 @@
+import app from "../app/twitter.app.mjs";
+export const listFieldProps = {
+    expansions: {
+        propDefinition: [
+            app,
+            "listExpansions",
+        ],
+    },
+    listFields: {
+        propDefinition: [
+            app,
+            "listFields",
+        ],
+    },
+    userFields: {
+        propDefinition: [
+            app,
+            "userFields",
+        ],
+        description: "Specific [user fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user) to be included in the returned user object. Only applicable if you've requested the `owner_id` expansion.",
+    },
+};
+export const tweetFieldProps = {
+    expansions: {
+        propDefinition: [
+            app,
+            "tweetExpansions",
+        ],
+    },
+    mediaFields: {
+        propDefinition: [
+            app,
+            "mediaFields",
+        ],
+    },
+    placeFields: {
+        propDefinition: [
+            app,
+            "placeFields",
+        ],
+    },
+    pollFields: {
+        propDefinition: [
+            app,
+            "pollFields",
+        ],
+    },
+    tweetFields: {
+        propDefinition: [
+            app,
+            "tweetFields",
+        ],
+    },
+    userFields: {
+        propDefinition: [
+            app,
+            "userFields",
+        ],
+    },
+};
+export const userFieldProps = {
+    expansions: {
+        propDefinition: [
+            app,
+            "userExpansions",
+        ],
+    },
+    tweetFields: {
+        propDefinition: [
+            app,
+            "tweetFields",
+        ],
+        description: "Specific [tweet fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet) to be included in the returned pinned Tweet. Only applicable if the user has a pinned Tweet and you've requested the `referenced_tweets.id` expansion.",
+    },
+    userFields: {
+        propDefinition: [
+            app,
+            "userFields",
+        ],
+        description: "Specific [user fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user) to be included in the returned user object.",
+    },
+};

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

@@ -0,0 +1,18 @@
+export interface ListFields {
+    expansions?: string;
+    "list.fields"?: string;
+    "user.fields"?: string;
+}
+export interface UserFields {
+    expansions?: string;
+    "tweet.fields"?: string;
+    "user.fields"?: string;
+}
+export interface TweetFields {
+    expansions?: string;
+    "media.fields"?: string;
+    "place.fields"?: string;
+    "poll.fields"?: string;
+    "tweet.fields"?: string;
+    "user.fields"?: string;
+}

package/dist/common/types/fields.mjs

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

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

@@ -0,0 +1,103 @@
+import { Pipedream } from "@pipedream/types";
+import { ListFields, TweetFields, UserFields } from "./fields.js";
+interface PdAxiosRequest {
+    $: Pipedream;
+}
+interface PaginationParams {
+    maxPerPage?: number;
+    maxResults?: number;
+}
+interface PaginatedRequest extends PdAxiosRequest, PaginationParams {
+}
+export interface HttpRequestParams extends PdAxiosRequest {
+    url: string;
+    method: string;
+    data?: object | string;
+    params?: object;
+}
+export interface PaginatedRequestParams extends HttpRequestParams, PaginationParams {
+}
+export interface AddUserToListParams extends PdAxiosRequest {
+    listId: string;
+    data: {
+        user_id: string;
+    };
+}
+export interface CreateTweetParams extends PdAxiosRequest {
+    data: {
+        text: string;
+        geo?: {
+            place_id: string;
+        };
+        media?: {
+            media_ids: string[];
+            tagged_user_ids: string[];
+        };
+        reply?: {
+            exclude_reply_user_ids: string[];
+            in_reply_to_tweet_id: string;
+        };
+    };
+}
+interface ListId {
+    listId: string;
+}
+interface UserId {
+    userId: string;
+}
+interface TweetId {
+    tweetId: string;
+}
+export interface DeleteTweetParams extends PdAxiosRequest, TweetId {
+}
+export interface FollowUserParams extends PdAxiosRequest {
+    data: {
+        target_user_id: string;
+    };
+}
+export interface GetUserLikedTweetParams extends PaginatedRequest, UserId {
+    params?: TweetFields;
+}
+export interface GetListTweetsParams extends PaginatedRequest, ListId {
+    params?: TweetFields;
+}
+export interface GetUserOwnedListsParams extends PaginatedRequest, UserId {
+    params?: ListFields;
+}
+export interface GetUserMentionsParams extends PaginatedRequest, UserId {
+    params?: TweetFields;
+}
+export interface GetUserTweetsParams extends PaginatedRequest, UserId {
+    params?: TweetFields & {
+        since_id?: string;
+    };
+}
+export interface GetUserFollowedListsParams extends PaginatedRequest, UserId {
+    params?: ListFields;
+}
+export interface GetUserParams extends PdAxiosRequest, UserId {
+    params?: UserFields;
+}
+export interface GetTweetParams extends PdAxiosRequest, TweetId {
+    params?: TweetFields;
+}
+export interface GetUserFollowersParams extends PaginatedRequest, UserId {
+    params?: UserFields;
+}
+export type GetUserFollowingParams = GetUserFollowersParams;
+export interface LikeTweetParams extends PdAxiosRequest {
+    data: {
+        tweet_id: string;
+    };
+}
+export type RetweetParams = LikeTweetParams;
+export interface SearchTweetsParams extends PaginatedRequest {
+    params: {
+        query: string;
+    };
+}
+export interface UnfollowUserParams extends PdAxiosRequest, UserId {
+}
+export interface UnlikeTweetParams extends PdAxiosRequest, TweetId {
+}
+export {};

package/dist/common/types/requestParams.mjs

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

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

@@ -0,0 +1,42 @@
+export interface TwitterEntity {
+    id: string;
+}
+export type TwitterEntityMap = Record<string, object>;
+export interface List extends TwitterEntity {
+    name: string;
+}
+export interface Tweet extends TwitterEntity {
+    text: string;
+    edit_history_tweet_ids: string[];
+    referenced_tweets?: ReferencedTweet[];
+    includes?: {
+        tweets?: Tweet[];
+    };
+}
+export interface ReferencedTweet {
+    id: string;
+    type: "retweeted" | "quoted" | "replied_to";
+}
+export interface User extends TwitterEntity {
+    name: string;
+    username: string;
+}
+interface ResponseIncludes {
+    users?: User[];
+    tweets?: Tweet[];
+}
+interface ResponseBase {
+    includes?: ResponseIncludes;
+    errors?: object;
+}
+export type ResponseObject<T extends TwitterEntity> = ResponseBase & {
+    data?: T | T[];
+};
+export type PaginatedResponseObject<T extends TwitterEntity> = ResponseBase & {
+    data?: T[];
+    meta?: {
+        next_token?: string;
+        result_count: number;
+    };
+};
+export {};

package/dist/common/types/responseSchemas.mjs

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

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

@@ -0,0 +1,149 @@
+import { TwitterEntity } from "../../common/types/responseSchemas.js";
+declare const _default: {
+    props: {
+        app: import("@pipedream/types").App<{
+            _getAuthHeader(config: import("../../common/types/requestParams.js").HttpRequestParams): Promise<import("oauth-1.0a").Header>;
+            _getBaseUrl(): "https://api.twitter.com/2";
+            _httpRequest({ $, ...args }: import("../../common/types/requestParams.js").HttpRequestParams): Promise<import("../../common/types/responseSchemas").ResponseObject<TwitterEntity>>;
+            _paginatedRequest({ maxResults, maxPerPage, params, ...args }: import("../../common/types/requestParams.js").PaginatedRequestParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<TwitterEntity>>;
+            addUserToList({ listId, ...args }: import("../../common/types/requestParams.js").AddUserToListParams): Promise<object>;
+            createTweet(args: import("../../common/types/requestParams.js").CreateTweetParams): Promise<object>;
+            deleteTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").DeleteTweetParams): Promise<object>;
+            followUser(args: import("../../common/types/requestParams.js").FollowUserParams): Promise<object>;
+            getListTweets({ listId, ...args }: import("../../common/types/requestParams.js").GetListTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").GetTweetParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getAuthenticatedUserId(): Promise<string>;
+            getUserLikedTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserLikedTweetParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getUserOwnedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserOwnedListsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").List>>;
+            getUserFollowedLists({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowedListsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").List>>;
+            getUserMentions({ userId, ...args }: import("../../common/types/requestParams.js").GetUserMentionsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getUserTweets({ userId, ...args }: import("../../common/types/requestParams.js").GetUserTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            getUserByUsername(username: string): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").User>>;
+            getUser({ userId, ...args }: import("../../common/types/requestParams.js").GetUserParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").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").PaginatedResponseObject<import("../../common/types/responseSchemas").User>>;
+            getUserFollowing({ userId, ...args }: import("../../common/types/requestParams.js").GetUserFollowersParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").User>>;
+            retweet(args: import("../../common/types/requestParams.js").LikeTweetParams): Promise<object>;
+            searchTweets(args: import("../../common/types/requestParams.js").SearchTweetsParams): Promise<import("../../common/types/responseSchemas").PaginatedResponseObject<import("../../common/types/responseSchemas").Tweet>>;
+            unfollowUser({ userId, ...args }: import("../../common/types/requestParams.js").UnfollowUserParams): Promise<object>;
+            unlikeTweet({ tweetId, ...args }: import("../../common/types/requestParams.js").UnlikeTweetParams): Promise<object>;
+        }, {
+            maxResults: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+            };
+            listId: {
+                type: string;
+                label: string;
+                description: string;
+                options(): Promise<{
+                    label: string;
+                    value: string;
+                }[]>;
+            };
+            userNameOrId: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                default: string;
+            };
+            tweetId: {
+                type: string;
+                label: string;
+                description: string;
+            };
+            query: {
+                type: string;
+                label: string;
+                description: string;
+            };
+            listExpansions: {
+                type: string;
+                label: string;
+                optional: boolean;
+                description: string;
+                options: string[];
+            };
+            tweetExpansions: {
+                type: string;
+                label: string;
+                optional: boolean;
+                description: string;
+                options: string[];
+            };
+            userExpansions: {
+                type: string;
+                label: string;
+                optional: boolean;
+                description: string;
+                options: string[];
+            };
+            listFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            mediaFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            placeFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            pollFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            tweetFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+            userFields: {
+                type: string;
+                label: string;
+                description: string;
+                optional: boolean;
+                options: string[];
+            };
+        }>;
+        db: string;
+        timer: {
+            type: string;
+            default: {
+                intervalSeconds: number;
+            };
+        };
+    };
+    hooks: {
+        deploy(): Promise<void>;
+    };
+    methods: {
+        getEntityName(): string;
+        getItemSummary(): string;
+        getResources(): Promise<TwitterEntity[]>;
+        getSavedIds(): string[];
+        setSavedIds(data: string[]): void;
+        getAndProcessData(emit?: boolean): Promise<void>;
+        emitEvent(data: TwitterEntity): void;
+    };
+    run(): Promise<void>;
+};
+export default _default;

package/dist/sources/common/base.mjs

@@ -0,0 +1,62 @@
+import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
+import app from "../../app/twitter.app.mjs";
+export default {
+    props: {
+        app,
+        db: "$.service.db",
+        timer: {
+            type: "$.interface.timer",
+            default: {
+                intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+            },
+        },
+    },
+    hooks: {
+        async deploy() {
+            await this.getAndProcessData();
+        },
+    },
+    methods: {
+        getEntityName() {
+            return "Entity";
+        },
+        getItemSummary() {
+            throw new Error("getItemSummary() not implemented in component");
+        },
+        async getResources() {
+            throw new Error("getResources() not implemented in component");
+        },
+        getSavedIds() {
+            return this.db.get("savedEntityIds");
+        },
+        setSavedIds(data) {
+            this.db.set("savedEntityIds", data);
+        },
+        async getAndProcessData(emit = false) {
+            const data = await this.getResources(emit);
+            if (data) {
+                const savedIds = this.getSavedIds() ?? [];
+                data.filter(({ id }) => !savedIds.includes(id)).reverse()
+                    .forEach((obj) => {
+                    if (emit)
+                        this.emitEvent(obj);
+                    const { id } = obj;
+                    savedIds.push(id);
+                });
+                this.setSavedIds(savedIds);
+            }
+        },
+        emitEvent(data) {
+            const ts = Date.now();
+            const { id } = data;
+            this.$emit(data, {
+                id,
+                summary: `New ${this.getEntityName()}: "${this.getItemSummary(data)}"`,
+                ts,
+            });
+        },
+    },
+    async run() {
+        await this.getAndProcessData(true);
+    },
+};

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

@@ -0,0 +1,7 @@
+import { getUserId } from "../../common/methods.js";
+declare function getCachedUserId(): Promise<string>;
+declare const _default: {
+    getCachedUserId: typeof getCachedUserId;
+    getUserId: typeof getUserId;
+};
+export default _default;

package/dist/sources/common/cacheUserId.mjs

@@ -0,0 +1,18 @@
+import { getUserId } from "../../common/methods.mjs";
+async function getCachedUserId() {
+    const { userNameOrId: name } = this;
+    const cache = this.db.get("cachedUser");
+    if (cache?.name === name) {
+        return cache.id;
+    }
+    const id = await this.getUserId();
+    this.db.set("cachedUser", {
+        id,
+        name,
+    });
+    return id;
+}
+export default {
+    getCachedUserId,
+    getUserId,
+};

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

@@ -0,0 +1,4 @@
+import { List, Tweet, User } from "../../common/types/responseSchemas.js";
+export declare function getListSummary({ name }: List): string;
+export declare function getTweetSummary({ text }: Tweet): string;
+export declare function getUserSummary({ username }: User): string;

package/dist/sources/common/getItemSummary.mjs

@@ -0,0 +1,12 @@
+export function getListSummary({ name }) {
+    return name;
+}
+export function getTweetSummary({ text }) {
+    const TWEET_SUMMARY_MAX_LENGTH = 30;
+    return text.length > TWEET_SUMMARY_MAX_LENGTH
+        ? text.slice(0, TWEET_SUMMARY_MAX_LENGTH) + "..."
+        : text;
+}
+export function getUserSummary({ username }) {
+    return username;
+}