@developer.krd/discord-dashboard 0.1.2 → 0.1.5

package/dist/index.d.ts

@@ -1,6 +1,13 @@
-import { Express } from 'express';
+import { Elysia, Static } from 'elysia';
+import express, { Express } from 'express';
+import { FastifyInstance } from 'fastify';
+import { Client } from 'discord.js';
+import * as _sinclair_typebox from '@sinclair/typebox';
 
+type DashboardScope = "setup" | "user" | "guild";
+type DashboardBoxWidth = 100 | 50 | 33 | 20;
 type CardIntent = "neutral" | "success" | "warning" | "danger" | "info";
+
 interface DashboardCard {
     id: string;
     title: string;
@@ -12,7 +19,6 @@ interface DashboardCard {
         direction: "up" | "down" | "flat";
     };
 }
-type DashboardBoxWidth = 100 | 50 | 33 | 20;
 interface DashboardDesignConfig {
     bg?: string;
     rail?: string;
@@ -27,6 +33,13 @@ interface DashboardDesignConfig {
     danger?: string;
     info?: string;
     border?: string;
+    customCss?: string;
+    surface?: string;
+    card?: string;
+    card2?: string;
+    accent?: string;
+    radiusLg?: string;
+    radiusMd?: string;
 }
 interface DashboardTemplateRenderContext {
     dashboardName: string;
@@ -34,36 +47,24 @@ interface DashboardTemplateRenderContext {
     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 {
+
+interface DashboardUser {
     id: string;
-    label: string;
-    variant?: "primary" | "secondary" | "danger";
-    collectFields?: boolean;
+    username: string;
+    discriminator: string;
+    avatar: string | null;
+    global_name?: string | null;
+    avatarUrl?: string | null;
 }
-interface PluginPanel {
+interface DashboardGuild {
     id: string;
-    title: string;
-    description?: string;
-    width?: DashboardBoxWidth;
-    fields?: PluginPanelField[];
-    actions?: PluginPanelAction[];
-}
-interface PluginActionResult {
-    ok: boolean;
-    message?: string;
-    refresh?: boolean;
-    data?: unknown;
+    name: string;
+    icon: string | null;
+    owner: boolean;
+    permissions: string;
+    iconUrl?: string | null;
+    botInGuild?: boolean;
+    inviteUrl?: string;
 }
 interface DiscordChannel {
     id: string;
@@ -113,13 +114,55 @@ interface DashboardDiscordHelpers {
     }) => Promise<DiscordMember[]>;
     getGuildMember: (guildId: string, userId: string) => Promise<DiscordMember | null>;
 }
-type DashboardScope = "setup" | "user" | "guild";
-interface HomeCategory {
+interface DashboardContext {
+    user: DashboardUser;
+    guilds: DashboardGuild[];
+    accessToken: string;
+    selectedGuildId?: string;
+    helpers: DashboardDiscordHelpers;
+}
+
+interface PluginActionResult {
+    ok: boolean;
+    message?: string;
+    refresh?: boolean;
+    data?: unknown;
+}
+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;
-    scope: DashboardScope;
+    variant?: "primary" | "secondary" | "danger";
+    collectFields?: boolean;
+}
+interface PluginPanel {
+    id: string;
+    title: string;
     description?: string;
+    width?: DashboardBoxWidth;
+    fields?: PluginPanelField[];
+    actions?: PluginPanelAction[];
 }
+interface DashboardPlugin {
+    id: string;
+    name: string;
+    description?: string;
+    scope?: DashboardScope | "both";
+    panels?: PluginPanel[];
+    getPanels?: (context: DashboardContext) => Promise<PluginPanel[]> | PluginPanel[];
+    actions?: Record<string, (context: DashboardContext, body: unknown) => Promise<PluginActionResult> | PluginActionResult>;
+}
+
 type HomeFieldType = "text" | "textarea" | "number" | "select" | "boolean" | "role-search" | "channel-search" | "member-search" | "string-list";
 interface HomeLookupConfig {
     limit?: number;
@@ -132,6 +175,12 @@ interface HomeFieldOption {
     label: string;
     value: string;
 }
+interface HomeCategory {
+    id: string;
+    label: string;
+    scope: DashboardScope;
+    description?: string;
+}
 interface HomeSectionField {
     id: string;
     label: string;
@@ -168,49 +217,148 @@ interface DashboardHomeBuilder {
     getSections?: (context: DashboardContext) => Promise<HomeSection[]> | HomeSection[];
     actions?: Record<string, (context: DashboardContext, payload: HomeActionPayload) => Promise<PluginActionResult> | PluginActionResult>;
 }
-interface DashboardUser {
+
+interface DashboardOverviewCard {
+    title: string;
+    value: string;
+    subtitle?: string;
+}
+interface DashboardCategory {
     id: string;
-    username: string;
-    discriminator: string;
-    avatar: string | null;
-    global_name?: string | null;
+    label: string;
+    description?: string;
 }
-interface DashboardGuild {
+interface DashboardAction {
     id: string;
-    name: string;
-    icon: string | null;
-    owner: boolean;
-    permissions: string;
-    iconUrl?: string | null;
-    botInGuild?: boolean;
-    inviteUrl?: string;
+    label: string;
+    variant?: "primary" | "danger" | "default";
+    collectFields?: boolean;
+    handler?: (context: unknown, values: Record<string, unknown>) => Promise<{
+        message?: string;
+        refresh?: boolean;
+    }> | {
+        message?: string;
+        refresh?: boolean;
+    };
 }
-interface DashboardContext {
-    user: DashboardUser;
-    guilds: DashboardGuild[];
-    accessToken: string;
-    selectedGuildId?: string;
-    helpers: DashboardDiscordHelpers;
+interface DashboardField {
+    id: string;
+    label: string;
+    type: "text" | "number" | "boolean" | "textarea" | "select" | "string-list" | "role-search" | "channel-search" | "member-search" | "url";
+    value?: unknown;
+    placeholder?: string;
+    required?: boolean;
+    readOnly?: boolean;
+    editable?: boolean;
+    options?: {
+        label: string;
+        value: string;
+    }[];
+    lookup?: {
+        minQueryLength?: number;
+        limit?: number;
+        includeManaged?: boolean;
+        nsfw?: boolean;
+        channelTypes?: number[];
+    };
 }
-interface DashboardPlugin {
+interface DashboardSection {
+    id: string;
+    categoryId: string;
+    title: string;
+    description?: string;
+    width: 20 | 33 | 50 | 100;
+    fields: DashboardField[];
+    actions: DashboardAction[];
+}
+interface DashboardPanel {
+    id: string;
+    title: string;
+    description?: string;
+    fields: DashboardField[];
+    actions: DashboardAction[];
+}
+interface DashboardPluginData {
     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>;
+    panels: DashboardPanel[];
+}
+interface DashboardData {
+    categories: DashboardCategory[];
+    sections: DashboardSection[];
+    plugins: DashboardPluginData[];
+    overviewCards: DashboardOverviewCard[];
 }
+
+declare function renderCompactLayout(context: DashboardTemplateRenderContext): string;
+
+declare function renderDefaultLayout(context: DashboardTemplateRenderContext): string;
+
+declare function renderShadcnMagicLayout(context: DashboardTemplateRenderContext): string;
+
+declare const BuiltinLayouts: {
+    default: typeof renderDefaultLayout;
+    compact: typeof renderCompactLayout;
+    "shadcn-magic": typeof renderShadcnMagicLayout;
+};
+
+declare const BuiltinThemes: {
+    default: {
+        bg: string;
+        rail: string;
+        contentBg: string;
+        panel: string;
+        panel2: string;
+        text: string;
+        muted: string;
+        primary: string;
+        success: string;
+        warning: string;
+        danger: string;
+        border: string;
+    };
+    compact: {
+        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;
+    };
+    "shadcn-magic": {
+        bg: string;
+        surface: string;
+        card: string;
+        card2: string;
+        text: string;
+        muted: string;
+        primary: string;
+        accent: string;
+        border: string;
+        radiusLg: string;
+        radiusMd: string;
+    };
+};
+
+type BuiltinLayoutNames = keyof typeof BuiltinLayouts;
+type BuiltinThemeNames = keyof typeof BuiltinThemes;
 interface DashboardOptions {
-    app?: Express;
+    app?: Express | Elysia | FastifyInstance;
     port?: number;
     host?: string;
     trustProxy?: boolean | number;
     basePath?: string;
     dashboardName?: string;
-    setupDesign?: DashboardDesignConfig;
-    uiTemplate?: string;
-    uiTemplates?: Record<string, DashboardTemplateRenderer>;
     botToken: string;
+    client: Client;
     clientId: string;
     clientSecret: string;
     redirectUri: string;
@@ -225,93 +373,183 @@ interface DashboardOptions {
     getOverviewCards?: (context: DashboardContext) => Promise<DashboardCard[]> | DashboardCard[];
     home?: DashboardHomeBuilder;
     plugins?: DashboardPlugin[];
+    uiTemplate?: BuiltinLayoutNames | DashboardTemplateRenderer;
+    uiTheme?: BuiltinThemeNames | DashboardDesignConfig;
+    setupDesign?: DashboardDesignConfig;
+    uiTemplates?: Record<string, DashboardTemplateRenderer>;
+    dashboardData?: DashboardData;
 }
 interface DashboardInstance {
-    app: Express;
+    app: Express | Elysia | FastifyInstance;
     start: () => Promise<void>;
     stop: () => Promise<void>;
 }
 
-declare function createDashboard(options: DashboardOptions): DashboardInstance;
+declare const SessionSchema: _sinclair_typebox.TObject<{
+    oauthState: _sinclair_typebox.TOptional<_sinclair_typebox.TString>;
+    discordAuth: _sinclair_typebox.TOptional<_sinclair_typebox.TObject<{
+        accessToken: _sinclair_typebox.TString;
+        user: _sinclair_typebox.TObject<{
+            id: _sinclair_typebox.TString;
+            username: _sinclair_typebox.TString;
+            discriminator: _sinclair_typebox.TString;
+            avatar: _sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNull]>;
+            global_name: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNull]>>;
+        }>;
+        guilds: _sinclair_typebox.TArray<_sinclair_typebox.TObject<{
+            id: _sinclair_typebox.TString;
+            name: _sinclair_typebox.TString;
+            icon: _sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNull]>;
+            owner: _sinclair_typebox.TBoolean;
+            permissions: _sinclair_typebox.TString;
+            iconUrl: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNull]>>;
+            botInGuild: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TBoolean, _sinclair_typebox.TNull]>>;
+            inviteUrl: _sinclair_typebox.TOptional<_sinclair_typebox.TUnion<[_sinclair_typebox.TString, _sinclair_typebox.TNull]>>;
+        }>>;
+    }>>;
+}>;
+type SessionData = Static<typeof SessionSchema>;
+
+declare class DiscordHelpers implements DashboardDiscordHelpers {
+    private readonly botToken;
+    private readonly DISCORD_API;
+    constructor(botToken: string);
+    private fetchDiscordWithBot;
+    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>;
+    getGuildIconUrl(guildId: string, iconHash: string | null): string | null;
+    getUserAvatarUrl(userId: string, avatarHash: string | null): string | null;
+}
+
+declare class DashboardEngine {
+    options: DashboardOptions;
+    helpers: DiscordHelpers;
+    private templateManager;
+    private DISCORD_API;
+    constructor(options: DashboardOptions);
+    getAuthUrl(state: string): string;
+    exchangeCode(code: string): Promise<{
+        access_token: string;
+        refresh_token?: string;
+        expires_in?: number;
+    }>;
+    fetchUser(token: string): Promise<DashboardUser>;
+    fetchGuilds(token: string): Promise<DashboardGuild[]>;
+    render(basePath: string): string;
+}
 
-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[];
+    data: DashboardCategory;
+    constructor(id: string, label: string);
+    setDescription(description: string): this;
+}
+declare class SectionBuilder {
+    id: string;
+    categoryId: string;
+    title: string;
+    data: any;
+    constructor(id: string, categoryId: string, title: string);
+    setDescription(description: string): this;
+    setWidth(width: 20 | 33 | 50 | 100): this;
+    addField(field: DashboardField): this;
+    addAction(id: string, label: string, options?: {
+        variant?: "primary" | "danger" | "default";
+        collectFields?: boolean;
+    }, handler?: DashboardAction["handler"]): this;
+}
+declare class PanelBuilder {
+    id: string;
+    title: string;
+    data: any;
+    constructor(id: string, title: string);
+    setDescription(description: string): this;
+    addField(field: DashboardField): this;
+    addAction(id: string, label: string, options?: {
+        variant?: "primary" | "danger" | "default";
+        collectFields?: boolean;
+    }, handler?: DashboardAction["handler"]): this;
+}
+declare class PluginBuilder {
+    id: string;
+    name: string;
+    data: any;
+    constructor(id: string, name: string);
+    setDescription(description: string): this;
+    addPanel(panel: PanelBuilder): this;
 }
 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;
+    private config;
+    private categories;
+    private sections;
+    private plugins;
+    private overviewCards;
+    constructor(dashboardName?: string);
+    setLayout(template: DashboardOptions["uiTemplate"]): this;
+    setTheme(theme: DashboardOptions["uiTheme"]): this;
+    setColors(colors: DashboardDesignConfig): this;
+    setCustomCss(css: string): this;
+    registerCustomLayout(name: string, renderer: DashboardTemplateRenderer): this;
+    addOverviewCard(title: string, value: string, subtitle?: string): this;
+    addCategory(category: CategoryBuilder): this;
+    addSection(section: SectionBuilder): this;
+    addPlugin(plugin: PluginBuilder): this;
+    build(): Partial<DashboardOptions>;
+}
+
+declare function createExpressAdapter(options: DashboardOptions): {
+    app: express.Express;
+    engine: DashboardEngine;
+};
 
-declare function createDiscordHelpers(botToken: string): DashboardDiscordHelpers;
+declare function createElysiaAdapter(options: DashboardOptions): {
+    app: Elysia<"", {
+        decorator: {};
+        store: {};
+        derive: {};
+        resolve: {};
+    }, {
+        typebox: {};
+        error: {};
+    }, {
+        schema: {};
+        standaloneSchema: {};
+        macro: {};
+        macroFn: {};
+        parser: {};
+        response: {};
+    }, {}, {
+        derive: {};
+        resolve: {};
+        schema: {};
+        standaloneSchema: {};
+        response: {};
+    }, {
+        derive: {};
+        resolve: {};
+        schema: {};
+        standaloneSchema: {};
+        response: {};
+    }>;
+    engine: DashboardEngine;
+};
 
-declare const builtinTemplateRenderers: Record<string, DashboardTemplateRenderer>;
-declare function getBuiltinTemplateRenderer(templateId: string): DashboardTemplateRenderer | undefined;
+declare function createFastifyAdapter(fastify: FastifyInstance, options: DashboardOptions): {
+    engine: DashboardEngine;
+};
 
-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 };
+export { type CardIntent, type DashboardAction, type DashboardBoxWidth, type DashboardCard, type DashboardCategory, type DashboardContext, type DashboardData, type DashboardDesignConfig, DashboardDesigner, type DashboardDiscordHelpers, DashboardEngine, type DashboardField, type DashboardGuild, type DashboardHomeBuilder, type DashboardInstance, type DashboardOptions, type DashboardOverviewCard, type DashboardPanel, type DashboardPlugin, type DashboardPluginData, type DashboardScope, type DashboardSection, 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, type SessionData, SessionSchema, createElysiaAdapter, createExpressAdapter, createFastifyAdapter };