@appgram/react 0.1.1 → 0.1.4

package/dist/index-C_IqzaBU.d.mts

@@ -0,0 +1,917 @@
+import { W as WishFilters, b as Wish, c as Comment, k as CommentCreateInput, r as Roadmap, s as RoadmapColumn, d as Release, g as HelpArticle, H as HelpCollection, f as HelpFlow, h as SupportRequest, S as SupportRequestInput, y as StatusData } from './StatusBoard-DZWI3zGJ.mjs';
+
+/**
+ * Survey Types
+ *
+ * Decision tree surveys for gathering user feedback.
+ */
+/**
+ * Survey Question Types
+ */
+type SurveyQuestionType = 'yes_no' | 'short_answer' | 'paragraph' | 'multiple_choice' | 'checkboxes' | 'rating';
+/**
+ * Survey Node Option
+ */
+interface SurveyNodeOption {
+    value: string;
+    label: string;
+}
+/**
+ * Survey Node Branch
+ *
+ * Conditional branching configuration for decision tree logic.
+ */
+interface SurveyNodeBranch {
+    condition: {
+        type: 'equals' | 'contains' | 'gt' | 'lt' | 'gte' | 'lte';
+        value: string | number | boolean;
+    };
+    next_node_id: string;
+}
+/**
+ * Survey Node
+ *
+ * Individual questions or result nodes in a survey decision tree.
+ */
+interface SurveyNode {
+    id: string;
+    survey_id: string;
+    parent_id: string | null;
+    question: string;
+    question_type: SurveyQuestionType;
+    options?: SurveyNodeOption[];
+    min_rating?: number;
+    max_rating?: number;
+    is_required?: boolean;
+    answer_yes_node_id: string | null;
+    answer_no_node_id: string | null;
+    branches?: SurveyNodeBranch[];
+    next_node_id?: string | null;
+    result_message: string | null;
+    sort_order: number;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Survey
+ */
+interface Survey {
+    id: string;
+    project_id: string;
+    name: string;
+    slug: string;
+    description: string;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+    number_of_questions?: number;
+    number_of_responses?: number;
+    nodes?: SurveyNode[];
+    responses?: SurveyResponse[];
+}
+/**
+ * Survey Response
+ */
+interface SurveyResponse {
+    id: string;
+    survey_id: string;
+    external_user_id: string | null;
+    fingerprint: string;
+    metadata: Record<string, unknown>;
+    created_at: string;
+    answers?: SurveyAnswer[];
+}
+/**
+ * Survey Answer
+ */
+interface SurveyAnswer {
+    id: string;
+    response_id: string;
+    node_id: string;
+    answer?: boolean;
+    answer_text?: string;
+    answer_options?: string[];
+    answer_rating?: number;
+    created_at: string;
+    node?: {
+        id: string;
+        question: string;
+        question_type?: SurveyQuestionType;
+        result_message: string | null;
+    };
+}
+/**
+ * Input for submitting a survey response
+ */
+interface SurveySubmitInput {
+    fingerprint: string;
+    external_user_id?: string;
+    metadata?: Record<string, unknown>;
+    answers: Array<{
+        node_id: string;
+        answer?: boolean;
+        answer_text?: string;
+        answer_options?: string[];
+        answer_rating?: number;
+    }>;
+}
+
+/**
+ * Contact Form Types
+ *
+ * Configurable contact forms for collecting user submissions.
+ */
+type ContactFormFieldType = 'text' | 'email' | 'textarea' | 'select' | 'radio' | 'checkbox';
+interface ContactFormFieldValidation {
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+}
+interface ContactFormField {
+    id: string;
+    type: ContactFormFieldType;
+    label: string;
+    placeholder?: string;
+    required: boolean;
+    options?: string[];
+    validation?: ContactFormFieldValidation;
+}
+interface ContactForm {
+    id: string;
+    name: string;
+    description?: string;
+    fields: ContactFormField[];
+    submitButtonText: string;
+    successMessage: string;
+    emailRecipient: string;
+    emailSubject: string;
+    enabled: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface ContactFormSubmission {
+    id: string;
+    form_id: string;
+    project_id: string;
+    data: Record<string, string | boolean>;
+    submitted_at: string;
+}
+interface ContactFormSubmitInput {
+    data: Record<string, string | boolean>;
+    metadata?: Record<string, unknown>;
+}
+
+/**
+ * Status Page Types
+ *
+ * Types for status page API responses.
+ */
+type StatusType = 'operational' | 'maintenance' | 'degraded_performance' | 'partial_outage' | 'major_outage' | 'incident';
+type StatusState = 'active' | 'resolved';
+interface StatusPage {
+    id: string;
+    project_id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+interface StatusUpdate {
+    id: string;
+    status_page_id: string;
+    title: string;
+    description: string;
+    status_type: StatusType;
+    state: StatusState;
+    is_public: boolean;
+    affected_services: string[];
+    created_at: string;
+    updated_at: string;
+    resolved_at: string | null;
+}
+interface StatusPageService {
+    id: string;
+    status_page_id: string;
+    name: string;
+    description: string | null;
+    group_name: string | null;
+    color: string | null;
+    sort_order: number;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+interface StatusPageOverview {
+    status_page: StatusPage;
+    current_status: StatusType;
+    active_updates: StatusUpdate[];
+    recent_updates: StatusUpdate[];
+    status_breakdown: Record<string, number>;
+    services_status: Record<string, StatusType>;
+    services: StatusPageService[];
+    total_updates: number;
+    active_count: number;
+    resolved_count: number;
+}
+
+/**
+ * useWishes Hook
+ *
+ * Fetches and manages a list of wishes with filtering and pagination.
+ * Provides headless access to the wishes API for custom UI implementations.
+ *
+ * @example
+ * ```tsx
+ * import { useWishes } from '@appgram/react'
+ *
+ * function WishList() {
+ *   const { wishes, isLoading, error, setFilters, refetch } = useWishes({
+ *     filters: { sort_by: 'votes', status: 'pending' },
+ *     refreshInterval: 30000,
+ *   })
+ *
+ *   if (isLoading) return <Spinner />
+ *   if (error) return <Error message={error} onRetry={refetch} />
+ *
+ *   return (
+ *     <ul>
+ *       {wishes.map(wish => (
+ *         <li key={wish.id}>{wish.title}</li>
+ *       ))}
+ *     </ul>
+ *   )
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With search and pagination
+ * function SearchableWishes() {
+ *   const { wishes, isLoading, setFilters, page, totalPages, setPage } = useWishes()
+ *
+ *   const handleSearch = (query: string) => {
+ *     setFilters({ search: query, page: 1 })
+ *   }
+ *
+ *   return (
+ *     <>
+ *       <Search onSearch={handleSearch} />
+ *       <WishGrid wishes={wishes} loading={isLoading} />
+ *       <Pagination
+ *         current={page}
+ *         total={totalPages}
+ *         onChange={setPage}
+ *       />
+ *     </>
+ *   )
+ * }
+ * ```
+ */
+
+interface UseWishesOptions {
+    /**
+     * Initial filters
+     */
+    filters?: WishFilters;
+    /**
+     * Auto-refresh interval in milliseconds (0 to disable)
+     * @default 0
+     */
+    refreshInterval?: number;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseWishesResult {
+    /**
+     * List of wishes
+     */
+    wishes: Wish[];
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Total number of wishes
+     */
+    total: number;
+    /**
+     * Current page
+     */
+    page: number;
+    /**
+     * Total pages
+     */
+    totalPages: number;
+    /**
+     * Update filters
+     */
+    setFilters: (filters: WishFilters) => void;
+    /**
+     * Go to a specific page
+     */
+    setPage: (page: number) => void;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useWishes(options?: UseWishesOptions): UseWishesResult;
+
+/**
+ * useWish Hook
+ *
+ * Fetches and manages a single wish.
+ */
+
+interface UseWishOptions {
+    /**
+     * The wish ID to fetch
+     */
+    wishId: string;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseWishResult {
+    /**
+     * The wish data
+     */
+    wish: Wish | null;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useWish(options: UseWishOptions): UseWishResult;
+
+/**
+ * useComments Hook
+ *
+ * Fetches and manages comments for a wish.
+ */
+
+interface UseCommentsOptions {
+    /**
+     * The wish ID to fetch comments for
+     */
+    wishId: string;
+    /**
+     * Number of comments per page
+     * @default 20
+     */
+    perPage?: number;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseCommentsResult {
+    /**
+     * List of comments
+     */
+    comments: Comment[];
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Loading state for creating a comment
+     */
+    isCreating: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Total number of comments
+     */
+    total: number;
+    /**
+     * Current page
+     */
+    page: number;
+    /**
+     * Total pages
+     */
+    totalPages: number;
+    /**
+     * Go to next page
+     */
+    nextPage: () => void;
+    /**
+     * Go to previous page
+     */
+    prevPage: () => void;
+    /**
+     * Go to specific page
+     */
+    setPage: (page: number) => void;
+    /**
+     * Create a new comment
+     */
+    createComment: (data: Omit<CommentCreateInput, 'wish_id'>) => Promise<Comment | null>;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useComments(options: UseCommentsOptions): UseCommentsResult;
+
+/**
+ * useRoadmap Hook
+ *
+ * Fetches and manages roadmap data for custom UI implementations.
+ *
+ * @example
+ * ```tsx
+ * import { useRoadmap } from '@appgram/react'
+ *
+ * function CustomRoadmap() {
+ *   const { roadmap, isLoading, error, refetch } = useRoadmap({
+ *     refreshInterval: 60000,
+ *   })
+ *
+ *   if (isLoading) return <Skeleton />
+ *   if (error) return <Error message={error} />
+ *
+ *   return (
+ *     <div className="roadmap-columns">
+ *       {roadmap?.columns.map(col => (
+ *         <Column key={col.id} title={col.title} items={col.items} />
+ *       ))}
+ *     </div>
+ *   )
+ * }
+ * ```
+ */
+
+interface UseRoadmapOptions {
+    /**
+     * Auto-refresh interval in milliseconds (0 to disable)
+     * @default 0
+     */
+    refreshInterval?: number;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseRoadmapResult {
+    /**
+     * Roadmap data
+     */
+    roadmap: Roadmap | null;
+    /**
+     * Roadmap columns with items
+     */
+    columns: RoadmapColumn[];
+    /**
+     * Total number of items
+     */
+    totalItems: number;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useRoadmap(options?: UseRoadmapOptions): UseRoadmapResult;
+
+/**
+ * useReleases Hook
+ *
+ * Fetches and manages releases/changelog data for custom UI implementations.
+ *
+ * @example
+ * ```tsx
+ * import { useReleases } from '@appgram/react'
+ *
+ * function ChangelogList() {
+ *   const { releases, isLoading, error, refetch } = useReleases({ limit: 10 })
+ *
+ *   if (isLoading) return <Spinner />
+ *   if (error) return <Alert>{error}</Alert>
+ *
+ *   return (
+ *     <ul className="changelog">
+ *       {releases.map(release => (
+ *         <li key={release.id}>
+ *           <h3>{release.title}</h3>
+ *           <time>{formatDate(release.published_at)}</time>
+ *           <div dangerouslySetInnerHTML={{ __html: release.content }} />
+ *         </li>
+ *       ))}
+ *     </ul>
+ *   )
+ * }
+ * ```
+ */
+
+interface UseReleasesOptions {
+    /**
+     * Maximum number of releases to fetch
+     * @default 50
+     */
+    limit?: number;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseReleasesResult {
+    /**
+     * List of releases
+     */
+    releases: Release[];
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useReleases(options?: UseReleasesOptions): UseReleasesResult;
+/**
+ * useRelease Hook
+ *
+ * Fetches a single release by slug.
+ */
+interface UseReleaseOptions {
+    /**
+     * The release slug to fetch
+     */
+    releaseSlug: string;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseReleaseResult {
+    /**
+     * The release data
+     */
+    release: Release | null;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useRelease(options: UseReleaseOptions): UseReleaseResult;
+
+/**
+ * useHelpCenter Hook
+ *
+ * Fetches and manages help center data.
+ */
+
+interface UseHelpCenterOptions {
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseHelpCenterResult {
+    /**
+     * Help collection
+     */
+    collection: HelpCollection | null;
+    /**
+     * Help flows
+     */
+    flows: HelpFlow[];
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useHelpCenter(options?: UseHelpCenterOptions): UseHelpCenterResult;
+/**
+ * useHelpFlow Hook
+ *
+ * Fetches a single help flow by slug.
+ */
+interface UseHelpFlowOptions {
+    /**
+     * The flow slug to fetch
+     */
+    flowSlug: string;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseHelpFlowResult {
+    /**
+     * The flow data
+     */
+    flow: HelpFlow | null;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useHelpFlow(options: UseHelpFlowOptions): UseHelpFlowResult;
+/**
+ * useHelpArticle Hook
+ *
+ * Fetches a single help article by slug.
+ */
+interface UseHelpArticleOptions {
+    /**
+     * The article slug to fetch
+     */
+    articleSlug: string;
+    /**
+     * The flow ID the article belongs to
+     */
+    flowId: string;
+    /**
+     * Skip initial fetch
+     * @default false
+     */
+    skip?: boolean;
+}
+interface UseHelpArticleResult {
+    /**
+     * The article data
+     */
+    article: HelpArticle | null;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Manually refetch data
+     */
+    refetch: () => Promise<void>;
+}
+declare function useHelpArticle(options: UseHelpArticleOptions): UseHelpArticleResult;
+
+/**
+ * useSupport Hook
+ *
+ * Manages support ticket submissions and access.
+ */
+
+interface UseSupportOptions {
+    /**
+     * Callback when a ticket is successfully submitted
+     */
+    onSubmitSuccess?: (ticket: SupportRequest) => void;
+    /**
+     * Callback when a submission fails
+     */
+    onSubmitError?: (error: string) => void;
+}
+interface UseSupportResult {
+    /**
+     * Loading state for ticket submission
+     */
+    isSubmitting: boolean;
+    /**
+     * Loading state for magic link request
+     */
+    isSendingMagicLink: boolean;
+    /**
+     * Loading state for token verification
+     */
+    isVerifying: boolean;
+    /**
+     * Error message if any
+     */
+    error: string | null;
+    /**
+     * Success message after submitting
+     */
+    successMessage: string | null;
+    /**
+     * Submit a new support ticket
+     */
+    submitTicket: (data: SupportRequestInput) => Promise<SupportRequest | null>;
+    /**
+     * Request a magic link to access tickets
+     */
+    requestMagicLink: (email: string) => Promise<boolean>;
+    /**
+     * Verify a magic link token
+     */
+    verifyToken: (token: string) => Promise<{
+        tickets: SupportRequest[];
+        userEmail: string;
+    } | null>;
+    /**
+     * Get a specific ticket by ID with token
+     */
+    getTicket: (ticketId: string, token: string) => Promise<SupportRequest | null>;
+    /**
+     * Add a message to a ticket
+     */
+    addMessage: (ticketId: string, token: string, content: string) => Promise<{
+        id: string;
+        content: string;
+        created_at: string;
+    } | null>;
+    /**
+     * Clear any error or success messages
+     */
+    clearMessages: () => void;
+}
+declare function useSupport(options?: UseSupportOptions): UseSupportResult;
+
+/**
+ * useStatus Hook
+ *
+ * Fetches status page data and transforms it for the StatusBoard component.
+ * Supports auto-refresh polling.
+ */
+
+interface UseStatusOptions {
+    /**
+     * Status page slug
+     * @default 'status'
+     */
+    slug?: string;
+    /**
+     * Whether to fetch immediately
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Auto-refresh interval in milliseconds (0 to disable)
+     * @default 30000
+     */
+    refreshInterval?: number;
+}
+interface UseStatusResult {
+    /**
+     * Transformed status data ready for StatusBoard
+     */
+    status: StatusData | null;
+    /**
+     * Raw API overview response
+     */
+    overview: StatusPageOverview | null;
+    /**
+     * Loading state
+     */
+    isLoading: boolean;
+    /**
+     * Error message
+     */
+    error: string | null;
+    /**
+     * Manually refresh
+     */
+    refetch: () => Promise<void>;
+}
+declare function useStatus(options?: UseStatusOptions): UseStatusResult;
+
+/**
+ * useSurvey Hook
+ *
+ * Fetches and manages survey data and response submission.
+ */
+
+interface UseSurveyOptions {
+    /**
+     * Whether to fetch the survey immediately
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseSurveyResult {
+    survey: Survey | null;
+    nodes: SurveyNode[];
+    isLoading: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+}
+declare function useSurvey(slug: string, options?: UseSurveyOptions): UseSurveyResult;
+interface UseSurveySubmitOptions {
+    onSuccess?: (response: SurveyResponse) => void;
+    onError?: (error: string) => void;
+}
+interface UseSurveySubmitResult {
+    isSubmitting: boolean;
+    error: string | null;
+    successMessage: string | null;
+    submitResponse: (surveyId: string, data: SurveySubmitInput) => Promise<SurveyResponse | null>;
+    clearMessages: () => void;
+}
+declare function useSurveySubmit(options?: UseSurveySubmitOptions): UseSurveySubmitResult;
+
+/**
+ * useContactForm Hook
+ *
+ * Fetches contact form config and manages form submission.
+ */
+
+interface UseContactFormOptions {
+    /**
+     * Whether to fetch the form immediately
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseContactFormResult {
+    form: ContactForm | null;
+    isLoading: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+}
+declare function useContactForm(formId: string, options?: UseContactFormOptions): UseContactFormResult;
+interface UseContactFormSubmitOptions {
+    /**
+     * Rate limit cooldown in milliseconds
+     * @default 5000
+     */
+    rateLimitMs?: number;
+    onSuccess?: (submission: ContactFormSubmission) => void;
+    onError?: (error: string) => void;
+}
+interface UseContactFormSubmitResult {
+    isSubmitting: boolean;
+    error: string | null;
+    successMessage: string | null;
+    isRateLimited: boolean;
+    submitForm: (projectId: string, formId: string, data: ContactFormSubmitInput) => Promise<ContactFormSubmission | null>;
+    validateField: (value: string, field: {
+        type: string;
+        required: boolean;
+        validation?: {
+            minLength?: number;
+            maxLength?: number;
+            pattern?: string;
+        };
+    }) => string | null;
+    clearMessages: () => void;
+}
+declare function useContactFormSubmit(options?: UseContactFormSubmitOptions): UseContactFormSubmitResult;
+
+export { useHelpArticle as $, type UseHelpCenterResult as A, type UseHelpFlowOptions as B, type ContactForm as C, type UseHelpFlowResult as D, type UseReleaseOptions as E, type UseReleaseResult as F, type UseReleasesOptions as G, type UseReleasesResult as H, type UseRoadmapOptions as I, type UseRoadmapResult as J, type UseStatusOptions as K, type UseStatusResult as L, type UseSupportOptions as M, type UseSupportResult as N, type UseSurveyOptions as O, type UseSurveyResult as P, type UseSurveySubmitOptions as Q, type UseSurveySubmitResult as R, type StatusPageOverview as S, type UseWishOptions as T, type UseCommentsOptions as U, type UseWishResult as V, type UseWishesOptions as W, type UseWishesResult as X, useComments as Y, useContactForm as Z, useContactFormSubmit as _, type Survey as a, useHelpCenter as a0, useHelpFlow as a1, useRelease as a2, useReleases as a3, useRoadmap as a4, useStatus as a5, useSupport as a6, useSurvey as a7, useSurveySubmit as a8, useWish as a9, useWishes as aa, type SurveyNode as b, type SurveySubmitInput as c, type SurveyResponse as d, type ContactFormSubmitInput as e, type ContactFormSubmission as f, type ContactFormField as g, type ContactFormFieldType as h, type ContactFormFieldValidation as i, type StatusPage as j, type StatusPageService as k, type StatusState as l, type StatusType as m, type StatusUpdate as n, type SurveyAnswer as o, type SurveyNodeBranch as p, type SurveyNodeOption as q, type SurveyQuestionType as r, type UseCommentsResult as s, type UseContactFormOptions as t, type UseContactFormResult as u, type UseContactFormSubmitOptions as v, type UseContactFormSubmitResult as w, type UseHelpArticleOptions as x, type UseHelpArticleResult as y, type UseHelpCenterOptions as z };