sparkle-react 0.0.58 → 0.0.59

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import React, { ReactNode } from 'react';
 import { z } from 'zod';
+import * as _twurple_api from '@twurple/api';
 
 declare const sparkleConfig: z.ZodObject<{
     userId: z.ZodString;
@@ -368,16 +369,259 @@ declare function useTask(): {
     invokeUntil: (taskId: string, delaySeconds: number, payload?: unknown) => Promise<boolean>;
 };
 
-/** Sous-ensemble lecture seule de `ctx.twitch` (runtime / Monaco). */
+interface Pagination extends ForwardPagination {
+    before?: string;
+}
 type UserId = string | number;
+interface CustomRewardRedemptionFilter {
+    newestFirst?: boolean;
+}
+interface PaginatedCustomRewardRedemptionFilter extends CustomRewardRedemptionFilter, ForwardPagination {
+}
+interface Subscription {
+    gifterId: string | null;
+    gifterName: string | null;
+    gifterDisplayName: string | null;
+    userId: string;
+    userName: string;
+    userDisplayName: string;
+    isGift: boolean;
+    tier: string;
+}
+interface SubscriptionData {
+    data: Subscription[];
+    cursor: string | null;
+    points: number;
+    total: number;
+}
+interface ChatChatterData {
+    userId: string;
+    userName: string;
+    userDisplayName: string;
+}
+interface ChatSettings {
+    slowModeEnabled: boolean;
+    slowModeDelay: number | null;
+    followerOnlyModeEnabled: boolean;
+    followerOnlyModeDelay: number | null;
+    subscriberOnlyModeEnabled: boolean;
+    emoteOnlyModeEnabled: boolean;
+    uniqueChatModeEnabled: boolean;
+}
+interface PrivilegedChatSettings extends ChatSettings {
+    nonModeratorChatDelay: boolean;
+    nonModeratorChatDelayDuration: number | null;
+}
+interface CustomReward {
+    id: string;
+    backgroundColor: string;
+    isEnabled: boolean;
+    cost: number;
+    title: string;
+    prompt: string;
+    userInputRequired: boolean;
+    maxRedemptionsPerStream: number | null;
+    maxRedemptionsPerUserPerStream: number | null;
+    globalCooldown: number | null;
+    isPaused: boolean;
+    isInStock: boolean;
+    redemptionsThisStream: number | null;
+    autoFulfill: boolean;
+    cooldownExpiryDate: Date | null;
+}
+interface CustomRewardRedemption {
+    id: string;
+    userId: string;
+    userName: string;
+    userDisplayName: string;
+    userInput: string;
+    isFulfilled: boolean;
+    isCanceled: boolean;
+    redemptionDate: Date;
+    rewardId: string;
+    rewardTitle: string;
+    rewardPrompt: string;
+    rewardCost: number;
+}
+interface BitsLeaderboardEntry {
+    amount: number;
+    rank: number;
+    userDisplayName: string;
+    userId: string;
+    userName: string;
+}
+interface BitsLeaderboard {
+    entries: BitsLeaderboardEntry[];
+    totalCount: number;
+}
+type BitsLeaderboardPeriod = "day" | "week" | "month" | "year" | "all";
+interface BitsLeaderboardQuery {
+    count?: number;
+    period?: BitsLeaderboardPeriod;
+    startDate?: Date;
+    contextUserId?: string;
+}
+interface Channel {
+    id: string;
+    name: string;
+    displayName: string;
+    language: string;
+    gameId: string;
+    gameName: string;
+    title: string;
+    delay: number;
+    tags: string[];
+    contentClassificationLabels: string[];
+    isBrandedContent: boolean;
+}
+interface ChannelEditor {
+    userId: string;
+    userDisplayName: string;
+    creationDate: Date;
+}
+interface Clip {
+    id: string;
+    url: string;
+    embedUrl: string;
+    creatorId: string;
+    creatorName: string;
+    videoId: string;
+    gameId: string;
+    language: string;
+    title: string;
+    viewCount: number;
+    createdAt: Date;
+    thumbnailUrl: string;
+}
+interface PaginatedClipFilter extends Pagination {
+    startDate?: string;
+    endDate?: string;
+    isFeatured?: boolean;
+}
+type GoalType = "follower" | "subscription" | "subscription_count" | "new_subscription" | "new_subscription_count";
+interface Goal {
+    id: string;
+    type: GoalType;
+    description: string;
+    currentAmount: number;
+    targetAmount: number;
+    creationDate: Date;
+}
+type StreamType = "live" | "vodcast" | "";
+interface Stream {
+    id: string;
+    userId: string;
+    userName: string;
+    userDisplayName: string;
+    gameId: string;
+    gameName: string;
+    type: StreamType;
+    title: string;
+    viewers: number;
+    startDate: Date;
+    language: string;
+    thumbnailUrl: string;
+    tags: string[];
+    isMature: boolean;
+}
+interface StreamMarker {
+    id: string;
+    creationDate: Date;
+    description: string;
+    positionInSeconds: number;
+    url: string;
+}
+interface BlockedTerm {
+    id: string;
+    creationDate: Date;
+    expirationDate: Date;
+    updatedDate: Date;
+    moderatorId: string;
+    text: string;
+}
+interface Poll {
+    id: string;
+    broadcasterId: string;
+    broadcasterName: string;
+    broadcasterDisplayName: string;
+    title: string;
+    isChannelPointsVotingEnabled: boolean;
+    channelPointsPerVote: number;
+    status: _twurple_api.HelixPollStatus;
+    durationInSeconds: number;
+    startDate: Date;
+    endDate: Date;
+    choices: {
+        id: string;
+        title: string;
+        totalVotes: number;
+        channelPointsVotes: number;
+    }[];
+}
+type PredictionOutcomeColor = "BLUE" | "PINK";
+type PredictionStatus = "ACTIVE" | "RESOLVED" | "CANCELED" | "LOCKED";
+interface Prediction {
+    id: string;
+    title: string;
+    status: PredictionStatus;
+    autoLockAfter: number;
+    createdAt: Date;
+    endedAt: Date | null;
+    lockedAt: Date | null;
+    outcomes: PredictionOutcome[];
+    winningOutcomeId: string | null;
+    winningOutcome: PredictionOutcome | null;
+}
+interface Predictor {
+    userId: string;
+    userName: string;
+    userDisplayName: string;
+    channelPointsUsed: number;
+    channelPointsWon: number | null;
+}
+interface PredictionOutcome {
+    id: string;
+    title: string;
+    users: number;
+    totalChannelPoints: number;
+    color: PredictionOutcomeColor;
+    topPredictors: Predictor[];
+}
+type UserType = "staff" | "admin" | "global_mod" | "";
+type BroadcasterType = "partner" | "affiliate" | "";
+interface User {
+    id: string;
+    name: string;
+    displayName: string;
+    description: string;
+    type: UserType;
+    broadcasterType: BroadcasterType;
+    profilePictureUrl: string;
+    offlinePlaceholderUrl: string;
+    creationDate: Date;
+}
 interface ForwardPagination {
     limit?: number;
     after?: string;
 }
+interface ForwardPagination {
+    limit?: number;
+    after?: string;
+}
+/** Sous-ensemble lecture seule de `ctx.twitch` (runtime / Monaco). */
 interface PaginatedResult<T> {
     readonly data: T[];
     cursor?: string;
 }
+interface PaginatedResult<T> {
+    readonly data: T[];
+    cursor?: string;
+}
+interface PaginatedResultWithTotal<T> {
+    readonly data: T[];
+    cursor: string;
+    total: number;
+}
 interface PaginatedResultWithTotal<T> {
     readonly data: T[];
     cursor: string;
@@ -385,82 +629,88 @@ interface PaginatedResultWithTotal<T> {
 }
 interface TwitchGetClient {
     bits: {
-        getLeaderboard: (params?: {
-            count?: number;
-            period?: "day" | "week" | "month" | "all";
-            startedAt?: Date;
-        }) => Promise<unknown>;
+        getLeaderboard: (params?: BitsLeaderboardQuery) => Promise<BitsLeaderboard>;
     };
     channelPoints: {
-        getCustomRewards: (onlyManageable?: boolean) => Promise<unknown[]>;
-        getCustomRewardsByIds: (rewardIds: string[]) => Promise<unknown[]>;
-        getCustomRewardById: (rewardId: string) => Promise<unknown>;
-        getRedemptionsByIds: (rewardId: string, redemptionIds: string[]) => Promise<unknown[]>;
-        getRedemptionById: (rewardId: string, redemptionId: string) => Promise<unknown>;
-        getRedemptions: (rewardId: string, status: string, filter: unknown) => Promise<PaginatedResult<unknown>>;
+        getCustomRewards: (onlyManageable?: boolean) => Promise<CustomReward[]>;
+        getCustomRewardsByIds: (rewardIds: string[]) => Promise<CustomReward[]>;
+        getCustomRewardById: (rewardId: string) => Promise<CustomReward>;
+        getRedemptionsByIds: (rewardId: string, redemptionIds: string[]) => Promise<CustomRewardRedemption[]>;
+        getRedemptionById: (rewardId: string, redemptionId: string) => Promise<CustomRewardRedemption>;
+        getRedemptions: (rewardId: string, status: string, filter: PaginatedCustomRewardRedemptionFilter) => Promise<PaginatedResult<CustomRewardRedemption>>;
     };
     channel: {
-        getChannelInfoById: (user: UserId) => Promise<unknown>;
+        getChannelInfoById: (user: UserId) => Promise<Channel>;
         getFollowDate: (user: UserId) => Promise<number | null>;
-        getChannelEditors: () => Promise<unknown[]>;
-        getVips: () => Promise<unknown[]>;
-        checkVipForUsers: (users: UserId[]) => Promise<unknown[]>;
+        getChannelEditors: () => Promise<ChannelEditor[]>;
+        getVips: () => Promise<ChatChatterData[]>;
+        checkVipForUsers: (users: UserId[]) => Promise<ChatChatterData[]>;
         checkVipForUser: (user: UserId) => Promise<boolean>;
         getChannelFollowerCount: () => Promise<number>;
     };
     chat: {
-        getChatters: (pagination?: ForwardPagination) => Promise<PaginatedResultWithTotal<unknown>>;
-        getSettings: () => Promise<unknown>;
-        getSettingsPrivileged: () => Promise<unknown>;
+        getChatters: (pagination?: ForwardPagination) => Promise<PaginatedResultWithTotal<ChatChatterData>>;
+        getSettings: () => Promise<ChatSettings>;
+        getSettingsPrivileged: () => Promise<PrivilegedChatSettings>;
         getColorsForUsers: (users: UserId[]) => Promise<Record<string, string>>;
         getColorForUser: (user: UserId) => Promise<string>;
     };
     clips: {
-        getClips: (filter?: unknown) => Promise<PaginatedResult<unknown>>;
-        getClipById: (id: string) => Promise<unknown>;
-        getClipsByIds: (ids: string[]) => Promise<unknown[]>;
+        getClips: (filter?: PaginatedClipFilter) => Promise<PaginatedResult<Clip>>;
+        getClipById: (id: string) => Promise<Clip>;
+        getClipsByIds: (ids: string[]) => Promise<Clip[]>;
     };
     goals: {
-        getGoals: () => Promise<unknown[]>;
+        getGoals: () => Promise<Goal[]>;
     };
     polls: {
         getPolls: (pagination?: ForwardPagination) => Promise<{
-            data: unknown[];
+            data: Poll[];
             cursor: string;
         }>;
-        getPollsByIds: (ids: string[]) => Promise<unknown[]>;
-        getPollById: (id: string) => Promise<unknown>;
+        getPollsByIds: (ids: string[]) => Promise<Poll[]>;
+        getPollById: (id: string) => Promise<Poll>;
     };
     predictions: {
         getPredictions: (pagination?: ForwardPagination) => Promise<{
-            data: unknown[];
+            data: Prediction[];
             cursor: string;
         }>;
-        getPredictionsByIds: (ids: string[]) => Promise<unknown[]>;
-        getPredictionById: (id: string) => Promise<unknown>;
+        getPredictionsByIds: (ids: string[]) => Promise<Prediction[]>;
+        getPredictionById: (id: string) => Promise<Prediction>;
     };
     streams: {
-        getStream: () => Promise<unknown | null>;
-        getStreamMarkers: (pagination?: ForwardPagination) => Promise<PaginatedResult<unknown>>;
+        getStream: () => Promise<Stream | null>;
+        getStreamMarkers: (pagination?: ForwardPagination) => Promise<PaginatedResult<StreamMarker>>;
     };
     subscriptions: {
-        getSubscriptions: (pagination?: ForwardPagination) => Promise<unknown>;
-        getSubscriptionsForUsers: (users: UserId[]) => Promise<unknown[]>;
-        getSubscriptionForUser: (user: UserId) => Promise<unknown>;
-        checkUserSubscription: (user: UserId) => Promise<unknown>;
+        getSubscriptions: (pagination?: ForwardPagination) => Promise<SubscriptionData>;
+        getSubscriptionsForUsers: (users: UserId[]) => Promise<Subscription[]>;
+        getSubscriptionForUser: (user: UserId) => Promise<Subscription>;
+        checkUserSubscription: (user: UserId) => Promise<Subscription>;
     };
     moderation: {
-        getBanned: () => Promise<unknown[]>;
+        getBanned: () => Promise<{
+            creationDate: Date;
+            expiryDate: Date;
+            moderatorDisplayName: string;
+            moderatorId: string;
+            moderatorName: string;
+            reason: string;
+            userId: string;
+            userName: string;
+            userDisplayName: string;
+        }[]>;
         checkBan: (userId: string) => Promise<boolean>;
         getModerators: () => Promise<unknown[]>;
         checkModerator: (userId: string) => Promise<boolean>;
-        getBlockedTerms: () => Promise<unknown[]>;
+        getBlockedTerms: () => Promise<BlockedTerm[]>;
     };
     utils: {
-        getUserById: (id: string) => Promise<unknown>;
-        getUserByName: (name: string) => Promise<unknown>;
-        getUserByIds: (ids: string[]) => Promise<unknown[]>;
-        getUserByNames: (names: string[]) => Promise<unknown[]>;
+        getUserById: (id: string) => Promise<User>;
+        getUserByName: (name: string) => Promise<User>;
+        getUserByIds: (ids: string[]) => Promise<User[]>;
+        getUserByNames: (names: string[]) => Promise<User[]>;
     };
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sparkle-react",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "files": [
     "dist"
   ],