ts-twitch-api 0.1.1 → 0.1.3

package/dist/twitch-api.js

@@ -0,0 +1,851 @@
+const BASE_URL = 'https://api.twitch.tv/helix';
+const getSearchParams = (params) => {
+    const kvPairs = [];
+    for (const key of Object.keys(params)) {
+        const value = params[key];
+        if (Array.isArray(value)) {
+            value.forEach((v) => kvPairs.push(`${key}=${v}`));
+        }
+        else {
+            kvPairs.push(`${key}=${value}`);
+        }
+    }
+    return kvPairs.join('&');
+};
+export class TwitchApi {
+    _accessToken;
+    _clientId;
+    constructor({ accessToken = '', clientId = '' } = {}) {
+        this._accessToken = accessToken;
+        this._clientId = clientId;
+    }
+    async callApi({ path, method = 'GET', params, body, requiresAuth = true, request: [clientId = null, accessToken = null, requestInit = {}], }) {
+        const url = params
+            ? `${BASE_URL}${path}?${getSearchParams(params)}`
+            : `${BASE_URL}${path}`;
+        const options = { ...requestInit, method };
+        const headers = new Headers();
+        options.headers = headers;
+        if (body) {
+            headers.set('Content-Type', 'application/json');
+            options.body = JSON.stringify(body);
+        }
+        if (requiresAuth) {
+            options.headers.set('Authorization', `Bearer ${accessToken || this._accessToken}`);
+            options.headers.set('Client-Id', clientId || this._clientId);
+        }
+        const response = await fetch(url, options);
+        return {
+            ok: response.ok,
+            status: response.status,
+            data: await response.json(),
+        };
+    }
+    ads = {
+        startCommercial: async (body, ...request) => this.callApi({
+            path: '/channels/commercial',
+            method: 'POST',
+            body,
+            request,
+        }),
+        getAdSchedule: async (params, ...request) => this.callApi({
+            path: '/channels/ads',
+            params,
+            request,
+        }),
+        snoozeNextAd: async (params, ...request) => this.callApi({
+            path: '/channels/ads/schedule/snooze',
+            method: 'POST',
+            params,
+            request,
+        }),
+    };
+    analytics = {
+        getExtensionAnalytics: async (params = null, ...request) => this.callApi({
+            path: '/analytics/extensions',
+            params,
+            request,
+        }),
+        getGameAnalytics: async (params = null, ...request) => this.callApi({
+            path: '/analytics/games',
+            params,
+            request,
+        }),
+    };
+    bits = {
+        getBitsLeaderboard: async (params = null, ...request) => this.callApi({
+            path: '/bits/leaderboard',
+            params,
+            request,
+        }),
+        getCheermotes: async (params = null, ...request) => this.callApi({
+            path: '/bits/cheermotes',
+            params,
+            request,
+        }),
+        getExtensionTransactions: async (params, ...request) => this.callApi({
+            path: '/extensions/transactions',
+            params,
+            request,
+        }),
+    };
+    channels = {
+        getChannelInformation: async (params, ...request) => this.callApi({
+            path: '/channels',
+            params,
+            request,
+        }),
+        modifyChannelInformation: async (params, body = null, ...request) => this.callApi({
+            path: '/channels',
+            method: 'PATCH',
+            params,
+            body,
+            request,
+        }),
+        getChannelEditors: async (params, ...request) => this.callApi({
+            path: '/channels/editors',
+            params,
+            request,
+        }),
+        getFollowedChannels: async (params, ...request) => this.callApi({
+            path: '/channels/followed',
+            params,
+            request,
+        }),
+        getChannelFollowers: async (params, ...request) => this.callApi({
+            path: '/channels/followers',
+            params,
+            request,
+        }),
+    };
+    channelPoints = {
+        createCustomRewards: async (params, body, ...request) => this.callApi({
+            path: '/channel_points/custom_rewards',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        deleteCustomReward: async (params, ...request) => this.callApi({
+            path: '/channel_points/custom_rewards',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getCustomReward: async (params, ...request) => this.callApi({
+            path: '/channel_points/custom_rewards',
+            params,
+            request,
+        }),
+        updateCustomReward: async (params, body = null, ...request) => this.callApi({
+            path: '/channel_points/custom_rewards',
+            method: 'PATCH',
+            params,
+            body,
+            request,
+        }),
+        getCustomRewardRedemption: async (params, ...request) => this.callApi({
+            path: '/channel_points/custom_rewards/redemptions',
+            params,
+            request,
+        }),
+        updateRedemptionStatus: async (params, body, ...request) => this.callApi({
+            path: '/channel_points/custom_rewards/redemptions',
+            method: 'PATCH',
+            params,
+            body,
+            request,
+        }),
+    };
+    charity = {
+        getCharityCampaign: async (params, ...request) => this.callApi({
+            path: '/charity/campaigns',
+            params,
+            request,
+        }),
+        getCharityCampaignDonations: async (params, ...request) => this.callApi({
+            path: '/charity/donations',
+            params,
+            request,
+        }),
+    };
+    chat = {
+        getChatters: async (params, ...request) => this.callApi({
+            path: '/chat/chatters',
+            params,
+            request,
+        }),
+        getChannelEmotes: async (params, ...request) => this.callApi({
+            path: '/chat/emotes',
+            params,
+            request,
+        }),
+        getGlobalEmotes: async (...request) => this.callApi({
+            path: '/chat/emotes/global',
+            request,
+        }),
+        getEmoteSets: async (params, ...request) => this.callApi({
+            path: '/chat/emotes/set',
+            params,
+            request,
+        }),
+        getChannelChatBadges: async (params, ...request) => this.callApi({
+            path: '/chat/badges',
+            params,
+            request,
+        }),
+        getGlobalChatBadges: async (...request) => this.callApi({
+            path: '/chat/badges/global',
+            request,
+        }),
+        getChatSettings: async (params, ...request) => this.callApi({
+            path: '/chat/settings',
+            params,
+            request,
+        }),
+        updateChatSettings: async (params, body = null, ...request) => this.callApi({
+            path: '/chat/settings',
+            method: 'PATCH',
+            params,
+            body,
+            request,
+        }),
+        sendChatAnnouncement: async (params, body, ...request) => this.callApi({
+            path: '/chat/announcements',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        sendShoutout: async (params, ...request) => this.callApi({
+            path: '/chat/shoutouts',
+            method: 'POST',
+            params,
+            request,
+        }),
+        sendChatMessage: async (body, ...request) => this.callApi({
+            path: '/chat/messages',
+            method: 'POST',
+            body,
+            request,
+        }),
+        getUserChatColor: async (params, ...request) => this.callApi({
+            path: '/chat/color',
+            params,
+            request,
+        }),
+        updateUserChatColor: async (params, ...request) => this.callApi({
+            path: '/chat/color',
+            method: 'PUT',
+            params,
+            request,
+        }),
+    };
+    clips = {
+        createClip: async (params, ...request) => this.callApi({
+            path: '/clips',
+            method: 'POST',
+            params,
+            request,
+        }),
+        getClips: async (params = null, ...request) => this.callApi({
+            path: '/clips',
+            params,
+            request,
+        }),
+    };
+    conduits = {
+        getConduits: async (...request) => this.callApi({
+            path: '/eventsub/conduits',
+            request,
+        }),
+        createConduits: async (body, ...request) => this.callApi({
+            path: '/eventsub/conduits',
+            method: 'POST',
+            body,
+            request,
+        }),
+        updateConduits: async (body, ...request) => this.callApi({
+            path: '/eventsub/conduits',
+            method: 'PATCH',
+            body,
+            request,
+        }),
+        deleteConduit: async (params, ...request) => this.callApi({
+            path: '/eventsub/conduits',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getConduitShards: async (params, ...request) => this.callApi({
+            path: '/eventsub/conduits/shards',
+            params,
+            request,
+        }),
+        updateConduitShards: async (body, ...request) => this.callApi({
+            path: '/eventsub/conduits/shards',
+            method: 'PATCH',
+            body,
+            request,
+        }),
+    };
+    ccls = {
+        getContentClassificationLabels: async (params = null, ...request) => this.callApi({
+            path: '/content_classification_labels',
+            params,
+            request,
+        }),
+    };
+    entitlements = {
+        getDropsEntitlements: async (params = null, ...request) => this.callApi({
+            path: '/entitlements/drops',
+            params,
+            request,
+        }),
+        updateDropsEntitlements: async (body = null, ...request) => this.callApi({
+            path: '/entitlements/drops',
+            method: 'PATCH',
+            body,
+            request,
+        }),
+    };
+    extensions = {
+        getExtensionConfigurationSegment: async (params, ...request) => this.callApi({
+            path: '/extensions/configurations',
+            params,
+            request,
+        }),
+        setExtensionConfigurationSegment: async (body, ...request) => this.callApi({
+            path: '/extensions/configurations',
+            method: 'PUT',
+            body,
+            request,
+        }),
+        setExtensionRequiredConfiguration: async (params, body, ...request) => this.callApi({
+            path: '/extensions/required_configuration',
+            method: 'PUT',
+            params,
+            body,
+            request,
+        }),
+        sendExtensionPubSubMessage: async (body, ...request) => this.callApi({
+            path: '/extensions/pubsub',
+            method: 'POST',
+            body,
+            request,
+        }),
+        getExtensionLiveChannels: async (params, ...request) => this.callApi({
+            path: '/extensions/live',
+            params,
+            request,
+        }),
+        getExtensionSecrets: async (...request) => this.callApi({
+            path: '/extensions/jwt/secrets',
+            request,
+        }),
+        createExtensionSecret: async (params, ...request) => this.callApi({
+            path: '/extensions/jwt/secrets',
+            method: 'POST',
+            params,
+            request,
+        }),
+        sendExtensionChatMessage: async (params, body, ...request) => this.callApi({
+            path: '/extensions/chat',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        getExtensions: async (params, ...request) => this.callApi({
+            path: '/extensions',
+            params,
+            request,
+        }),
+        getReleasedExtensions: async (params, ...request) => this.callApi({
+            path: '/extensions/released',
+            params,
+            request,
+        }),
+        getExtensionBitsProducts: async (params = null, ...request) => this.callApi({
+            path: '/bits/extensions',
+            params,
+            request,
+        }),
+        updateExtensionBitsProduct: async (body, ...request) => this.callApi({
+            path: '/bits/extensions',
+            method: 'PUT',
+            body,
+            request,
+        }),
+    };
+    eventSub = {
+        createEventSubSubscription: async (body, ...request) => this.callApi({
+            path: '/eventsub/subscriptions',
+            method: 'POST',
+            body,
+            request,
+        }),
+        deleteEventSubSubscription: async (params, ...request) => this.callApi({
+            path: '/eventsub/subscriptions',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getEventSubSubscriptions: async (params = null, ...request) => this.callApi({
+            path: '/eventsub/subscriptions',
+            params,
+            request,
+        }),
+    };
+    games = {
+        getTopGames: async (params = null, ...request) => this.callApi({
+            path: '/games/top',
+            params,
+            request,
+        }),
+        getGames: async (params = null, ...request) => this.callApi({
+            path: '/games',
+            params,
+            request,
+        }),
+    };
+    goals = {
+        getCreatorGoals: async (params, ...request) => this.callApi({
+            path: '/goals',
+            params,
+            request,
+        }),
+    };
+    guestStar = {
+        getChannelGuestStarSettings: async (params, ...request) => this.callApi({
+            path: '/guest_star/channel_settings',
+            params,
+            request,
+        }),
+        updateChannelGuestStarSettings: async (params, body = null, ...request) => this.callApi({
+            path: '/guest_star/channel_settings',
+            method: 'PUT',
+            params,
+            body,
+            request,
+        }),
+        getGuestStarSession: async (params, ...request) => this.callApi({
+            path: '/guest_star/session',
+            params,
+            request,
+        }),
+        createGuestStarSession: async (params, ...request) => this.callApi({
+            path: '/guest_star/session',
+            method: 'POST',
+            params,
+            request,
+        }),
+        endGuestStarSession: async (params, ...request) => this.callApi({
+            path: '/guest_star/session',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getGuestStarInvites: async (params, ...request) => this.callApi({
+            path: '/guest_star/invites',
+            params,
+            request,
+        }),
+        sendGuestStarInvite: async (params, ...request) => this.callApi({
+            path: '/guest_star/invites',
+            method: 'POST',
+            params,
+            request,
+        }),
+        deleteGuestStarInvite: async (params, ...request) => this.callApi({
+            path: '/guest_star/invites',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        assignGuestStarSlot: async (params, ...request) => this.callApi({
+            path: '/guest_star/slot',
+            method: 'POST',
+            params,
+            request,
+        }),
+        updateGuestStarSlot: async (params, ...request) => this.callApi({
+            path: '/guest_star/slot',
+            method: 'PATCH',
+            params,
+            request,
+        }),
+        deleteGuestStarSlot: async (params, ...request) => this.callApi({
+            path: '/guest_star/slot',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        updateGuestStarSlotSettings: async (params, ...request) => this.callApi({
+            path: '/guest_star/slot_settings',
+            method: 'PATCH',
+            params,
+            request,
+        }),
+    };
+    hypeTrain = {
+        getHypeTrainEvents: async (params, ...request) => this.callApi({
+            path: '/hypetrain/events',
+            params,
+            request,
+        }),
+    };
+    moderation = {
+        checkAutoModStatus: async (params, body, ...request) => this.callApi({
+            path: '/moderation/enforcements/status',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        manageHeldAutoModMessages: async (body, ...request) => this.callApi({
+            path: '/moderation/automod/message',
+            method: 'POST',
+            body,
+            request,
+        }),
+        getAutoModSettings: async (params, ...request) => this.callApi({
+            path: '/moderation/automod/settings',
+            params,
+            request,
+        }),
+        updateAutoModSettings: async (params, body = null, ...request) => this.callApi({
+            path: '/moderation/automod/settings',
+            method: 'PUT',
+            params,
+            body,
+            request,
+        }),
+        getBannedUsers: async (params, ...request) => this.callApi({
+            path: '/moderation/banned',
+            params,
+            request,
+        }),
+        banUser: async (params, body, ...request) => this.callApi({
+            path: '/moderation/bans',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        unbanUser: async (params, ...request) => this.callApi({
+            path: '/moderation/bans',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getBlockedTerms: async (params, ...request) => this.callApi({
+            path: '/moderation/blocked_terms',
+            params,
+            request,
+        }),
+        addBlockedTerm: async (params, body, ...request) => this.callApi({
+            path: '/moderation/blocked_terms',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        removeBlockedTerm: async (params, ...request) => this.callApi({
+            path: '/moderation/blocked_terms',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        deleteChatMessages: async (params, ...request) => this.callApi({
+            path: '/moderation/chat',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getModeratedChannels: async (params, ...request) => this.callApi({
+            path: '/moderation/channels',
+            params,
+            request,
+        }),
+        getModerators: async (params, ...request) => this.callApi({
+            path: '/moderation/moderators',
+            params,
+            request,
+        }),
+        addChannelModerator: async (params, ...request) => this.callApi({
+            path: '/moderation/moderators',
+            method: 'POST',
+            params,
+            request,
+        }),
+        removeChannelModerator: async (params, ...request) => this.callApi({
+            path: '/moderation/moderators',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getVIPs: async (params, ...request) => this.callApi({
+            path: '/channels/vips',
+            params,
+            request,
+        }),
+        addChannelVIP: async (params, ...request) => this.callApi({
+            path: '/channels/vips',
+            method: 'POST',
+            params,
+            request,
+        }),
+        removeChannelVIP: async (params, ...request) => this.callApi({
+            path: '/channels/vips',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        updateShieldModeStatus: async (params, body, ...request) => this.callApi({
+            path: '/moderation/shield_mode',
+            method: 'PUT',
+            params,
+            body,
+            request,
+        }),
+        getShieldModeStatus: async (params, ...request) => this.callApi({
+            path: '/moderation/shield_mode',
+            params,
+            request,
+        }),
+    };
+    polls = {
+        getPolls: async (params, ...request) => this.callApi({
+            path: '/polls',
+            params,
+            request,
+        }),
+        createPoll: async (body, ...request) => this.callApi({
+            path: '/polls',
+            method: 'POST',
+            body,
+            request,
+        }),
+        endPoll: async (body, ...request) => this.callApi({
+            path: '/polls',
+            method: 'PATCH',
+            body,
+            request,
+        }),
+    };
+    predictions = {
+        getPredictions: async (params, ...request) => this.callApi({
+            path: '/predictions',
+            params,
+            request,
+        }),
+        createPrediction: async (body, ...request) => this.callApi({
+            path: '/predictions',
+            method: 'POST',
+            body,
+            request,
+        }),
+        endPrediction: async (body, ...request) => this.callApi({
+            path: '/predictions',
+            method: 'PATCH',
+            body,
+            request,
+        }),
+    };
+    raids = {
+        startRaid: async (params = null, ...request) => this.callApi({
+            path: '/raids',
+            method: 'POST',
+            params,
+            request,
+        }),
+        cancelRaid: async (params, ...request) => this.callApi({
+            path: '/raids',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+    };
+    schedule = {
+        getChannelStreamSchedule: async (params, ...request) => this.callApi({
+            path: '/schedule',
+            params,
+            request,
+        }),
+        getChannelICalendar: async (params, ...request) => this.callApi({
+            path: '/schedule/icalendar',
+            params,
+            request,
+        }),
+        updateChannelStreamSchedule: async (params, ...request) => this.callApi({
+            path: '/schedule/settings',
+            method: 'PATCH',
+            params,
+            request,
+        }),
+        createChannelStreamScheduleSegment: async (params, body, ...request) => this.callApi({
+            path: '/schedule/segment',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+        updateChannelStreamScheduleSegment: async (params, body = null, ...request) => this.callApi({
+            path: '/schedule/segment',
+            method: 'PATCH',
+            params,
+            body,
+            request,
+        }),
+        deleteChannelStreamScheduleSegment: async (params, ...request) => this.callApi({
+            path: '/schedule/segment',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+    };
+    search = {
+        searchCategories: async (params, ...request) => this.callApi({
+            path: '/search/categories',
+            params,
+            request,
+        }),
+        searchChannels: async (params, ...request) => this.callApi({
+            path: '/search/channels',
+            params,
+            request,
+        }),
+    };
+    streams = {
+        getStreamKey: async (params, ...request) => this.callApi({
+            path: '/streams/key',
+            params,
+            request,
+        }),
+        getStreams: async (params = null, ...request) => this.callApi({
+            path: '/streams',
+            params,
+            request,
+        }),
+        getFollowedStreams: async (params, ...request) => this.callApi({
+            path: '/streams/followed',
+            params,
+            request,
+        }),
+        createStreamMarker: async (body, ...request) => this.callApi({
+            path: '/streams/markers',
+            method: 'POST',
+            body,
+            request,
+        }),
+        getStreamMarkers: async (params = null, ...request) => this.callApi({
+            path: '/streams/markers',
+            params,
+            request,
+        }),
+    };
+    subscriptions = {
+        getBroadcasterSubscriptions: async (params, ...request) => this.callApi({
+            path: '/subscriptions',
+            params,
+            request,
+        }),
+        checkUserSubscription: async (params, ...request) => this.callApi({
+            path: '/subscriptions/user',
+            params,
+            request,
+        }),
+    };
+    tags = {
+        getAllStreamTags: async (params = null, ...request) => this.callApi({
+            path: '/tags/streams',
+            params,
+            request,
+        }),
+        getStreamTags: async (params, ...request) => this.callApi({
+            path: '/streams/tags',
+            params,
+            request,
+        }),
+    };
+    teams = {
+        getChannelTeams: async (params, ...request) => this.callApi({
+            path: '/teams/channel',
+            params,
+            request,
+        }),
+        getTeams: async (params = null, ...request) => this.callApi({
+            path: '/teams',
+            params,
+            request,
+        }),
+    };
+    users = {
+        getUsers: async (params = null, ...request) => this.callApi({
+            path: '/users',
+            params,
+            request,
+        }),
+        updateUser: async (params = null, ...request) => this.callApi({
+            path: '/users',
+            method: 'PUT',
+            params,
+            request,
+        }),
+        getUserBlockList: async (params, ...request) => this.callApi({
+            path: '/users/blocks',
+            params,
+            request,
+        }),
+        blockUser: async (params, ...request) => this.callApi({
+            path: '/users/blocks',
+            method: 'PUT',
+            params,
+            request,
+        }),
+        unblockUser: async (params, ...request) => this.callApi({
+            path: '/users/blocks',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+        getUserExtensions: async (...request) => this.callApi({
+            path: '/users/extensions/list',
+            request,
+        }),
+        getUserActiveExtensions: async (params = null, ...request) => this.callApi({
+            path: '/users/extensions',
+            params,
+            request,
+        }),
+        updateUserExtensions: async (body, ...request) => this.callApi({
+            path: '/users/extensions',
+            method: 'PUT',
+            body,
+            request,
+        }),
+    };
+    videos = {
+        getVideos: async (params = null, ...request) => this.callApi({
+            path: '/videos',
+            params,
+            request,
+        }),
+        deleteVideos: async (params, ...request) => this.callApi({
+            path: '/videos',
+            method: 'DELETE',
+            params,
+            request,
+        }),
+    };
+    whispers = {
+        sendWhisper: async (params, body, ...request) => this.callApi({
+            path: '/whispers',
+            method: 'POST',
+            params,
+            body,
+            request,
+        }),
+    };
+}