@developer.krd/discord-dashboard 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,317 @@
+import { Express } from 'express';
+
+type CardIntent = "neutral" | "success" | "warning" | "danger" | "info";
+interface DashboardCard {
+    id: string;
+    title: string;
+    value: string | number;
+    subtitle?: string;
+    intent?: CardIntent;
+    trend?: {
+        value: string;
+        direction: "up" | "down" | "flat";
+    };
+}
+type DashboardBoxWidth = 100 | 50 | 33 | 20;
+interface DashboardDesignConfig {
+    bg?: string;
+    rail?: string;
+    contentBg?: string;
+    panel?: string;
+    panel2?: string;
+    text?: string;
+    muted?: string;
+    primary?: string;
+    success?: string;
+    warning?: string;
+    danger?: string;
+    info?: string;
+    border?: string;
+}
+interface DashboardTemplateRenderContext {
+    dashboardName: string;
+    basePath: string;
+    setupDesign?: DashboardDesignConfig;
+}
+type DashboardTemplateRenderer = (context: DashboardTemplateRenderContext) => string;
+interface PluginPanelField {
+    id?: string;
+    label: string;
+    value: string | number | boolean | string[] | Record<string, unknown>;
+    type?: HomeFieldType | "url";
+    editable?: boolean;
+    placeholder?: string;
+    required?: boolean;
+    options?: HomeFieldOption[];
+    lookup?: HomeLookupConfig;
+}
+interface PluginPanelAction {
+    id: string;
+    label: string;
+    variant?: "primary" | "secondary" | "danger";
+    collectFields?: boolean;
+}
+interface PluginPanel {
+    id: string;
+    title: string;
+    description?: string;
+    width?: DashboardBoxWidth;
+    fields?: PluginPanelField[];
+    actions?: PluginPanelAction[];
+}
+interface PluginActionResult {
+    ok: boolean;
+    message?: string;
+    refresh?: boolean;
+    data?: unknown;
+}
+interface DiscordChannel {
+    id: string;
+    guild_id?: string;
+    name: string;
+    type: number;
+    parent_id?: string | null;
+    nsfw?: boolean;
+}
+interface DiscordRole {
+    id: string;
+    name: string;
+    color: number;
+    position: number;
+    permissions: string;
+    managed?: boolean;
+    mentionable?: boolean;
+    hoist?: boolean;
+}
+interface DiscordMember {
+    user?: {
+        id: string;
+        username: string;
+        discriminator: string;
+        avatar: string | null;
+    };
+    roles: string[];
+    nick?: string | null;
+    joined_at?: string;
+}
+interface DashboardDiscordHelpers {
+    getChannel: (channelId: string) => Promise<DiscordChannel | null>;
+    getGuildChannels: (guildId: string) => Promise<DiscordChannel[]>;
+    searchGuildChannels: (guildId: string, query: string, options?: {
+        limit?: number;
+        nsfw?: boolean;
+        channelTypes?: number[];
+    }) => Promise<DiscordChannel[]>;
+    getRole: (guildId: string, roleId: string) => Promise<DiscordRole | null>;
+    getGuildRoles: (guildId: string) => Promise<DiscordRole[]>;
+    searchGuildRoles: (guildId: string, query: string, options?: {
+        limit?: number;
+        includeManaged?: boolean;
+    }) => Promise<DiscordRole[]>;
+    searchGuildMembers: (guildId: string, query: string, options?: {
+        limit?: number;
+    }) => Promise<DiscordMember[]>;
+    getGuildMember: (guildId: string, userId: string) => Promise<DiscordMember | null>;
+}
+type DashboardScope = "setup" | "user" | "guild";
+interface HomeCategory {
+    id: string;
+    label: string;
+    scope: DashboardScope;
+    description?: string;
+}
+type HomeFieldType = "text" | "textarea" | "number" | "select" | "boolean" | "role-search" | "channel-search" | "member-search" | "string-list";
+interface HomeLookupConfig {
+    limit?: number;
+    minQueryLength?: number;
+    nsfw?: boolean;
+    channelTypes?: number[];
+    includeManaged?: boolean;
+}
+interface HomeFieldOption {
+    label: string;
+    value: string;
+}
+interface HomeSectionField {
+    id: string;
+    label: string;
+    type: HomeFieldType;
+    value?: string | number | boolean | string[] | Record<string, unknown>;
+    placeholder?: string;
+    required?: boolean;
+    readOnly?: boolean;
+    options?: HomeFieldOption[];
+    lookup?: HomeLookupConfig;
+}
+interface HomeSectionAction {
+    id: string;
+    label: string;
+    variant?: "primary" | "secondary" | "danger";
+}
+interface HomeSection {
+    id: string;
+    title: string;
+    description?: string;
+    width?: DashboardBoxWidth;
+    scope?: DashboardScope;
+    categoryId?: string;
+    fields?: HomeSectionField[];
+    actions?: HomeSectionAction[];
+}
+interface HomeActionPayload {
+    sectionId: string;
+    values: Record<string, unknown>;
+}
+interface DashboardHomeBuilder {
+    getOverviewSections?: (context: DashboardContext) => Promise<HomeSection[]> | HomeSection[];
+    getCategories?: (context: DashboardContext) => Promise<HomeCategory[]> | HomeCategory[];
+    getSections?: (context: DashboardContext) => Promise<HomeSection[]> | HomeSection[];
+    actions?: Record<string, (context: DashboardContext, payload: HomeActionPayload) => Promise<PluginActionResult> | PluginActionResult>;
+}
+interface DashboardUser {
+    id: string;
+    username: string;
+    discriminator: string;
+    avatar: string | null;
+    global_name?: string | null;
+}
+interface DashboardGuild {
+    id: string;
+    name: string;
+    icon: string | null;
+    owner: boolean;
+    permissions: string;
+    iconUrl?: string | null;
+    botInGuild?: boolean;
+    inviteUrl?: string;
+}
+interface DashboardContext {
+    user: DashboardUser;
+    guilds: DashboardGuild[];
+    accessToken: string;
+    selectedGuildId?: string;
+    helpers: DashboardDiscordHelpers;
+}
+interface DashboardPlugin {
+    id: string;
+    name: string;
+    description?: string;
+    scope?: DashboardScope | "both";
+    getPanels: (context: DashboardContext) => Promise<PluginPanel[]> | PluginPanel[];
+    actions?: Record<string, (context: DashboardContext, body: unknown) => Promise<PluginActionResult> | PluginActionResult>;
+}
+interface DashboardOptions {
+    app?: Express;
+    port?: number;
+    host?: string;
+    trustProxy?: boolean | number;
+    basePath?: string;
+    dashboardName?: string;
+    setupDesign?: DashboardDesignConfig;
+    uiTemplate?: string;
+    uiTemplates?: Record<string, DashboardTemplateRenderer>;
+    botToken: string;
+    clientId: string;
+    clientSecret: string;
+    redirectUri: string;
+    sessionSecret: string;
+    sessionName?: string;
+    sessionMaxAgeMs?: number;
+    scopes?: string[];
+    botInvitePermissions?: string;
+    botInviteScopes?: string[];
+    ownerIds?: string[];
+    guildFilter?: (guild: DashboardGuild, context: DashboardContext) => Promise<boolean> | boolean;
+    getOverviewCards?: (context: DashboardContext) => Promise<DashboardCard[]> | DashboardCard[];
+    home?: DashboardHomeBuilder;
+    plugins?: DashboardPlugin[];
+}
+interface DashboardInstance {
+    app: Express;
+    start: () => Promise<void>;
+    stop: () => Promise<void>;
+}
+
+declare function createDashboard(options: DashboardOptions): DashboardInstance;
+
+type HomeActionHandler = (context: DashboardContext, payload: HomeActionPayload) => Promise<PluginActionResult> | PluginActionResult;
+type HomeLoadHandler = (context: DashboardContext, section: HomeSection) => Promise<Partial<HomeSection> | HomeSection | void> | Partial<HomeSection> | HomeSection | void;
+declare class CategoryBuilder {
+    private readonly scope;
+    private readonly categoryId;
+    private readonly categoryLabel;
+    private sections;
+    constructor(scope: DashboardScope, categoryId: string, categoryLabel: string);
+    section(input: {
+        id: string;
+        title: string;
+        description?: string;
+        width?: 100 | 50 | 33 | 20;
+        fields?: HomeSectionField[];
+        actions?: HomeSectionAction[];
+    }): this;
+    buildCategory(): HomeCategory;
+    buildSections(): HomeSection[];
+}
+declare class DashboardDesigner {
+    private readonly partialOptions;
+    private readonly categories;
+    private readonly pages;
+    private readonly homeActions;
+    private readonly loadHandlers;
+    private readonly saveHandlers;
+    constructor(baseOptions: Omit<DashboardOptions, "home">);
+    setup(input: {
+        ownerIds?: string[];
+        botInvitePermissions?: string;
+        botInviteScopes?: string[];
+        dashboardName?: string;
+        basePath?: string;
+        uiTemplate?: string;
+    }): this;
+    useTemplate(templateId: string): this;
+    addTemplate(templateId: string, renderer: DashboardTemplateRenderer): this;
+    setupDesign(input: {
+        bg?: string;
+        rail?: string;
+        contentBg?: string;
+        panel?: string;
+        panel2?: string;
+        text?: string;
+        muted?: string;
+        primary?: string;
+        success?: string;
+        warning?: string;
+        danger?: string;
+        info?: string;
+        border?: string;
+    }): this;
+    userCategory(categoryId: string, categoryLabel: string, build: (builder: CategoryBuilder) => void): this;
+    guildCategory(categoryId: string, categoryLabel: string, build: (builder: CategoryBuilder) => void): this;
+    setupCategory(categoryId: string, categoryLabel: string, build: (builder: CategoryBuilder) => void): this;
+    setupPage(input: {
+        id: string;
+        title: string;
+        label?: string;
+        scope?: DashboardScope;
+        categoryId?: string;
+        description?: string;
+        width?: 100 | 50 | 33 | 20;
+        fields?: HomeSectionField[];
+        actions?: HomeSectionAction[];
+    }): this;
+    onHomeAction(actionId: string, handler: HomeActionHandler): this;
+    onLoad(pageId: string, handler: HomeLoadHandler): this;
+    onload(pageId: string, handler: HomeLoadHandler): this;
+    onSave(pageId: string, handler: HomeActionHandler): this;
+    onsave(pageId: string, handler: HomeActionHandler): this;
+    build(): DashboardOptions;
+}
+declare function createDashboardDesigner(baseOptions: Omit<DashboardOptions, "home">): DashboardDesigner;
+
+declare function createDiscordHelpers(botToken: string): DashboardDiscordHelpers;
+
+declare const builtinTemplateRenderers: Record<string, DashboardTemplateRenderer>;
+declare function getBuiltinTemplateRenderer(templateId: string): DashboardTemplateRenderer | undefined;
+
+export { type CardIntent, type DashboardBoxWidth, type DashboardCard, type DashboardContext, type DashboardDesignConfig, DashboardDesigner, type DashboardDiscordHelpers, type DashboardGuild, type DashboardHomeBuilder, type DashboardInstance, type DashboardOptions, type DashboardPlugin, type DashboardScope, type DashboardTemplateRenderContext, type DashboardTemplateRenderer, type DashboardUser, type DiscordChannel, type DiscordMember, type DiscordRole, type HomeActionPayload, type HomeCategory, type HomeFieldOption, type HomeFieldType, type HomeLookupConfig, type HomeSection, type HomeSectionAction, type HomeSectionField, type PluginActionResult, type PluginPanel, type PluginPanelAction, type PluginPanelField, builtinTemplateRenderers, createDashboard, createDashboardDesigner, createDiscordHelpers, getBuiltinTemplateRenderer };