twitter-openapi-typescript 0.0.43 → 0.0.45

package/src/apis/tweetApi.ts

@@ -1,289 +0,0 @@
-import {
-  DefaultFlag,
-  RequestParam,
-  TimelineApiUtilsResponse,
-  TweetApiUtilsData,
-  TwitterApiUtilsResponse,
-  initOverrides,
-} from '@/models';
-import {
-  buildHeader,
-  entriesCursor,
-  errorCheck,
-  getKwargs,
-  instructionConverter,
-  instructionToEntry,
-  nonNullable,
-  tweetEntriesConverter,
-} from '@/utils';
-import * as i from 'twitter-openapi-typescript-generated';
-
-type GetTweetDetailParam = {
-  focalTweetId: string;
-  cursor?: string;
-  controllerData?: string;
-  extraParam?: { [key: string]: any };
-};
-
-type GetSearchTimelineParam = {
-  rawQuery: string;
-  product?: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-type GetHomeTimelineParam = {
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetHomeLatestTimelineParam = {
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetListLatestTweetsTimelineParam = {
-  listId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetUserTweetsParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetUserTweetsAndRepliesParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetUserMediaParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetLikesParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetBookmarksParam = {
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type ResponseType = TwitterApiUtilsResponse<TimelineApiUtilsResponse<TweetApiUtilsData>>;
-
-export class TweetApiUtils {
-  api: i.TweetApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.TweetApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-
-  async request<T>(param: RequestParam<i.InstructionUnion[], T>): Promise<ResponseType> {
-    const apiFn: typeof param.apiFn = param.apiFn.bind(this.api);
-    const args = getKwargs(this.flag[param.key], param.param);
-    const response = await apiFn(args, this.initOverrides);
-    const checked = errorCheck(await response.value());
-    const instruction = param.convertFn(checked);
-    const entry = instructionToEntry(instruction);
-    const data = [...tweetEntriesConverter(entry), ...instructionConverter(instruction)];
-    return {
-      raw: {
-        response: response.raw,
-      },
-      header: buildHeader(response.raw.headers),
-      data: {
-        raw: {
-          instruction,
-          entry,
-        },
-        cursor: entriesCursor(entry),
-        data: data,
-      },
-    };
-  }
-
-  async getTweetDetail(param: GetTweetDetailParam): Promise<ResponseType> {
-    const args = {
-      focalTweetId: param.focalTweetId,
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.controllerData == undefined ? {} : { controller_data: param.controllerData }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getTweetDetailRaw,
-      convertFn: (e) => e.data.threadedConversationWithInjectionsV2.instructions,
-      key: 'TweetDetail',
-      param: args,
-    });
-    return response;
-  }
-  async getSearchTimeline(param: GetSearchTimelineParam): Promise<ResponseType> {
-    const args = {
-      rawQuery: param.rawQuery,
-      ...(param.product == undefined ? {} : { product: param.product }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getSearchTimelineRaw,
-      convertFn: (e) => e.data.searchByRawQuery.searchTimeline.timeline.instructions,
-      key: 'SearchTimeline',
-      param: args,
-    });
-    return response;
-  }
-
-  async getHomeTimeline(param: GetHomeTimelineParam = {}): Promise<ResponseType> {
-    const args = {
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getHomeTimelineRaw,
-      convertFn: (e) => e.data.home.homeTimelineUrt.instructions,
-      key: 'HomeTimeline',
-      param: args,
-    });
-    return response;
-  }
-
-  async getHomeLatestTimeline(param: GetHomeLatestTimelineParam = {}): Promise<ResponseType> {
-    const args = {
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getHomeLatestTimelineRaw,
-      convertFn: (e) => e.data.home.homeTimelineUrt.instructions,
-      key: 'HomeLatestTimeline',
-      param: args,
-    });
-    return response;
-  }
-
-  async getListLatestTweetsTimeline(param: GetListLatestTweetsTimelineParam): Promise<ResponseType> {
-    const args = {
-      listId: param.listId,
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getListLatestTweetsTimelineRaw,
-      convertFn: (e) => e.data.list.tweetsTimeline.timeline?.instructions ?? [],
-      key: 'ListLatestTweetsTimeline',
-      param: args,
-    });
-    return response;
-  }
-
-  async getUserTweets(param: GetUserTweetsParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getUserTweetsRaw,
-      convertFn: (e) => nonNullable(e.data.user.result.timelineV2.timeline).instructions,
-      key: 'UserTweets',
-      param: args,
-    });
-    return response;
-  }
-
-  async getUserTweetsAndReplies(param: GetUserTweetsAndRepliesParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getUserTweetsAndRepliesRaw,
-      convertFn: (e) => nonNullable(e.data.user.result.timelineV2.timeline).instructions,
-      key: 'UserTweetsAndReplies',
-      param: args,
-    });
-    return response;
-  }
-
-  async getUserMedia(param: GetUserMediaParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getUserMediaRaw,
-      convertFn: (e) => nonNullable(e.data.user.result.timelineV2.timeline).instructions,
-      key: 'UserMedia',
-      param: args,
-    });
-    return response;
-  }
-  async getLikes(param: GetLikesParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getLikesRaw,
-      convertFn: (e) => nonNullable(e.data.user.result.timelineV2.timeline).instructions,
-      key: 'Likes',
-      param: args,
-    });
-    return response;
-  }
-  async getBookmarks(param: GetBookmarksParam = {}): Promise<ResponseType> {
-    const args = {
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...param.extraParam,
-    };
-
-    const response = await this.request({
-      apiFn: this.api.getBookmarksRaw,
-      convertFn: (e) => e.data.bookmarkTimelineV2.timeline.instructions,
-      key: 'Bookmarks',
-      param: args,
-    });
-    return response;
-  }
-}

package/src/apis/userApi.ts

@@ -1,72 +0,0 @@
-import { DefaultFlag, RequestParam, TwitterApiUtilsResponse, UserApiUtilsData, initOverrides } from '@/models';
-import { buildHeader, errorCheck, getKwargs, nonNullable, userOrNullConverter } from '@/utils';
-import * as i from 'twitter-openapi-typescript-generated';
-
-type getUserByScreenNameParam = {
-  screenName: string;
-  extraParam?: { [key: string]: any };
-};
-
-type getUserByRestIdParam = {
-  userId: string;
-  extraParam?: { [key: string]: any };
-};
-
-type ResponseType = TwitterApiUtilsResponse<UserApiUtilsData>;
-
-export class UserApiUtils {
-  api: i.UserApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.UserApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-
-  async request<T>(param: RequestParam<i.UserResults, T>): Promise<ResponseType> {
-    const apiFn: typeof param.apiFn = param.apiFn.bind(this.api);
-    const args = getKwargs(this.flag[param.key], param.param);
-    const response = await apiFn(args, this.initOverrides);
-    const checked = errorCheck(await response.value());
-    const result = param.convertFn(checked);
-    const user = result.result && userOrNullConverter(result.result);
-
-    return {
-      raw: { response: response.raw },
-      header: buildHeader(response.raw.headers),
-      data: {
-        raw: result,
-        user: user,
-      },
-    };
-  }
-
-  async getUserByScreenName(param: getUserByScreenNameParam): Promise<ResponseType> {
-    const args = {
-      screen_name: param.screenName,
-      ...param.extraParam,
-    };
-    const response = this.request({
-      key: 'UserByScreenName',
-      apiFn: this.api.getUserByScreenNameRaw,
-      convertFn: (e) => nonNullable(e.data.user),
-      param: args,
-    });
-    return response;
-  }
-  async getUserByRestId(param: getUserByRestIdParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...param.extraParam,
-    };
-    const response = this.request({
-      key: 'UserByRestId',
-      apiFn: this.api.getUserByRestIdRaw,
-      convertFn: (e) => nonNullable(e.data.user),
-      param: args,
-    });
-    return response;
-  }
-}

package/src/apis/userListApi.ts

@@ -1,173 +0,0 @@
-import {
-  DefaultFlag,
-  RequestParam,
-  TimelineApiUtilsResponse,
-  TwitterApiUtilsResponse,
-  UserApiUtilsData,
-  initOverrides,
-} from '@/models';
-import {
-  buildHeader,
-  entriesCursor,
-  errorCheck,
-  getKwargs,
-  instructionToEntry,
-  nonNullable,
-  userEntriesConverter,
-  userResultConverter,
-} from '@/utils';
-import * as i from 'twitter-openapi-typescript-generated';
-
-type GetFollowersParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetFollowingParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetFollowersYouKnowParam = {
-  userId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetFavoritersParam = {
-  tweetId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type GetRetweetersParam = {
-  tweetId: string;
-  cursor?: string;
-  count?: number;
-  extraParam?: { [key: string]: any };
-};
-
-type ResponseType = TwitterApiUtilsResponse<TimelineApiUtilsResponse<UserApiUtilsData>>;
-
-export class UserListApiUtils {
-  api: i.UserListApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.UserListApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-
-  async request<T>(param: RequestParam<i.InstructionUnion[], T>): Promise<ResponseType> {
-    const apiFn: typeof param.apiFn = param.apiFn.bind(this.api);
-    const args = getKwargs(this.flag[param.key], param.param);
-    const response = await apiFn(args, this.initOverrides);
-    const checked = errorCheck(await response.value());
-    const instruction = param.convertFn(checked);
-    const entry = instructionToEntry(instruction);
-    const userList = userEntriesConverter(entry);
-    const data = userResultConverter(userList);
-
-    return {
-      raw: {
-        response: response.raw,
-      },
-      header: buildHeader(response.raw.headers),
-      data: {
-        raw: {
-          instruction: instruction,
-          entry: entry,
-        },
-        data: data,
-        cursor: entriesCursor(entry),
-      },
-    };
-  }
-
-  async getFollowers(param: GetFollowersParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...param.extraParam,
-    };
-    const response = await this.request({
-      apiFn: this.api.getFollowersRaw,
-      convertFn: (e) => e.data.user.result.timeline.timeline.instructions,
-      key: 'Followers',
-      param: args,
-    });
-    return response;
-  }
-  async getFollowing(param: GetFollowingParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...param.extraParam,
-    };
-    const response = await this.request({
-      apiFn: this.api.getFollowingRaw,
-      convertFn: (e) => e.data.user.result.timeline.timeline.instructions,
-      key: 'Following',
-      param: args,
-    });
-    return response;
-  }
-
-  async getFollowersYouKnow(param: GetFollowersYouKnowParam): Promise<ResponseType> {
-    const args = {
-      userId: param.userId,
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...param.extraParam,
-    };
-    const response = await this.request({
-      apiFn: this.api.getFollowersYouKnowRaw,
-      convertFn: (e) => e.data.user.result.timeline.timeline.instructions,
-      key: 'FollowersYouKnow',
-      param: args,
-    });
-    return response;
-  }
-
-  async getFavoriters(param: GetFavoritersParam): Promise<ResponseType> {
-    const args = {
-      tweetId: param.tweetId,
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...param.extraParam,
-    };
-    const response = await this.request({
-      apiFn: this.api.getFavoritersRaw,
-      convertFn: (e) => nonNullable(e.data.favoritersTimeline.timeline).instructions,
-      key: 'Favoriters',
-      param: args,
-    });
-    return response;
-  }
-
-  async getRetweeters(param: GetRetweetersParam): Promise<ResponseType> {
-    const args = {
-      tweetId: param.tweetId,
-      ...(param.cursor == undefined ? {} : { cursor: param.cursor }),
-      ...(param.count == undefined ? {} : { count: param.count }),
-      ...param.extraParam,
-    };
-    const response = await this.request({
-      apiFn: this.api.getRetweetersRaw,
-      convertFn: (e) => nonNullable(e.data.retweetersTimeline.timeline).instructions,
-      key: 'Retweeters',
-      param: args,
-    });
-    return response;
-  }
-}

package/src/apis/usersApi.ts

@@ -1,50 +0,0 @@
-import { DefaultFlag, RequestParam, TwitterApiUtilsResponse, UserApiUtilsData, initOverrides } from '@/models';
-import { buildHeader, errorCheck, getKwargs, userResultConverter } from '@/utils';
-import * as i from 'twitter-openapi-typescript-generated';
-
-type getUsersByRestIdsParam = {
-  userIds: string[];
-  extraParam?: { [key: string]: any };
-};
-
-type ResponseType = TwitterApiUtilsResponse<UserApiUtilsData[]>;
-
-export class UsersApiUtils {
-  api: i.UsersApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.UsersApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-
-  async request<T>(param: RequestParam<i.UserResults[], T>): Promise<ResponseType> {
-    const apiFn: typeof param.apiFn = param.apiFn.bind(this.api);
-    const args = getKwargs(this.flag[param.key], param.param);
-    const response = await apiFn(args, this.initOverrides);
-    const checked = errorCheck(await response.value());
-    const result = param.convertFn(checked);
-    const user = userResultConverter(result);
-
-    return {
-      raw: { response: response.raw },
-      header: buildHeader(response.raw.headers),
-      data: user,
-    };
-  }
-  async getUsersByRestIds(param: getUsersByRestIdsParam): Promise<ResponseType> {
-    const args = {
-      userIds: param.userIds,
-      ...param.extraParam,
-    };
-    const response = this.request({
-      key: 'UsersByRestIds',
-      apiFn: this.api.getUsersByRestIdsRaw,
-      convertFn: (e) => e.data.users,
-      param: args,
-    });
-    return response;
-  }
-}

package/src/apis/v11GetApi.ts

@@ -1,14 +0,0 @@
-import { DefaultFlag, initOverrides } from '@/models';
-import * as i from 'twitter-openapi-typescript-generated';
-
-export class V11GetApiUtils {
-  api: i.V11GetApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.V11GetApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-}

package/src/apis/v11PostApi.ts

@@ -1,75 +0,0 @@
-import { DefaultFlag, TwitterApiUtilsResponse, initOverrides } from '@/models';
-import { buildHeader } from '@/utils';
-import * as i from 'twitter-openapi-typescript-generated';
-
-type PostCreateFriendshipsParam = {
-  userId: string;
-  extraParam?: { [key: string]: any };
-};
-
-type PostDestroyFriendshipsParam = {
-  userId: string;
-  extraParam?: { [key: string]: any };
-};
-
-export class V11PostApiUtils {
-  api: i.V11PostApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.V11PostApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-
-  async postCreateFriendships(param: PostCreateFriendshipsParam): Promise<TwitterApiUtilsResponse<undefined>> {
-    const response = await this.api.postCreateFriendshipsRaw({
-      includeBlockedBy: 1,
-      includeBlocking: 1,
-      includeCanDm: 1,
-      includeCanMediaTag: 1,
-      includeExtHasNftAvatar: 1,
-      includeExtIsBlueVerified: 1,
-      includeExtProfileImageShape: 1,
-      includeExtVerifiedType: 1,
-      includeFollowedBy: 1,
-      includeMuteEdge: 1,
-      includeProfileInterstitialType: 1,
-      includeWantRetweets: 1,
-      skipStatus: 1,
-      userId: param.userId,
-      ...param.extraParam,
-    });
-    return {
-      raw: { response: response.raw },
-      header: buildHeader(response.raw.headers),
-      data: undefined,
-    };
-  }
-
-  async postDestroyFriendships(param: PostDestroyFriendshipsParam): Promise<TwitterApiUtilsResponse<undefined>> {
-    const response = await this.api.postDestroyFriendshipsRaw({
-      includeBlockedBy: 0,
-      includeBlocking: 0,
-      includeCanDm: 0,
-      includeCanMediaTag: 0,
-      includeExtHasNftAvatar: 0,
-      includeExtIsBlueVerified: 0,
-      includeExtProfileImageShape: 0,
-      includeExtVerifiedType: 0,
-      includeFollowedBy: 0,
-      includeMuteEdge: 0,
-      includeProfileInterstitialType: 0,
-      includeWantRetweets: 0,
-      skipStatus: 0,
-      userId: param.userId,
-      ...param.extraParam,
-    });
-    return {
-      raw: { response: response.raw },
-      header: buildHeader(response.raw.headers),
-      data: undefined,
-    };
-  }
-}

package/src/apis/v20GetApi.ts

@@ -1,14 +0,0 @@
-import { DefaultFlag, initOverrides } from '@/models';
-import * as i from 'twitter-openapi-typescript-generated';
-
-export class V20GetApiUtils {
-  api: i.V20GetApi;
-  flag: DefaultFlag;
-  initOverrides: initOverrides;
-
-  constructor(api: i.V20GetApi, flag: DefaultFlag, initOverrides: initOverrides) {
-    this.api = api;
-    this.flag = flag;
-    this.initOverrides = initOverrides;
-  }
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export * from '@/api';
-export * from '@/apis';
-export * from '@/models';
-export * from '@/utils';

package/src/models/flag.ts

@@ -1,5 +0,0 @@
-export type DefaultFlag = {
-  [key: string]: {
-    [key: string]: any;
-  };
-};