@malto/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,202 @@
+type SdkMode = "bubble" | "modal" | "inline" | "trigger";
+type SdkPosition = "bottom-right" | "bottom-left" | "top-right" | "top-left";
+type SdkFeature = "submit" | "vote" | "list" | "comment" | "roadmap" | "changelog";
+type IdentifyPayload = {
+    externalUserId: string;
+    email: string;
+    name?: string;
+    hash: string;
+};
+type MaltoConfig = {
+    apiKey: string;
+    apiUrl?: string;
+    mode?: SdkMode;
+    position?: SdkPosition;
+    triggerLabel?: string;
+    primaryColor?: string;
+    /** Override CSS variables exposed by the widget. Keys are CSS custom property names without leading `--`. */
+    cssVars?: Partial<MaltoCssVars>;
+    /**
+     * Raw CSS injected after the base stylesheet. Wins over base styles except
+     * !important rules.
+     *
+     * **Security**: this string is rendered into the DOM via a <style> element.
+     * Treat it as code, not data. The SDK strips obvious break-out patterns
+     * (</style>, </script>, expression(), javascript:) but cannot prevent every
+     * CSS-based exfiltration vector. Never pass user-supplied CSS.
+     */
+    customCss?: string;
+    /** Border radius scale: "sm" 8px, "md" 14px (default), "lg" 22px. */
+    radius?: "sm" | "md" | "lg";
+    /** Color scheme. "auto" follows OS preference. */
+    appearance?: "light" | "dark" | "auto";
+    zIndex?: number;
+    views?: SdkFeature[];
+    identify?: IdentifyPayload;
+    target?: string | HTMLElement;
+    onReady?: () => void;
+    onError?: (err: Error) => void;
+};
+type MaltoCssVars = {
+    primary: string;
+    primaryContrast: string;
+    surface: string;
+    surfaceMuted: string;
+    border: string;
+    text: string;
+    textMuted: string;
+    radius: string;
+    shadow: string;
+    font: string;
+};
+type BoardInfo = {
+    slug: string | null;
+    companyName: string | null;
+    companyLogoUrl: string | null;
+    boardName: string | null;
+    boardDescription: string | null;
+    boardThemeColor: string | null;
+};
+type WidgetSettings = {
+    enabledFeatures: SdkFeature[];
+    defaultMode: SdkMode;
+    position: SdkPosition;
+    primaryColor: string | null;
+    triggerLabel: string | null;
+    requireIdentity: boolean;
+};
+type BoardResponse = {
+    board: BoardInfo;
+    widget: WidgetSettings;
+};
+type FeedbackItem = {
+    id: string;
+    title: string;
+    description: string | null;
+    status: string;
+    votes: number;
+    createdAt: string;
+    hasVoted?: boolean;
+};
+type CommentItem = {
+    id: string;
+    body: string;
+    createdAt: string;
+    author: {
+        id: string;
+        name: string;
+        avatarUrl: string | null;
+    };
+    likes: number;
+    hasLiked: boolean;
+};
+type SessionResponse = {
+    sessionToken: string;
+    expiresAt: string;
+    user: {
+        email: string;
+        name: string | null;
+    };
+};
+type ReleaseItem = {
+    id: string;
+    title: string;
+    body: string;
+    category: string;
+    publishedAt: string | null;
+};
+
+type ClientOptions = {
+    apiKey: string;
+    apiUrl?: string;
+    getSessionToken: () => string | null;
+};
+declare class MaltoClient {
+    private readonly apiKey;
+    private readonly apiUrl;
+    private readonly getSessionToken;
+    constructor(opts: ClientOptions);
+    private request;
+    board(): Promise<BoardResponse>;
+    listFeedbacks(): Promise<FeedbackItem[]>;
+    feedback(id: string): Promise<FeedbackItem>;
+    createFeedback(input: {
+        title: string;
+        description?: string;
+        category?: string;
+    }): Promise<FeedbackItem>;
+    vote(id: string): Promise<{
+        voted: boolean;
+        votes: number;
+    }>;
+    comments(id: string): Promise<CommentItem[]>;
+    addComment(id: string, body: string, parentId?: string): Promise<CommentItem>;
+    roadmap(): Promise<Record<string, FeedbackItem[]>>;
+    releases(): Promise<ReleaseItem[]>;
+    startMagicLink(input: {
+        email: string;
+        name?: string;
+        returnUrl?: string;
+    }): Promise<{
+        ok: true;
+    }>;
+    verifyMagicLink(token: string): Promise<SessionResponse>;
+    identify(payload: IdentifyPayload): Promise<SessionResponse>;
+}
+declare class MaltoApiError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}
+
+declare class MaltoWidget {
+    private readonly config;
+    private readonly client;
+    private readonly apiKeyPrefix;
+    private resolvedMode;
+    private root;
+    private container;
+    private trigger;
+    private board;
+    private state;
+    constructor(config: MaltoConfig);
+    mount(): Promise<void>;
+    unmount(): void;
+    open(): void;
+    close(): void;
+    setIdentify(identify: IdentifyPayload | null): void;
+    private runIdentify;
+    private renderHost;
+    private buildBubble;
+    private resolveTarget;
+    private render;
+    private buildPanelBody;
+    private buildHeader;
+    private buildTabs;
+    private tabBtn;
+    private go;
+    private allowedViews;
+    private buildView;
+    private viewList;
+    private feedbackRow;
+    private viewSubmit;
+    private viewAuth;
+    private viewRoadmap;
+    private viewChangelog;
+    private viewDetail;
+    private skeletonList;
+    private emptyState;
+    private loadFeedbacks;
+    private loadRoadmap;
+    private loadReleases;
+    private loadComments;
+    private handleVote;
+}
+
+declare function init(config: MaltoConfig): MaltoWidget;
+declare function open(): void;
+declare function close(): void;
+declare function identify(payload: IdentifyPayload): void;
+declare function reset(apiKey: string): void;
+declare function destroy(): void;
+
+export { type BoardInfo, type BoardResponse, type CommentItem, type FeedbackItem, type IdentifyPayload, MaltoApiError, MaltoClient, type MaltoConfig, type MaltoCssVars, MaltoWidget, type ReleaseItem, type SdkFeature, type SdkMode, type SdkPosition, type SessionResponse, type WidgetSettings, close, destroy, identify, init, open, reset };

package/dist/index.d.ts

@@ -0,0 +1,202 @@
+type SdkMode = "bubble" | "modal" | "inline" | "trigger";
+type SdkPosition = "bottom-right" | "bottom-left" | "top-right" | "top-left";
+type SdkFeature = "submit" | "vote" | "list" | "comment" | "roadmap" | "changelog";
+type IdentifyPayload = {
+    externalUserId: string;
+    email: string;
+    name?: string;
+    hash: string;
+};
+type MaltoConfig = {
+    apiKey: string;
+    apiUrl?: string;
+    mode?: SdkMode;
+    position?: SdkPosition;
+    triggerLabel?: string;
+    primaryColor?: string;
+    /** Override CSS variables exposed by the widget. Keys are CSS custom property names without leading `--`. */
+    cssVars?: Partial<MaltoCssVars>;
+    /**
+     * Raw CSS injected after the base stylesheet. Wins over base styles except
+     * !important rules.
+     *
+     * **Security**: this string is rendered into the DOM via a <style> element.
+     * Treat it as code, not data. The SDK strips obvious break-out patterns
+     * (</style>, </script>, expression(), javascript:) but cannot prevent every
+     * CSS-based exfiltration vector. Never pass user-supplied CSS.
+     */
+    customCss?: string;
+    /** Border radius scale: "sm" 8px, "md" 14px (default), "lg" 22px. */
+    radius?: "sm" | "md" | "lg";
+    /** Color scheme. "auto" follows OS preference. */
+    appearance?: "light" | "dark" | "auto";
+    zIndex?: number;
+    views?: SdkFeature[];
+    identify?: IdentifyPayload;
+    target?: string | HTMLElement;
+    onReady?: () => void;
+    onError?: (err: Error) => void;
+};
+type MaltoCssVars = {
+    primary: string;
+    primaryContrast: string;
+    surface: string;
+    surfaceMuted: string;
+    border: string;
+    text: string;
+    textMuted: string;
+    radius: string;
+    shadow: string;
+    font: string;
+};
+type BoardInfo = {
+    slug: string | null;
+    companyName: string | null;
+    companyLogoUrl: string | null;
+    boardName: string | null;
+    boardDescription: string | null;
+    boardThemeColor: string | null;
+};
+type WidgetSettings = {
+    enabledFeatures: SdkFeature[];
+    defaultMode: SdkMode;
+    position: SdkPosition;
+    primaryColor: string | null;
+    triggerLabel: string | null;
+    requireIdentity: boolean;
+};
+type BoardResponse = {
+    board: BoardInfo;
+    widget: WidgetSettings;
+};
+type FeedbackItem = {
+    id: string;
+    title: string;
+    description: string | null;
+    status: string;
+    votes: number;
+    createdAt: string;
+    hasVoted?: boolean;
+};
+type CommentItem = {
+    id: string;
+    body: string;
+    createdAt: string;
+    author: {
+        id: string;
+        name: string;
+        avatarUrl: string | null;
+    };
+    likes: number;
+    hasLiked: boolean;
+};
+type SessionResponse = {
+    sessionToken: string;
+    expiresAt: string;
+    user: {
+        email: string;
+        name: string | null;
+    };
+};
+type ReleaseItem = {
+    id: string;
+    title: string;
+    body: string;
+    category: string;
+    publishedAt: string | null;
+};
+
+type ClientOptions = {
+    apiKey: string;
+    apiUrl?: string;
+    getSessionToken: () => string | null;
+};
+declare class MaltoClient {
+    private readonly apiKey;
+    private readonly apiUrl;
+    private readonly getSessionToken;
+    constructor(opts: ClientOptions);
+    private request;
+    board(): Promise<BoardResponse>;
+    listFeedbacks(): Promise<FeedbackItem[]>;
+    feedback(id: string): Promise<FeedbackItem>;
+    createFeedback(input: {
+        title: string;
+        description?: string;
+        category?: string;
+    }): Promise<FeedbackItem>;
+    vote(id: string): Promise<{
+        voted: boolean;
+        votes: number;
+    }>;
+    comments(id: string): Promise<CommentItem[]>;
+    addComment(id: string, body: string, parentId?: string): Promise<CommentItem>;
+    roadmap(): Promise<Record<string, FeedbackItem[]>>;
+    releases(): Promise<ReleaseItem[]>;
+    startMagicLink(input: {
+        email: string;
+        name?: string;
+        returnUrl?: string;
+    }): Promise<{
+        ok: true;
+    }>;
+    verifyMagicLink(token: string): Promise<SessionResponse>;
+    identify(payload: IdentifyPayload): Promise<SessionResponse>;
+}
+declare class MaltoApiError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}
+
+declare class MaltoWidget {
+    private readonly config;
+    private readonly client;
+    private readonly apiKeyPrefix;
+    private resolvedMode;
+    private root;
+    private container;
+    private trigger;
+    private board;
+    private state;
+    constructor(config: MaltoConfig);
+    mount(): Promise<void>;
+    unmount(): void;
+    open(): void;
+    close(): void;
+    setIdentify(identify: IdentifyPayload | null): void;
+    private runIdentify;
+    private renderHost;
+    private buildBubble;
+    private resolveTarget;
+    private render;
+    private buildPanelBody;
+    private buildHeader;
+    private buildTabs;
+    private tabBtn;
+    private go;
+    private allowedViews;
+    private buildView;
+    private viewList;
+    private feedbackRow;
+    private viewSubmit;
+    private viewAuth;
+    private viewRoadmap;
+    private viewChangelog;
+    private viewDetail;
+    private skeletonList;
+    private emptyState;
+    private loadFeedbacks;
+    private loadRoadmap;
+    private loadReleases;
+    private loadComments;
+    private handleVote;
+}
+
+declare function init(config: MaltoConfig): MaltoWidget;
+declare function open(): void;
+declare function close(): void;
+declare function identify(payload: IdentifyPayload): void;
+declare function reset(apiKey: string): void;
+declare function destroy(): void;
+
+export { type BoardInfo, type BoardResponse, type CommentItem, type FeedbackItem, type IdentifyPayload, MaltoApiError, MaltoClient, type MaltoConfig, type MaltoCssVars, MaltoWidget, type ReleaseItem, type SdkFeature, type SdkMode, type SdkPosition, type SessionResponse, type WidgetSettings, close, destroy, identify, init, open, reset };