@xpoz/xpoz 0.6.13 → 0.8.0

package/dist/index.d.cts

@@ -26,6 +26,13 @@ declare class RestTransport {
     get<T>(path: string, params?: QueryParams): Promise<T>;
 }
 
+declare abstract class LiveNamespace {
+    protected transport: RestTransport;
+    constructor(transport: RestTransport);
+    protected page<T>(path: string, params: QueryParams): Promise<CursorResult<T>>;
+    protected single<T>(path: string, params: QueryParams): Promise<T | null>;
+}
+
 interface CursorPageResponse<T> {
     results: T[];
     count: number;
@@ -35,6 +42,9 @@ interface CursorPageResponse<T> {
 }
 type InstagramConnectionType = "followers" | "following";
 type InstagramInteractionType = "commenters" | "likers";
+type TwitterConnectionType = "followers" | "following";
+type TwitterInteractionType = "commenters" | "quoters" | "retweeters";
+type TwitterLiveSortBy = "relevance" | "latest";
 interface PaginationInfo {
     tableName?: string | null;
     totalRows: number;
@@ -63,6 +73,8 @@ interface InstagramPost {
     likeCount?: number | null;
     commentCount?: number | null;
     reshareCount?: number | null;
+    mediaRepostCount?: number | null;
+    saveCount?: number | null;
     videoPlayCount?: number | null;
     location?: string | null;
     genAiChatWithAiCtaInfo?: string | null;
@@ -92,6 +104,8 @@ interface InstagramUser {
     relevantPostsLikesSum?: number | null;
     relevantPostsCommentsSum?: number | null;
     relevantPostsResharesSum?: number | null;
+    relevantPostsMediaRepostsSum?: number | null;
+    relevantPostsSavesSum?: number | null;
     relevantPostsVideoPlaysSum?: number | null;
     [key: string]: unknown;
 }
@@ -117,11 +131,7 @@ interface InstagramComment {
     [key: string]: unknown;
 }
 
-declare class InstagramLiveNamespace {
-    private transport;
-    constructor(transport: RestTransport);
-    private page;
-    private single;
+declare class InstagramLiveNamespace extends LiveNamespace {
     searchPosts(query: string, options?: {
         fields?: string[];
         cursor?: string;
@@ -154,44 +164,6 @@ declare class InstagramLiveNamespace {
     }): Promise<CursorResult<InstagramUser>>;
 }
 
-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;
@@ -279,6 +251,88 @@ interface TwitterUser {
     [key: string]: unknown;
 }
 
+declare class TwitterLiveNamespace extends LiveNamespace {
+    searchPosts(query: string, options?: {
+        since?: string;
+        until?: string;
+        lang?: string;
+        countryCode?: string;
+        sortBy?: TwitterLiveSortBy;
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getPostsByUser(username: string, options?: {
+        since?: string;
+        until?: string;
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getPost(postId: string, options?: {
+        fields?: string[];
+    }): Promise<TwitterPost | null>;
+    getComments(postId: string, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getQuotes(postId: string, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getPostInteractingUsers(postId: string, interactionType: TwitterInteractionType, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterUser>>;
+    searchUsers(query: string, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterUser>>;
+    getUser(username: string, options?: {
+        fields?: string[];
+    }): Promise<TwitterUser | null>;
+    getUserConnections(username: string, connectionType: TwitterConnectionType, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterUser>>;
+}
+
+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[];
+}
+
 declare enum ResponseType {
     Fast = "fast",
     Paging = "paging",
@@ -286,6 +340,9 @@ declare enum ResponseType {
 }
 
 declare class TwitterNamespace extends BaseNamespace {
+    private rest;
+    constructor(callTool: (name: string, args: Record<string, unknown>) => Promise<Record<string, unknown>>, timeoutMs: number, restTransport: RestTransport);
+    private cursorToPaginatedResult;
     getPostsByIds(postIds: string[], options?: {
         fields?: string[];
         forceLatest?: boolean;
@@ -364,6 +421,9 @@ declare class TwitterNamespace extends BaseNamespace {
 }
 
 declare class InstagramNamespace extends BaseNamespace {
+    private rest;
+    constructor(callTool: (name: string, args: Record<string, unknown>) => Promise<Record<string, unknown>>, timeoutMs: number, restTransport: RestTransport);
+    private cursorToPaginatedResult;
     getPostsByIds(postIds: string[], options?: {
         fields?: string[];
         forceLatest?: boolean;
@@ -873,6 +933,7 @@ declare class XpozClient {
     private versionCheck;
     private restTransport;
     private instagramLiveNamespace?;
+    private twitterLiveNamespace?;
     constructor(options?: {
         apiKey?: string;
         serverUrl?: string;
@@ -881,6 +942,7 @@ declare class XpozClient {
         apiUrl?: string;
     });
     get instagramLive(): InstagramLiveNamespace;
+    get twitterLive(): TwitterLiveNamespace;
     connect(): Promise<void>;
     close(): Promise<void>;
     [Symbol.asyncDispose](): Promise<void>;
@@ -916,8 +978,8 @@ declare class OperationCancelledError extends XpozError {
     constructor(operationId: string);
 }
 
-declare const VERSION = "0.6.13";
+declare const VERSION = "0.8.0";
 
 declare function checkForUpdates(): Promise<void>;
 
-export { type AccountBilling, type AccountDetails, type AccountUsage, type AddTrackedItemsResult, AuthenticationError, BillingPeriod, CreditResetFrequency, type CreditsUsageHistory, type CursorPageResponse, CursorResult, type InstagramComment, type InstagramConnectionType, type InstagramInteractionType, type InstagramPost, type InstagramUser, NotFoundError, OperationCancelledError, OperationFailedError, OperationTimeoutError, PaginatedResult, type PaginationInfo, type PlanFeatures, type RedditComment, type RedditPost, type RedditPostWithComments, type RedditSubreddit, type RedditUser, type RemoveTrackedItemsResult, ResponseType, type SubredditWithPosts, type TiktokComment, type TiktokPost, type TiktokUser, type TrackedItem, TrackedItemPlatform, TrackedItemType, type TwitterPost, type TwitterUser, type UsageHistoryBucket, VERSION, ValidationError, XpozClient, XpozConnectionError, XpozError, checkForUpdates };
+export { type AccountBilling, type AccountDetails, type AccountUsage, type AddTrackedItemsResult, AuthenticationError, BillingPeriod, CreditResetFrequency, type CreditsUsageHistory, type CursorPageResponse, CursorResult, type InstagramComment, type InstagramConnectionType, type InstagramInteractionType, type InstagramPost, type InstagramUser, NotFoundError, OperationCancelledError, OperationFailedError, OperationTimeoutError, PaginatedResult, type PaginationInfo, type PlanFeatures, type RedditComment, type RedditPost, type RedditPostWithComments, type RedditSubreddit, type RedditUser, type RemoveTrackedItemsResult, ResponseType, type SubredditWithPosts, type TiktokComment, type TiktokPost, type TiktokUser, type TrackedItem, TrackedItemPlatform, TrackedItemType, type TwitterConnectionType, type TwitterInteractionType, type TwitterLiveSortBy, type TwitterPost, type TwitterUser, type UsageHistoryBucket, VERSION, ValidationError, XpozClient, XpozConnectionError, XpozError, checkForUpdates };

package/dist/index.d.ts

@@ -26,6 +26,13 @@ declare class RestTransport {
     get<T>(path: string, params?: QueryParams): Promise<T>;
 }
 
+declare abstract class LiveNamespace {
+    protected transport: RestTransport;
+    constructor(transport: RestTransport);
+    protected page<T>(path: string, params: QueryParams): Promise<CursorResult<T>>;
+    protected single<T>(path: string, params: QueryParams): Promise<T | null>;
+}
+
 interface CursorPageResponse<T> {
     results: T[];
     count: number;
@@ -35,6 +42,9 @@ interface CursorPageResponse<T> {
 }
 type InstagramConnectionType = "followers" | "following";
 type InstagramInteractionType = "commenters" | "likers";
+type TwitterConnectionType = "followers" | "following";
+type TwitterInteractionType = "commenters" | "quoters" | "retweeters";
+type TwitterLiveSortBy = "relevance" | "latest";
 interface PaginationInfo {
     tableName?: string | null;
     totalRows: number;
@@ -63,6 +73,8 @@ interface InstagramPost {
     likeCount?: number | null;
     commentCount?: number | null;
     reshareCount?: number | null;
+    mediaRepostCount?: number | null;
+    saveCount?: number | null;
     videoPlayCount?: number | null;
     location?: string | null;
     genAiChatWithAiCtaInfo?: string | null;
@@ -92,6 +104,8 @@ interface InstagramUser {
     relevantPostsLikesSum?: number | null;
     relevantPostsCommentsSum?: number | null;
     relevantPostsResharesSum?: number | null;
+    relevantPostsMediaRepostsSum?: number | null;
+    relevantPostsSavesSum?: number | null;
     relevantPostsVideoPlaysSum?: number | null;
     [key: string]: unknown;
 }
@@ -117,11 +131,7 @@ interface InstagramComment {
     [key: string]: unknown;
 }
 
-declare class InstagramLiveNamespace {
-    private transport;
-    constructor(transport: RestTransport);
-    private page;
-    private single;
+declare class InstagramLiveNamespace extends LiveNamespace {
     searchPosts(query: string, options?: {
         fields?: string[];
         cursor?: string;
@@ -154,44 +164,6 @@ declare class InstagramLiveNamespace {
     }): Promise<CursorResult<InstagramUser>>;
 }
 
-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;
@@ -279,6 +251,88 @@ interface TwitterUser {
     [key: string]: unknown;
 }
 
+declare class TwitterLiveNamespace extends LiveNamespace {
+    searchPosts(query: string, options?: {
+        since?: string;
+        until?: string;
+        lang?: string;
+        countryCode?: string;
+        sortBy?: TwitterLiveSortBy;
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getPostsByUser(username: string, options?: {
+        since?: string;
+        until?: string;
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getPost(postId: string, options?: {
+        fields?: string[];
+    }): Promise<TwitterPost | null>;
+    getComments(postId: string, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getQuotes(postId: string, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterPost>>;
+    getPostInteractingUsers(postId: string, interactionType: TwitterInteractionType, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterUser>>;
+    searchUsers(query: string, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterUser>>;
+    getUser(username: string, options?: {
+        fields?: string[];
+    }): Promise<TwitterUser | null>;
+    getUserConnections(username: string, connectionType: TwitterConnectionType, options?: {
+        fields?: string[];
+        cursor?: string;
+    }): Promise<CursorResult<TwitterUser>>;
+}
+
+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[];
+}
+
 declare enum ResponseType {
     Fast = "fast",
     Paging = "paging",
@@ -286,6 +340,9 @@ declare enum ResponseType {
 }
 
 declare class TwitterNamespace extends BaseNamespace {
+    private rest;
+    constructor(callTool: (name: string, args: Record<string, unknown>) => Promise<Record<string, unknown>>, timeoutMs: number, restTransport: RestTransport);
+    private cursorToPaginatedResult;
     getPostsByIds(postIds: string[], options?: {
         fields?: string[];
         forceLatest?: boolean;
@@ -364,6 +421,9 @@ declare class TwitterNamespace extends BaseNamespace {
 }
 
 declare class InstagramNamespace extends BaseNamespace {
+    private rest;
+    constructor(callTool: (name: string, args: Record<string, unknown>) => Promise<Record<string, unknown>>, timeoutMs: number, restTransport: RestTransport);
+    private cursorToPaginatedResult;
     getPostsByIds(postIds: string[], options?: {
         fields?: string[];
         forceLatest?: boolean;
@@ -873,6 +933,7 @@ declare class XpozClient {
     private versionCheck;
     private restTransport;
     private instagramLiveNamespace?;
+    private twitterLiveNamespace?;
     constructor(options?: {
         apiKey?: string;
         serverUrl?: string;
@@ -881,6 +942,7 @@ declare class XpozClient {
         apiUrl?: string;
     });
     get instagramLive(): InstagramLiveNamespace;
+    get twitterLive(): TwitterLiveNamespace;
     connect(): Promise<void>;
     close(): Promise<void>;
     [Symbol.asyncDispose](): Promise<void>;
@@ -916,8 +978,8 @@ declare class OperationCancelledError extends XpozError {
     constructor(operationId: string);
 }
 
-declare const VERSION = "0.6.13";
+declare const VERSION = "0.8.0";
 
 declare function checkForUpdates(): Promise<void>;
 
-export { type AccountBilling, type AccountDetails, type AccountUsage, type AddTrackedItemsResult, AuthenticationError, BillingPeriod, CreditResetFrequency, type CreditsUsageHistory, type CursorPageResponse, CursorResult, type InstagramComment, type InstagramConnectionType, type InstagramInteractionType, type InstagramPost, type InstagramUser, NotFoundError, OperationCancelledError, OperationFailedError, OperationTimeoutError, PaginatedResult, type PaginationInfo, type PlanFeatures, type RedditComment, type RedditPost, type RedditPostWithComments, type RedditSubreddit, type RedditUser, type RemoveTrackedItemsResult, ResponseType, type SubredditWithPosts, type TiktokComment, type TiktokPost, type TiktokUser, type TrackedItem, TrackedItemPlatform, TrackedItemType, type TwitterPost, type TwitterUser, type UsageHistoryBucket, VERSION, ValidationError, XpozClient, XpozConnectionError, XpozError, checkForUpdates };
+export { type AccountBilling, type AccountDetails, type AccountUsage, type AddTrackedItemsResult, AuthenticationError, BillingPeriod, CreditResetFrequency, type CreditsUsageHistory, type CursorPageResponse, CursorResult, type InstagramComment, type InstagramConnectionType, type InstagramInteractionType, type InstagramPost, type InstagramUser, NotFoundError, OperationCancelledError, OperationFailedError, OperationTimeoutError, PaginatedResult, type PaginationInfo, type PlanFeatures, type RedditComment, type RedditPost, type RedditPostWithComments, type RedditSubreddit, type RedditUser, type RemoveTrackedItemsResult, ResponseType, type SubredditWithPosts, type TiktokComment, type TiktokPost, type TiktokUser, type TrackedItem, TrackedItemPlatform, TrackedItemType, type TwitterConnectionType, type TwitterInteractionType, type TwitterLiveSortBy, type TwitterPost, type TwitterUser, type UsageHistoryBucket, VERSION, ValidationError, XpozClient, XpozConnectionError, XpozError, checkForUpdates };