@notidotbot/noti-api-client 1.6.13 → 1.7.0

package/dist/classes/minigamesFishing.d.ts

@@ -0,0 +1,168 @@
+import { CancelOutWebResponses } from '../types';
+import { WebDataManager } from '../core/manager';
+/**
+ * PUBLIC fishing catalogue.
+ *
+ * Unauthenticated and safe to call from a browser: every endpoint serves static catalogue data —
+ * species, rarities, collections, habitats and dock tiers — and nothing per-guild or per-user. There
+ * is no `auth` parameter on any method here, which is deliberate rather than an oversight.
+ *
+ * Namespaced `/minigames/fishing/...` because fishing is the FIRST minigame, not the only one; a
+ * second game slots in beside it without a breaking path change for existing consumers.
+ *
+ * Responses are cached for an hour with `stale-while-revalidate`, so polling this is cheap.
+ */
+export declare class APIMinigamesFishing {
+    private web;
+    constructor(web: WebDataManager);
+    /** Index: counts and the list of available endpoints. */
+    getOverview(): Promise<import("../types").WebResponse<FishingOverview>>;
+    /**
+     * The species catalogue.
+     *
+     * Returned unpaginated — the catalogue is small by design — with `total` alongside so a consumer
+     * never has to guess whether it was truncated. Filters are exact-match; an unknown value yields an
+     * empty list rather than an error, so you can filter optimistically.
+     */
+    listSpecies({ rarity, habitat, family, seasonalSet }?: MinigamesFishingFunctionsInput['listSpecies']): Promise<import("../types").WebResponse<FishingSpeciesList>>;
+    getSpecies({ speciesId }: MinigamesFishingFunctionsInput['getSpecies']): Promise<import("../types").WebResponse<FishingSpecies>>;
+    /**
+     * Rarity tiers and their base weights.
+     *
+     * `mythic` is included with `rollable: false` — it is never obtainable by casting (boss drops,
+     * seasonal events and collection completion only), and stating that as data means a consumer does
+     * not have to infer it from a missing weight. Per-guild reweights are guild config and are NOT
+     * exposed here.
+     */
+    listRarities(): Promise<import("../types").WebResponse<FishingRarity[]>>;
+    /** Collection sets. Derived from the catalogue, so none is gated on an uncatchable species. */
+    listCollections(): Promise<import("../types").WebResponse<FishingCollection[]>>;
+    /** Habitats and BOTH unlock requirements — the server's dock tier and the player's own level. */
+    listHabitats(): Promise<import("../types").WebResponse<FishingHabitat[]>>;
+    /** Dock tiers, their build manifests, the component list and the prestige name ladder. */
+    getDock(): Promise<import("../types").WebResponse<FishingDock>>;
+}
+export type MinigamesFishingFunctionsInput = {
+    'getOverview': Record<string, never>;
+    'listSpecies': {
+        rarity?: FishingRarityName;
+        habitat?: FishingHabitatName;
+        family?: string;
+        seasonalSet?: string;
+    };
+    'getSpecies': {
+        speciesId: string;
+    };
+    'listRarities': Record<string, never>;
+    'listCollections': Record<string, never>;
+    'listHabitats': Record<string, never>;
+    'getDock': Record<string, never>;
+};
+export type MinigamesFishingGetReturnTypes = {
+    'getOverviewRaw': Awaited<ReturnType<APIMinigamesFishing['getOverview']>>;
+    'getOverviewSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['getOverview']>>>;
+    'listSpeciesRaw': Awaited<ReturnType<APIMinigamesFishing['listSpecies']>>;
+    'listSpeciesSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['listSpecies']>>>;
+    'getSpeciesRaw': Awaited<ReturnType<APIMinigamesFishing['getSpecies']>>;
+    'getSpeciesSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['getSpecies']>>>;
+    'listRaritiesRaw': Awaited<ReturnType<APIMinigamesFishing['listRarities']>>;
+    'listRaritiesSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['listRarities']>>>;
+    'listCollectionsRaw': Awaited<ReturnType<APIMinigamesFishing['listCollections']>>;
+    'listCollectionsSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['listCollections']>>>;
+    'listHabitatsRaw': Awaited<ReturnType<APIMinigamesFishing['listHabitats']>>;
+    'listHabitatsSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['listHabitats']>>>;
+    'getDockRaw': Awaited<ReturnType<APIMinigamesFishing['getDock']>>;
+    'getDockSuccess': CancelOutWebResponses<Awaited<ReturnType<APIMinigamesFishing['getDock']>>>;
+};
+/** Rollable tiers plus `mythic`, which is never obtainable by casting. */
+export type FishingRarityName = 'common' | 'uncommon' | 'rare' | 'epic' | 'legendary' | 'mythic';
+export type FishingHabitatName = 'shallow' | 'deep' | 'reef' | 'abyss';
+export type FishingOverview = {
+    game: 'fishing';
+    counts: {
+        species: number;
+        /** Species actually obtainable by casting — excludes mythic and junk. */
+        rollableSpecies: number;
+        collections: number;
+        components: number;
+        dockTiers: number;
+        badges: number;
+    };
+    endpoints: string[];
+};
+export type FishingSpecies = {
+    id: string;
+    name: string;
+    rarity: FishingRarityName;
+    habitat: FishingHabitatName;
+    family: string;
+    baseValueCoins: number;
+    weightRangeG: {
+        min: number;
+        max: number;
+    };
+    /**
+     * BOTH gates. The dock tier opens the water for the whole server; the player still needs their own
+     * level. Showing only one makes the other look like a bug when it blocks someone.
+     */
+    requires: {
+        dockTier: number;
+        playerLevel: number;
+    };
+    /** Null unless the species belongs to a limited-edition set. */
+    seasonal: {
+        set: string;
+        startsAt: string | null;
+        endsAt: string | null;
+    } | null;
+    /** False for mythic and junk — obtainable, but never from a cast. */
+    rollable: boolean;
+};
+export type FishingSpeciesList = {
+    species: FishingSpecies[];
+    /** Stated so a consumer never has to guess whether the list was truncated. It is not. */
+    total: number;
+};
+export type FishingRarity = {
+    rarity: FishingRarityName;
+    rollable: boolean;
+    baseWeight: number;
+    /** Share of the roll at default weights. Per-guild overrides are not exposed. */
+    approxShare: number;
+    speciesCount: number;
+    /** Present only on non-rollable tiers, explaining where they actually come from. */
+    source?: string;
+};
+export type FishingCollection = {
+    id: string;
+    type: 'family' | 'habitat';
+    speciesIds: string[];
+    size: number;
+};
+export type FishingHabitat = {
+    habitat: FishingHabitatName;
+    requiresDockTier: number;
+    requiresPlayerLevel: number;
+    speciesCount: number;
+};
+export type FishingDockTier = {
+    tier: number;
+    /** `{ componentId: quantity }` needed to build this tier. */
+    componentManifest: Record<string, number>;
+    scrapRequired: number;
+    contributorTarget: number;
+    buildTimeMinutes: number;
+    habitatUnlocked: FishingHabitatName | null;
+};
+export type FishingComponent = {
+    id: string;
+    name: string;
+    band: 'common' | 'uncommon' | 'rare' | 'veryRare';
+};
+export type FishingDock = {
+    tiers: FishingDockTier[];
+    components: FishingComponent[];
+    /** The named part of the ladder. It continues past this with numerals — see `prestigeNote`. */
+    prestigeNames: readonly string[];
+    prestigeNote: string;
+};

package/dist/classes/minigamesFishing.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIMinigamesFishing = void 0;
+// Data.
+/**
+ * PUBLIC fishing catalogue.
+ *
+ * Unauthenticated and safe to call from a browser: every endpoint serves static catalogue data —
+ * species, rarities, collections, habitats and dock tiers — and nothing per-guild or per-user. There
+ * is no `auth` parameter on any method here, which is deliberate rather than an oversight.
+ *
+ * Namespaced `/minigames/fishing/...` because fishing is the FIRST minigame, not the only one; a
+ * second game slots in beside it without a breaking path change for existing consumers.
+ *
+ * Responses are cached for an hour with `stale-while-revalidate`, so polling this is cheap.
+ */
+class APIMinigamesFishing {
+    web;
+    constructor(web) {
+        this.web = web;
+    }
+    /** Index: counts and the list of available endpoints. */
+    async getOverview() {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing'),
+        });
+    }
+    /**
+     * The species catalogue.
+     *
+     * Returned unpaginated — the catalogue is small by design — with `total` alongside so a consumer
+     * never has to guess whether it was truncated. Filters are exact-match; an unknown value yields an
+     * empty list rather than an error, so you can filter optimistically.
+     */
+    async listSpecies({ rarity, habitat, family, seasonalSet } = {}) {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing/species', { rarity, habitat, family, seasonalSet }),
+        });
+    }
+    async getSpecies({ speciesId }) {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing/species/' + speciesId),
+        });
+    }
+    /**
+     * Rarity tiers and their base weights.
+     *
+     * `mythic` is included with `rollable: false` — it is never obtainable by casting (boss drops,
+     * seasonal events and collection completion only), and stating that as data means a consumer does
+     * not have to infer it from a missing weight. Per-guild reweights are guild config and are NOT
+     * exposed here.
+     */
+    async listRarities() {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing/rarities'),
+        });
+    }
+    /** Collection sets. Derived from the catalogue, so none is gated on an uncatchable species. */
+    async listCollections() {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing/collections'),
+        });
+    }
+    /** Habitats and BOTH unlock requirements — the server's dock tier and the player's own level. */
+    async listHabitats() {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing/habitats'),
+        });
+    }
+    /** Dock tiers, their build manifests, the component list and the prestige name ladder. */
+    async getDock() {
+        return await this.web.request({
+            method: 'GET',
+            endpoint: this.web.qp('/minigames/fishing/dock'),
+        });
+    }
+}
+exports.APIMinigamesFishing = APIMinigamesFishing;

package/dist/core/manager.d.ts

@@ -23,6 +23,9 @@ import { APIOther } from '../classes/other';
 import { APIGuild } from '../classes/guild';
 import { APIEmotes } from '../classes/emotes';
 import { APIFiles } from '../classes/files';
+import { APIMinigamesFishing } from '../classes/minigamesFishing';
+import { APIGuildFishing } from '../classes/guildFishing';
+import { APIAdminFishing } from '../classes/adminFishing';
 import { APIAdmin } from '../classes/admin';
 import { APIVods } from '../classes/vods';
 import { APIUser } from '../classes/user';
@@ -38,6 +41,9 @@ export declare class WebDataManager {
     readonly vods: APIVods;
     readonly files: APIFiles;
     readonly admin: APIAdmin;
+    readonly adminFishing: APIAdminFishing;
+    readonly guildFishing: APIGuildFishing;
+    readonly minigamesFishing: APIMinigamesFishing;
     readonly other: APIOther;
     readonly guild: APIGuild;
     readonly teams: APITeams;

package/dist/core/manager.js

@@ -28,6 +28,9 @@ const other_1 = require("../classes/other");
 const guild_1 = require("../classes/guild");
 const emotes_1 = require("../classes/emotes");
 const files_1 = require("../classes/files");
+const minigamesFishing_1 = require("../classes/minigamesFishing");
+const guildFishing_1 = require("../classes/guildFishing");
+const adminFishing_1 = require("../classes/adminFishing");
 const admin_1 = require("../classes/admin");
 const vods_1 = require("../classes/vods");
 const user_1 = require("../classes/user");
@@ -42,6 +45,9 @@ class WebDataManager {
     vods = new vods_1.APIVods(this);
     files = new files_1.APIFiles(this);
     admin = new admin_1.APIAdmin(this);
+    adminFishing = new adminFishing_1.APIAdminFishing(this);
+    guildFishing = new guildFishing_1.APIGuildFishing(this);
+    minigamesFishing = new minigamesFishing_1.APIMinigamesFishing(this);
     other = new other_1.APIOther(this);
     guild = new guild_1.APIGuild(this);
     teams = new teams_1.APITeams(this);

package/dist/index.d.ts

@@ -3,6 +3,9 @@ export * from './types';
 export * from './classes/@me';
 export * from './classes/user';
 export * from './classes/admin';
+export * from './classes/adminFishing';
+export * from './classes/guildFishing';
+export * from './classes/minigamesFishing';
 export * from './classes/emotes';
 export * from './classes/files';
 export * from './classes/other';

package/dist/index.js

@@ -20,6 +20,9 @@ __exportStar(require("./types"), exports);
 __exportStar(require("./classes/@me"), exports);
 __exportStar(require("./classes/user"), exports);
 __exportStar(require("./classes/admin"), exports);
+__exportStar(require("./classes/adminFishing"), exports);
+__exportStar(require("./classes/guildFishing"), exports);
+__exportStar(require("./classes/minigamesFishing"), exports);
 __exportStar(require("./classes/emotes"), exports);
 __exportStar(require("./classes/files"), exports);
 __exportStar(require("./classes/other"), exports);

package/dist/other/templates.d.ts

@@ -47,6 +47,25 @@ export declare const placeholders: {
         lastTriggerUserId: string;
         lastTriggerUserMention: string;
     };
+    scheduledMessage: {
+        guildName: string;
+        guildMemberCount: string;
+        guildId: string;
+        channelName: string;
+        channelId: string;
+        nextRun: string;
+        lastRun: string;
+        date: string;
+        time: string;
+    };
+    rolePanel: {
+        guildName: string;
+        guildId: string;
+        channelName: string;
+        channelId: string;
+        panelName: string;
+        roleCount: string;
+    };
     live: {
         kick: {
             platform: string;

package/dist/other/templates.js

@@ -50,6 +50,25 @@ exports.placeholders = {
         'lastTriggerUserId': '123456789',
         'lastTriggerUserMention': '<@123456789>',
     },
+    scheduledMessage: {
+        'guildName': 'Example Guild',
+        'guildMemberCount': '123',
+        'guildId': '123456789',
+        'channelName': 'Example Channel',
+        'channelId': '123456789',
+        'nextRun': '<t:164099520:R>',
+        'lastRun': '<t:164099520:R>',
+        'date': '05/08/2026',
+        'time': '14:30',
+    },
+    rolePanel: {
+        'guildName': 'Example Guild',
+        'guildId': '123456789',
+        'channelName': 'Example Channel',
+        'channelId': '123456789',
+        'panelName': 'Example Panel',
+        'roleCount': '5',
+    },
     live: {
         kick: {
             'platform': 'Kick',

package/dist/other/zod/rolePanels.zod.d.ts

@@ -20,6 +20,9 @@ export declare const GuildRolePanelZod: {
         messageId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         maxRoles: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         logChannelId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        webhookEnabled: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+        webhookUsername: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodString>>>;
+        webhookAvatarUrl: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodString>>>;
         requireAccountAgeDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         requireJoinAgeDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         requireMessageCount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -71,6 +74,9 @@ export declare const GuildRolePanelZod: {
         }>;
         maxRoles: z.ZodNullable<z.ZodNumber>;
         logChannelId: z.ZodNullable<z.ZodString>;
+        webhookEnabled: z.ZodDefault<z.ZodBoolean>;
+        webhookUsername: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+        webhookAvatarUrl: z.ZodDefault<z.ZodNullable<z.ZodString>>;
         requireAccountAgeDays: z.ZodNullable<z.ZodNumber>;
         requireJoinAgeDays: z.ZodNullable<z.ZodNumber>;
         requireMessageCount: z.ZodNullable<z.ZodNumber>;

package/dist/other/zod/rolePanels.zod.js

@@ -16,6 +16,10 @@ const mainSchemaFields = {
     assignMode: RolePanelAssignModeEnum,
     maxRoles: zod_2.z.number().min(1).nullable(),
     logChannelId: zod_1.SnowFlake.nullable(),
+    // Premium Plus (RolePanelWebhooks): post the panel under a custom webhook identity.
+    webhookEnabled: zod_2.z.boolean().default(false),
+    webhookUsername: zod_2.z.string().min(1).max(80).nullable().default(null),
+    webhookAvatarUrl: zod_2.z.string().url().max(2000).nullable().default(null),
     requireAccountAgeDays: zod_2.z.number().min(0).nullable(),
     requireJoinAgeDays: zod_2.z.number().min(0).nullable(),
     requireMessageCount: zod_2.z.number().min(0).nullable(),