@notidotbot/noti-api-client 1.9.39 → 1.9.41

package/dist/classes/guildClipForward.d.ts

@@ -1,357 +1,45 @@
-import { GuildClipForwardCreateSchema, GuildClipForwardZod } from '../other/prisma';
+import { GuildClipForward, GuildClipForwardCreateSchema, GuildClipForwardZod } from '../other/prisma';
 import { CancelOutWebResponses, DeepPartial } from '../types';
 import { WebDataManager } from '../core/manager';
+/** The platforms clip forwarding supports. Caps, addons and rows are all counted per platform. */
+export type ClipForwardPlatform = 'kick' | 'twitch';
+/** One platform's allowance: tier default + purchased addon, and how much of it is used. */
+export type ClipForwardCap = {
+    currentTotal: number;
+    maxLimit: number;
+};
+export type GuildClipForwardsData = {
+    forwards: GuildClipForward[];
+    /**
+     * PER PLATFORM, because the allowance is. `defaultKickClips` and `defaultTwitchClips` are separate
+     * tier numbers with separate addons (`additionalKickClips` / `additionalTwitchClips`), so a single
+     * pair would be wrong for whichever platform you were rendering.
+     *
+     * The server computes this with the same helper the create route enforces with, so a UI that
+     * believes there is room will not be refused - render the Add control off `currentTotal < maxLimit`
+     * rather than counting `forwards` yourself.
+     */
+    limits: Record<ClipForwardPlatform, ClipForwardCap>;
+    /** Which tier the allowance came from, so an upsell can name it. */
+    premium: {
+        tierId: string;
+        tierName: string;
+    };
+};
 export declare class APIGuildClipForward {
     private web;
     constructor(web: WebDataManager);
-    getGuildClipForwards({ auth, guildId }: GuildClipForwardFunctionsInput['getGuildClipForwards']): Promise<import("../types").WebResponse<({
-        customMessages: ({
-            clipForward: {
-                dbId: string;
-                guildId: string;
-                platform: import("@prisma/client").$Enums.PlatformEnum;
-                channelId: string | null;
-                streamerUserName: string;
-                usePerStreamerEmbeds: boolean | null;
-                showNotifyButton: boolean | null;
-                pingRoleId: string | null;
-                clipForwardId: string;
-                minViews: number | null;
-                minDuration: number | null;
-                maxPerCycle: number | null;
-                allowMature: boolean | null;
-                includeOffline: boolean | null;
-                whitelistClippers: string[];
-                blacklistClippers: string[];
-                whitelistCategories: string[];
-                blacklistCategories: string[];
-                lastClipAt: Date | null;
-                lastClipId: string | null;
-            } | null;
-            webhook: ({
-                cfCustomMessage: ({
-                    clipForward: {
-                        dbId: string;
-                        guildId: string;
-                        platform: import("@prisma/client").$Enums.PlatformEnum;
-                        channelId: string | null;
-                        streamerUserName: string;
-                        usePerStreamerEmbeds: boolean | null;
-                        showNotifyButton: boolean | null;
-                        pingRoleId: string | null;
-                        clipForwardId: string;
-                        minViews: number | null;
-                        minDuration: number | null;
-                        maxPerCycle: number | null;
-                        allowMature: boolean | null;
-                        includeOffline: boolean | null;
-                        whitelistClippers: string[];
-                        blacklistClippers: string[];
-                        whitelistCategories: string[];
-                        blacklistCategories: string[];
-                        lastClipAt: Date | null;
-                        lastClipId: string | null;
-                    } | null;
-                    embed: ({
-                        fields: ({
-                            cfMessageEmbed: {
-                                dbId: string;
-                                title: string | null;
-                                description: string;
-                                url: string | null;
-                                color: string | null;
-                                footer: string | null;
-                                footerIcon: string | null;
-                                image: string | null;
-                                thumbnail: string | null;
-                                author: string | null;
-                                authorIcon: string | null;
-                                cfCustomMessageId: string;
-                            } | null;
-                        } & {
-                            name: string;
-                            dbId: string;
-                            value: string | null;
-                            inline: boolean | null;
-                            cfMessageEmbedId: string;
-                        })[];
-                    } & {
-                        dbId: string;
-                        title: string | null;
-                        description: string;
-                        url: string | null;
-                        color: string | null;
-                        footer: string | null;
-                        footerIcon: string | null;
-                        image: string | null;
-                        thumbnail: string | null;
-                        author: string | null;
-                        authorIcon: string | null;
-                        cfCustomMessageId: string;
-                    }) | null;
-                    buttons: {
-                        dbId: string;
-                        title: string;
-                        url: string | null;
-                        emojiUnicodeOrId: string | null;
-                        cfCustomMessageId: string;
-                    }[];
-                } & {
-                    dbId: string;
-                    type: import("@prisma/client").$Enums.StreamerMessageTypeEnum;
-                    content: string | null;
-                    showInviteButton: boolean | null;
-                    showWatchButton: boolean | null;
-                    clipForwardId: string;
-                }) | null;
-            } & {
-                dbId: string;
-                enabled: boolean | null;
-                username: string | null;
-                avatarUrl: string | null;
-                cfCustomMessageId: string;
-            }) | null;
-            embed: ({
-                fields: ({
-                    cfMessageEmbed: ({
-                        cfCustomMessage: ({
-                            clipForward: {
-                                dbId: string;
-                                guildId: string;
-                                platform: import("@prisma/client").$Enums.PlatformEnum;
-                                channelId: string | null;
-                                streamerUserName: string;
-                                usePerStreamerEmbeds: boolean | null;
-                                showNotifyButton: boolean | null;
-                                pingRoleId: string | null;
-                                clipForwardId: string;
-                                minViews: number | null;
-                                minDuration: number | null;
-                                maxPerCycle: number | null;
-                                allowMature: boolean | null;
-                                includeOffline: boolean | null;
-                                whitelistClippers: string[];
-                                blacklistClippers: string[];
-                                whitelistCategories: string[];
-                                blacklistCategories: string[];
-                                lastClipAt: Date | null;
-                                lastClipId: string | null;
-                            } | null;
-                            webhook: {
-                                dbId: string;
-                                enabled: boolean | null;
-                                username: string | null;
-                                avatarUrl: string | null;
-                                cfCustomMessageId: string;
-                            } | null;
-                            buttons: {
-                                dbId: string;
-                                title: string;
-                                url: string | null;
-                                emojiUnicodeOrId: string | null;
-                                cfCustomMessageId: string;
-                            }[];
-                        } & {
-                            dbId: string;
-                            type: import("@prisma/client").$Enums.StreamerMessageTypeEnum;
-                            content: string | null;
-                            showInviteButton: boolean | null;
-                            showWatchButton: boolean | null;
-                            clipForwardId: string;
-                        }) | null;
-                    } & {
-                        dbId: string;
-                        title: string | null;
-                        description: string;
-                        url: string | null;
-                        color: string | null;
-                        footer: string | null;
-                        footerIcon: string | null;
-                        image: string | null;
-                        thumbnail: string | null;
-                        author: string | null;
-                        authorIcon: string | null;
-                        cfCustomMessageId: string;
-                    }) | null;
-                } & {
-                    name: string;
-                    dbId: string;
-                    value: string | null;
-                    inline: boolean | null;
-                    cfMessageEmbedId: string;
-                })[];
-                cfCustomMessage: ({
-                    clipForward: {
-                        dbId: string;
-                        guildId: string;
-                        platform: import("@prisma/client").$Enums.PlatformEnum;
-                        channelId: string | null;
-                        streamerUserName: string;
-                        usePerStreamerEmbeds: boolean | null;
-                        showNotifyButton: boolean | null;
-                        pingRoleId: string | null;
-                        clipForwardId: string;
-                        minViews: number | null;
-                        minDuration: number | null;
-                        maxPerCycle: number | null;
-                        allowMature: boolean | null;
-                        includeOffline: boolean | null;
-                        whitelistClippers: string[];
-                        blacklistClippers: string[];
-                        whitelistCategories: string[];
-                        blacklistCategories: string[];
-                        lastClipAt: Date | null;
-                        lastClipId: string | null;
-                    } | null;
-                    webhook: {
-                        dbId: string;
-                        enabled: boolean | null;
-                        username: string | null;
-                        avatarUrl: string | null;
-                        cfCustomMessageId: string;
-                    } | null;
-                    buttons: {
-                        dbId: string;
-                        title: string;
-                        url: string | null;
-                        emojiUnicodeOrId: string | null;
-                        cfCustomMessageId: string;
-                    }[];
-                } & {
-                    dbId: string;
-                    type: import("@prisma/client").$Enums.StreamerMessageTypeEnum;
-                    content: string | null;
-                    showInviteButton: boolean | null;
-                    showWatchButton: boolean | null;
-                    clipForwardId: string;
-                }) | null;
-            } & {
-                dbId: string;
-                title: string | null;
-                description: string;
-                url: string | null;
-                color: string | null;
-                footer: string | null;
-                footerIcon: string | null;
-                image: string | null;
-                thumbnail: string | null;
-                author: string | null;
-                authorIcon: string | null;
-                cfCustomMessageId: string;
-            }) | null;
-            buttons: ({
-                cfCustomMessage: ({
-                    clipForward: {
-                        dbId: string;
-                        guildId: string;
-                        platform: import("@prisma/client").$Enums.PlatformEnum;
-                        channelId: string | null;
-                        streamerUserName: string;
-                        usePerStreamerEmbeds: boolean | null;
-                        showNotifyButton: boolean | null;
-                        pingRoleId: string | null;
-                        clipForwardId: string;
-                        minViews: number | null;
-                        minDuration: number | null;
-                        maxPerCycle: number | null;
-                        allowMature: boolean | null;
-                        includeOffline: boolean | null;
-                        whitelistClippers: string[];
-                        blacklistClippers: string[];
-                        whitelistCategories: string[];
-                        blacklistCategories: string[];
-                        lastClipAt: Date | null;
-                        lastClipId: string | null;
-                    } | null;
-                    webhook: {
-                        dbId: string;
-                        enabled: boolean | null;
-                        username: string | null;
-                        avatarUrl: string | null;
-                        cfCustomMessageId: string;
-                    } | null;
-                    embed: ({
-                        fields: ({
-                            cfMessageEmbed: {
-                                dbId: string;
-                                title: string | null;
-                                description: string;
-                                url: string | null;
-                                color: string | null;
-                                footer: string | null;
-                                footerIcon: string | null;
-                                image: string | null;
-                                thumbnail: string | null;
-                                author: string | null;
-                                authorIcon: string | null;
-                                cfCustomMessageId: string;
-                            } | null;
-                        } & {
-                            name: string;
-                            dbId: string;
-                            value: string | null;
-                            inline: boolean | null;
-                            cfMessageEmbedId: string;
-                        })[];
-                    } & {
-                        dbId: string;
-                        title: string | null;
-                        description: string;
-                        url: string | null;
-                        color: string | null;
-                        footer: string | null;
-                        footerIcon: string | null;
-                        image: string | null;
-                        thumbnail: string | null;
-                        author: string | null;
-                        authorIcon: string | null;
-                        cfCustomMessageId: string;
-                    }) | null;
-                } & {
-                    dbId: string;
-                    type: import("@prisma/client").$Enums.StreamerMessageTypeEnum;
-                    content: string | null;
-                    showInviteButton: boolean | null;
-                    showWatchButton: boolean | null;
-                    clipForwardId: string;
-                }) | null;
-            } & {
-                dbId: string;
-                title: string;
-                url: string | null;
-                emojiUnicodeOrId: string | null;
-                cfCustomMessageId: string;
-            })[];
-        } & {
-            dbId: string;
-            type: import("@prisma/client").$Enums.StreamerMessageTypeEnum;
-            content: string | null;
-            showInviteButton: boolean | null;
-            showWatchButton: boolean | null;
-            clipForwardId: string;
-        })[];
-    } & {
-        dbId: string;
-        guildId: string;
-        platform: import("@prisma/client").$Enums.PlatformEnum;
-        channelId: string | null;
-        streamerUserName: string;
-        usePerStreamerEmbeds: boolean | null;
-        showNotifyButton: boolean | null;
-        pingRoleId: string | null;
-        clipForwardId: string;
-        minViews: number | null;
-        minDuration: number | null;
-        maxPerCycle: number | null;
-        allowMature: boolean | null;
-        includeOffline: boolean | null;
-        whitelistClippers: string[];
-        blacklistClippers: string[];
-        whitelistCategories: string[];
-        blacklistCategories: string[];
-        lastClipAt: Date | null;
-        lastClipId: string | null;
-    })[]>>;
+    /**
+     * Every clip-forward rule for this guild, with the per-platform allowance.
+     *
+     * **BREAKING in 1.9.40**: this returned `GuildClipForward[]` directly. The rows moved to
+     * `data.forwards` so the allowance could travel with them - `WebResponse` is exactly
+     * `{ status, data }`, so there is no room for a sibling field and an array has nowhere to put one.
+     *
+     * The caps were always enforced on create; they were simply never reported, which made a capped
+     * feature indistinguishable from an uncapped one until the create failed.
+     */
+    getGuildClipForwards({ auth, guildId }: GuildClipForwardFunctionsInput['getGuildClipForwards']): Promise<import("../types").WebResponse<GuildClipForwardsData>>;
     getGuildClipForward({ auth, guildId, clipForwardId }: GuildClipForwardFunctionsInput['getGuildClipForward']): Promise<import("../types").WebResponse<{
         customMessages: ({
             clipForward: {

package/dist/classes/guildClipForward.js

@@ -8,6 +8,16 @@ class APIGuildClipForward {
         this.web = web;
     }
     // Methods.
+    /**
+     * Every clip-forward rule for this guild, with the per-platform allowance.
+     *
+     * **BREAKING in 1.9.40**: this returned `GuildClipForward[]` directly. The rows moved to
+     * `data.forwards` so the allowance could travel with them - `WebResponse` is exactly
+     * `{ status, data }`, so there is no room for a sibling field and an array has nowhere to put one.
+     *
+     * The caps were always enforced on create; they were simply never reported, which made a capped
+     * feature indistinguishable from an uncapped one until the create failed.
+     */
     async getGuildClipForwards({ auth, guildId }) {
         return await this.web.request({
             method: 'GET', auth,

package/dist/classes/guildStatChannels.d.ts

@@ -10,6 +10,33 @@ import { WebDataManager } from '../core/manager';
 export type StatChannelPlatform = 'kick' | 'twitch' | 'youtube' | 'tiktok' | 'rumble' | 'whatnot' | 'twitter';
 /** Only Kick has a follower counter. Every other model has `isLive` alone. */
 export type StatChannelKind = 'isLive' | 'followers';
+/**
+ * What `createStatChannels` accepts, which is NOT `StatChannelKind`.
+ *
+ * `liveUpdates` is the same counter `StatChannelKind` calls `isLive`. The create body has said
+ * `liveUpdates` since counters were made from `POST /panel`, and the rest of the stat-channel surface
+ * says `isLive`; the server keeps both rather than breaking existing callers, and its RESPONSE always
+ * speaks `StatChannelKind`. So you send `liveUpdates` and read `isLive` back, deliberately.
+ */
+export type StatChannelCreateType = 'liveUpdates' | 'followers';
+/**
+ * The three counter names a guild can format.
+ *
+ * NOT `StatChannelKind` - that is which CHANNEL exists (`isLive` is one channel whose name changes
+ * between states), while `live` and `offline` are two templates for that same channel.
+ */
+export type StatChannelFormatKind = 'live' | 'offline' | 'followers';
+/**
+ * Per-platform counter name formats.
+ *
+ * A counter's name came from ONE guild-wide template, so a server watching Kick and Twitch got the
+ * identical name for both. An entry here overrides that for one platform; a platform with no entry
+ * falls back to the guild-wide template, which falls back to the bot's default.
+ *
+ * `followers` is Kick-only - it is the only platform with a follower counter at all, and the API
+ * refuses the key elsewhere rather than storing something no channel could use.
+ */
+export type StatChannelFormats = Partial<Record<StatChannelPlatform, Partial<Record<StatChannelFormatKind, string>>>>;
 /**
  * Why a counter is or is not updating.
  *
@@ -50,6 +77,24 @@ export type StatChannelsData = {
      * `cluster-unreachable` and none of them says anything about the channels themselves.
      */
     inspected: boolean;
+    /**
+     * Platforms a counter can be CREATED for, which is narrower than the platforms that can hold one.
+     *
+     * Creating a counter needs the bot to resolve the creator's live state first, and only some
+     * platforms have a check for that - so YouTube, X and Whatnot can carry a counter that already
+     * exists while refusing a new one. Read this instead of hard-coding the list: it is served from the
+     * single constant the server also gates the create route on, and it widened once already.
+     *
+     * Absent on an API older than 1.9.40, so treat `undefined` as "Kick only".
+     */
+    canCreate?: StatChannelPlatform[];
+    /**
+     * The per-platform name formats currently stored, so an editor can render them without a second
+     * call. `{}` when nothing is overridden - never null.
+     *
+     * Absent on an API older than 1.9.41.
+     */
+    formats?: StatChannelFormats;
     channels: StatChannel[];
 };
 export type UpdatedStatChannel = {
@@ -71,6 +116,17 @@ export type DeletedStatChannels = {
     /** Always false. Unlinking stops the counter; the Discord channel stays theirs to remove. */
     channelDeleted: boolean;
 };
+export type CreatedStatChannels = {
+    platform: StatChannelPlatform;
+    username: string;
+    /**
+     * One entry per counter created, in `updateStatChannel`'s shape.
+     *
+     * Read back from the database after creation rather than echoing the request, so the ids are the
+     * ones that actually landed. A caller does not need to re-`getStatChannels` to learn them.
+     */
+    channels: UpdatedStatChannel[];
+};
 export type RetriedStatChannel = {
     platform: StatChannelPlatform;
     username: string;
@@ -87,6 +143,40 @@ export declare class APIGuildStatChannels {
     constructor(web: WebDataManager);
     /** Every counter this guild has configured, with why each is or is not updating. */
     getStatChannels({ auth, guildId }: GuildStatChannelsFunctionsInput['getStatChannels']): Promise<WebResponse<StatChannelsData>>;
+    /**
+     * Set the per-platform counter name formats.
+     *
+     * **REPLACES the whole map** - send it in full every time. Omit a platform to drop its override,
+     * send `{}` to clear every one. It does NOT merge, and that is deliberate: under merge a key once
+     * written could never be removed and the unset state would be unreachable after the first save.
+     * Same contract as fishing's `logChannelOverrides`.
+     *
+     * Requires the message-editor feature as well as stat counters - 403 without it, because storing a
+     * format that would never be read looks saved and does nothing.
+     *
+     * 400 on a platform that cannot have counters, on a `followers` format for anything but Kick, and
+     * on a format over 100 characters - refused rather than truncated, since a silently shortened
+     * channel name is not what anyone typed.
+     */
+    updateStatChannelFormats({ auth, guildId, formats }: GuildStatChannelsFunctionsInput['updateStatChannelFormats']): Promise<WebResponse<{
+        formats: StatChannelFormats;
+    }>>;
+    /**
+     * Create the counter channels themselves, and link them.
+     *
+     * Use this rather than making a voice channel and pointing `updateStatChannel` at it - the bot
+     * names the new channel from the server's own `statChannelLive` / `statFollowers` template and sets
+     * its permissions.
+     *
+     * **Check `canCreate` from `getStatChannels` first.** Creating needs the bot to read the creator's
+     * live state, and the platforms that support that are narrower than the ones that can hold a
+     * counter - a platform outside that list is a 400, not a silent no-op.
+     *
+     * `followers` is Kick-only; asking for it anywhere else is a 400 naming the platform. 404 when the
+     * creator is not tracked in this guild, 400 when the live or follower read failed, in which case
+     * nothing was created.
+     */
+    createStatChannels({ auth, guildId, platform, username, types }: GuildStatChannelsFunctionsInput['createStatChannels']): Promise<WebResponse<CreatedStatChannels>>;
     /**
      * Point a counter at a channel, creating it if the creator had none.
      *
@@ -114,6 +204,18 @@ export type GuildStatChannelsFunctionsInput = {
         auth: string;
         guildId: string;
     };
+    'createStatChannels': {
+        auth: string;
+        guildId: string;
+        platform: StatChannelPlatform;
+        username: string;
+        types: StatChannelCreateType[];
+    };
+    'updateStatChannelFormats': {
+        auth: string;
+        guildId: string;
+        formats: StatChannelFormats;
+    };
     'updateStatChannel': {
         auth: string;
         guildId: string;
@@ -140,6 +242,10 @@ export type GuildStatChannelsFunctionsInput = {
 export type GuildStatChannelsReturnTypes = {
     'getStatChannelsRaw': Awaited<ReturnType<APIGuildStatChannels['getStatChannels']>>;
     'getStatChannelsSuccess': CancelOutWebResponses<Awaited<ReturnType<APIGuildStatChannels['getStatChannels']>>>;
+    'createStatChannelsRaw': Awaited<ReturnType<APIGuildStatChannels['createStatChannels']>>;
+    'createStatChannelsSuccess': CancelOutWebResponses<Awaited<ReturnType<APIGuildStatChannels['createStatChannels']>>>;
+    'updateStatChannelFormatsRaw': Awaited<ReturnType<APIGuildStatChannels['updateStatChannelFormats']>>;
+    'updateStatChannelFormatsSuccess': CancelOutWebResponses<Awaited<ReturnType<APIGuildStatChannels['updateStatChannelFormats']>>>;
     'updateStatChannelRaw': Awaited<ReturnType<APIGuildStatChannels['updateStatChannel']>>;
     'updateStatChannelSuccess': CancelOutWebResponses<Awaited<ReturnType<APIGuildStatChannels['updateStatChannel']>>>;
     'deleteStatChannelsRaw': Awaited<ReturnType<APIGuildStatChannels['deleteStatChannels']>>;

package/dist/classes/guildStatChannels.js

@@ -15,6 +15,50 @@ class APIGuildStatChannels {
             endpoint: this.web.qp(`/data/guild/${guildId}/stat-channels`),
         });
     }
+    /**
+     * Set the per-platform counter name formats.
+     *
+     * **REPLACES the whole map** - send it in full every time. Omit a platform to drop its override,
+     * send `{}` to clear every one. It does NOT merge, and that is deliberate: under merge a key once
+     * written could never be removed and the unset state would be unreachable after the first save.
+     * Same contract as fishing's `logChannelOverrides`.
+     *
+     * Requires the message-editor feature as well as stat counters - 403 without it, because storing a
+     * format that would never be read looks saved and does nothing.
+     *
+     * 400 on a platform that cannot have counters, on a `followers` format for anything but Kick, and
+     * on a format over 100 characters - refused rather than truncated, since a silently shortened
+     * channel name is not what anyone typed.
+     */
+    async updateStatChannelFormats({ auth, guildId, formats }) {
+        return await this.web.request({
+            method: 'PATCH', auth,
+            endpoint: this.web.qp(`/data/guild/${guildId}/stat-channels/formats`),
+            body: { formats },
+        });
+    }
+    /**
+     * Create the counter channels themselves, and link them.
+     *
+     * Use this rather than making a voice channel and pointing `updateStatChannel` at it - the bot
+     * names the new channel from the server's own `statChannelLive` / `statFollowers` template and sets
+     * its permissions.
+     *
+     * **Check `canCreate` from `getStatChannels` first.** Creating needs the bot to read the creator's
+     * live state, and the platforms that support that are narrower than the ones that can hold a
+     * counter - a platform outside that list is a 400, not a silent no-op.
+     *
+     * `followers` is Kick-only; asking for it anywhere else is a 400 naming the platform. 404 when the
+     * creator is not tracked in this guild, 400 when the live or follower read failed, in which case
+     * nothing was created.
+     */
+    async createStatChannels({ auth, guildId, platform, username, types }) {
+        return await this.web.request({
+            method: 'POST', auth,
+            endpoint: this.web.qp(`/data/guild/${guildId}/stat-channels/${platform}/${username}`),
+            body: { types },
+        });
+    }
     /**
      * Point a counter at a channel, creating it if the creator had none.
      *