@crowbartools/firebot-types 5.67.0-alpha1.3 → 5.67.0-alpha10

package/backend/streaming-platforms/twitch/ad-manager.d.ts

@@ -0,0 +1,18 @@
+declare class AdManager {
+    private logger;
+    private _adCheckIntervalId;
+    private _nextAdBreak;
+    private _isAdCheckRunning;
+    private _upcomingEventTriggered;
+    private _isAdRunning;
+    constructor();
+    get secondsUntilNextAdBreak(): number;
+    get isAdBreakRunning(): boolean;
+    runAdCheck(): Promise<void>;
+    triggerAdBreakStart(duration: number, endsAt: Date): void;
+    triggerAdBreakComplete(): void;
+    startAdCheck(): Promise<void>;
+    stopAdCheck(): void;
+}
+declare const adManager: AdManager;
+export = adManager;

package/backend/streaming-platforms/twitch/api/eventsub/custom-subscriptions/power-up-redemption-add-subscription.d.ts

@@ -0,0 +1,30 @@
+import type { HelixEventSubSubscription } from "@twurple/api";
+import { EventSubSubscription, EventSubBase } from "@twurple/eventsub-base";
+type EventData = {
+    id: string;
+    broadcaster_user_id: string;
+    broadcaster_user_login: string;
+    broadcaster_user_name: string;
+    user_id: string;
+    user_login: string;
+    user_name: string;
+    user_input: string;
+    status: string;
+    custom_power_up: {
+        id: string;
+        title: string;
+        bits_cost: number;
+        prompt: string;
+    };
+    redeemed_at: string;
+};
+export declare class EventSubPowerUpRedemptionAddSubscription extends EventSubSubscription<EventData> {
+    private readonly _broadcasterId;
+    readonly _cliName = "power-up-redemption-add";
+    constructor(handler: (data: EventData) => void, client: EventSubBase, _broadcasterId: string);
+    get id(): string;
+    get authUserId(): string | null;
+    protected transformData(data: EventData): EventData;
+    protected _subscribe(): Promise<HelixEventSubSubscription>;
+}
+export {};

package/backend/streaming-platforms/twitch/api/eventsub/eventsub-chat-helpers.d.ts

@@ -0,0 +1,69 @@
+import type { HelixChatBadgeSet, HelixCheermoteList, HelixEmoteScale } from "@twurple/api";
+import { type EventSubAutoModMessageHoldV2Event, type EventSubChannelChatNotificationEvent, type EventSubUserWhisperMessageEvent, EventSubChannelChatMessageEvent } from "@twurple/eventsub-base";
+import type { FirebotChatMessage } from "../../../../../types/chat";
+import { ThirdPartyEmote } from "../../../../chat/third-party/third-party-emote-provider";
+export interface ChatBadge {
+    title: string;
+    url: string;
+}
+interface HelixEmoteBase {
+    id: string;
+    name: string;
+    getStaticImageUrl(scale?: HelixEmoteScale): string;
+    getAnimatedImageUrl(scale?: HelixEmoteScale): string;
+}
+declare class TwitchEventSubChatHelpers {
+    private logger;
+    private readonly CHAT_ACTION_REGEX;
+    private readonly URL_REGEX;
+    readonly HIGHLIGHT_MESSAGE_REWARD_ID = "highlight-message";
+    private _badgeCache;
+    private _colorCache;
+    private _getAllTwitchEmotes;
+    private _twitchEmotes;
+    private _thirdPartyEmotes;
+    private _thirdPartyEmoteProviders;
+    private _twitchCheermotes;
+    private _profilePicUrlCache;
+    constructor();
+    get badges(): HelixChatBadgeSet[];
+    get twitchEmotes(): {
+        streamer: HelixEmoteBase[];
+        bot: HelixEmoteBase[];
+    };
+    get thirdPartyEmotes(): ThirdPartyEmote[];
+    get twitchCheermotes(): HelixCheermoteList;
+    cacheBadges(): Promise<void>;
+    cacheTwitchEmotes(): Promise<void>;
+    cacheThirdPartyEmotes(): Promise<void>;
+    cacheCheermotes(): Promise<void>;
+    cacheChatAssets(): Promise<void>;
+    private _mapCachedEmotesForFrontend;
+    private getEmoteUrl;
+    private accountTaggedInText;
+    private parseMessageParts;
+    private parseEmote;
+    private parseEventSubEmote;
+    private parseCheermote;
+    private parseEventSubCheermote;
+    private parseFirebotCheermote;
+    private parseEventSubMention;
+    private parseChatBadges;
+    private updateAccountAvatar;
+    getUserProfilePicUrl(userId: string): Promise<string>;
+    setUserProfilePicUrl(userId: string, url: string, updateAccountAvatars?: boolean): void;
+    cacheUserColor(userId: string, color?: string | null): string;
+    /**
+     * Parses out any control characters from a chat message (like ACTION when /me is used)
+     * @param rawText Raw message text
+     * @returns Chat message text, stripped of control characters
+     */
+    private getChatMessage;
+    private buildBaseChatMessage;
+    buildChatMessageFromChatEvent(event: EventSubChannelChatMessageEvent | EventSubChannelChatNotificationEvent): Promise<FirebotChatMessage>;
+    buildFirebotChatMessageFromWhisper(message: EventSubUserWhisperMessageEvent): Promise<FirebotChatMessage>;
+    buildChatMessageFromAutoModEvent(event: EventSubAutoModMessageHoldV2Event): Promise<FirebotChatMessage>;
+    enrichMessageWithRanksAndRoles(firebotChatMessage: FirebotChatMessage): Promise<void>;
+}
+declare const chatHelpers: TwitchEventSubChatHelpers;
+export { chatHelpers as TwitchEventSubChatHelpers };

package/backend/streaming-platforms/twitch/api/eventsub/eventsub-client.d.ts

@@ -0,0 +1,11 @@
+declare class TwitchEventSubClient {
+    private logger;
+    private _eventSubListener;
+    private _subscriptions;
+    private createSubscriptions;
+    createClient(): void;
+    removeSubscriptions(): void;
+    disconnectEventSub(): void;
+}
+declare const client: TwitchEventSubClient;
+export { client as TwitchEventSubClient };

package/backend/streaming-platforms/twitch/api/eventsub/eventsub-helpers.d.ts

@@ -0,0 +1,7 @@
+import type { EventSubChannelRewardEvent, EventSubChannelSharedChatSessionParticipant } from "@twurple/eventsub-base";
+import type { SharedChatParticipant } from "../../../../../types";
+import type { CustomReward } from "../resource/channel-rewards";
+import { CustomPowerUp } from "../resource/power-ups";
+export declare function mapEventSubRewardToTwitchData(event: EventSubChannelRewardEvent): CustomReward;
+export declare function getChannelRewardOrPowerUpImageUrl(rewardOrPowerUp: CustomReward | CustomPowerUp): string;
+export declare function mapSharedChatParticipants(participants: EventSubChannelSharedChatSessionParticipant[]): Promise<SharedChatParticipant[]>;

package/backend/streaming-platforms/twitch/api/index.d.ts

@@ -0,0 +1,85 @@
+import { ApiClient } from "@twurple/api";
+import type { AuthProvider } from "@twurple/auth";
+import type { FirebotAccount } from "../../../../types/accounts";
+import { TwitchAuthApi } from "./resource/auth";
+import { TwitchBitsApi } from "./resource/bits";
+import { TwitchCategoriesApi } from "./resource/categories";
+import { TwitchChannelRewardsApi } from "./resource/channel-rewards";
+import { TwitchChannelsApi } from "./resource/channels";
+import { TwitchCharityApi } from "./resource/charity";
+import { TwitchChatApi } from "./resource/chat";
+import { TwitchClipsApi } from "./resource/clips";
+import { TwitchGoalsApi } from "./resource/goals";
+import { TwitchHypeTrainApi } from "./resource/hypetrain";
+import { TwitchModerationApi } from "./resource/moderation";
+import { TwitchPollsApi } from "./resource/polls";
+import { TwitchPowerUpsApi } from "./resource/power-ups";
+import { TwitchPredictionsApi } from "./resource/predictions";
+import { TwitchStreamsApi } from "./resource/streams";
+import { TwitchSubscriptionsApi } from "./resource/subscriptions";
+import { TwitchTeamsApi } from "./resource/teams";
+import { TwitchUsersApi } from "./resource/users";
+import { TwitchVideosApi } from "./resource/videos";
+import { TwitchWhispersApi } from "./resource/whispers";
+declare class TwitchApi {
+    private _streamerClient;
+    private _botClient;
+    constructor();
+    private refreshAccountData;
+    refreshAccounts(): Promise<void>;
+    setupApiClients(streamerProvider: AuthProvider, botProvider: AuthProvider): void;
+    /**
+     * @deprecated Use the {@linkcode streamerClient} and {@linkcode botClient} properties going forward
+     */
+    getClient(): ApiClient;
+    get streamerClient(): ApiClient;
+    get botClient(): ApiClient;
+    get moderationClient(): ApiClient;
+    get accounts(): {
+        streamer: FirebotAccount;
+        bot: FirebotAccount;
+    };
+    get logger(): import("winston").Logger;
+    private _auth;
+    get auth(): TwitchAuthApi;
+    private _bits;
+    get bits(): TwitchBitsApi;
+    private _powerUps;
+    get powerUps(): TwitchPowerUpsApi;
+    private _categories;
+    get categories(): TwitchCategoriesApi;
+    private _channelRewards;
+    get channelRewards(): TwitchChannelRewardsApi;
+    private _channels;
+    get channels(): TwitchChannelsApi;
+    private _charity;
+    get charity(): TwitchCharityApi;
+    private _chat;
+    get chat(): TwitchChatApi;
+    private _clips;
+    get clips(): TwitchClipsApi;
+    private _goals;
+    get goals(): TwitchGoalsApi;
+    private _hypeTrain;
+    get hypeTrain(): TwitchHypeTrainApi;
+    private _moderation;
+    get moderation(): TwitchModerationApi;
+    private _polls;
+    get polls(): TwitchPollsApi;
+    private _preditions;
+    get predictions(): TwitchPredictionsApi;
+    private _streams;
+    get streams(): TwitchStreamsApi;
+    private _subscriptions;
+    get subscriptions(): TwitchSubscriptionsApi;
+    private _teams;
+    get teams(): TwitchTeamsApi;
+    private _users;
+    get users(): TwitchUsersApi;
+    private _videos;
+    get videos(): TwitchVideosApi;
+    private _whispers;
+    get whispers(): TwitchWhispersApi;
+}
+declare const twitchApi: TwitchApi;
+export { twitchApi as TwitchApi };

package/backend/streaming-platforms/twitch/api/resource/api-resource-base.d.ts

@@ -0,0 +1,16 @@
+import { ApiClient } from "@twurple/api";
+import { ListenerSignature, TypedEmitter } from "tiny-typed-emitter";
+import type { TwitchApi } from "../";
+export declare abstract class ApiResourceBase<T extends ListenerSignature<T> = unknown> extends TypedEmitter<T> {
+    private _apiBase;
+    constructor(apiBase: typeof TwitchApi);
+    protected get streamerClient(): ApiClient;
+    protected get botClient(): ApiClient;
+    protected get moderationClient(): ApiClient;
+    protected get logger(): import("winston").Logger;
+    protected get accounts(): {
+        streamer: import("../../../../../types").FirebotAccount;
+        bot: import("../../../../../types").FirebotAccount;
+    };
+    protected get usersApi(): import("./users").TwitchUsersApi;
+}

package/backend/streaming-platforms/twitch/api/resource/auth.d.ts

@@ -0,0 +1,6 @@
+import { ApiResourceBase } from './api-resource-base';
+import type { TwitchApi } from "../";
+export declare class TwitchAuthApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    isTokenValid(type: "streamer" | "bot"): Promise<boolean>;
+}

package/backend/streaming-platforms/twitch/api/resource/bits.d.ts

@@ -0,0 +1,9 @@
+import { HelixBitsLeaderboardEntry, HelixBitsLeaderboardPeriod, HelixCheermoteList } from "@twurple/api";
+import { ApiResourceBase } from "./api-resource-base";
+import type { TwitchApi } from "../";
+export declare class TwitchBitsApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    getChannelBitsLeaderboard(count?: number, period?: HelixBitsLeaderboardPeriod, startDate?: Date, userId?: string): Promise<HelixBitsLeaderboardEntry[]>;
+    getChannelBitsTopCheerers(count?: number, period?: HelixBitsLeaderboardPeriod, startDate?: Date): Promise<string[]>;
+    getChannelCheermotes(): Promise<HelixCheermoteList>;
+}

package/backend/streaming-platforms/twitch/api/resource/categories.d.ts

@@ -0,0 +1,19 @@
+import { ApiResourceBase } from "./api-resource-base";
+import type { TwitchApi } from "../";
+/**
+ * Defines a Twitch category
+ */
+export interface TwitchCategory {
+    /** The Twitch ID of the category */
+    id: string;
+    /** The name of the category */
+    name: string;
+    /** The box art or cover image URL of the category */
+    boxArtUrl: string;
+}
+export declare class TwitchCategoriesApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    private mapTwitchCategory;
+    getCategoryById(categoryId: string, size?: string): Promise<TwitchCategory>;
+    searchCategories(categoryName: string): Promise<TwitchCategory[]>;
+}

package/backend/streaming-platforms/twitch/api/resource/channel-rewards.d.ts

@@ -0,0 +1,74 @@
+import { ApiResourceBase } from "./api-resource-base";
+import type { TwitchApi } from "../";
+export interface ImageSet {
+    url1x: string;
+    url2x: string;
+    url4x: string;
+}
+export interface CustomReward {
+    broadcasterId: string;
+    broadcasterLogin: string;
+    broadcasterName: string;
+    id: string;
+    title: string;
+    prompt: string;
+    cost: number;
+    image?: ImageSet;
+    defaultImage: ImageSet;
+    backgroundColor: string;
+    isEnabled: boolean;
+    isUserInputRequired: boolean;
+    maxPerStreamSetting: {
+        isEnabled: boolean;
+        maxPerStream: number;
+    };
+    maxPerUserPerStreamSetting: {
+        isEnabled: boolean;
+        maxPerUserPerStream: number;
+    };
+    globalCooldownSetting: {
+        isEnabled: boolean;
+        globalCooldownSeconds: number;
+    };
+    isPaused: boolean;
+    isInStock: boolean;
+    shouldRedemptionsSkipRequestQueue: boolean;
+    redemptionsRedeemedCurrentStream?: number;
+    cooldownExpiresAt?: Date;
+}
+export interface RewardRedemption {
+    id: string;
+    rewardId: string;
+    redemptionDate: Date;
+    userId: string;
+    userName: string;
+    userDisplayName: string;
+    rewardMessage?: string;
+}
+export interface RewardRedemptionsApprovalRequest {
+    rewardId: string;
+    redemptionIds?: string[];
+    approve?: boolean;
+}
+export declare class TwitchChannelRewardsApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    private mapCustomRewardToCreateRewardPayload;
+    private mapCustomRewardToUpdateRewardPayload;
+    private mapCustomRewardResponse;
+    private mapCustomRewardRedemptionResponse;
+    /**
+     * Get an array of custom channel rewards
+     * @param {boolean} onlyManageable - Only get rewards manageable by Firebot
+     */
+    getCustomChannelRewards(onlyManageable?: boolean): Promise<CustomReward[]>;
+    getCustomChannelReward(rewardId: string): Promise<CustomReward>;
+    getManageableCustomChannelRewards(): Promise<CustomReward[]>;
+    getUnmanageableCustomChannelRewards(): Promise<CustomReward[]>;
+    getTotalChannelRewardCount(): Promise<number>;
+    createCustomChannelReward(reward: CustomReward): Promise<CustomReward>;
+    updateCustomChannelReward(reward: CustomReward): Promise<boolean>;
+    deleteCustomChannelReward(rewardId: string): Promise<boolean>;
+    getOpenChannelRewardRedemptions(): Promise<Record<string, RewardRedemption[]>>;
+    approveOrRejectChannelRewardRedemption(request: RewardRedemptionsApprovalRequest): Promise<boolean>;
+    approveOrRejectAllRedemptionsForChannelRewards(rewardIds: string[], approve?: boolean): Promise<boolean>;
+}

package/backend/streaming-platforms/twitch/api/resource/channels.d.ts

@@ -0,0 +1,64 @@
+import { HelixAdSchedule, HelixChannel, HelixChannelUpdate, HelixUserRelation, HelixChannelFollower } from "@twurple/api";
+import { ApiResourceBase } from './api-resource-base';
+import type { TwitchApi } from "../";
+export declare class TwitchChannelsApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    /**
+     * Get channel info (game, title, etc) for the given broadcaster user id
+     *
+     * @param broadcasterId The id of the broadcaster to get channel info for. Defaults to Streamer channel if left blank.
+     */
+    getChannelInformation(broadcasterId?: string): Promise<HelixChannel>;
+    /**
+     * Check whether a streamer is currently live.
+     *
+     * @param userId
+     */
+    getOnlineStatus(userId: string): Promise<boolean>;
+    /**
+     * Update the information of a Twitch channel.
+     *
+     * @param data
+     */
+    updateChannelInformation(data: HelixChannelUpdate): Promise<void>;
+    /**
+     * Get channel info (game, title, etc) for the given username
+     *
+     * @param username The id of the broadcaster to get channel info for.
+     */
+    getChannelInformationByUsername(username: string): Promise<HelixChannel>;
+    /**
+     * Retrieves the current ad schedule for the streamer's channel.
+     */
+    getAdSchedule(): Promise<HelixAdSchedule>;
+    /**
+     * Trigger a Twitch ad break. Default length 30 seconds.
+     *
+     * @param adLength How long the ad should run.
+     */
+    triggerAdBreak(adLength?: number): Promise<boolean>;
+    /**
+     * Snoozes the next scheduled mid-roll ad break by 5 minutes.
+     */
+    snoozeAdBreak(): Promise<boolean>;
+    /**
+     * Starts a raid
+     *
+     * @param targetUserId The Twitch user ID whose channel to raid
+     */
+    raidChannel(targetUserId: string): Promise<boolean>;
+    /**
+     * Cancels a raid
+     */
+    cancelRaid(): Promise<boolean>;
+    /**
+     * Gets all the VIPs in the streamer's channel
+     */
+    getVips(): Promise<HelixUserRelation[]>;
+    /**
+     * Gets an optionally specified amount of followers of the streamer's channel.
+     *
+     * @param amount The amount of followers that need to be retrieved. When omitted, retrieves all followers.
+     */
+    getFollowers(amount?: number): Promise<HelixChannelFollower[]>;
+}

package/backend/streaming-platforms/twitch/api/resource/charity.d.ts

@@ -0,0 +1,7 @@
+import { ApiResourceBase } from "./api-resource-base";
+import type { TwitchApi } from "../";
+export declare class TwitchCharityApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    getCurrentCharityFundraiserTotal(): Promise<number>;
+    getCurrentCharityFundraiserGoal(): Promise<number>;
+}

package/backend/streaming-platforms/twitch/api/resource/chat.d.ts

@@ -0,0 +1,116 @@
+import { HelixChatAnnouncementColor, HelixChatChatter, HelixUserEmote } from "@twurple/api";
+import type { SharedChatParticipant } from "../../../../../types";
+import { ApiResourceBase } from "./api-resource-base";
+import type { TwitchApi } from "../";
+interface ResultWithError<TResult, TError> {
+    success: boolean;
+    result?: TResult;
+    error?: TError;
+}
+export declare class TwitchChatApi extends ApiResourceBase {
+    private _slashCommandHandler;
+    constructor(apiBase: typeof TwitchApi);
+    /**
+     * Gets the list of all chatters in the channel.
+     */
+    getAllChatters(): Promise<HelixChatChatter[]>;
+    /**
+     * Sends a chat message to the streamer's chat.
+     *
+     * @param message Chat message to send.
+     * @param replyToMessageId The ID of the message this should be replying to. Leave as null for non replies.
+     * @param sendAsBot If the chat message should be sent as the bot or not.
+     * If this is set to `false` or the bot account is not logged in, the chat message will be sent as the streamer.
+     * @returns `true` if sending the chat message was successful or `false` if it failed
+     */
+    sendChatMessage(message: string, replyToMessageId?: string, sendAsBot?: boolean): Promise<boolean>;
+    /**
+     * Sends an announcement to the streamer's chat.
+     *
+     * @param message The announcement to send
+     * @param color The color of the announcement. Options include `primary`, `blue`, `green`, `orange`, and `purple`.
+     * Defaults to `primary`, the streamer's brand color.
+     * @param sendAsBot If the announcement should be sent as the bot or not.
+     * If this is set to `false`, the announcement will be sent as the streamer.
+     * @returns `true` if the announcement was successful or `false` if it failed
+     */
+    sendAnnouncement(message: string, color?: HelixChatAnnouncementColor, sendAsBot?: boolean): Promise<boolean>;
+    /**
+     * Sends a Twitch shoutout to another channel
+     *
+     * @param targetUserId The Twitch user ID whose channel to shoutout
+     * @returns true when successful, error message string when unsuccessful
+     */
+    sendShoutout(targetUserId: string): Promise<ResultWithError<undefined, string>>;
+    /**
+     * Deletes a chat message from the streamer's chat.
+     *
+     * @param messageId The ID of the message to delete
+     * @returns `true` if the message was deleted or `false` if it failed
+     */
+    deleteChatMessage(messageId: string): Promise<boolean>;
+    /**
+     * Clears the streamer's chat.
+     *
+     * @returns `true` if chat was cleared or `false` if it failed
+     */
+    clearChat(): Promise<boolean>;
+    /**
+     * Turns emote-only mode on or off in the streamer's chat.
+     *
+     * @param enable `true` will enable emote-only mode. `false` will disable emote-only mode. Defaults to `true`.
+     * @returns `true` if the update succeeded or `false` if it failed
+     */
+    setEmoteOnlyMode(enable?: boolean): Promise<boolean>;
+    /**
+     * Turns follower-only mode on or off in the streamer's chat.
+     *
+     * @param enable `true` will enable follower-only mode. `false` will disable follower-only mode. Defaults to `true`.
+     * @param duration Duration in minutes that a user must be following the channel before they're allowed to chat. Default is `0`.
+     * @returns `true` if the update succeeded or `false` if it failed
+     */
+    setFollowerOnlyMode(enable?: boolean, duration?: number): Promise<boolean>;
+    /**
+     * Turns subscriber-only mode on or off in the streamer's chat.
+     *
+     * @param enable `true` will enable subscriber-only mode. `false` will disable subscriber-only mode. Defaults to `true`.
+     * @returns `true` if the update succeeded or `false` if it failed
+     */
+    setSubscriberOnlyMode(enable?: boolean): Promise<boolean>;
+    /**
+     * Turns slow mode on or off in the streamer's chat.
+     *
+     * @param enable `true` will enable slow mode. `false` will disable slow mode. Defaults to `true`.
+     * @param duration Duration in seconds that a user must wait between sending messages. Default is `5`.
+     * @returns `true` if the update succeeded or `false` if it failed
+     */
+    setSlowMode(enable?: boolean, duration?: number): Promise<boolean>;
+    /**
+     * Turns unique mode on or off in the streamer's chat.
+     *
+     * @param enable `true` will enable unique mode. `false` will disable unique mode. Defaults to `true`.
+     * @returns `true` if the update succeeded or `false` if it failed
+     */
+    setUniqueMode(enable?: boolean): Promise<boolean>;
+    /**
+     * Gets the chat color for a user.
+     *
+     * @param targetUserId numerical ID of the user as sting.
+     * @returns the color as hex code, null if the user did not set a color, or undefined if the user is unknown.
+     */
+    getColorForUser(targetUserId: string): Promise<string>;
+    /**
+     * Gets all emotes that can be used on Twitch by the specified Firebot account.
+     *
+     * @param account Either `streamer` or `bot`
+     * @returns An array of {@link HelixUserEmote} containing all the emotes the user can use on Twitch, or null if the request failed
+     */
+    getAllUserEmotes(account?: "streamer" | "bot"): Promise<HelixUserEmote[]>;
+    /**
+     * Gets the participants in the current shared chat session.
+     *
+     * @returns An array of {@link SharedChatParticipant} containing all the participants in the shared chat session, or null if there is no active session
+     */
+    getSharedChatParticipants(): Promise<SharedChatParticipant[]>;
+}
+export {};

package/backend/streaming-platforms/twitch/api/resource/clips.d.ts

@@ -0,0 +1,55 @@
+import { HelixClip, UserIdResolvable } from "@twurple/api";
+import { ApiResourceBase } from "./api-resource-base";
+import type { TwitchApi } from "../";
+export declare class TwitchClipsApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    /**
+     * Creates a clip in the streamer's channel
+     * @returns A {@linkcode HelixClip} representing the newly created clip
+     */
+    createClip(duration?: number, title?: string): Promise<HelixClip>;
+    /**
+     * Gets a Twitch clip from the specified clip URL
+     * @param url URL of the clip
+     * @returns A {@link HelixClip} from the given URL, or `null` if it doesn't exist
+     */
+    getClipFromClipUrl(url: string): Promise<HelixClip>;
+    /**
+     * Gets a random clip for the given user ID
+     * @param userId Twitch user ID
+     * @param limit How many clips to retrieve for random pool. Default is `100`.
+     * @param isFeatured `true` for only featured clips, `false` for only non-featured, or `undefined` for all
+     * @param startDate The earliest {@link Date} to find clips for, or `undefined` for no lower limit
+     * @param endDate The latest {@link Date} to find clips for, or `undefined` for no upper limit
+     * @returns A random {@link HelixClip} from the user's channel, or `null` if the user doesn't exist or their channel has no clips
+     */
+    getRandomClipForUserById(userId: UserIdResolvable, limit?: number, isFeatured?: boolean, startDate?: Date, endDate?: Date): Promise<HelixClip>;
+    /**
+     * Gets a random clip for the given username
+     * @param userId Twitch username
+     * @param limit How many clips to retrieve for random pool. Default is `100`.
+     * @param isFeatured `true` for only featured clips, `false` for only non-featured, or `undefined` for all
+     * @param startDate The earliest {@link Date} to find clips for, or `undefined` for no lower limit
+     * @param endDate The latest {@link Date} to find clips for, or `undefined` for no upper limit
+     * @returns A random {@link HelixClip} from the user's channel, or `null` if the user doesn't exist or their channel has no clips
+     */
+    getRandomClipForUserByName(username: string, limit?: number, isFeatured?: boolean, startDate?: Date, endDate?: Date): Promise<HelixClip>;
+    /**
+     * Get the latest clip for the given user ID.
+     *
+     * NOTE: Due to how the Twitch API works, this can take several seconds and the clip may not be the very latest.
+     * @param userId Twitch user ID
+     * @param isFeatured `true` for only featured clips, `false` for only non-featured, or `undefined` for all
+     * @returns The most recently created {@link HelixClip} from the user's channel, or `null` if the user doesn't exist or their channel has no clips
+     */
+    getLatestClipForUserById(userId: UserIdResolvable, isFeatured?: boolean): Promise<HelixClip>;
+    /**
+     * Get the latest clip for the given username.
+     *
+     * NOTE: Due to how the Twitch API works, this can take several seconds and the clip may not be the very latest.
+     * @param username Twitch username
+     * @param isFeatured `true` for only featured clips, `false` for only non-featured, or `undefined` for all
+     * @returns The most recently created {@link HelixClip} from the user's channel, or `null` if the user doesn't exist or their channel has no clips
+     */
+    getLatestClipForUserByName(username: string, isFeatured?: boolean): Promise<HelixClip>;
+}

package/backend/streaming-platforms/twitch/api/resource/goals.d.ts

@@ -0,0 +1,12 @@
+import { HelixGoal } from "@twurple/api";
+import { ApiResourceBase } from './api-resource-base';
+import type { TwitchApi } from "../";
+export declare class TwitchGoalsApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    /**
+     * Retrieves the current Twitch channel goals
+     *
+     * @returns A HelixPoll object with the most recent Twitch poll data
+     */
+    getCurrentChannelGoals(): Promise<HelixGoal[]>;
+}

package/backend/streaming-platforms/twitch/api/resource/hypetrain.d.ts

@@ -0,0 +1,10 @@
+import { HelixHypeTrain } from "@twurple/api";
+import { ApiResourceBase } from './api-resource-base';
+import type { TwitchApi } from "../";
+export declare class TwitchHypeTrainApi extends ApiResourceBase {
+    constructor(apiBase: typeof TwitchApi);
+    /**
+     * Retrieves current Twitch channel hype train for the streamer
+     */
+    getCurrentHypeTrain(): Promise<HelixHypeTrain>;
+}