scrapebadger 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,156 @@
+import { T as TwitterClient, S as ScrapeBadgerConfig } from './index-B3rJn_Jw.cjs';
+export { A as ApiResponse, C as CommunitiesClient, t as Community, r as CommunityBanner, u as CommunityMember, s as CommunityRule, g as CommunityTweetType, G as GeoClient, e as GeoSearchOptions, H as Hashtag, I as IteratorOptions, q as List, z as ListResponse, L as ListsClient, w as Location, M as Media, P as PaginatedResponse, a as PaginationOptions, y as Place, x as PlaceTrends, i as Poll, h as PollOption, Q as QueryType, R as ResolvedConfig, v as Trend, f as TrendCategory, d as TrendsClient, m as Tweet, l as TweetPlace, b as TweetsClient, j as Url, n as User, o as UserAbout, p as UserIds, k as UserMention, U as UsersClient, c as collectAll } from './index-B3rJn_Jw.cjs';
+
+/**
+ * Main ScrapeBadger client.
+ *
+ * This is the primary entry point for the ScrapeBadger SDK.
+ */
+
+/**
+ * ScrapeBadger API client.
+ *
+ * The main client for interacting with the ScrapeBadger API.
+ * Provides access to all available scrapers through typed sub-clients.
+ *
+ * @example
+ * ```typescript
+ * import { ScrapeBadger } from "scrapebadger";
+ *
+ * // Create client with API key
+ * const client = new ScrapeBadger({ apiKey: "your-api-key" });
+ *
+ * // Or use environment variable (SCRAPEBADGER_API_KEY)
+ * const client = new ScrapeBadger();
+ *
+ * // Access Twitter API
+ * const tweet = await client.twitter.tweets.getById("1234567890");
+ * const user = await client.twitter.users.getByUsername("elonmusk");
+ *
+ * // Search with automatic pagination
+ * for await (const tweet of client.twitter.tweets.searchAll("python")) {
+ *   console.log(tweet.text);
+ * }
+ *
+ * // Collect all results into an array
+ * import { collectAll } from "scrapebadger";
+ * const tweets = await collectAll(
+ *   client.twitter.tweets.searchAll("python", { maxItems: 100 })
+ * );
+ * ```
+ */
+declare class ScrapeBadger {
+    private readonly baseClient;
+    /** Twitter API client */
+    readonly twitter: TwitterClient;
+    /**
+     * Create a new ScrapeBadger client.
+     *
+     * @param config - Configuration options. If apiKey is not provided,
+     *   it will be read from the SCRAPEBADGER_API_KEY environment variable.
+     * @throws Error if no API key is provided or found in environment.
+     *
+     * @example
+     * ```typescript
+     * // With explicit API key
+     * const client = new ScrapeBadger({ apiKey: "your-api-key" });
+     *
+     * // With custom options
+     * const client = new ScrapeBadger({
+     *   apiKey: "your-api-key",
+     *   baseUrl: "https://custom.api.com",
+     *   timeout: 60000,
+     *   maxRetries: 5
+     * });
+     *
+     * // Using environment variable
+     * // Set SCRAPEBADGER_API_KEY=your-api-key
+     * const client = new ScrapeBadger();
+     * ```
+     */
+    constructor(config?: Partial<ScrapeBadgerConfig>);
+}
+
+/**
+ * Custom exceptions for the ScrapeBadger SDK.
+ */
+/**
+ * Base error class for all ScrapeBadger errors.
+ */
+declare class ScrapeBadgerError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when authentication fails (invalid or missing API key).
+ */
+declare class AuthenticationError extends ScrapeBadgerError {
+    constructor(message?: string);
+}
+/**
+ * Raised when rate limit is exceeded.
+ */
+declare class RateLimitError extends ScrapeBadgerError {
+    /** Unix timestamp when the rate limit resets */
+    readonly retryAfter: number | undefined;
+    /** Maximum requests per minute for this tier */
+    readonly limit: number | undefined;
+    /** Remaining requests in the current window */
+    readonly remaining: number | undefined;
+    constructor(message?: string, options?: {
+        retryAfter?: number;
+        limit?: number;
+        remaining?: number;
+    });
+}
+/**
+ * Raised when the requested resource is not found.
+ */
+declare class NotFoundError extends ScrapeBadgerError {
+    /** The resource type that was not found */
+    readonly resourceType: string | undefined;
+    /** The resource ID that was not found */
+    readonly resourceId: string | undefined;
+    constructor(message?: string, resourceType?: string, resourceId?: string);
+}
+/**
+ * Raised when the request is invalid.
+ */
+declare class ValidationError extends ScrapeBadgerError {
+    /** Validation errors by field */
+    readonly errors: Record<string, string[]> | undefined;
+    constructor(message?: string, errors?: Record<string, string[]>);
+}
+/**
+ * Raised when an internal server error occurs.
+ */
+declare class ServerError extends ScrapeBadgerError {
+    /** HTTP status code */
+    readonly statusCode: number;
+    constructor(message?: string, statusCode?: number);
+}
+/**
+ * Raised when the request times out.
+ */
+declare class TimeoutError extends ScrapeBadgerError {
+    /** Timeout duration in milliseconds */
+    readonly timeout: number;
+    constructor(message: string | undefined, timeout: number);
+}
+/**
+ * Raised when the account has insufficient credits.
+ */
+declare class InsufficientCreditsError extends ScrapeBadgerError {
+    /** Current credit balance */
+    readonly creditsBalance: number | undefined;
+    constructor(message?: string, creditsBalance?: number);
+}
+/**
+ * Raised when the account is restricted.
+ */
+declare class AccountRestrictedError extends ScrapeBadgerError {
+    /** Reason for the restriction */
+    readonly reason: string | undefined;
+    constructor(message?: string, reason?: string);
+}
+
+export { AccountRestrictedError, AuthenticationError, InsufficientCreditsError, NotFoundError, RateLimitError, ScrapeBadger, ScrapeBadgerConfig, ScrapeBadgerError, ServerError, TimeoutError, TwitterClient, ValidationError };

package/dist/index.d.ts

@@ -0,0 +1,156 @@
+import { T as TwitterClient, S as ScrapeBadgerConfig } from './index-B3rJn_Jw.js';
+export { A as ApiResponse, C as CommunitiesClient, t as Community, r as CommunityBanner, u as CommunityMember, s as CommunityRule, g as CommunityTweetType, G as GeoClient, e as GeoSearchOptions, H as Hashtag, I as IteratorOptions, q as List, z as ListResponse, L as ListsClient, w as Location, M as Media, P as PaginatedResponse, a as PaginationOptions, y as Place, x as PlaceTrends, i as Poll, h as PollOption, Q as QueryType, R as ResolvedConfig, v as Trend, f as TrendCategory, d as TrendsClient, m as Tweet, l as TweetPlace, b as TweetsClient, j as Url, n as User, o as UserAbout, p as UserIds, k as UserMention, U as UsersClient, c as collectAll } from './index-B3rJn_Jw.js';
+
+/**
+ * Main ScrapeBadger client.
+ *
+ * This is the primary entry point for the ScrapeBadger SDK.
+ */
+
+/**
+ * ScrapeBadger API client.
+ *
+ * The main client for interacting with the ScrapeBadger API.
+ * Provides access to all available scrapers through typed sub-clients.
+ *
+ * @example
+ * ```typescript
+ * import { ScrapeBadger } from "scrapebadger";
+ *
+ * // Create client with API key
+ * const client = new ScrapeBadger({ apiKey: "your-api-key" });
+ *
+ * // Or use environment variable (SCRAPEBADGER_API_KEY)
+ * const client = new ScrapeBadger();
+ *
+ * // Access Twitter API
+ * const tweet = await client.twitter.tweets.getById("1234567890");
+ * const user = await client.twitter.users.getByUsername("elonmusk");
+ *
+ * // Search with automatic pagination
+ * for await (const tweet of client.twitter.tweets.searchAll("python")) {
+ *   console.log(tweet.text);
+ * }
+ *
+ * // Collect all results into an array
+ * import { collectAll } from "scrapebadger";
+ * const tweets = await collectAll(
+ *   client.twitter.tweets.searchAll("python", { maxItems: 100 })
+ * );
+ * ```
+ */
+declare class ScrapeBadger {
+    private readonly baseClient;
+    /** Twitter API client */
+    readonly twitter: TwitterClient;
+    /**
+     * Create a new ScrapeBadger client.
+     *
+     * @param config - Configuration options. If apiKey is not provided,
+     *   it will be read from the SCRAPEBADGER_API_KEY environment variable.
+     * @throws Error if no API key is provided or found in environment.
+     *
+     * @example
+     * ```typescript
+     * // With explicit API key
+     * const client = new ScrapeBadger({ apiKey: "your-api-key" });
+     *
+     * // With custom options
+     * const client = new ScrapeBadger({
+     *   apiKey: "your-api-key",
+     *   baseUrl: "https://custom.api.com",
+     *   timeout: 60000,
+     *   maxRetries: 5
+     * });
+     *
+     * // Using environment variable
+     * // Set SCRAPEBADGER_API_KEY=your-api-key
+     * const client = new ScrapeBadger();
+     * ```
+     */
+    constructor(config?: Partial<ScrapeBadgerConfig>);
+}
+
+/**
+ * Custom exceptions for the ScrapeBadger SDK.
+ */
+/**
+ * Base error class for all ScrapeBadger errors.
+ */
+declare class ScrapeBadgerError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when authentication fails (invalid or missing API key).
+ */
+declare class AuthenticationError extends ScrapeBadgerError {
+    constructor(message?: string);
+}
+/**
+ * Raised when rate limit is exceeded.
+ */
+declare class RateLimitError extends ScrapeBadgerError {
+    /** Unix timestamp when the rate limit resets */
+    readonly retryAfter: number | undefined;
+    /** Maximum requests per minute for this tier */
+    readonly limit: number | undefined;
+    /** Remaining requests in the current window */
+    readonly remaining: number | undefined;
+    constructor(message?: string, options?: {
+        retryAfter?: number;
+        limit?: number;
+        remaining?: number;
+    });
+}
+/**
+ * Raised when the requested resource is not found.
+ */
+declare class NotFoundError extends ScrapeBadgerError {
+    /** The resource type that was not found */
+    readonly resourceType: string | undefined;
+    /** The resource ID that was not found */
+    readonly resourceId: string | undefined;
+    constructor(message?: string, resourceType?: string, resourceId?: string);
+}
+/**
+ * Raised when the request is invalid.
+ */
+declare class ValidationError extends ScrapeBadgerError {
+    /** Validation errors by field */
+    readonly errors: Record<string, string[]> | undefined;
+    constructor(message?: string, errors?: Record<string, string[]>);
+}
+/**
+ * Raised when an internal server error occurs.
+ */
+declare class ServerError extends ScrapeBadgerError {
+    /** HTTP status code */
+    readonly statusCode: number;
+    constructor(message?: string, statusCode?: number);
+}
+/**
+ * Raised when the request times out.
+ */
+declare class TimeoutError extends ScrapeBadgerError {
+    /** Timeout duration in milliseconds */
+    readonly timeout: number;
+    constructor(message: string | undefined, timeout: number);
+}
+/**
+ * Raised when the account has insufficient credits.
+ */
+declare class InsufficientCreditsError extends ScrapeBadgerError {
+    /** Current credit balance */
+    readonly creditsBalance: number | undefined;
+    constructor(message?: string, creditsBalance?: number);
+}
+/**
+ * Raised when the account is restricted.
+ */
+declare class AccountRestrictedError extends ScrapeBadgerError {
+    /** Reason for the restriction */
+    readonly reason: string | undefined;
+    constructor(message?: string, reason?: string);
+}
+
+export { AccountRestrictedError, AuthenticationError, InsufficientCreditsError, NotFoundError, RateLimitError, ScrapeBadger, ScrapeBadgerConfig, ScrapeBadgerError, ServerError, TimeoutError, TwitterClient, ValidationError };