@fanapps/react-native 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,238 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { QueryClient, UseQueryResult, UseMutationResult } from '@tanstack/react-query';
+import { ReactNode } from 'react';
+
+interface StorageAdapter {
+    getItem(key: string): Promise<string | null>;
+    setItem(key: string, value: string): Promise<void>;
+    removeItem(key: string): Promise<void>;
+}
+
+type Locale = string;
+type EntryData = Record<string, unknown>;
+interface Entry {
+    id: string | number;
+    slug: string;
+    published: boolean;
+    date: string | null;
+    order: number | null;
+    collection: string | null;
+    blueprint: string;
+    data: EntryData;
+    created_at: string;
+    updated_at: string;
+    locale: Locale;
+    available_locales?: Locale[];
+}
+interface Article {
+    id: string | number;
+    title: string;
+    content: string;
+    is_published: boolean;
+    featured_image_url: string | null;
+    created_at: string;
+    updated_at: string;
+    locale: Locale;
+    available_locales?: Locale[];
+}
+interface TriviaAnswer {
+    id: string | number;
+    text: string;
+    is_correct: boolean;
+    sort_order: number;
+}
+interface Trivia {
+    id: string | number;
+    title: string;
+    description: string | null;
+    featured_image_id: string | number | null;
+    featured_image?: {
+        id: string | number;
+        url: string;
+        [key: string]: unknown;
+    } | null;
+    awards_points: boolean;
+    points_amount: number;
+    max_time_seconds: number | null;
+    show_correct_after: boolean;
+    starts_at: string | null;
+    ends_at: string | null;
+    answers: TriviaAnswer[];
+    responses_count?: number;
+    created_at: string;
+    updated_at: string;
+}
+interface TriviaResponseResult {
+    is_correct: boolean;
+    points_awarded: number;
+    correct_answer?: TriviaAnswer;
+}
+interface PaginationMeta {
+    current_page: number;
+    last_page: number;
+    per_page: number;
+    total: number;
+    from: number | null;
+    to: number | null;
+    path?: string;
+}
+interface PaginationLinks {
+    first: string | null;
+    last: string | null;
+    prev: string | null;
+    next: string | null;
+}
+interface Paginated<T> {
+    data: T[];
+    meta: PaginationMeta;
+    links: PaginationLinks;
+}
+interface PaginationParams {
+    page?: number;
+    perPage?: number;
+    sort?: string;
+}
+interface EntryFilters extends PaginationParams {
+    blueprint?: string;
+    collection?: string;
+    slug?: string;
+    published?: boolean;
+}
+interface ArticleFilters extends PaginationParams {
+    is_published?: boolean;
+}
+interface HookOptions {
+    locale?: Locale;
+    enabled?: boolean;
+}
+type AuthStatus = 'loading' | 'signed-in' | 'signed-out';
+interface AuthUser {
+    uid: string;
+    email: string | null;
+    displayName: string | null;
+    photoURL: string | null;
+    phoneNumber: string | null;
+    isAnonymous: boolean;
+    providerId: string | null;
+}
+interface PushTarget {
+    id: string;
+    app_user_id: number | string | null;
+    identifier: string;
+    provider: 'fcm' | 'apns';
+    provider_id: string | null;
+    device_brand: string | null;
+    device_model: string | null;
+    os_name: string | null;
+    os_version: string | null;
+    last_seen_at: string | null;
+    created_at: string;
+    updated_at: string;
+}
+interface CreatePushTargetInput {
+    targetId: string;
+    identifier: string;
+    providerId?: string;
+    deviceBrand?: string;
+    deviceModel?: string;
+    osName?: string;
+    osVersion?: string;
+}
+
+interface FanappsProviderProps {
+    apiKey: string;
+    project: string;
+    locale?: Locale;
+    baseUrl?: string;
+    queryClient?: QueryClient;
+    storage?: StorageAdapter;
+    children: ReactNode;
+}
+declare function FanappsProvider({ apiKey, project, locale, baseUrl, queryClient, storage, children, }: FanappsProviderProps): react_jsx_runtime.JSX.Element;
+
+interface FanappsClientOptions {
+    apiKey: string;
+    project: string;
+    baseUrl: string;
+    getIdToken?: () => Promise<string | null>;
+}
+type QueryParams = Record<string, unknown>;
+declare class FanappsClient {
+    private readonly apiKey;
+    private readonly project;
+    private readonly baseUrl;
+    private readonly getIdToken?;
+    constructor(options: FanappsClientOptions);
+    get<T>(path: string, params?: QueryParams, signal?: AbortSignal): Promise<T>;
+    post<T>(path: string, body?: unknown, signal?: AbortSignal): Promise<T>;
+    patch<T>(path: string, body?: unknown, signal?: AbortSignal): Promise<T>;
+    delete<T>(path: string, signal?: AbortSignal): Promise<T>;
+    createPushTarget(input: CreatePushTargetInput): Promise<PushTarget>;
+    updatePushTarget(targetId: string, identifier: string): Promise<PushTarget>;
+    deletePushTarget(targetId: string): Promise<void>;
+    private request;
+    private buildUrl;
+}
+
+declare class FanappsError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(message: string, status: number, body: unknown);
+}
+
+declare class FanappsAuthError extends Error {
+    readonly code: string;
+    constructor(message: string, code: string);
+}
+
+declare function useFanappsClient(): FanappsClient;
+
+interface UseAuthResult {
+    user: AuthUser | null;
+    status: AuthStatus;
+    signInWithEmail(email: string, password: string): Promise<AuthUser>;
+    signUpWithEmail(email: string, password: string): Promise<AuthUser>;
+    sendPasswordResetEmail(email: string): Promise<void>;
+    sendEmailVerification(): Promise<void>;
+    signInWithGoogle(): Promise<AuthUser>;
+    signInWithApple(): Promise<AuthUser>;
+    signOut(): Promise<void>;
+}
+declare function useAuth(): UseAuthResult;
+
+declare function useEntries(filters?: EntryFilters, options?: HookOptions): UseQueryResult<Paginated<Entry>>;
+
+declare function useEntry(id: string | number | null | undefined, options?: HookOptions): UseQueryResult<Entry>;
+
+declare function useArticles(filters?: ArticleFilters, options?: HookOptions): UseQueryResult<Paginated<Article>>;
+
+declare function useArticle(id: string | number | null | undefined, options?: HookOptions): UseQueryResult<Article>;
+
+interface UseRegisterDeviceResult {
+    targetId: string | null;
+    token: string | null;
+    target: PushTarget | null;
+    isRegistering: boolean;
+    error: Error | null;
+    register(): Promise<PushTarget>;
+    unregister(): Promise<void>;
+}
+declare function useRegisterDevice(): UseRegisterDeviceResult;
+
+declare function useTrivias(options?: HookOptions): UseQueryResult<Trivia[]>;
+
+declare function useTrivia(id: string | number | null | undefined, options?: HookOptions): UseQueryResult<Trivia>;
+
+interface SubmitTriviaResponseInput {
+    triviaId: string | number;
+    answerId: string | number;
+}
+declare function useSubmitTriviaResponse(): UseMutationResult<TriviaResponseResult, FanappsError, SubmitTriviaResponseInput>;
+
+interface UseTopicSubscriptionResult {
+    subscribe(topic: string): Promise<void>;
+    unsubscribe(topic: string): Promise<void>;
+}
+declare function useTopicSubscription(): UseTopicSubscriptionResult;
+
+export { type Article, type ArticleFilters, type AuthStatus, type AuthUser, type CreatePushTargetInput, type Entry, type EntryData, type EntryFilters, FanappsAuthError, FanappsClient, type FanappsClientOptions, FanappsError, FanappsProvider, type FanappsProviderProps, type HookOptions, type Locale, type Paginated, type PaginationLinks, type PaginationMeta, type PaginationParams, type PushTarget, type StorageAdapter, type SubmitTriviaResponseInput, type Trivia, type TriviaAnswer, type TriviaResponseResult, type UseAuthResult, type UseRegisterDeviceResult, type UseTopicSubscriptionResult, useArticle, useArticles, useAuth, useEntries, useEntry, useFanappsClient, useRegisterDevice, useSubmitTriviaResponse, useTopicSubscription, useTrivia, useTrivias };