reflet-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,290 @@
+/**
+ * Reflet SDK Types
+ */
+interface RefletConfig {
+    /** Your board's public API key (fb_pub_xxx) */
+    publicKey: string;
+    /** API base URL (defaults to https://api.reflet.app) */
+    baseUrl?: string;
+    /** User identification for SSO */
+    user?: RefletUser;
+    /** Pre-signed user token (alternative to user object) */
+    userToken?: string;
+}
+interface RefletUser {
+    /** Unique identifier for the user in your system */
+    id: string;
+    /** User's email address */
+    email?: string;
+    /** User's display name */
+    name?: string;
+    /** URL to user's avatar image */
+    avatar?: string;
+    /** Additional metadata */
+    metadata?: Record<string, unknown>;
+}
+interface BoardConfig {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    isPublic: boolean;
+    settings?: BoardSettings;
+    organization: {
+        id: string;
+        name: string;
+        slug: string;
+        logo?: string;
+        primaryColor?: string;
+    };
+    statuses: BoardStatus[];
+}
+interface BoardSettings {
+    allowAnonymousVoting?: boolean;
+    requireApproval?: boolean;
+    defaultStatus?: FeedbackStatus;
+}
+interface BoardStatus {
+    id: string;
+    name: string;
+    color: string;
+    icon?: string;
+    order: number;
+}
+type FeedbackStatus = "open" | "under_review" | "planned" | "in_progress" | "completed" | "closed";
+interface FeedbackItem {
+    id: string;
+    title: string;
+    description: string;
+    status: FeedbackStatus;
+    voteCount: number;
+    commentCount: number;
+    isPinned: boolean;
+    hasVoted: boolean;
+    createdAt: number;
+    updatedAt: number;
+    completedAt?: number;
+    tags: FeedbackTag[];
+    boardStatus: {
+        id: string;
+        name: string;
+        color: string;
+    } | null;
+    author: FeedbackAuthor | null;
+}
+interface FeedbackDetail extends FeedbackItem {
+    isSubscribed: boolean;
+}
+interface FeedbackTag {
+    id: string;
+    name: string;
+    color: string;
+}
+interface FeedbackAuthor {
+    name?: string;
+    email?: string;
+    avatar?: string;
+    isExternal: boolean;
+}
+interface FeedbackListResponse {
+    items: FeedbackItem[];
+    total: number;
+    hasMore: boolean;
+}
+interface FeedbackListParams {
+    /** Filter by custom status ID */
+    statusId?: string;
+    /** Filter by status name */
+    status?: FeedbackStatus;
+    /** Search in title and description */
+    search?: string;
+    /** Sort order */
+    sortBy?: "votes" | "newest" | "oldest" | "comments";
+    /** Number of items to return (max 100) */
+    limit?: number;
+    /** Offset for pagination */
+    offset?: number;
+}
+interface CreateFeedbackParams {
+    title: string;
+    description: string;
+}
+interface CreateFeedbackResponse {
+    feedbackId: string;
+    isApproved: boolean;
+}
+interface VoteResponse {
+    voted: boolean;
+    voteCount: number;
+}
+interface Comment {
+    id: string;
+    body: string;
+    isOfficial: boolean;
+    author: FeedbackAuthor | null;
+    replies: CommentReply[];
+    createdAt: number;
+    updatedAt: number;
+}
+interface CommentReply {
+    id: string;
+    body: string;
+    isOfficial: boolean;
+    author: FeedbackAuthor | null;
+    createdAt: number;
+    updatedAt: number;
+}
+interface AddCommentParams {
+    feedbackId: string;
+    body: string;
+    parentId?: string;
+}
+interface AddCommentResponse {
+    commentId: string;
+}
+interface SubscribeResponse {
+    subscribed: boolean;
+    alreadySubscribed?: boolean;
+}
+interface UnsubscribeResponse {
+    unsubscribed: boolean;
+    wasNotSubscribed?: boolean;
+}
+interface Roadmap {
+    lanes: RoadmapLane[];
+}
+interface RoadmapLane {
+    id: string;
+    name: string;
+    color: string;
+    items: RoadmapItem[];
+}
+interface RoadmapItem {
+    id: string;
+    title: string;
+    status: FeedbackStatus;
+    voteCount: number;
+}
+interface ChangelogEntry {
+    id: string;
+    title: string;
+    description?: string;
+    version?: string;
+    publishedAt?: number;
+    feedback: {
+        id: string;
+        title: string;
+    }[];
+}
+declare class RefletError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    constructor(message: string, status: number, code?: string);
+}
+declare class RefletAuthError extends RefletError {
+    constructor(message: string);
+}
+declare class RefletValidationError extends RefletError {
+    constructor(message: string);
+}
+declare class RefletNotFoundError extends RefletError {
+    constructor(message: string);
+}
+
+/**
+ * Reflet SDK Client
+ *
+ * @example
+ * ```ts
+ * import { Reflet } from '@reflet/sdk';
+ *
+ * const reflet = new Reflet({
+ *   publicKey: 'fb_pub_xxx',
+ *   user: { id: 'user_123', email: 'user@example.com', name: 'John' }
+ * });
+ *
+ * // List feedback
+ * const { items } = await reflet.list({ status: 'open' });
+ *
+ * // Vote on feedback
+ * await reflet.vote('feedback_id');
+ *
+ * // Submit new feedback
+ * await reflet.create({ title: 'Great idea', description: 'Details...' });
+ * ```
+ */
+declare class Reflet {
+    private readonly publicKey;
+    private readonly baseUrl;
+    private userToken;
+    private user;
+    constructor(config: RefletConfig);
+    /**
+     * Update the user identification
+     */
+    setUser(user: RefletUser | undefined): void;
+    /**
+     * Set the user token directly (for server-signed tokens)
+     */
+    setUserToken(token: string | undefined): void;
+    /**
+     * Get the board configuration
+     */
+    getConfig(): Promise<BoardConfig>;
+    /**
+     * List feedback items with optional filtering
+     */
+    list(params?: FeedbackListParams): Promise<FeedbackListResponse>;
+    /**
+     * Get a single feedback item by ID
+     */
+    get(feedbackId: string): Promise<FeedbackDetail>;
+    /**
+     * Create new feedback
+     * Requires user identification
+     */
+    create(params: CreateFeedbackParams): Promise<CreateFeedbackResponse>;
+    /**
+     * Toggle vote on feedback
+     * Requires user identification
+     */
+    vote(feedbackId: string, type?: "upvote" | "downvote"): Promise<VoteResponse>;
+    /**
+     * Get comments for a feedback item
+     */
+    getComments(feedbackId: string, sortBy?: "newest" | "oldest"): Promise<Comment[]>;
+    /**
+     * Add a comment to feedback
+     * Requires user identification
+     */
+    comment(params: AddCommentParams): Promise<AddCommentResponse>;
+    /**
+     * Subscribe to feedback updates
+     * Requires user identification
+     */
+    subscribe(feedbackId: string): Promise<SubscribeResponse>;
+    /**
+     * Unsubscribe from feedback updates
+     * Requires user identification
+     */
+    unsubscribe(feedbackId: string): Promise<UnsubscribeResponse>;
+    /**
+     * Get roadmap data
+     */
+    getRoadmap(): Promise<Roadmap>;
+    /**
+     * Get changelog entries
+     */
+    getChangelog(limit?: number): Promise<ChangelogEntry[]>;
+    /**
+     * Make an authenticated API request
+     */
+    private request;
+    /**
+     * Generate a simple user token for client-side use
+     * Note: For production, use server-side token signing
+     */
+    private generateUserToken;
+}
+
+export { type AddCommentParams, type AddCommentResponse, type BoardConfig, type BoardSettings, type BoardStatus, type ChangelogEntry, type Comment, type CommentReply, type CreateFeedbackParams, type CreateFeedbackResponse, type FeedbackAuthor, type FeedbackDetail, type FeedbackItem, type FeedbackListParams, type FeedbackListResponse, type FeedbackStatus, type FeedbackTag, Reflet, RefletAuthError, type RefletConfig, RefletError, RefletNotFoundError, type RefletUser, RefletValidationError, type Roadmap, type RoadmapItem, type RoadmapLane, type SubscribeResponse, type UnsubscribeResponse, type VoteResponse };

package/dist/index.js

@@ -0,0 +1,3 @@
+export { Reflet, RefletAuthError, RefletError, RefletNotFoundError, RefletValidationError } from './chunk-RDQP4VCA.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/dist/react.d.ts

@@ -0,0 +1,158 @@
+import { RefletUser, Reflet, FeedbackListParams, AddCommentParams, BoardConfig, ChangelogEntry, Comment, CreateFeedbackParams, FeedbackDetail, FeedbackItem, Roadmap } from './index.js';
+export { FeedbackStatus, FeedbackTag, RefletConfig, RoadmapItem, RoadmapLane } from './index.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+interface RefletContextValue {
+    client: Reflet;
+    isReady: boolean;
+    user: RefletUser | undefined;
+    setUser: (user: RefletUser | undefined) => void;
+}
+interface RefletProviderProps {
+    /** Your board's public API key */
+    publicKey: string;
+    /** API base URL (optional) */
+    baseUrl?: string;
+    /** Initial user identification */
+    user?: RefletUser;
+    /** Pre-signed user token (alternative to user) */
+    userToken?: string;
+    /** Children */
+    children: ReactNode;
+}
+/**
+ * Provider component for Reflet SDK
+ *
+ * @example
+ * ```tsx
+ * import { RefletProvider } from '@reflet/sdk/react';
+ *
+ * function App() {
+ *   return (
+ *     <RefletProvider
+ *       publicKey="fb_pub_xxx"
+ *       user={{ id: 'user_123', email: 'user@example.com', name: 'John' }}
+ *     >
+ *       <YourApp />
+ *     </RefletProvider>
+ *   );
+ * }
+ * ```
+ */
+declare function RefletProvider({ publicKey, baseUrl, user: initialUser, userToken, children, }: RefletProviderProps): react_jsx_runtime.JSX.Element;
+declare function useRefletContext(): RefletContextValue;
+declare function useRefletClient(): Reflet;
+
+interface UseQueryResult<T> {
+    data: T | undefined;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => Promise<void>;
+}
+interface UseMutationResult<TData, TVariables> {
+    mutate: (variables: TVariables) => Promise<TData>;
+    isLoading: boolean;
+    error: Error | null;
+    data: TData | undefined;
+    reset: () => void;
+}
+/**
+ * Hook to fetch board configuration
+ */
+declare function useBoardConfig(): UseQueryResult<BoardConfig>;
+interface UseFeedbackListOptions extends FeedbackListParams {
+    /** Auto-fetch on mount */
+    enabled?: boolean;
+}
+/**
+ * Hook to fetch feedback list with filtering
+ *
+ * @example
+ * ```tsx
+ * const { data, isLoading } = useFeedbackList({ status: 'open', sortBy: 'votes' });
+ * ```
+ */
+declare function useFeedbackList(options?: UseFeedbackListOptions): UseQueryResult<{
+    items: FeedbackItem[];
+    total: number;
+    hasMore: boolean;
+}>;
+/**
+ * Hook to fetch a single feedback item
+ *
+ * @example
+ * ```tsx
+ * const { data: feedback, isLoading } = useFeedback('feedback_id');
+ * ```
+ */
+declare function useFeedback(feedbackId: string | undefined): UseQueryResult<FeedbackDetail>;
+/**
+ * Hook to fetch comments for a feedback item
+ */
+declare function useComments(feedbackId: string | undefined, sortBy?: "newest" | "oldest"): UseQueryResult<Comment[]>;
+/**
+ * Hook to fetch roadmap data
+ */
+declare function useRoadmap(): UseQueryResult<Roadmap>;
+/**
+ * Hook to fetch changelog entries
+ */
+declare function useChangelog(limit?: number): UseQueryResult<ChangelogEntry[]>;
+/**
+ * Hook to create new feedback
+ *
+ * @example
+ * ```tsx
+ * const { mutate: createFeedback, isLoading } = useCreateFeedback();
+ *
+ * const handleSubmit = async (data) => {
+ *   const result = await createFeedback(data);
+ *   console.log('Created:', result.feedbackId);
+ * };
+ * ```
+ */
+declare function useCreateFeedback(): UseMutationResult<{
+    feedbackId: string;
+    isApproved: boolean;
+}, CreateFeedbackParams>;
+/**
+ * Hook to vote on feedback
+ *
+ * @example
+ * ```tsx
+ * const { mutate: vote } = useVote();
+ *
+ * <button onClick={() => vote({ feedbackId: 'xxx' })}>
+ *   Vote
+ * </button>
+ * ```
+ */
+declare function useVote(): UseMutationResult<{
+    voted: boolean;
+    voteCount: number;
+}, {
+    feedbackId: string;
+    type?: "upvote" | "downvote";
+}>;
+/**
+ * Hook to add a comment
+ */
+declare function useAddComment(): UseMutationResult<{
+    commentId: string;
+}, AddCommentParams>;
+/**
+ * Hook to subscribe/unsubscribe to feedback
+ */
+declare function useSubscription(): {
+    subscribe: (feedbackId: string) => Promise<{
+        subscribed: boolean;
+    }>;
+    unsubscribe: (feedbackId: string) => Promise<{
+        unsubscribed: boolean;
+    }>;
+    isLoading: boolean;
+    error: Error | null;
+};
+
+export { AddCommentParams, BoardConfig, ChangelogEntry, Comment, CreateFeedbackParams, FeedbackDetail, FeedbackItem, FeedbackListParams, Reflet, RefletProvider, type RefletProviderProps, RefletUser, Roadmap, type UseFeedbackListOptions, useAddComment, useBoardConfig, useChangelog, useComments, useCreateFeedback, useFeedback, useFeedbackList, useRefletClient, useRefletContext, useRoadmap, useSubscription, useVote };