fxtwitter 1.0.0 → 2.1.0

package/dist/v1-BKUGwGbc.d.mts

@@ -1,267 +0,0 @@
-//#region src/http.d.ts
-/** Options shared by every client, forwarded to ofetch. */
-interface ClientOptions {
-  /** Overrides the API host. Defaults to `https://api.fxtwitter.com`. */
-  baseUrl?: string;
-  /** Custom fetch implementation (e.g. a mock, or undici in older runtimes). */
-  fetch?: typeof fetch;
-  /**
-   * Extra headers sent with every request.
-   *
-   * When no `User-Agent` is given, one describing the current runtime is
-   * added, because the API answers `401` to requests that do not identify
-   * themselves. Set your own here to override it.
-   */
-  headers?: Record<string, string>;
-  /** Abort a request after this many milliseconds. Disabled by default. */
-  timeout?: number;
-  /** Retry count for failed requests. Defaults to ofetch's `1` for GET. */
-  retry?: number | false;
-  /** Delay between retries in milliseconds. Defaults to `0`. */
-  retryDelay?: number;
-}
-//#endregion
-//#region src/types/v1.d.ts
-interface Facet {
-  /** e.g. `url`, `mention`, `hashtag`, `media`. */
-  type: string;
-  /** Start/end UTF-16 indices. */
-  indices: [number, number];
-  original?: string;
-  replacement?: string;
-  display?: string;
-  id?: string;
-}
-interface RawText {
-  text: string;
-  facets: Facet[];
-}
-interface StatusRawText extends RawText {
-  display_text_range: [number, number];
-}
-interface Website {
-  url: string;
-  display_url: string;
-}
-type VerificationType = "organization" | "government" | "individual" | null;
-interface Verification {
-  verified: boolean;
-  type: VerificationType;
-  verified_at?: string | null;
-  identity_verified?: boolean;
-  verified_by?: string;
-}
-/** The author embedded in a status. Same shape as {@link User}, plus `avatar_color`. */
-interface Author {
-  id: string;
-  name: string;
-  screen_name: string;
-  url: string;
-  description: string;
-  raw_description: RawText;
-  location: string;
-  avatar_url: string | null;
-  banner_url: string | null;
-  /** @deprecated Always `null` upstream. */
-  avatar_color?: string | null;
-  followers: number;
-  following: number;
-  likes: number;
-  media_count: number;
-  joined: string;
-  protected: boolean;
-  website: Website | null;
-  verification?: Verification;
-}
-/** The user returned by `GET /:screen_name`. Uses `tweets` where v2 uses `statuses`. */
-interface User extends Author {
-  /** Status count. Named `statuses` in the v2 API. */
-  tweets: number;
-}
-interface Translation {
-  text: string;
-  source_lang: string;
-  source_lang_en: string;
-  target_lang: string;
-  provider: string;
-}
-interface PollChoice {
-  label: string;
-  count: number;
-  /** 0-100. */
-  percentage: number;
-}
-interface Poll {
-  choices: PollChoice[];
-  total_votes: number;
-  ends_at: string;
-  time_left_en: string;
-}
-interface VideoFormat {
-  container?: "mp4" | "webm" | "m3u8";
-  codec?: "h264" | "hevc" | "vp9" | "av1";
-  bitrate?: number;
-  url: string;
-  size?: number;
-  height?: number;
-  width?: number;
-}
-interface Photo {
-  id?: string;
-  /** MIME type, e.g. `image/jpeg`. */
-  format?: string;
-  type: "photo" | "gif";
-  url: string;
-  width: number;
-  height: number;
-  transcode_url?: string | null;
-  altText?: string;
-}
-interface Video {
-  id?: string;
-  /** MIME type, e.g. `video/mp4`. */
-  format?: string;
-  type: "video" | "gif";
-  url: string;
-  width: number;
-  height: number;
-  thumbnail_url?: string | null;
-  transcode_url?: string | null;
-  duration: number;
-  filesize?: number;
-  formats?: VideoFormat[];
-}
-interface MosaicPhoto {
-  id?: string;
-  type: "mosaic_photo";
-  url?: string;
-  width: number;
-  height: number;
-  formats: {
-    webp: string;
-    jpeg: string;
-  };
-}
-interface ExternalMedia {
-  /** Currently always `video`. */
-  type: string;
-  url: string;
-  thumbnail_url?: string;
-  height?: number;
-  width?: number;
-  duration?: number;
-}
-type AnyMedia = Photo | Video | MosaicPhoto;
-interface StatusMedia {
-  /** Preserves the original ordering across photos and videos. */
-  all?: AnyMedia[];
-  external?: ExternalMedia;
-  photos?: Photo[];
-  videos?: Video[];
-  mosaic?: MosaicPhoto;
-}
-interface CommunityNote {
-  text: string;
-  facets: Facet[];
-}
-interface RepostedBy {
-  id: string;
-  name: string;
-  screen_name: string;
-  avatar_url?: string | null;
-  url?: string;
-}
-type TwitterCard = "tweet" | "summary" | "summary_large_image" | "player";
-interface Tweet {
-  id: string;
-  url: string;
-  text: string;
-  raw_text: StatusRawText;
-  created_at: string;
-  created_timestamp: number;
-  author: Author;
-  likes: number;
-  /** Named `reposts` in the v2 API. */
-  retweets: number;
-  replies: number;
-  quotes: number;
-  views: number | null;
-  bookmarks?: number | null;
-  lang: string | null;
-  /** Screen name of the account being replied to. An object in the v2 API. */
-  replying_to: string | null;
-  /** Status ID being replied to. Folded into `replying_to` in the v2 API. */
-  replying_to_status: string | null;
-  source: string | null;
-  /** Named `embed_card` in the v2 API. */
-  twitter_card: TwitterCard;
-  provider?: string;
-  possibly_sensitive?: boolean;
-  is_note_tweet: boolean;
-  community_note: CommunityNote | null;
-  reposted_by: RepostedBy | null;
-  /** @deprecated Always `null` upstream. */
-  color?: string | null;
-  quote?: Tweet;
-  poll?: Poll;
-  /** Only present when a translation target was requested. */
-  translation?: Translation;
-  media?: StatusMedia;
-}
-/**
- * `message` values the API maps onto its status codes: 200, 401, 404, 503
- * and 500 respectively.
- */
-type StatusMessage = "OK" | "PRIVATE_TWEET" | "NOT_FOUND" | "UPSTREAM_UNAVAILABLE" | "API_FAIL";
-interface StatusResponse {
-  /** Mirrors the HTTP status code. */
-  code: number;
-  message: StatusMessage | string;
-  /** `null` when the status could not be retrieved. */
-  tweet: Tweet | null;
-}
-interface UserResponse {
-  /** Mirrors the HTTP status code. */
-  code: number;
-  message: string;
-  /** Omitted entirely when the user could not be retrieved. */
-  user?: User;
-  /** Set to `suspended` when the account is suspended. */
-  reason?: "suspended";
-}
-//#endregion
-//#region src/v1.d.ts
-type FxTwitterV1Options = ClientOptions;
-interface GetStatusOptions {
-  /**
-   * Included in the URL for readability only. The API resolves the status from
-   * `id` alone and never validates this, so a wrong handle still succeeds.
-   */
-  screenName?: string;
-  /**
-   * Language to translate the status into, as an ISO 639-1 code (`es`) or a
-   * locale (`zh-cn`). Adds a `translation` object to the returned status.
-   */
-  translateTo?: string;
-  /** Per-call cancellation, composed with the client-level `timeout`. */
-  signal?: AbortSignal;
-}
-interface GetUserOptions {
-  signal?: AbortSignal;
-}
-/** Client for the FxTwitter v1 API. */
-declare class FxTwitterV1 {
-  private readonly http;
-  constructor(options?: FxTwitterV1Options);
-  /**
-   * Fetches a single status by its snowflake ID.
-   *
-   * `GET /status/:id`, `GET /status/:id/:language`,
-   * `GET /:handle/status/:id`, `GET /:handle/status/:id/:language`
-   */
-  getStatus(id: string, options?: GetStatusOptions): Promise<StatusResponse>;
-  /** Fetches a user profile by handle (`GET /:handle`). */
-  getUser(screenName: string, options?: GetUserOptions): Promise<UserResponse>;
-}
-//#endregion
-export { ClientOptions as A, User as C, Video as D, VerificationType as E, VideoFormat as O, TwitterCard as S, Verification as T, StatusMessage as _, AnyMedia as a, Translation as b, ExternalMedia as c, Photo as d, Poll as f, StatusMedia as g, RepostedBy as h, GetUserOptions as i, Website as k, Facet as l, RawText as m, FxTwitterV1Options as n, Author as o, PollChoice as p, GetStatusOptions as r, CommunityNote as s, FxTwitterV1 as t, MosaicPhoto as u, StatusRawText as v, UserResponse as w, Tweet as x, StatusResponse as y };