@framed-dev/react 0.0.0

package/dist/index.d.cts

@@ -0,0 +1,264 @@
+import { FramedConfig, Session, WidgetDataLayer, Task, LimitStatus, WidgetFeatures, AuthConfig, FeedbackComment, TaskStatus, SyncResult } from '@framed/core';
+export { AIConfig, AnnotationData, AnnotationMode, Assignment, Attachment, AuthConfig, AuthMode, Comment, ElementInfo, FeedbackComment, FeedbackInfo, FramedConfig, LimitStatus, Mention, PageInfo, PendingAttachment, Position, Session, SyncConfig, SyncResult, Task, TaskInfo, TaskStatus, TaskType, UsageLimits, ViewportMode, WidgetConfig, WidgetDataLayer, WidgetFeatures } from '@framed/core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type WidgetVersion = 'latest' | 'v3' | string;
+type WidgetSource = 'cdn' | 'bundled';
+interface FramedProviderConfig extends FramedConfig {
+    widgetVersion?: WidgetVersion;
+    widgetSource?: WidgetSource;
+}
+interface FramedContextValue {
+    config: FramedProviderConfig;
+    projectId: string;
+    isAuthenticated: boolean;
+    session: Session | null;
+    isAuthLoading: boolean;
+    authError: string | null;
+    login: () => void;
+    logout: () => void;
+    dataLayer: WidgetDataLayer;
+    tasks: Task[];
+    openTasks: Task[];
+    isTasksLoading: boolean;
+    refreshTasks: () => Promise<void>;
+    saveTask: (task: Task) => Promise<void>;
+    updateTask: (id: string, updates: Partial<Task>) => Promise<void>;
+    limits: LimitStatus | null;
+    checkLimits: () => Promise<LimitStatus>;
+    features: WidgetFeatures;
+    isWidgetReady: boolean;
+}
+interface FramedProviderProps {
+    config: FramedProviderConfig;
+    children: ReactNode;
+}
+declare function FramedProvider({ config, children }: FramedProviderProps): react_jsx_runtime.JSX.Element;
+declare function useFramed(): FramedContextValue;
+
+interface AuthContextValue {
+    isAuthenticated: boolean;
+    session: Session | null;
+    isLoading: boolean;
+    error: string | null;
+    login: () => void;
+    logout: () => void;
+}
+interface AuthProviderProps {
+    config: AuthConfig;
+    projectId: string;
+    apiKey?: string;
+    supabaseUrl?: string;
+    children: ReactNode;
+}
+declare function AuthProvider({ config, projectId, apiKey, supabaseUrl, children, }: AuthProviderProps): react_jsx_runtime.JSX.Element;
+declare function useAuth(): AuthContextValue;
+
+interface FeedbackWidgetProps {
+    /** User's display name for feedback attribution */
+    author?: string;
+    /** Called when a new comment is submitted */
+    onSubmit?: (comment: FeedbackComment) => void;
+    /** Called when a task is created from feedback */
+    onTaskCreated?: (task: Task) => void;
+    /** Called when user takes a screenshot */
+    onScreenshot?: () => void;
+    /** Called when user locates a comment */
+    onLocateComment?: (comment: FeedbackComment) => void;
+    /** Called when user exports summary */
+    onExport?: () => void;
+    /** Called when widget is closed */
+    onClose?: () => void;
+}
+declare function FeedbackWidget({ author, onSubmit, onTaskCreated, onScreenshot, onLocateComment, onExport, onClose, }: FeedbackWidgetProps): react_jsx_runtime.JSX.Element | null;
+
+interface TasksReadyPanelProps {
+    /** Maximum number of tasks to show in preview */
+    maxPreview?: number;
+    /** Called when prompt is copied */
+    onPromptCopied?: () => void;
+    /** Custom class name */
+    className?: string;
+}
+declare function TasksReadyPanel({ maxPreview, onPromptCopied, className, }: TasksReadyPanelProps): react_jsx_runtime.JSX.Element | null;
+
+interface SiteContext {
+    capturedAt: string;
+    capturedBy: 'widget' | 'cli';
+    pages: SitePageInfo[];
+    navigation: NavigationItem[];
+    patterns: SitePatterns;
+    framework: FrameworkInfo;
+    contentMap: ContentMap[];
+}
+interface SitePageInfo {
+    url: string;
+    title: string;
+    description?: string;
+    hasContent: boolean;
+    sections: string[];
+    lastModified?: string;
+}
+interface NavigationItem {
+    label: string;
+    href: string;
+    isActive: boolean;
+    children?: NavigationItem[];
+    location: 'header' | 'footer' | 'sidebar';
+}
+interface SitePatterns {
+    hasBlog: boolean;
+    hasBlogPosts: boolean;
+    hasTeamSection: boolean;
+    hasContactForm: boolean;
+    hasNewsletter: boolean;
+    hasPricing: boolean;
+    hasTestimonials: boolean;
+    hasFAQ: boolean;
+    hasProducts: boolean;
+    hasCart: boolean;
+    hasCheckout: boolean;
+    hasHero: boolean;
+    hasFooter: boolean;
+    hasSidebar: boolean;
+}
+interface FrameworkInfo {
+    detected: 'nextjs-app' | 'nextjs-pages' | 'remix' | 'react-router' | 'astro' | 'unknown';
+    confidence: number;
+    hints: string[];
+}
+interface ContentMap {
+    page: string;
+    sections: {
+        id: string;
+        selector: string;
+        type: 'hero' | 'content' | 'list' | 'form' | 'cta' | 'unknown';
+        hasImages: boolean;
+        hasText: boolean;
+        approximateWords: number;
+    }[];
+}
+declare function scanSiteContext(): Promise<SiteContext>;
+
+interface PromptOptions {
+    apiKey: string;
+    includeContext?: boolean;
+    format?: 'full' | 'compact';
+}
+declare function generateAIPrompt(tasks: Task[], options: PromptOptions, siteContext?: SiteContext): string;
+declare function copyPromptToClipboard(prompt: string): Promise<boolean>;
+
+interface UseFramedTasksResult {
+    tasks: Task[];
+    openTasks: Task[];
+    inProgressTasks: Task[];
+    doneTasks: Task[];
+    isLoading: boolean;
+    openCount: number;
+    totalCount: number;
+    refresh: () => Promise<void>;
+    markDone: (taskId: string) => Promise<void>;
+    updateStatus: (taskId: string, status: TaskStatus) => Promise<void>;
+    generatePrompt: (options?: Partial<PromptOptions>) => Promise<string>;
+    copyPrompt: (options?: Partial<PromptOptions>) => Promise<boolean>;
+}
+declare function useFramedTasks(): UseFramedTasksResult;
+
+declare class LocalDataLayer implements WidgetDataLayer {
+    private projectId;
+    constructor(projectId: string);
+    getSession(): Promise<Session | null>;
+    loadTasks(page?: string): Promise<Task[]>;
+    saveTask(task: Task): Promise<void>;
+    updateTask(id: string, updates: Partial<Task>): Promise<void>;
+    uploadFile(file: File): Promise<{
+        url: string;
+        path: string;
+    }>;
+    checkLimits(): Promise<LimitStatus>;
+    sync: undefined;
+    deleteTask(id: string): Promise<void>;
+    clearAllTasks(): Promise<void>;
+    exportTasks(): Promise<string>;
+}
+
+interface FramedAPIConfig {
+    apiKey: string;
+    supabaseUrl: string;
+}
+interface TasksResponse {
+    tasks: Task[];
+    meta: {
+        total: number;
+        projectId: string;
+        projectName: string;
+    };
+}
+interface UploadResponse {
+    url: string;
+    path: string;
+    expiresAt?: string;
+}
+interface ValidationResult {
+    valid: boolean;
+    session?: Session;
+    error?: string;
+}
+declare class FramedAPIClient {
+    private apiKey;
+    private baseUrl;
+    constructor(config: FramedAPIConfig);
+    private request;
+    getTasks(options?: {
+        status?: 'open' | 'in_progress' | 'done' | 'rejected';
+        page?: string;
+    }): Promise<TasksResponse>;
+    createTask(task: Omit<Task, 'id' | 'meta'>): Promise<Task>;
+    updateTask(taskId: string, updates: Partial<Task>): Promise<Task>;
+    markTaskDone(taskId: string): Promise<{
+        success: boolean;
+        task: Task;
+    }>;
+    uploadFile(file: File): Promise<UploadResponse>;
+    validateMagicToken(token: string): Promise<ValidationResult>;
+    exchangeSessionToken(sessionToken: string): Promise<ValidationResult>;
+    getSession(): Promise<Session | null>;
+}
+
+declare class SyncDataLayer implements WidgetDataLayer {
+    private projectId;
+    private client;
+    private session;
+    constructor(projectId: string, config: FramedAPIConfig);
+    private loadCachedSession;
+    private cacheSession;
+    getSession(): Promise<Session | null>;
+    loadTasks(page?: string): Promise<Task[]>;
+    saveTask(task: Task): Promise<void>;
+    updateTask(id: string, updates: Partial<Task>): Promise<void>;
+    uploadFile(file: File): Promise<{
+        url: string;
+        path: string;
+    }>;
+    private createFormData;
+    checkLimits(): Promise<LimitStatus>;
+    sync(): Promise<SyncResult>;
+    private getPendingTasks;
+    private savePendingTasks;
+    private addPendingTask;
+    validateMagicToken(token: string): Promise<{
+        valid: boolean;
+        session?: Session;
+        error?: string;
+    }>;
+    exchangeSessionToken(sessionToken: string): Promise<{
+        valid: boolean;
+        session?: Session;
+        error?: string;
+    }>;
+    clearSession(): void;
+    markTaskDone(taskId: string): Promise<void>;
+}
+
+export { AuthProvider, type ContentMap, FeedbackWidget, type FeedbackWidgetProps, FramedAPIClient, type FramedAPIConfig, FramedProvider, type FramedProviderConfig, type FramedProviderProps, type FrameworkInfo, LocalDataLayer, type NavigationItem, type PromptOptions, type SiteContext, type SitePageInfo, type SitePatterns, SyncDataLayer, TasksReadyPanel, type TasksReadyPanelProps, type TasksResponse, type UploadResponse, type UseFramedTasksResult, type ValidationResult, copyPromptToClipboard, generateAIPrompt, scanSiteContext, useAuth, useFramed, useFramedTasks };

package/dist/index.d.ts

@@ -0,0 +1,264 @@
+import { FramedConfig, Session, WidgetDataLayer, Task, LimitStatus, WidgetFeatures, AuthConfig, FeedbackComment, TaskStatus, SyncResult } from '@framed/core';
+export { AIConfig, AnnotationData, AnnotationMode, Assignment, Attachment, AuthConfig, AuthMode, Comment, ElementInfo, FeedbackComment, FeedbackInfo, FramedConfig, LimitStatus, Mention, PageInfo, PendingAttachment, Position, Session, SyncConfig, SyncResult, Task, TaskInfo, TaskStatus, TaskType, UsageLimits, ViewportMode, WidgetConfig, WidgetDataLayer, WidgetFeatures } from '@framed/core';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+type WidgetVersion = 'latest' | 'v3' | string;
+type WidgetSource = 'cdn' | 'bundled';
+interface FramedProviderConfig extends FramedConfig {
+    widgetVersion?: WidgetVersion;
+    widgetSource?: WidgetSource;
+}
+interface FramedContextValue {
+    config: FramedProviderConfig;
+    projectId: string;
+    isAuthenticated: boolean;
+    session: Session | null;
+    isAuthLoading: boolean;
+    authError: string | null;
+    login: () => void;
+    logout: () => void;
+    dataLayer: WidgetDataLayer;
+    tasks: Task[];
+    openTasks: Task[];
+    isTasksLoading: boolean;
+    refreshTasks: () => Promise<void>;
+    saveTask: (task: Task) => Promise<void>;
+    updateTask: (id: string, updates: Partial<Task>) => Promise<void>;
+    limits: LimitStatus | null;
+    checkLimits: () => Promise<LimitStatus>;
+    features: WidgetFeatures;
+    isWidgetReady: boolean;
+}
+interface FramedProviderProps {
+    config: FramedProviderConfig;
+    children: ReactNode;
+}
+declare function FramedProvider({ config, children }: FramedProviderProps): react_jsx_runtime.JSX.Element;
+declare function useFramed(): FramedContextValue;
+
+interface AuthContextValue {
+    isAuthenticated: boolean;
+    session: Session | null;
+    isLoading: boolean;
+    error: string | null;
+    login: () => void;
+    logout: () => void;
+}
+interface AuthProviderProps {
+    config: AuthConfig;
+    projectId: string;
+    apiKey?: string;
+    supabaseUrl?: string;
+    children: ReactNode;
+}
+declare function AuthProvider({ config, projectId, apiKey, supabaseUrl, children, }: AuthProviderProps): react_jsx_runtime.JSX.Element;
+declare function useAuth(): AuthContextValue;
+
+interface FeedbackWidgetProps {
+    /** User's display name for feedback attribution */
+    author?: string;
+    /** Called when a new comment is submitted */
+    onSubmit?: (comment: FeedbackComment) => void;
+    /** Called when a task is created from feedback */
+    onTaskCreated?: (task: Task) => void;
+    /** Called when user takes a screenshot */
+    onScreenshot?: () => void;
+    /** Called when user locates a comment */
+    onLocateComment?: (comment: FeedbackComment) => void;
+    /** Called when user exports summary */
+    onExport?: () => void;
+    /** Called when widget is closed */
+    onClose?: () => void;
+}
+declare function FeedbackWidget({ author, onSubmit, onTaskCreated, onScreenshot, onLocateComment, onExport, onClose, }: FeedbackWidgetProps): react_jsx_runtime.JSX.Element | null;
+
+interface TasksReadyPanelProps {
+    /** Maximum number of tasks to show in preview */
+    maxPreview?: number;
+    /** Called when prompt is copied */
+    onPromptCopied?: () => void;
+    /** Custom class name */
+    className?: string;
+}
+declare function TasksReadyPanel({ maxPreview, onPromptCopied, className, }: TasksReadyPanelProps): react_jsx_runtime.JSX.Element | null;
+
+interface SiteContext {
+    capturedAt: string;
+    capturedBy: 'widget' | 'cli';
+    pages: SitePageInfo[];
+    navigation: NavigationItem[];
+    patterns: SitePatterns;
+    framework: FrameworkInfo;
+    contentMap: ContentMap[];
+}
+interface SitePageInfo {
+    url: string;
+    title: string;
+    description?: string;
+    hasContent: boolean;
+    sections: string[];
+    lastModified?: string;
+}
+interface NavigationItem {
+    label: string;
+    href: string;
+    isActive: boolean;
+    children?: NavigationItem[];
+    location: 'header' | 'footer' | 'sidebar';
+}
+interface SitePatterns {
+    hasBlog: boolean;
+    hasBlogPosts: boolean;
+    hasTeamSection: boolean;
+    hasContactForm: boolean;
+    hasNewsletter: boolean;
+    hasPricing: boolean;
+    hasTestimonials: boolean;
+    hasFAQ: boolean;
+    hasProducts: boolean;
+    hasCart: boolean;
+    hasCheckout: boolean;
+    hasHero: boolean;
+    hasFooter: boolean;
+    hasSidebar: boolean;
+}
+interface FrameworkInfo {
+    detected: 'nextjs-app' | 'nextjs-pages' | 'remix' | 'react-router' | 'astro' | 'unknown';
+    confidence: number;
+    hints: string[];
+}
+interface ContentMap {
+    page: string;
+    sections: {
+        id: string;
+        selector: string;
+        type: 'hero' | 'content' | 'list' | 'form' | 'cta' | 'unknown';
+        hasImages: boolean;
+        hasText: boolean;
+        approximateWords: number;
+    }[];
+}
+declare function scanSiteContext(): Promise<SiteContext>;
+
+interface PromptOptions {
+    apiKey: string;
+    includeContext?: boolean;
+    format?: 'full' | 'compact';
+}
+declare function generateAIPrompt(tasks: Task[], options: PromptOptions, siteContext?: SiteContext): string;
+declare function copyPromptToClipboard(prompt: string): Promise<boolean>;
+
+interface UseFramedTasksResult {
+    tasks: Task[];
+    openTasks: Task[];
+    inProgressTasks: Task[];
+    doneTasks: Task[];
+    isLoading: boolean;
+    openCount: number;
+    totalCount: number;
+    refresh: () => Promise<void>;
+    markDone: (taskId: string) => Promise<void>;
+    updateStatus: (taskId: string, status: TaskStatus) => Promise<void>;
+    generatePrompt: (options?: Partial<PromptOptions>) => Promise<string>;
+    copyPrompt: (options?: Partial<PromptOptions>) => Promise<boolean>;
+}
+declare function useFramedTasks(): UseFramedTasksResult;
+
+declare class LocalDataLayer implements WidgetDataLayer {
+    private projectId;
+    constructor(projectId: string);
+    getSession(): Promise<Session | null>;
+    loadTasks(page?: string): Promise<Task[]>;
+    saveTask(task: Task): Promise<void>;
+    updateTask(id: string, updates: Partial<Task>): Promise<void>;
+    uploadFile(file: File): Promise<{
+        url: string;
+        path: string;
+    }>;
+    checkLimits(): Promise<LimitStatus>;
+    sync: undefined;
+    deleteTask(id: string): Promise<void>;
+    clearAllTasks(): Promise<void>;
+    exportTasks(): Promise<string>;
+}
+
+interface FramedAPIConfig {
+    apiKey: string;
+    supabaseUrl: string;
+}
+interface TasksResponse {
+    tasks: Task[];
+    meta: {
+        total: number;
+        projectId: string;
+        projectName: string;
+    };
+}
+interface UploadResponse {
+    url: string;
+    path: string;
+    expiresAt?: string;
+}
+interface ValidationResult {
+    valid: boolean;
+    session?: Session;
+    error?: string;
+}
+declare class FramedAPIClient {
+    private apiKey;
+    private baseUrl;
+    constructor(config: FramedAPIConfig);
+    private request;
+    getTasks(options?: {
+        status?: 'open' | 'in_progress' | 'done' | 'rejected';
+        page?: string;
+    }): Promise<TasksResponse>;
+    createTask(task: Omit<Task, 'id' | 'meta'>): Promise<Task>;
+    updateTask(taskId: string, updates: Partial<Task>): Promise<Task>;
+    markTaskDone(taskId: string): Promise<{
+        success: boolean;
+        task: Task;
+    }>;
+    uploadFile(file: File): Promise<UploadResponse>;
+    validateMagicToken(token: string): Promise<ValidationResult>;
+    exchangeSessionToken(sessionToken: string): Promise<ValidationResult>;
+    getSession(): Promise<Session | null>;
+}
+
+declare class SyncDataLayer implements WidgetDataLayer {
+    private projectId;
+    private client;
+    private session;
+    constructor(projectId: string, config: FramedAPIConfig);
+    private loadCachedSession;
+    private cacheSession;
+    getSession(): Promise<Session | null>;
+    loadTasks(page?: string): Promise<Task[]>;
+    saveTask(task: Task): Promise<void>;
+    updateTask(id: string, updates: Partial<Task>): Promise<void>;
+    uploadFile(file: File): Promise<{
+        url: string;
+        path: string;
+    }>;
+    private createFormData;
+    checkLimits(): Promise<LimitStatus>;
+    sync(): Promise<SyncResult>;
+    private getPendingTasks;
+    private savePendingTasks;
+    private addPendingTask;
+    validateMagicToken(token: string): Promise<{
+        valid: boolean;
+        session?: Session;
+        error?: string;
+    }>;
+    exchangeSessionToken(sessionToken: string): Promise<{
+        valid: boolean;
+        session?: Session;
+        error?: string;
+    }>;
+    clearSession(): void;
+    markTaskDone(taskId: string): Promise<void>;
+}
+
+export { AuthProvider, type ContentMap, FeedbackWidget, type FeedbackWidgetProps, FramedAPIClient, type FramedAPIConfig, FramedProvider, type FramedProviderConfig, type FramedProviderProps, type FrameworkInfo, LocalDataLayer, type NavigationItem, type PromptOptions, type SiteContext, type SitePageInfo, type SitePatterns, SyncDataLayer, TasksReadyPanel, type TasksReadyPanelProps, type TasksResponse, type UploadResponse, type UseFramedTasksResult, type ValidationResult, copyPromptToClipboard, generateAIPrompt, scanSiteContext, useAuth, useFramed, useFramedTasks };