@appgram/react 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,399 @@
+import React from 'react';
+import { W as WishFilters, a as WishesResponse, b as Wish, C as CommentsResponse, c as Comment, R as RoadmapData, d as Release, e as ReleaseFeature, H as HelpCollection, f as HelpFlow, g as HelpArticle, S as SupportRequestInput, h as SupportRequest } from './useVote-CLhkwtLT.js';
+export { A as ArticleType, i as Category, j as CommentAuthor, k as CommentCreateInput, F as FlowDisplayType, l as HelpArticlesResponse, m as HelpCenterData, n as ReleasesResponse, o as Roadmap, p as RoadmapColumnType, q as RoadmapItem, r as RoadmapVisibility, s as SupportAttachment, t as SupportMessage, u as SupportRequestCategory, v as SupportRequestPriority, w as SupportRequestStatus, x as SupportRequestsResponse, U as UseVoteOptions, y as UseVoteResult, z as WishAuthor, B as WishPriority, D as WishStatus, E as useVote } from './useVote-CLhkwtLT.js';
+export { UseCommentsOptions, UseCommentsResult, UseHelpArticleOptions, UseHelpArticleResult, UseHelpCenterOptions, UseHelpCenterResult, UseHelpFlowOptions, UseHelpFlowResult, UseReleaseOptions, UseReleaseResult, UseReleasesOptions, UseReleasesResult, UseRoadmapOptions, UseRoadmapResult, UseSupportOptions, UseSupportResult, UseWishOptions, UseWishResult, UseWishesOptions, UseWishesResult, useComments, useHelpArticle, useHelpCenter, useHelpFlow, useRelease, useReleases, useRoadmap, useSupport, useWish, useWishes } from './hooks/index.js';
+export { ComponentStatus, HelpArticleDetail, HelpArticleDetailProps, HelpArticles, HelpArticlesProps, HelpCenter, HelpCenterProps, HelpCollections, HelpCollectionsProps, IncidentImpact, IncidentStatus, IncidentUpdate, OverallStatus, QuickAction, ReleaseCard, ReleaseCardProps, ReleaseDetail, ReleaseDetailProps, ReleaseList, ReleaseListProps, Releases, ReleasesProps, RoadmapBoard, RoadmapBoardProps, RoadmapColumn, RoadmapColumnProps, StatusBoard, StatusBoardProps, StatusComponent, StatusData, StatusIncident, StatusIncidentDetail, StatusIncidentDetailProps, SubmitWishForm, SubmitWishFormProps, SupportForm, SupportFormProps, VoteButton, VoteButtonProps, WhatsNewPopup, WhatsNewPopupProps, WishCard, WishCardProps, WishDetail, WishDetailProps, WishList, WishListProps } from './components/index.js';
+import { ClassValue } from 'clsx';
+
+/**
+ * Vote Types
+ */
+interface Vote {
+    id: string;
+    wish_id: string;
+    user_id?: string | null;
+    voter_email?: string | null;
+    fingerprint: string;
+    created_at: string;
+}
+interface VoteCheckResponse {
+    has_voted: boolean;
+    vote_id?: string;
+}
+interface VoteCreateInput {
+    wish_id: string;
+    fingerprint: string;
+    voter_email?: string;
+}
+interface VoteState {
+    hasVoted: boolean;
+    voteId?: string;
+    voteCount: number;
+    isLoading: boolean;
+    error?: string | null;
+}
+
+/**
+ * Customization & Theme Types
+ */
+interface CustomColors {
+    primary: string;
+    secondary: string;
+    accent: string;
+    background: string;
+    text: string;
+    cardBackground?: string;
+    cardText?: string;
+    navbarBackground?: string;
+    navbarText?: string;
+}
+interface CustomTypography {
+    fontFamily?: string;
+    fontSizes?: {
+        h1: number;
+        h2: number;
+        h3: number;
+        h4: number;
+        body: number;
+        small: number;
+    };
+}
+/**
+ * Theme mode - 'light', 'dark', or 'system' (follows OS preference)
+ */
+type ThemeMode = 'light' | 'dark' | 'system';
+interface AppgramTheme {
+    /**
+     * Theme mode - 'light', 'dark', or 'system' (default: 'system')
+     */
+    mode?: ThemeMode;
+    /**
+     * Light mode colors (used when mode is 'light' or system is light)
+     */
+    colors?: Partial<CustomColors>;
+    /**
+     * Dark mode colors (used when mode is 'dark' or system is dark)
+     * If not provided, will auto-generate from light colors
+     */
+    darkColors?: Partial<CustomColors>;
+    typography?: Partial<CustomTypography>;
+    borderRadius?: number;
+}
+interface LayoutConfig {
+    borderRadius?: number;
+    cardStyle?: {
+        color?: string;
+        textColor?: string;
+        shadow?: 'none' | 'sm' | 'md' | 'lg';
+    };
+}
+
+/**
+ * Type Exports
+ */
+
+/**
+ * API Response wrapper
+ */
+interface ApiResponse<T> {
+    success: boolean;
+    data?: T;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+/**
+ * Paginated response wrapper
+ */
+interface PaginatedResponse<T> {
+    data: T[];
+    total: number;
+    page: number;
+    per_page: number;
+    total_pages: number;
+}
+
+/**
+ * AppgramClient
+ *
+ * API client for Appgram portal/public endpoints.
+ * Adapted from the main app's api.ts for use in the SDK.
+ */
+
+interface AppgramClientConfig {
+    baseUrl: string;
+    projectId: string;
+    orgSlug?: string;
+    projectSlug?: string;
+}
+declare class AppgramClient {
+    private baseUrl;
+    private projectId;
+    private orgSlug?;
+    private projectSlug?;
+    constructor(config: AppgramClientConfig);
+    private request;
+    private get;
+    /**
+     * Raw request that returns the API response as-is without transformation
+     */
+    private requestRaw;
+    private post;
+    private delete;
+    /**
+     * Get public wishes for the project
+     */
+    getPublicWishes(filters?: WishFilters): Promise<ApiResponse<WishesResponse>>;
+    /**
+     * Get a single wish by ID
+     */
+    getWish(wishId: string): Promise<ApiResponse<Wish>>;
+    /**
+     * Create a new wish (feature request)
+     */
+    createWish(data: {
+        title: string;
+        description: string;
+        author_email?: string;
+        author_name?: string;
+        category_id?: string;
+    }): Promise<ApiResponse<Wish>>;
+    /**
+     * Check if a fingerprint has voted on a wish
+     */
+    checkVote(wishId: string, fingerprint: string): Promise<ApiResponse<VoteCheckResponse>>;
+    /**
+     * Create a vote
+     */
+    createVote(wishId: string, fingerprint: string, voterEmail?: string): Promise<ApiResponse<{
+        id: string;
+        wish_id: string;
+    }>>;
+    /**
+     * Delete a vote
+     */
+    deleteVote(voteId: string): Promise<ApiResponse<{
+        success: boolean;
+    }>>;
+    /**
+     * Get comments for a wish
+     */
+    getComments(wishId: string, options?: {
+        page?: number;
+        per_page?: number;
+    }): Promise<ApiResponse<CommentsResponse>>;
+    /**
+     * Create a comment
+     */
+    createComment(data: {
+        wish_id: string;
+        content: string;
+        author_name?: string;
+        author_email?: string;
+        parent_id?: string;
+    }): Promise<ApiResponse<Comment>>;
+    /**
+     * Get roadmap data for the project
+     */
+    getRoadmapData(): Promise<ApiResponse<RoadmapData>>;
+    /**
+     * Get public releases for the project
+     */
+    getReleases(options?: {
+        limit?: number;
+    }): Promise<ApiResponse<Release[]>>;
+    /**
+     * Get a single release by slug
+     */
+    getRelease(releaseSlug: string): Promise<ApiResponse<Release>>;
+    /**
+     * Get features for a release (public endpoint)
+     */
+    getReleaseFeatures(releaseSlug: string): Promise<ApiResponse<ReleaseFeature[]>>;
+    /**
+     * Get help center collection for the project
+     */
+    getHelpCollection(): Promise<ApiResponse<{
+        collection: HelpCollection | null;
+        flows: HelpFlow[];
+    }>>;
+    /**
+     * Get a help flow by slug
+     */
+    getHelpFlow(slug: string): Promise<ApiResponse<HelpFlow>>;
+    /**
+     * Get a help article by slug
+     */
+    getHelpArticle(slug: string, flowId: string): Promise<ApiResponse<HelpArticle>>;
+    /**
+     * Upload a file via public portal (no auth required)
+     */
+    uploadFile(file: File): Promise<ApiResponse<{
+        url: string;
+        name: string;
+        size: number;
+        mime_type?: string;
+    }>>;
+    /**
+     * Submit a support request
+     */
+    submitSupportRequest(data: SupportRequestInput): Promise<ApiResponse<SupportRequest>>;
+    /**
+     * Request a magic link to access support tickets
+     */
+    sendSupportMagicLink(userEmail: string): Promise<ApiResponse<{
+        success: boolean;
+        message: string;
+    }>>;
+    /**
+     * Verify magic link token and get user's support tickets
+     */
+    verifySupportToken(token: string): Promise<ApiResponse<{
+        tickets: SupportRequest[];
+        user_email: string;
+    }>>;
+    /**
+     * Get a specific support ticket using magic link token
+     */
+    getSupportTicket(ticketId: string, token: string): Promise<ApiResponse<SupportRequest>>;
+    /**
+     * Add a message to a support ticket
+     */
+    addSupportMessage(ticketId: string, token: string, content: string): Promise<ApiResponse<{
+        id: string;
+        content: string;
+        created_at: string;
+    }>>;
+    /**
+     * Get all public page data in one request
+     */
+    getPageData(): Promise<ApiResponse<{
+        project?: unknown;
+        customization_data?: unknown;
+        wishes?: Wish[];
+        total_wishes?: number;
+        categories?: unknown[];
+    }>>;
+}
+
+interface AppgramConfig {
+    /**
+     * Your Appgram project ID
+     */
+    projectId: string;
+    /**
+     * Organization slug (used for public URLs)
+     */
+    orgSlug?: string;
+    /**
+     * Project slug (used for public URLs)
+     */
+    projectSlug?: string;
+    /**
+     * Optional API URL override (defaults to https://api.appgram.dev)
+     */
+    apiUrl?: string;
+    /**
+     * Enable browser fingerprinting for anonymous voting
+     * @default true
+     */
+    enableFingerprinting?: boolean;
+    /**
+     * Theme customization
+     */
+    theme?: AppgramTheme;
+}
+interface AppgramContextValue {
+    /**
+     * The Appgram configuration
+     */
+    config: Required<Pick<AppgramConfig, 'projectId'>> & AppgramConfig;
+    /**
+     * The API client instance
+     */
+    client: AppgramClient;
+    /**
+     * Browser fingerprint for anonymous voting
+     */
+    fingerprint: string | null;
+    /**
+     * Theme values
+     */
+    theme: AppgramTheme;
+}
+/**
+ * Hook to access the Appgram context
+ * @throws Error if used outside of AppgramProvider
+ */
+declare function useAppgramContext(): AppgramContextValue;
+
+/**
+ * AppgramProvider
+ *
+ * Root provider component that manages configuration, API client, and theming.
+ */
+
+interface AppgramProviderProps {
+    /**
+     * Appgram configuration
+     */
+    config: AppgramConfig;
+    /**
+     * Child components
+     */
+    children: React.ReactNode;
+}
+/**
+ * AppgramProvider - Root provider for Appgram React SDK
+ *
+ * Supports automatic dark/light theme based on system preference.
+ *
+ * @example
+ * ```tsx
+ * <AppgramProvider
+ *   config={{
+ *     projectId: 'proj_xxx',
+ *     orgSlug: 'acme',
+ *     projectSlug: 'feedback',
+ *     theme: {
+ *       mode: 'system', // 'light' | 'dark' | 'system' (default: 'system')
+ *       colors: { primary: '#0EA5E9' }, // Light mode colors
+ *       darkColors: { primary: '#38BDF8' }, // Dark mode colors (optional)
+ *     }
+ *   }}
+ * >
+ *   <App />
+ * </AppgramProvider>
+ * ```
+ */
+declare function AppgramProvider({ config, children, }: AppgramProviderProps): React.ReactElement;
+
+/**
+ * Utility for merging Tailwind CSS classes
+ */
+
+/**
+ * Merges Tailwind CSS classes with proper precedence handling
+ * @param inputs - Class values to merge
+ * @returns Merged class string
+ */
+declare function cn(...inputs: ClassValue[]): string;
+
+/**
+ * Browser Fingerprint Utility
+ *
+ * Generates a unique fingerprint for anonymous voting.
+ * Uses a combination of browser/device characteristics.
+ */
+/**
+ * Get or create a fingerprint for the current browser/device
+ * @returns The fingerprint string
+ */
+declare function getFingerprint(): string;
+/**
+ * Reset the stored fingerprint (for testing purposes)
+ */
+declare function resetFingerprint(): void;
+
+export { type ApiResponse, AppgramClient, type AppgramClientConfig, type AppgramConfig, type AppgramContextValue, AppgramProvider, type AppgramProviderProps, type AppgramTheme, Comment, CommentsResponse, type CustomColors, type CustomTypography, HelpArticle, HelpCollection, HelpFlow, type LayoutConfig, type PaginatedResponse, Release, ReleaseFeature, RoadmapData, SupportRequest, SupportRequestInput, type ThemeMode, type Vote, type VoteCheckResponse, type VoteCreateInput, type VoteState, Wish, WishFilters, WishesResponse, cn, getFingerprint, resetFingerprint, useAppgramContext };