@pipedream/twitter 1.0.0 → 1.1.0

package/dist/common/additionalProps.mjs

@@ -0,0 +1,138 @@
+// This is no longer being used. Requests send all the available fields by default.
+// If it ever makes sense to allow customizing which fields are sent, this can be re-enabled
+/*
+import {
+  LIST_FIELD_OPTIONS,
+  MEDIA_FIELD_OPTIONS,
+  PLACE_FIELD_OPTIONS,
+  POLL_FIELD_OPTIONS,
+  TWEET_FIELD_OPTIONS,
+  USER_FIELD_OPTIONS,
+} from "./dataFields.mjs";
+import {
+  LIST_EXPANSION_OPTIONS,
+  TWEET_EXPANSION_OPTIONS,
+  USER_EXPANSION_OPTIONS,
+} from "./expansions.mjs";
+
+// These cannot be propDefinitions in the app file, because additionalProps() needs them to be primitives
+const listExpansions = {
+  type: "string[]",
+  label: "Expansions",
+  optional: true,
+  description:
+    "Additional data objects related to the List(s) to be included in the response.",
+  options: LIST_EXPANSION_OPTIONS,
+};
+const tweetExpansions = {
+  type: "string[]",
+  label: "Expansions",
+  optional: true,
+  description:
+    "Additional data objects related to the Tweet(s) to be included in the response.",
+  options: TWEET_EXPANSION_OPTIONS,
+};
+const userExpansions = {
+  type: "string[]",
+  label: "Expansions",
+  optional: true,
+  description:
+    "Additional data objects related to the User(s) to be included in the response.",
+  options: USER_EXPANSION_OPTIONS,
+};
+const listFields = {
+  type: "string[]",
+  label: "List Fields",
+  description:
+    "Specific [list fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/lists) to be included in the returned list object.",
+  optional: true,
+  options: LIST_FIELD_OPTIONS,
+};
+const mediaFields = {
+  type: "string[]",
+  label: "Media Fields",
+  description:
+    "Specific [media fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/media) to be included in the returned Tweet(s). Only applicable if the Tweet contains media and you've requested the `attachments.media_keys` expansion.",
+  optional: true,
+  options: MEDIA_FIELD_OPTIONS,
+};
+const placeFields = {
+  type: "string[]",
+  label: "Place Fields",
+  description:
+    "Specific [place fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/place) to be included in the returned Tweet(s). Only applicable if the Tweet contains a place and you've requested the `geo.place_id` expansion.",
+  optional: true,
+  options: PLACE_FIELD_OPTIONS,
+};
+const pollFields = {
+  type: "string[]",
+  label: "Poll Fields",
+  description:
+    "Specific [poll fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/poll) to be included in the returned Tweet(s). Only applicable if the Tweet contains a poll and you've requested the `attachments.poll_ids` expansion.",
+  optional: true,
+  options: POLL_FIELD_OPTIONS,
+};
+const tweetFields = {
+  type: "string[]",
+  label: "Tweet Fields",
+  description:
+    "Specific [tweet fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/tweet) to be included in the returned Tweet(s). If you've requested the `referenced_tweets.id` expansion, these fields will also be returned for any included referenced Tweets.",
+  optional: true,
+  options: TWEET_FIELD_OPTIONS,
+};
+const userFields = {
+  type: "string[]",
+  label: "User Fields",
+  description:
+    "Specific [user fields](https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user) to be included in the returned Tweet(s). Only applicable if you've requested one of the user expansions: `author_id`, `entities.mentions.username`, `in_reply_to_user_id`, `referenced_tweets.id.author_id`.",
+  optional: true,
+  options: USER_FIELD_OPTIONS,
+};
+
+// The 'any' here is needed because of the additionalProps behavior
+
+export async function listAdditionalProps(): Promise<Record<string, any>> {
+  return this.includeAllFields === false
+    ? {
+      expansions: listExpansions,
+      listFields,
+      userFields: {
+        ...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 async function tweetAdditionalProps(): Promise<Record<string, any>> {
+  return this.includeAllFields === false
+    ? {
+      expansions: tweetExpansions,
+      mediaFields,
+      placeFields,
+      pollFields,
+      tweetFields,
+      userFields,
+    }
+    : {};
+}
+
+export async function userAdditionalProps(): Promise<Record<string, any>> {
+  return this.includeAllFields === false
+    ? {
+      expansions: userExpansions,
+      tweetFields: {
+        ...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: {
+        ...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/methods.mjs

@@ -1,4 +1,6 @@
 import { ConfigurationError } from "@pipedream/platform";
+import { LIST_FIELD_OPTIONS, MEDIA_FIELD_OPTIONS, PLACE_FIELD_OPTIONS, POLL_FIELD_OPTIONS, TWEET_FIELD_OPTIONS, USER_FIELD_OPTIONS, } from "./dataFields.mjs";
+import { LIST_EXPANSION_OPTIONS, USER_EXPANSION_OPTIONS, } from "./expansions.mjs";
 export async function getUserId() {
     let { userNameOrId: id } = this;
     if (id === "me" || id === undefined) {
@@ -20,29 +22,48 @@ export function getMultiItemSummary(name, length) {
         : `No ${name}s were found`;
 }
 export function getListFields() {
-    const { expansions, listFields, userFields, } = this;
+    // See comment on "../common/additionalProps.ts"
+    /*
+    const {
+      includeAllFields, expansions, listFields, userFields,
+    }: Record<string, string[]> = this;
+    */
     return {
-        "expansions": expansions?.join(),
-        "list.fields": listFields?.join(),
-        "user.fields": userFields?.join(),
+        "expansions": LIST_EXPANSION_OPTIONS.join(),
+        "list.fields": LIST_FIELD_OPTIONS.join(),
+        "user.fields": USER_FIELD_OPTIONS.join(),
     };
 }
 export function getTweetFields() {
-    const { expansions, mediaFields, placeFields, pollFields, tweetFields, userFields, } = this;
+    /*
+    const {
+      includeAllFields,
+      expansions,
+      mediaFields,
+      placeFields,
+      pollFields,
+      tweetFields,
+      userFields,
+    }: Record<string, string[]> = this;
+    */
     return {
-        "expansions": expansions?.join(),
-        "media.fields": mediaFields?.join(),
-        "place.fields": placeFields?.join(),
-        "poll.fields": pollFields?.join(),
-        "tweet.fields": tweetFields?.join(),
-        "user.fields": userFields?.join(),
+        "expansions": LIST_EXPANSION_OPTIONS.join(),
+        "media.fields": MEDIA_FIELD_OPTIONS.join(),
+        "place.fields": PLACE_FIELD_OPTIONS.join(),
+        "poll.fields": POLL_FIELD_OPTIONS.join(),
+        "tweet.fields": TWEET_FIELD_OPTIONS.join(),
+        "user.fields": USER_FIELD_OPTIONS.join(),
     };
 }
 export function getUserFields() {
-    const { expansions, tweetFields, userFields, } = this;
+    /*
+    const {
+      includeAllFields, expansions, tweetFields, userFields,
+    }: Record<string, string[]> = this;
+    */
     return {
-        "expansions": expansions?.join(),
-        "tweet.fields": tweetFields?.join(),
-        "user.fields": userFields?.join(),
+        "expansions": USER_EXPANSION_OPTIONS.join(),
+        "tweet.fields": TWEET_FIELD_OPTIONS.join(),
+        "user.fields": USER_FIELD_OPTIONS.join(),
     };
 }

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

@@ -75,9 +75,11 @@ export interface GetUserTweetsParams extends PaginatedRequest, UserId {
 export interface GetUserFollowedListsParams extends PaginatedRequest, UserId {
     params?: ListFields;
 }
-export interface GetUserParams extends PdAxiosRequest, UserId {
+export interface GetAuthenticatedUserParams extends PdAxiosRequest {
     params?: UserFields;
 }
+export interface GetUserParams extends GetAuthenticatedUserParams, UserId {
+}
 export interface GetTweetParams extends PdAxiosRequest, TweetId {
     params?: TweetFields;
 }

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

@@ -12,6 +12,7 @@ declare const _default: {
             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>>;
+            getAuthenticatedUser(args: import("../../common/types/requestParams.js").GetAuthenticatedUserParams): Promise<import("../../common/types/responseSchemas").ResponseObject<import("../../common/types/responseSchemas").User>>;
             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>>;
@@ -60,69 +61,6 @@ declare const _default: {
                 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: {
@@ -141,7 +79,7 @@ declare const _default: {
         getResources(): Promise<TwitterEntity[]>;
         getSavedIds(): string[];
         setSavedIds(data: string[]): void;
-        getAndProcessData(emit?: boolean): Promise<void>;
+        getAndProcessData(maxResults?: number): Promise<void>;
         emitEvent(data: TwitterEntity): void;
     };
     run(): Promise<void>;

package/dist/sources/common/base.mjs

@@ -32,16 +32,14 @@ export default {
         setSavedIds(data) {
             this.db.set("savedEntityIds", data);
         },
-        async getAndProcessData(emit = false) {
-            const data = await this.getResources(emit);
+        async getAndProcessData(maxResults) {
+            const data = await this.getResources(maxResults);
             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.emitEvent(obj);
+                    savedIds.push(obj.id);
                 });
                 this.setSavedIds(savedIds);
             }
@@ -57,6 +55,6 @@ export default {
         },
     },
     async run() {
-        await this.getAndProcessData(true);
+        await this.getAndProcessData(50);
     },
 };