x-twitter-scraper 0.12.4 → 0.13.1

package/src/internal/builtin-types.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export type Fetch = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
 
 /**

package/src/internal/decoders/line.ts

@@ -0,0 +1,138 @@
+// SPDX-FileCopyrightText: 2026 Xquik contributors
+//
+// SPDX-License-Identifier: Apache-2.0
+
+import { concatBytes, decodeUTF8, encodeUTF8 } from '../utils/bytes';
+
+export type Bytes = string | ArrayBuffer | Uint8Array | null | undefined;
+
+/**
+ * A re-implementation of httpx's `LineDecoder` in Python that handles incrementally
+ * reading lines from text.
+ *
+ * https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258
+ */
+export class LineDecoder {
+  static NEWLINE_CHARS = new Set(['\n', '\r']);
+  static NEWLINE_REGEXP = /\r\n|[\n\r]/g;
+
+  #buffer: Uint8Array;
+  #carriageReturnIndex: number | null;
+
+  constructor() {
+    this.#buffer = new Uint8Array();
+    this.#carriageReturnIndex = null;
+  }
+
+  decode(chunk: Bytes): string[] {
+    if (chunk == null) {
+      return [];
+    }
+
+    const binaryChunk =
+      chunk instanceof ArrayBuffer ? new Uint8Array(chunk)
+      : typeof chunk === 'string' ? encodeUTF8(chunk)
+      : chunk;
+
+    this.#buffer = concatBytes([this.#buffer, binaryChunk]);
+
+    const lines: string[] = [];
+    let patternIndex;
+    while ((patternIndex = findNewlineIndex(this.#buffer, this.#carriageReturnIndex)) != null) {
+      if (patternIndex.carriage && this.#carriageReturnIndex == null) {
+        // skip until we either get a corresponding `\n`, a new `\r` or nothing
+        this.#carriageReturnIndex = patternIndex.index;
+        continue;
+      }
+
+      // we got double \r or \rtext\n
+      if (
+        this.#carriageReturnIndex != null &&
+        (patternIndex.index !== this.#carriageReturnIndex + 1 || patternIndex.carriage)
+      ) {
+        lines.push(decodeUTF8(this.#buffer.subarray(0, this.#carriageReturnIndex - 1)));
+        this.#buffer = this.#buffer.subarray(this.#carriageReturnIndex);
+        this.#carriageReturnIndex = null;
+        continue;
+      }
+
+      const endIndex =
+        this.#carriageReturnIndex !== null ? patternIndex.preceding - 1 : patternIndex.preceding;
+
+      const line = decodeUTF8(this.#buffer.subarray(0, endIndex));
+      lines.push(line);
+
+      this.#buffer = this.#buffer.subarray(patternIndex.index);
+      this.#carriageReturnIndex = null;
+    }
+
+    return lines;
+  }
+
+  flush(): string[] {
+    if (!this.#buffer.length) {
+      return [];
+    }
+    return this.decode('\n');
+  }
+}
+
+/**
+ * This function searches the buffer for the end patterns, (\r or \n)
+ * and returns an object with the index preceding the matched newline and the
+ * index after the newline char. `null` is returned if no new line is found.
+ *
+ * ```ts
+ * findNewLineIndex('abc\ndef') -> { preceding: 2, index: 3 }
+ * ```
+ */
+function findNewlineIndex(
+  buffer: Uint8Array,
+  startIndex: number | null,
+): { preceding: number; index: number; carriage: boolean } | null {
+  const newline = 0x0a; // \n
+  const carriage = 0x0d; // \r
+
+  for (let i = startIndex ?? 0; i < buffer.length; i++) {
+    if (buffer[i] === newline) {
+      return { preceding: i, index: i + 1, carriage: false };
+    }
+
+    if (buffer[i] === carriage) {
+      return { preceding: i, index: i + 1, carriage: true };
+    }
+  }
+
+  return null;
+}
+
+export function findDoubleNewlineIndex(buffer: Uint8Array): number {
+  // This function searches the buffer for the end patterns (\r\r, \n\n, \r\n\r\n)
+  // and returns the index right after the first occurrence of any pattern,
+  // or -1 if none of the patterns are found.
+  const newline = 0x0a; // \n
+  const carriage = 0x0d; // \r
+
+  for (let i = 0; i < buffer.length - 1; i++) {
+    if (buffer[i] === newline && buffer[i + 1] === newline) {
+      // \n\n
+      return i + 2;
+    }
+    if (buffer[i] === carriage && buffer[i + 1] === carriage) {
+      // \r\r
+      return i + 2;
+    }
+    if (
+      buffer[i] === carriage &&
+      buffer[i + 1] === newline &&
+      i + 3 < buffer.length &&
+      buffer[i + 2] === carriage &&
+      buffer[i + 3] === newline
+    ) {
+      // \r\n\r\n
+      return i + 4;
+    }
+  }
+
+  return -1;
+}

package/src/internal/detect-platform.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { VERSION } from '../version';
 
 export const isRunningInBrowser = () => {

package/src/internal/errors.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export function isAbortError(err: unknown) {
   return (
     typeof err === 'object' &&

package/src/internal/headers.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { isReadonlyArray } from './utils/values';
 
 type HeaderValue = string | undefined | null;

package/src/internal/parse.ts

@@ -2,9 +2,8 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import type { FinalRequestOptions } from './request-options';
+import { Stream } from '../core/streaming';
 import { type XTwitterScraper } from '../client';
 import { formatRequestDetails, loggerFor } from './utils/log';
 
@@ -20,6 +19,14 @@ export type APIResponseProps = {
 export async function defaultParseResponse<T>(client: XTwitterScraper, props: APIResponseProps): Promise<T> {
   const { response, requestLogID, retryOfRequestLogID, startTime } = props;
   const body = await (async () => {
+    if (props.options.stream) {
+      loggerFor(client).debug('response', response.status, response.url, response.headers, response.body);
+
+      // Note: there is an invariant here that isn't represented in the type system
+      // that if you set `stream: true` the response type must also be `Stream<T>`
+      return Stream.fromSSEResponse(response, props.controller, client) as any;
+    }
+
     // fetch refuses to read the body when the status code is 204.
     if (response.status === 204) {
       return null as T;

package/src/internal/request-options.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { NullableHeaders } from './headers';
 
 import type { BodyInit } from './builtin-types';

package/src/internal/shim-types.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 /**
  * Shims for types that we can't always rely on being available globally.
  *

package/src/internal/shims.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 /**
  * This module provides internal shims and utility functions for environments where certain Node.js or global types may not be available.
  *

package/src/internal/types.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export type PromiseOrValue<T> = T | Promise<T>;
 export type HTTPMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
 

package/src/internal/utils/base64.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { XTwitterScraperError } from '../../core/error';
 import { encodeUTF8 } from './bytes';
 

package/src/internal/utils/env.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 /**
  * Read an environment variable.
  *

package/src/internal/utils/log.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { hasOwn } from './values';
 import { type XTwitterScraper } from '../../client';
 import { RequestOptions } from '../request-options';

package/src/internal/utils/query.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { XTwitterScraperError } from '../../core/error';
 
 /**

package/src/internal/utils/sleep.ts

@@ -2,6 +2,4 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export const sleep = (ms: number) => new Promise<void>((resolve) => setTimeout(resolve, ms));

package/src/internal/utils/uuid.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 /**
  * https://stackoverflow.com/a/2117523
  */

package/src/internal/utils/values.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { XTwitterScraperError } from '../../core/error';
 
 // https://url.spec.whatwg.org/#url-scheme-string

package/src/internal/utils.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export * from './utils/values';
 export * from './utils/base64';
 export * from './utils/env';

package/src/lib/.keep

@@ -1,4 +1,2 @@
-File generated from our OpenAPI spec by Stainless.
-
-This directory can be used to store custom files to expand the SDK.
-It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.
+This directory holds custom files that extend the SDK.
+Code generation leaves it unchanged, except for this file.

package/src/resources/account.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -13,7 +11,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Account extends APIResource {
   /**
-   * Get account info
+   * Returns plan, credit, monitoring, and account settings for the authenticated
+   * user.
    *
    * @example
    * ```ts
@@ -25,7 +24,7 @@ export class Account extends APIResource {
   }
 
   /**
-   * Set linked X username
+   * Links an X username to the authenticated Xquik account.
    *
    * @example
    * ```ts
@@ -42,7 +41,7 @@ export class Account extends APIResource {
   }
 
   /**
-   * Update account locale
+   * Changes the locale used for account responses and notifications.
    *
    * @example
    * ```ts
@@ -72,6 +71,11 @@ export interface AccountRetrieveResponse {
 
   plan: 'active' | 'inactive';
 
+  /**
+   * Subscription state without billing provider identifiers.
+   */
+  subscription: AccountRetrieveResponse.Subscription;
+
   creditInfo?: AccountRetrieveResponse.CreditInfo;
 
   /**
@@ -83,24 +87,24 @@ export interface AccountRetrieveResponse {
 export namespace AccountRetrieveResponse {
   export interface MonitorBilling {
     /**
-     * Estimated daily usage for currently active monitors.
+     * Daily credits for currently active monitors.
      */
     activeDailyEstimate: string;
 
     /**
-     * Usage charged each hour for currently active monitors.
+     * Credits charged each hour for currently active monitors.
      */
     activeHourlyBurn: string;
 
     /**
-     * Rounded daily estimate for 1 active monitor.
+     * Daily credits charged for 1 active monitor.
      */
-    creditsPerActiveMonitorDay: string;
+    creditsPerActiveMonitorDay: '720';
 
     /**
-     * Hourly credits charged for 1 active monitor.
+     * Hourly credits charged for 1 active monitor. It is a monitor's only charge.
      */
-    creditsPerActiveMonitorHour: string;
+    creditsPerActiveMonitorHour: '30';
 
     /**
      * Webhook and event deliveries are included in monitor billing.
@@ -118,6 +122,22 @@ export namespace AccountRetrieveResponse {
     unlimitedSlots: boolean;
   }
 
+  /**
+   * Subscription state without billing provider identifiers.
+   */
+  export interface Subscription {
+    status: 'none' | 'active' | 'past_due' | 'canceling' | 'incomplete';
+
+    /**
+     * Renewal date, or the end date when canceling.
+     */
+    currentPeriodEnd?: string;
+
+    currentPeriodStart?: string;
+
+    tier?: 'starter' | 'pro' | 'business';
+  }
+
   export interface CreditInfo {
     /**
      * Dollar amount charged when automatic top-up runs.
@@ -126,10 +146,17 @@ export namespace AccountRetrieveResponse {
 
     autoTopupEnabled: boolean;
 
+    /**
+     * True when 3 declined charges in a row on one card stopped automatic top-up while
+     * it stays enabled. A paid top-up, a paid plan renewal, or the next automatic
+     * top-up on a new card clears it.
+     */
+    autoTopupStopped: boolean;
+
     /**
      * Bigint string threshold that triggers automatic top-up when enabled.
      */
-    autoTopupThreshold: string;
+    autoTopupThreshold: '10000' | '50000' | '100000' | '250000';
 
     /**
      * Bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
@@ -137,12 +164,12 @@ export namespace AccountRetrieveResponse {
     balance: string;
 
     /**
-     * Total purchased usage as a bigint string.
+     * Total purchased credits as a bigint string.
      */
     lifetimePurchased: string;
 
     /**
-     * Total consumed usage as a bigint string.
+     * Total consumed credits as a bigint string.
      */
     lifetimeUsed: string;
   }