abraham / twitter-d

TypeScript types for Twitter API objects

Recent Tweets

Abraham Williams @abraham Saturday, May 13, 2023 at 1:25 PM

Ready to try Mastodon? Here’s how to get started https://t.co/owYhfYDgrL via @firefox

   2 2

---

Abraham Williams @abraham Wednesday, May 3, 2023 at 6:56 PM

Musk threatens to reassign NPR Twitter account if it won’t start tweeting again

https://t.co/LAnpU8ydGy

 1 1   2 2

---

Abraham Williams @abraham Wednesday, April 12, 2023 at 7:16 PM

NPR quits Elon Musk's Twitter over 'government-funded' label

https://t.co/M608OOwcVn

  

---

Abraham Williams @abraham Sunday, April 9, 2023 at 3:46 PM

The sudden death and rebirth of Tweetbot

https://t.co/fCRsiXRrYg

  

---

Abraham Williams @abraham Thursday, April 6, 2023 at 11:15 PM

Twitter slaps NPR with a dubious new tag: ‘State-affiliated media’

https://t.co/aB8TaxVFHs

 1 1   1 1

Last updated Tuesday, June 13, 2023 at 5:33 PM UTC.

twitter-d's Issues

Nested User fields do not exist

Under Status.User, any key that is not in both User and TrimmedUser does not exist. I believe this is because of the incorrect type here:

export type User = TrimmedUser | FullUser

text field missing in interface Status definition

the interface status.d.ts has no text field
(but has full_text that doesn't exists)

See Example Response for object format at
https://developer.twitter.com/en/docs/twitter-api/v1/tweets/timelines/api-reference/get-statuses-mentions_timeline

export interface Status {
  // ...
  full_text: string; // doesn t exist !
  text: string; // field missing
}

FullUser and TrimmedUser should be exported from root

As a follow-up to this work: #37

A user can now import a specific type with import { FullUser } from "twitter-d/types/user";, but that goes against tslint rule no-submodule-imports. Just exporting it out of the root fixes the problem.

Create multiple Status types

There are a number of fields that are grouped together for specific types of tweets. It would be nice to have the following types:

export type Status = SimpleStatus | ExtendedStatus | QuotedStatus | ReplyStatus | RetweetStatus;

If there are too many permutations this might not make sense.

Deprecated User fields

Remove or highlight the deprecated fields.

https://twittercommunity.com/t/upcoming-changes-to-user-object-and-get-users-suggestions-endpoints/124732

Rename to twitter-dts

Seems like name-dts might be the common convention.

• https://github.com/google/schema-dts

User in Status may be trimmed

For example, statuses / user_timeline allows trim_user.
User information is excluded from Status by specifying trim_user as true.
In other words, I think User should be optional.

See also : https://developer.twitter.com/en/docs/tweets/timelines/api-reference/get-statuses-user_timeline.html

Field text is missing in status

Hello,

Many thanks to share these declarations.
Why did you remove the text field of a status?
Best regards,

Pierre-Olivier

Does this give types for the v2 API?