@xpoz/xpoz 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,579 @@
+interface PaginationInfo {
+    tableName?: string | null;
+    totalRows: number;
+    totalPages: number;
+    pageNumber: number;
+    pageSize: number;
+    resultsCount: number;
+}
+
+type FetchPage<T> = (pageNumber: number, tableName: string | null | undefined) => Promise<PaginatedResult<T>>;
+type FetchExport = (exportOperationId: string) => Promise<string>;
+declare class PaginatedResult<T> {
+    data: T[];
+    pagination: PaginationInfo;
+    private _tableName;
+    private _exportOperationId;
+    private _fetchPage;
+    private _fetchExport;
+    constructor(options: {
+        data: T[];
+        pagination: PaginationInfo;
+        tableName: string | null | undefined;
+        exportOperationId: string | null | undefined;
+        fetchPage: FetchPage<T>;
+        fetchExport: FetchExport | null;
+    });
+    hasNextPage(): boolean;
+    nextPage(): Promise<PaginatedResult<T>>;
+    getPage(pageNumber: number): Promise<PaginatedResult<T>>;
+    exportCsv(): Promise<string>;
+    private _fetchPageResult;
+    toString(): string;
+}
+
+type CallTool = (name: string, args: Record<string, unknown>) => Promise<Record<string, unknown>>;
+type RawDict = Record<string, unknown>;
+declare class BaseNamespace {
+    protected callTool: CallTool;
+    protected timeoutMs: number;
+    constructor(callTool: CallTool, timeoutMs?: number);
+    protected callAndMaybePoll(toolName: string, args: RawDict): Promise<RawDict>;
+    protected buildPaginatedResult<T>(raw: RawDict, parseItem: (item: RawDict) => T, toolName: string, baseArgs: RawDict): PaginatedResult<T>;
+    protected buildArgs(args: Record<string, unknown>): RawDict;
+    protected extractPagination(raw: RawDict): PaginationInfo;
+    protected extractResults(raw: RawDict): RawDict[];
+}
+
+interface TwitterPost {
+    id?: string | null;
+    text?: string | null;
+    authorId?: string | null;
+    authorUsername?: string | null;
+    conversationId?: string | null;
+    lang?: string | null;
+    source?: string | null;
+    status?: string | null;
+    deleted?: boolean | null;
+    suspended?: boolean | null;
+    possiblySensitive?: boolean | null;
+    isRetweet?: boolean | null;
+    likeCount?: number | null;
+    retweetCount?: number | null;
+    replyCount?: number | null;
+    quoteCount?: number | null;
+    impressionCount?: number | null;
+    bookmarkCount?: number | null;
+    quotedTweetId?: string | null;
+    retweetedTweetId?: string | null;
+    replyToTweetId?: string | null;
+    replyToUserId?: string | null;
+    replyToUsername?: string | null;
+    originalTweetId?: string | null;
+    editedTweets?: string[] | null;
+    replySettings?: string | null;
+    hashtags?: string[] | null;
+    mentions?: string[] | null;
+    mediaUrls?: string[] | null;
+    grokGeneratedContent?: Record<string, unknown>[] | null;
+    urls?: string[] | null;
+    country?: string | null;
+    region?: string | null;
+    city?: string | null;
+    hasBirdwatchNotes?: boolean | null;
+    birdwatchNotesId?: string | null;
+    birdwatchNotesText?: string | null;
+    birdwatchNotesUrl?: string | null;
+    createdAt?: string | null;
+    createdAtDate?: string | null;
+    xFetchedAt?: string | null;
+    [key: string]: unknown;
+}
+interface TwitterUser {
+    id?: string | null;
+    username?: string | null;
+    name?: string | null;
+    description?: string | null;
+    location?: string | null;
+    verified?: boolean | null;
+    verifiedType?: string | null;
+    protected?: boolean | null;
+    status?: string | null;
+    followersCount?: number | null;
+    followingCount?: number | null;
+    tweetCount?: number | null;
+    listedCount?: number | null;
+    likesCount?: number | null;
+    mediaCount?: number | null;
+    profileImageUrl?: string | null;
+    profileBannerUrl?: string | null;
+    profileInterstitialType?: string | null;
+    pinnedTweetId?: string | null;
+    source?: string | null;
+    isVerified?: boolean | null;
+    accountBasedIn?: string | null;
+    locationAccurate?: boolean | null;
+    label?: string | null;
+    labelType?: string | null;
+    collectedFollowingCount?: number | null;
+    collectedFollowersCount?: number | null;
+    collectedFollowersCoverage?: number | null;
+    collectedFollowingCoverage?: number | null;
+    avgTweetsPerDayLastMonth?: number | null;
+    nLang?: number | null;
+    nLangsFiltered?: number | null;
+    inauthenticType?: string | null;
+    isInauthentic?: boolean | null;
+    isInauthenticProbScore?: number | null;
+    isInauthenticCalculatedAt?: string | null;
+    verifiedSinceDatetime?: string | null;
+    usernameChanges?: string[] | null;
+    lastUsernameChangeDatetime?: string | null;
+    createdAt?: string | null;
+    createdAtDate?: string | null;
+    xFetchedAt?: string | null;
+    modifiedAt?: string | null;
+    xModifiedAt?: string | null;
+    aggRelevance?: number | null;
+    relevantTweetsCount?: number | null;
+    relevantTweetsImpressionsSum?: number | null;
+    relevantTweetsLikesSum?: number | null;
+    relevantTweetsQuotesSum?: number | null;
+    relevantTweetsRepliesSum?: number | null;
+    relevantTweetsRetweetsSum?: number | null;
+    [key: string]: unknown;
+}
+
+declare class TwitterNamespace extends BaseNamespace {
+    getPostsByIds(postIds: string[], options?: {
+        fields?: string[];
+        forceLatest?: boolean;
+    }): Promise<TwitterPost[]>;
+    getPostsByAuthor(identifier: string, options?: {
+        identifierType?: string;
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<TwitterPost>>;
+    searchPosts(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        authorUsername?: string;
+        authorId?: string;
+        language?: string;
+        forceLatest?: boolean;
+        responseType?: string;
+    }): Promise<PaginatedResult<TwitterPost>>;
+    getRetweets(postId: string, options?: {
+        fields?: string[];
+        startDate?: string;
+    }): Promise<PaginatedResult<TwitterPost>>;
+    getQuotes(postId: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<TwitterPost>>;
+    getComments(postId: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<TwitterPost>>;
+    getPostInteractingUsers(postId: string, interactionType: string, options?: {
+        fields?: string[];
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<TwitterUser>>;
+    countPosts(phrase: string, options?: {
+        startDate?: string;
+        endDate?: string;
+    }): Promise<number>;
+    getUser(identifier: string, options?: {
+        identifierType?: string;
+        fields?: string[];
+    }): Promise<TwitterUser>;
+    searchUsers(name: string, options?: {
+        limit?: number;
+        fields?: string[];
+    }): Promise<TwitterUser[]>;
+    getUserConnections(username: string, connectionType: string, options?: {
+        fields?: string[];
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<TwitterUser>>;
+    getUsersByKeywords(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        language?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<TwitterUser>>;
+}
+
+interface InstagramPost {
+    id?: string | null;
+    postType?: string | null;
+    userId?: string | null;
+    username?: string | null;
+    fullName?: string | null;
+    caption?: string | null;
+    mediaType?: string | null;
+    codeUrl?: string | null;
+    imageUrl?: string | null;
+    videoUrl?: string | null;
+    audioOnlyUrl?: string | null;
+    profilePicUrl?: string | null;
+    videoSubtitlesUri?: string | null;
+    subtitles?: string | null;
+    videoDuration?: number | null;
+    likeCount?: number | null;
+    commentCount?: number | null;
+    reshareCount?: number | null;
+    videoPlayCount?: number | null;
+    location?: string | null;
+    createdAt?: string | null;
+    createdAtTimestamp?: number | null;
+    createdAtDate?: string | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    [key: string]: unknown;
+}
+interface InstagramUser {
+    id?: string | null;
+    username?: string | null;
+    fullName?: string | null;
+    biography?: string | null;
+    isPrivate?: boolean | null;
+    isVerified?: boolean | null;
+    followerCount?: number | null;
+    followingCount?: number | null;
+    mediaCount?: number | null;
+    profilePicUrl?: string | null;
+    profilePicId?: string | null;
+    profileUrl?: string | null;
+    externalUrl?: string | null;
+    hasAnonymousProfilePicture?: boolean | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    aggRelevance?: number | null;
+    relevantPostsCount?: number | null;
+    relevantPostsLikesSum?: number | null;
+    relevantPostsCommentsSum?: number | null;
+    relevantPostsResharesSum?: number | null;
+    relevantPostsVideoPlaysSum?: number | null;
+    [key: string]: unknown;
+}
+interface InstagramComment {
+    id?: string | null;
+    text?: string | null;
+    parentPostId?: string | null;
+    parentPostUserId?: string | null;
+    type?: string | null;
+    parentCommentId?: string | null;
+    repliedToCommentId?: string | null;
+    childCommentCount?: number | null;
+    userId?: string | null;
+    username?: string | null;
+    fullName?: string | null;
+    likeCount?: number | null;
+    status?: string | null;
+    isSpam?: boolean | null;
+    hasTranslation?: boolean | null;
+    createdAt?: string | null;
+    createdAtTimestamp?: number | null;
+    createdAtDate?: string | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    [key: string]: unknown;
+}
+
+declare class InstagramNamespace extends BaseNamespace {
+    getPostsByIds(postIds: string[], options?: {
+        fields?: string[];
+        forceLatest?: boolean;
+    }): Promise<InstagramPost[]>;
+    getPostsByUser(identifier: string, options?: {
+        identifierType?: string;
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<InstagramPost>>;
+    searchPosts(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<InstagramPost>>;
+    getComments(postId: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<InstagramComment>>;
+    getUser(identifier: string, options?: {
+        identifierType?: string;
+        fields?: string[];
+    }): Promise<InstagramUser>;
+    searchUsers(name: string, options?: {
+        limit?: number;
+        fields?: string[];
+    }): Promise<InstagramUser[]>;
+    getUserConnections(username: string, connectionType: string, options?: {
+        fields?: string[];
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<InstagramUser>>;
+    getPostInteractingUsers(postId: string, interactionType: string, options?: {
+        fields?: string[];
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<InstagramUser>>;
+    getUsersByKeywords(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<InstagramUser>>;
+}
+
+interface RedditPost {
+    id?: string | null;
+    title?: string | null;
+    selftext?: string | null;
+    url?: string | null;
+    permalink?: string | null;
+    postUrl?: string | null;
+    thumbnail?: string | null;
+    authorId?: string | null;
+    authorUsername?: string | null;
+    subredditName?: string | null;
+    subredditId?: string | null;
+    score?: number | null;
+    upvotes?: number | null;
+    downvotes?: number | null;
+    upvoteRatio?: number | null;
+    commentsCount?: number | null;
+    crosspostsCount?: number | null;
+    isSelf?: boolean | null;
+    isVideo?: boolean | null;
+    isOriginalContent?: boolean | null;
+    over18?: boolean | null;
+    spoiler?: boolean | null;
+    locked?: boolean | null;
+    stickied?: boolean | null;
+    archived?: boolean | null;
+    linkFlairText?: string | null;
+    postHint?: string | null;
+    domain?: string | null;
+    crosspostParent?: string | null;
+    createdAt?: string | null;
+    createdAtTimestamp?: number | null;
+    createdAtDate?: string | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    [key: string]: unknown;
+}
+interface RedditUser {
+    id?: string | null;
+    username?: string | null;
+    profileUrl?: string | null;
+    profilePicUrl?: string | null;
+    snoovatarImg?: string | null;
+    linkKarma?: number | null;
+    commentKarma?: number | null;
+    totalKarma?: number | null;
+    awardeeKarma?: number | null;
+    awarderKarma?: number | null;
+    isGold?: boolean | null;
+    isMod?: boolean | null;
+    isEmployee?: boolean | null;
+    hasVerifiedEmail?: boolean | null;
+    isSuspended?: boolean | null;
+    verified?: boolean | null;
+    isBlocked?: boolean | null;
+    acceptFollowers?: boolean | null;
+    hasSubscribed?: boolean | null;
+    hideFromRobots?: boolean | null;
+    prefShowSnoovatar?: boolean | null;
+    profileDescription?: string | null;
+    profileBannerUrl?: string | null;
+    profileTitle?: string | null;
+    createdAt?: string | null;
+    createdAtTimestamp?: number | null;
+    createdAtDate?: string | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    aggRelevance?: number | null;
+    relevantPostsCount?: number | null;
+    relevantPostsUpvotesSum?: number | null;
+    relevantPostsCommentsCountSum?: number | null;
+    [key: string]: unknown;
+}
+interface RedditComment {
+    id?: string | null;
+    body?: string | null;
+    parentPostId?: string | null;
+    parentId?: string | null;
+    authorId?: string | null;
+    authorUsername?: string | null;
+    postSubredditName?: string | null;
+    postSubredditId?: string | null;
+    score?: number | null;
+    upvotes?: number | null;
+    downvotes?: number | null;
+    controversiality?: number | null;
+    depth?: number | null;
+    isSubmitter?: boolean | null;
+    stickied?: boolean | null;
+    collapsed?: boolean | null;
+    edited?: boolean | null;
+    distinguished?: string | null;
+    createdAt?: string | null;
+    createdAtTimestamp?: number | null;
+    createdAtDate?: string | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    [key: string]: unknown;
+}
+interface RedditSubreddit {
+    id?: string | null;
+    displayName?: string | null;
+    title?: string | null;
+    publicDescription?: string | null;
+    description?: string | null;
+    subscribersCount?: number | null;
+    activeUserCount?: number | null;
+    subredditType?: string | null;
+    over18?: boolean | null;
+    lang?: string | null;
+    url?: string | null;
+    subredditUrl?: string | null;
+    iconImg?: string | null;
+    bannerImg?: string | null;
+    headerImg?: string | null;
+    communityIcon?: string | null;
+    createdAt?: string | null;
+    createdAtTimestamp?: number | null;
+    createdAtDate?: string | null;
+    lastFetch?: string | null;
+    lastFetchDatetime?: string | null;
+    xLastUpdated?: string | null;
+    aggRelevance?: number | null;
+    relevantPostsCount?: number | null;
+    relevantPostsUpvotesSum?: number | null;
+    relevantPostsCommentsCountSum?: number | null;
+    [key: string]: unknown;
+}
+interface RedditPostWithComments {
+    post?: RedditPost | null;
+    comments?: RedditComment[] | null;
+    commentsPagination?: PaginationInfo | null;
+    commentsTableName?: string | null;
+}
+interface SubredditWithPosts {
+    subreddit?: RedditSubreddit | null;
+    posts?: RedditPost[] | null;
+    postsPagination?: PaginationInfo | null;
+    postsTableName?: string | null;
+}
+
+declare class RedditNamespace extends BaseNamespace {
+    searchPosts(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        sort?: string;
+        time?: string;
+        subreddit?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<RedditPost>>;
+    getPostWithComments(postId: string, options?: {
+        postFields?: string[];
+        commentFields?: string[];
+        forceLatest?: boolean;
+    }): Promise<RedditPostWithComments>;
+    searchComments(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        subreddit?: string;
+    }): Promise<PaginatedResult<RedditComment>>;
+    getUser(username: string, options?: {
+        fields?: string[];
+    }): Promise<RedditUser>;
+    searchUsers(name: string, options?: {
+        limit?: number;
+        fields?: string[];
+    }): Promise<RedditUser[]>;
+    getUsersByKeywords(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        subreddit?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<RedditUser>>;
+    searchSubreddits(query: string, options?: {
+        limit?: number;
+        fields?: string[];
+    }): Promise<RedditSubreddit[]>;
+    getSubredditWithPosts(subredditName: string, options?: {
+        subredditFields?: string[];
+        postFields?: string[];
+        forceLatest?: boolean;
+    }): Promise<SubredditWithPosts>;
+    getSubredditsByKeywords(query: string, options?: {
+        fields?: string[];
+        startDate?: string;
+        endDate?: string;
+        forceLatest?: boolean;
+    }): Promise<PaginatedResult<RedditSubreddit>>;
+    private _parsePostWithComments;
+    private _parseSubredditWithPosts;
+}
+
+declare class XpozClient {
+    twitter: TwitterNamespace;
+    instagram: InstagramNamespace;
+    reddit: RedditNamespace;
+    private transport;
+    constructor(options?: {
+        apiKey?: string;
+        serverUrl?: string;
+        timeoutMs?: number;
+    });
+    connect(): Promise<void>;
+    close(): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+}
+
+declare class XpozError extends Error {
+    constructor(message: string);
+}
+declare class AuthenticationError extends XpozError {
+    constructor(message: string);
+}
+declare class XpozConnectionError extends XpozError {
+    constructor(message: string);
+}
+declare class OperationTimeoutError extends XpozError {
+    operationId: string;
+    elapsedMs: number;
+    constructor(operationId: string, elapsedMs: number);
+}
+declare class OperationFailedError extends XpozError {
+    operationId: string;
+    operationError: string;
+    constructor(operationId: string, error: string);
+}
+declare class OperationCancelledError extends XpozError {
+    operationId: string;
+    constructor(operationId: string);
+}
+
+declare const VERSION = "0.1.0";
+
+export { AuthenticationError, type InstagramComment, type InstagramPost, type InstagramUser, OperationCancelledError, OperationFailedError, OperationTimeoutError, PaginatedResult, type PaginationInfo, type RedditComment, type RedditPost, type RedditPostWithComments, type RedditSubreddit, type RedditUser, type SubredditWithPosts, type TwitterPost, type TwitterUser, VERSION, XpozClient, XpozConnectionError, XpozError };