@weirdfingers/boards 0.1.4

package/dist/index.d.mts

@@ -0,0 +1,508 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+import * as urql from 'urql';
+
+/**
+ * Core authentication types and interfaces.
+ */
+interface User$1 {
+    id: string;
+    email: string;
+    name?: string;
+    avatar?: string;
+    metadata: Record<string, unknown>;
+    credits: {
+        balance: number;
+        reserved: number;
+    };
+}
+interface AuthProvider$1 {
+    id: string;
+    name: string;
+    type: 'oauth' | 'email' | 'magic-link' | 'custom';
+    config: Record<string, unknown>;
+}
+interface SignInOptions {
+    provider?: string;
+    redirectTo?: string;
+    [key: string]: unknown;
+}
+interface AuthState$1 {
+    user: User$1 | null;
+    status: 'loading' | 'authenticated' | 'unauthenticated' | 'error';
+    signIn: (provider?: AuthProvider$1, options?: SignInOptions) => Promise<void>;
+    signOut: () => Promise<void>;
+    getToken: () => Promise<string | null>;
+    refreshToken: () => Promise<string | null>;
+}
+interface AuthProviderConfig {
+    /**
+     * Tenant identifier for multi-tenant applications.
+     * If not provided, defaults to single-tenant mode.
+     */
+    tenantId?: string;
+    /**
+     * Additional configuration specific to the auth provider.
+     */
+    [key: string]: unknown;
+}
+interface AuthContextValue extends AuthState$1 {
+    /**
+     * Whether the auth system is initializing.
+     */
+    isInitializing: boolean;
+    /**
+     * Any error that occurred during authentication.
+     */
+    error: Error | null;
+    /**
+     * Clear any authentication errors.
+     */
+    clearError: () => void;
+}
+
+/**
+ * Base authentication provider abstract class.
+ */
+
+declare abstract class BaseAuthProvider {
+    protected config: AuthProviderConfig;
+    constructor(config?: AuthProviderConfig);
+    /**
+     * Initialize the auth provider.
+     * Called once when the provider is created.
+     */
+    abstract initialize(): Promise<void>;
+    /**
+     * Get the current authentication state.
+     */
+    abstract getAuthState(): Promise<AuthState$1>;
+    /**
+     * Sign in with the provider.
+     */
+    abstract signIn(opts?: Record<string, unknown>): Promise<void>;
+    /**
+     * Sign out from the provider.
+     */
+    abstract signOut(): Promise<void>;
+    /**
+     * Get the current authentication token.
+     */
+    abstract getToken(): Promise<string | null>;
+    /**
+     * Get the current user information.
+     */
+    abstract getUser(): Promise<User$1 | null>;
+    /**
+     * Listen for auth state changes.
+     * Returns an unsubscribe function.
+     */
+    abstract onAuthStateChange(callback: (state: AuthState$1) => void): () => void;
+    /**
+     * Clean up resources when the provider is destroyed.
+     */
+    abstract destroy(): Promise<void>;
+    /**
+     * Get the tenant ID from config.
+     */
+    protected getTenantId(): string;
+}
+
+interface AuthProviderProps {
+    provider: BaseAuthProvider;
+    children: React.ReactNode;
+}
+declare function AuthProvider({ provider, children }: AuthProviderProps): react_jsx_runtime.JSX.Element;
+declare function useAuth(): AuthContextValue;
+declare function useAuthOptional(): AuthContextValue | null;
+
+/**
+ * No-auth provider for local development without authentication.
+ */
+
+interface NoAuthConfig extends AuthProviderConfig {
+    /**
+     * Default user ID for development.
+     * Defaults to 'dev-user'.
+     */
+    defaultUserId?: string;
+    /**
+     * Default user email for development.
+     * Defaults to 'dev@example.com'.
+     */
+    defaultEmail?: string;
+    /**
+     * Default display name for development.
+     * Defaults to 'Development User'.
+     */
+    defaultDisplayName?: string;
+}
+declare class NoAuthProvider extends BaseAuthProvider {
+    protected config: NoAuthConfig;
+    private listeners;
+    private currentState;
+    private defaultUser;
+    constructor(config?: NoAuthConfig);
+    initialize(): Promise<void>;
+    getAuthState(): Promise<AuthState$1>;
+    signIn(): Promise<void>;
+    signOut(): Promise<void>;
+    getToken(): Promise<string | null>;
+    refreshToken(): Promise<string | null>;
+    getUser(): Promise<User$1 | null>;
+    onAuthStateChange(callback: (state: AuthState$1) => void): () => void;
+    destroy(): Promise<void>;
+    private updateState;
+}
+
+interface ApiConfig {
+    /**
+     * Base URL for the backend API (e.g., "http://localhost:8088")
+     * Used for REST endpoints like SSE streams
+     */
+    apiUrl: string;
+    /**
+     * GraphQL endpoint URL (e.g., "http://localhost:8088/graphql")
+     */
+    graphqlUrl: string;
+    /**
+     * WebSocket URL for GraphQL subscriptions
+     */
+    subscriptionUrl?: string;
+}
+declare function useApiConfig(): ApiConfig;
+
+/**
+ * GraphQL client configuration with authentication.
+ */
+interface AuthState {
+    getToken(): Promise<string | null>;
+}
+interface ClientConfig {
+    url: string;
+    subscriptionUrl?: string;
+    auth: AuthState;
+    tenantId?: string;
+}
+declare function createGraphQLClient({ url, subscriptionUrl, auth, tenantId, }: ClientConfig): urql.Client;
+
+/**
+ * GraphQL queries and mutations for the Boards API.
+ */
+declare const USER_FRAGMENT: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const BOARD_FRAGMENT: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GENERATION_FRAGMENT: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GET_CURRENT_USER: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GET_BOARDS: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GET_BOARD: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GET_GENERATORS: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GET_GENERATIONS: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const GET_GENERATION: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const CREATE_BOARD: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const UPDATE_BOARD: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const DELETE_BOARD: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const ADD_BOARD_MEMBER: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const UPDATE_BOARD_MEMBER_ROLE: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const REMOVE_BOARD_MEMBER: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const CREATE_GENERATION: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const CANCEL_GENERATION: urql.TypedDocumentNode<any, urql.AnyVariables>;
+declare const RETRY_GENERATION: urql.TypedDocumentNode<any, urql.AnyVariables>;
+interface CreateBoardInput {
+    title: string;
+    description?: string;
+    isPublic?: boolean;
+    settings?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+}
+interface UpdateBoardInput {
+    title?: string;
+    description?: string;
+    isPublic?: boolean;
+    settings?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+}
+interface CreateGenerationInput {
+    boardId: string;
+    generatorName: string;
+    artifactType: ArtifactType;
+    inputParams: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+}
+declare enum BoardRole {
+    VIEWER = "VIEWER",
+    EDITOR = "EDITOR",
+    ADMIN = "ADMIN"
+}
+declare enum GenerationStatus {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED"
+}
+declare enum ArtifactType {
+    IMAGE = "image",
+    VIDEO = "video",
+    AUDIO = "audio",
+    TEXT = "text",
+    LORA = "lora",
+    MODEL = "model"
+}
+
+/**
+ * Hook for managing multiple boards.
+ */
+
+interface Board$1 {
+    id: string;
+    tenantId: string;
+    ownerId: string;
+    title: string;
+    description?: string;
+    isPublic: boolean;
+    settings: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    generationCount: number;
+    owner: {
+        id: string;
+        email: string;
+        displayName: string;
+        avatarUrl?: string;
+        createdAt: string;
+    };
+}
+interface UseBoardsOptions {
+    limit?: number;
+    offset?: number;
+}
+interface BoardsHook {
+    boards: Board$1[];
+    loading: boolean;
+    error: Error | null;
+    createBoard: (data: CreateBoardInput) => Promise<Board$1>;
+    deleteBoard: (boardId: string) => Promise<void>;
+    searchBoards: (query: string) => Promise<Board$1[]>;
+    refresh: () => Promise<void>;
+    setSearchQuery: (query: string) => void;
+    searchQuery: string;
+}
+declare function useBoards(options?: UseBoardsOptions): BoardsHook;
+
+/**
+ * Hook for managing a single board.
+ */
+
+interface User {
+    id: string;
+    email: string;
+    displayName: string;
+    avatarUrl?: string;
+    createdAt: string;
+}
+interface BoardMember {
+    id: string;
+    boardId: string;
+    userId: string;
+    role: BoardRole;
+    invitedBy?: string;
+    joinedAt: string;
+    user: User;
+    inviter?: User;
+}
+interface Generation {
+    id: string;
+    boardId: string;
+    userId: string;
+    generatorName: string;
+    artifactType: string;
+    status: string;
+    progress: number;
+    storageUrl?: string | null;
+    thumbnailUrl?: string | null;
+    inputParams: Record<string, unknown>;
+    outputMetadata: Record<string, unknown>;
+    errorMessage?: string | null;
+    createdAt: string;
+    updatedAt: string;
+    completedAt?: string | null;
+}
+interface Board {
+    id: string;
+    tenantId: string;
+    ownerId: string;
+    title: string;
+    description?: string;
+    isPublic: boolean;
+    settings: Record<string, unknown>;
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    generationCount: number;
+    owner: User;
+    members: BoardMember[];
+    generations: Generation[];
+}
+type MemberRole = BoardRole;
+interface BoardPermissions {
+    canEdit: boolean;
+    canDelete: boolean;
+    canAddMembers: boolean;
+    canRemoveMembers: boolean;
+    canGenerate: boolean;
+    canExport: boolean;
+}
+interface ShareLinkOptions {
+    expiresIn?: number;
+    permissions?: string[];
+}
+interface ShareLink {
+    id: string;
+    url: string;
+    expiresAt?: string;
+    permissions: string[];
+}
+interface BoardHook {
+    board: Board | null;
+    members: BoardMember[];
+    permissions: BoardPermissions;
+    loading: boolean;
+    error: Error | null;
+    updateBoard: (updates: Partial<UpdateBoardInput>) => Promise<Board>;
+    deleteBoard: () => Promise<void>;
+    refresh: () => Promise<void>;
+    addMember: (email: string, role: MemberRole) => Promise<BoardMember>;
+    removeMember: (memberId: string) => Promise<void>;
+    updateMemberRole: (memberId: string, role: MemberRole) => Promise<BoardMember>;
+    generateShareLink: (options: ShareLinkOptions) => Promise<ShareLink>;
+    revokeShareLink: (linkId: string) => Promise<void>;
+}
+declare function useBoard(boardId: string): BoardHook;
+
+/**
+ * Hook for managing AI generations with real-time progress via SSE.
+ */
+
+interface GenerationRequest {
+    model: string;
+    artifactType: ArtifactType;
+    inputs: GenerationInputs;
+    boardId: string;
+    options?: GenerationOptions;
+}
+interface GenerationInputs {
+    prompt: string;
+    negativePrompt?: string;
+    image?: string | File;
+    mask?: string | File;
+    loras?: LoRAInput[];
+    seed?: number;
+    steps?: number;
+    guidance?: number;
+    aspectRatio?: string;
+    style?: string;
+    [key: string]: unknown;
+}
+interface GenerationOptions {
+    priority?: "low" | "normal" | "high";
+    timeout?: number;
+    webhookUrl?: string;
+    [key: string]: unknown;
+}
+interface LoRAInput {
+    id: string;
+    weight: number;
+}
+interface GenerationProgress {
+    jobId: string;
+    status: "queued" | "processing" | "completed" | "failed" | "cancelled";
+    progress: number;
+    phase: string;
+    message?: string | null;
+    estimatedTimeRemaining?: number;
+    currentStep?: string;
+    logs?: string[];
+}
+interface GenerationResult {
+    id: string;
+    jobId: string;
+    boardId: string;
+    request: GenerationRequest;
+    artifacts: Artifact[];
+    credits: {
+        cost: number;
+        balanceBefore: number;
+        balance: number;
+    };
+    performance: {
+        queueTime: number;
+        processingTime: number;
+        totalTime: number;
+    };
+    createdAt: Date;
+}
+interface Artifact {
+    id: string;
+    type: string;
+    url: string;
+    thumbnailUrl?: string;
+    metadata: Record<string, unknown>;
+}
+interface GenerationHook {
+    progress: GenerationProgress | null;
+    result: GenerationResult | null;
+    error: Error | null;
+    isGenerating: boolean;
+    submit: (request: GenerationRequest) => Promise<string>;
+    cancel: (jobId: string) => Promise<void>;
+    retry: (jobId: string) => Promise<void>;
+    history: GenerationResult[];
+    clearHistory: () => void;
+}
+declare function useGeneration(): GenerationHook;
+
+/**
+ * Hook for fetching available generators.
+ */
+
+interface Generator {
+    name: string;
+    description: string;
+    artifactType: ArtifactType;
+    inputSchema: Record<string, unknown>;
+}
+interface UseGeneratorsOptions {
+    artifactType?: string;
+}
+interface GeneratorsHook {
+    generators: Generator[];
+    loading: boolean;
+    error: Error | null;
+}
+declare function useGenerators(options?: UseGeneratorsOptions): GeneratorsHook;
+
+interface BoardsProviderProps {
+    children: ReactNode;
+    /**
+     * Base URL for the backend API (e.g., "http://localhost:8088")
+     * Used for REST endpoints like SSE streams
+     */
+    apiUrl: string;
+    /**
+     * GraphQL endpoint URL (e.g., "http://localhost:8088/graphql")
+     * If not provided, defaults to `${apiUrl}/graphql`
+     */
+    graphqlUrl?: string;
+    /**
+     * WebSocket URL for GraphQL subscriptions
+     */
+    subscriptionUrl?: string;
+    authProvider: BaseAuthProvider;
+    tenantId?: string;
+}
+declare function BoardsProvider({ children, apiUrl, graphqlUrl, subscriptionUrl, authProvider, tenantId, }: BoardsProviderProps): react_jsx_runtime.JSX.Element;
+
+declare const VERSION = "0.1.0";
+
+export { ADD_BOARD_MEMBER, type ApiConfig, ArtifactType, type AuthContextValue, AuthProvider, type AuthProviderConfig, type AuthState$1 as AuthState, BOARD_FRAGMENT, BaseAuthProvider, BoardRole, BoardsProvider, CANCEL_GENERATION, CREATE_BOARD, CREATE_GENERATION, type CreateBoardInput, type CreateGenerationInput, DELETE_BOARD, GENERATION_FRAGMENT, GET_BOARD, GET_BOARDS, GET_CURRENT_USER, GET_GENERATION, GET_GENERATIONS, GET_GENERATORS, GenerationStatus, NoAuthProvider, REMOVE_BOARD_MEMBER, RETRY_GENERATION, type SignInOptions, UPDATE_BOARD, UPDATE_BOARD_MEMBER_ROLE, USER_FRAGMENT, type UpdateBoardInput, type User$1 as User, VERSION, createGraphQLClient, useApiConfig, useAuth, useAuthOptional, useBoard, useBoards, useGeneration, useGenerators };