@speakableio/core 0.1.21 → 0.1.23

package/dist/index.native.d.mts

@@ -0,0 +1,1291 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { QueryClient } from '@tanstack/react-query';
+import * as firebase_firestore from 'firebase/firestore';
+import { Firestore, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
+import { FirebaseFirestoreTypes, Timestamp } from '@react-native-firebase/firestore';
+
+type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
+type FirestoreHelpers = typeof firebase_firestore;
+type CustomTimestamp = Timestamp | Timestamp$1;
+type CallableFunction<T = any, R = any> = (data: T) => Promise<R>;
+
+interface Assignment {
+    name: string;
+    description: string;
+    scheduledTime?: string | null;
+    dueTime?: {
+        hours: number;
+        minutes: number;
+        nanos: number;
+    };
+    speakableio: boolean;
+    owners: string[];
+    image: {
+        path: string | null;
+        url: string;
+    };
+    dueDate: {
+        day: number;
+        month: number;
+        year: number;
+    };
+    teacherName: string;
+    courseWorkId: string | null;
+    dueDateTimestamp: CustomTimestamp;
+    scheduledTimeTimestamp: number;
+    active: boolean;
+    voice: string | null;
+    setId: string;
+    dateMade: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    maxPoints: number;
+    courseId: string;
+    isAssessment: boolean;
+    isAvailable: boolean;
+    ltiDeeplink?: string;
+}
+interface AssignmentWithId extends Assignment {
+    id: string;
+    isAvailable: boolean;
+    scores?: unknown;
+}
+interface Score {
+    userId: string;
+    owners: string[];
+    progress: number;
+    score: number;
+    cards?: {
+        [cardId: string]: CardScore;
+    };
+    courseId?: string;
+    firstLoad?: boolean;
+    googleClassroomUserId?: string;
+    skippedCards?: number;
+    lastPlayed?: CustomTimestamp;
+    startDate?: CustomTimestamp;
+    submissionDate?: CustomTimestamp;
+    status?: 'SUBMITTED' | 'PENDING_REVIEW' | 'IN_PROGRESS' | 'FINALIZED';
+    submitted?: boolean;
+    successfulCards?: number;
+    total_voiceSuccess?: number;
+    total_voice_attempts?: number;
+    total_words_spoken?: number;
+    history?: CardScore[];
+    attempts?: number;
+    assignmentId?: string;
+    setId?: string;
+}
+interface ScoreWithId extends Score {
+    id: string;
+}
+interface CardScore {
+    voiceSuccess?: number;
+    voiceAttempts?: number;
+    voiceFail?: number;
+    completed?: boolean;
+    attempts?: number;
+    correct?: number;
+    success?: boolean;
+    aiSuccess?: boolean;
+    grading_method?: 'simple' | 'rubric' | 'manual' | 'standards_based';
+    grammar_insights?: {
+        type?: string;
+        justification?: string;
+        error?: boolean;
+        correction?: string;
+    }[];
+    promptSuccess?: boolean;
+    score?: number;
+    simple_grading?: {
+        justification?: string;
+        success?: boolean;
+    };
+    suggested_response?: string;
+    summary?: string;
+    transcript?: string;
+    errors?: any;
+    improvedResponse?: string;
+    audio?: string;
+    actfl?: {
+        justification: string;
+        level: string;
+    };
+    wida?: {
+        justification: string;
+        level: string;
+    };
+    earned_points?: number;
+    fileName?: string;
+    max_points?: number;
+    passing_score?: number;
+    rubric?: {
+        description: string;
+        justification: string;
+        maxPoints: number;
+        score: number;
+        score_title: string;
+        title: string;
+    }[];
+    scoring_type?: string;
+    history?: CardScore[];
+    media_area_opened?: boolean;
+    noFeedbackAvailable?: boolean;
+    proficiency_level?: {
+        standardId: string;
+        level: string;
+        justification: string;
+        key_indicators?: string[];
+    };
+    status?: string;
+}
+
+declare const enum AssignmentAnalyticsType {
+    Macro = "macro",
+    Gradebook = "gradebook",
+    Cards = "cards",
+    Student = "student",
+    StudentSummary = "student_summary",
+    All = "all"
+}
+
+declare const createAssignmentRepo: () => {
+    getAssignment: (params: {
+        assignmentId: string;
+        currentUserId: string;
+        analyticType?: AssignmentAnalyticsType;
+        studentId?: string;
+    }) => Promise<AssignmentWithId | {
+        scores: any;
+        id: string;
+        isAvailable: boolean;
+        name: string;
+        description: string;
+        scheduledTime?: string | null;
+        dueTime?: {
+            hours: number;
+            minutes: number;
+            nanos: number;
+        };
+        speakableio: boolean;
+        owners: string[];
+        image: {
+            path: string | null;
+            url: string;
+        };
+        dueDate: {
+            day: number;
+            month: number;
+            year: number;
+        };
+        teacherName: string;
+        courseWorkId: string | null;
+        dueDateTimestamp: CustomTimestamp;
+        scheduledTimeTimestamp: number;
+        active: boolean;
+        voice: string | null;
+        setId: string;
+        dateMade: {
+            seconds: number;
+            nanoseconds: number;
+        };
+        maxPoints: number;
+        courseId: string;
+        isAssessment: boolean;
+        ltiDeeplink?: string;
+    } | null>;
+    attachScoresAssignment: (args_0: {
+        assignments: AssignmentWithId[];
+        analyticType: AssignmentAnalyticsType;
+        studentId?: string;
+        currentUserId: string;
+    }) => Promise<{
+        scores: any;
+        id: string;
+        isAvailable: boolean;
+        name: string;
+        description: string;
+        scheduledTime?: string | null;
+        dueTime?: {
+            hours: number;
+            minutes: number;
+            nanos: number;
+        };
+        speakableio: boolean;
+        owners: string[];
+        image: {
+            path: string | null;
+            url: string;
+        };
+        dueDate: {
+            day: number;
+            month: number;
+            year: number;
+        };
+        teacherName: string;
+        courseWorkId: string | null;
+        dueDateTimestamp: CustomTimestamp;
+        scheduledTimeTimestamp: number;
+        active: boolean;
+        voice: string | null;
+        setId: string;
+        dateMade: {
+            seconds: number;
+            nanoseconds: number;
+        };
+        maxPoints: number;
+        courseId: string;
+        isAssessment: boolean;
+        ltiDeeplink?: string;
+    }[]>;
+    getAssignmentScores: (args_0: {
+        assignmentId: string;
+        currentUserId: string;
+        analyticType?: AssignmentAnalyticsType;
+        studentId?: string;
+    }) => Promise<{
+        scores: unknown;
+        id: string;
+    } | undefined>;
+    getAllAssignments: () => Promise<AssignmentWithId[]>;
+};
+
+declare const assignmentQueryKeys: {
+    all: readonly ["assignments"];
+    byId: (id: string) => readonly ["assignments", string];
+    list: () => readonly ["assignments", "list"];
+};
+declare function useAssignment({ assignmentId, enabled, analyticType, userId, }: {
+    assignmentId: string;
+    enabled?: boolean;
+    analyticType?: AssignmentAnalyticsType;
+    userId: string;
+}): _tanstack_react_query.UseQueryResult<AssignmentWithId | {
+    scores: any;
+    id: string;
+    isAvailable: boolean;
+    name: string;
+    description: string;
+    scheduledTime?: string | null;
+    dueTime?: {
+        hours: number;
+        minutes: number;
+        nanos: number;
+    };
+    speakableio: boolean;
+    owners: string[];
+    image: {
+        path: string | null;
+        url: string;
+    };
+    dueDate: {
+        day: number;
+        month: number;
+        year: number;
+    };
+    teacherName: string;
+    courseWorkId: string | null;
+    dueDateTimestamp: CustomTimestamp;
+    scheduledTimeTimestamp: number;
+    active: boolean;
+    voice: string | null;
+    setId: string;
+    dateMade: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    maxPoints: number;
+    courseId: string;
+    isAssessment: boolean;
+    ltiDeeplink?: string;
+} | null, Error>;
+
+declare const enum FeedbackTypesCard {
+    SuggestedResponse = "suggested_response",
+    Wida = "wida",
+    GrammarInsights = "grammar_insights",
+    Actfl = "actfl",
+    ProficiencyLevel = "proficiency_level"
+}
+declare const enum LeniencyCard {
+    CONFIDENCE = "confidence",
+    EASY = "easy",
+    NORMAL = "normal",
+    HARD = "hard"
+}
+declare const LENIENCY_OPTIONS: {
+    label: string;
+    value: LeniencyCard;
+}[];
+declare const STUDENT_LEVELS_OPTIONS: {
+    label: string;
+    description: string;
+    value: string;
+}[];
+declare const BASE_RESPOND_FIELD_VALUES: {
+    title: string;
+    allowRetries: boolean;
+    respondTime: number;
+    maxCharacters: number;
+};
+declare const BASE_REPEAT_FIELD_VALUES: {
+    repeat: number;
+};
+declare const BASE_MULTIPLE_CHOICE_FIELD_VALUES: {
+    MCQType: string;
+    answer: string[];
+    choices: {
+        option: string;
+        value: string;
+    }[];
+};
+declare const enum VerificationCardStatus {
+    VERIFIED = "VERIFIED",
+    WARNING = "WARNING",
+    NOT_RECOMMENDED = "NOT_RECOMMENDED",
+    NOT_WORKING = "NOT_WORKING",
+    NOT_CHECKED = "NOT_CHECKED"
+}
+declare const CARDS_COLLECTION = "flashcards";
+type RefsCardsFiresotre = `${typeof CARDS_COLLECTION}/${string}`;
+declare const refsCardsFiresotre: {
+    allCards: string;
+    card: (id: string) => `flashcards/${string}`;
+};
+
+interface CardActivityWithId extends CardActivity {
+    id: string;
+}
+interface CardActivity {
+    owners: string[];
+    checked?: boolean;
+    completed?: boolean;
+    media_area_id?: string | null;
+    media_area_layout?: 'left' | 'right' | null;
+    score?: number;
+    verificationStatus?: VerificationCardStatus;
+    native_text?: string;
+    repeat?: number;
+    language?: string | null;
+    image?: {
+        path?: string | null;
+        url?: string;
+    };
+    audio?: {
+        path?: string | null;
+        url?: string;
+    } | null;
+    notes?: string;
+    difficulty?: string;
+    default_language?: string;
+    target_text?: string;
+    type: CardActivityType;
+    grading_criteria?: string;
+    scoring_type?: string;
+    grading_method?: 'simple' | 'rubric' | 'manual' | 'standards_based';
+    feedback_types?: string[];
+    rubricId?: string;
+    prompt?: string;
+    title?: string;
+    passing_score?: number;
+    maxCharacters?: number;
+    answer?: string[];
+    choices?: {
+        value: string;
+        option: string;
+    }[];
+    MCQType?: string;
+    multipleAttemptsAllowed?: boolean;
+    allowRetries?: boolean;
+    question?: string;
+    respondTime?: number;
+    hidePrompt?: boolean;
+    videoUrl?: string;
+    link?: string;
+    text?: string;
+    isListenAloud?: boolean;
+    embedCode?: string;
+    attempt?: number;
+    correct?: number;
+    autoGrade?: boolean;
+    points?: number;
+    shuffle?: boolean;
+    translation?: string;
+    includeAIContext?: boolean;
+    media_area_context_ref?: string | null;
+    standardId?: string;
+    target_proficiency_level?: string;
+    allowTTS?: boolean;
+}
+declare const enum CardActivityType {
+    READ_REPEAT = "READ_REPEAT",
+    VIDEO = "VIDEO",
+    TEXT = "TEXT",
+    READ_RESPOND = "READ_RESPOND",
+    FREE_RESPONSE = "FREE_RESPONSE",
+    REPEAT = "REPEAT",
+    RESPOND = "RESPOND",
+    RESPOND_WRITE = "RESPOND_WRITE",
+    TEXT_TO_SPEECH = "TEXT_TO_SPEECH",
+    MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
+    PODCAST = "PODCAST",
+    MEDIA_PAGE = "MEDIA_PAGE",
+    WRITE = "WRITE",
+    SHORT_ANSWER = "SHORT_ANSWER",
+    SHORT_STORY = "SHORT_STORY",
+    SPEAK = "SPEAK",
+    CONVERSATION = "CONVERSATION",
+    CONVERSATION_WRITE = "CONVERSATION_WRITE",
+    DIALOGUE = "DIALOGUE",
+    INSTRUCTION = "INSTRUCTION",
+    LISTEN = "LISTEN",
+    READ = "READ",
+    ANSWER = "ANSWER"
+}
+declare const RESPOND_CARD_ACTIVITY_TYPES: CardActivityType[];
+declare const MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES: CardActivityType[];
+declare const REPEAT_CARD_ACTIVITY_TYPES: CardActivityType[];
+declare const RESPOND_WRITE_CARD_ACTIVITY_TYPES: CardActivityType[];
+declare const RESPOND_AUDIO_CARD_ACTIVITY_TYPES: CardActivityType[];
+declare const ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY: CardActivityType[];
+
+declare const cardsQueryKeys: {
+    all: string[];
+    one: (params: {
+        cardId: string;
+    }) => string[];
+};
+declare function useCards({ cardIds, enabled, asObject, }: {
+    cardIds: string[];
+    enabled: boolean;
+    asObject?: boolean;
+}): {
+    cards: CardActivityWithId[];
+    cardsObject: Record<string, CardActivityWithId> | null;
+    cardsQueries: _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>[];
+};
+declare function useCreateCard(): {
+    mutationCreateCard: _tanstack_react_query.UseMutationResult<{
+        id: string;
+    } & Partial<CardActivity>, Error, {
+        data: Partial<CardActivity>;
+    }, unknown>;
+};
+declare function useCreateCards(): {
+    mutationCreateCards: _tanstack_react_query.UseMutationResult<{
+        id: string;
+        owners: string[];
+        checked?: boolean;
+        completed?: boolean;
+        media_area_id?: string | null;
+        media_area_layout?: "left" | "right" | null;
+        score?: number;
+        verificationStatus?: VerificationCardStatus;
+        native_text?: string;
+        repeat?: number;
+        language?: string | null;
+        image?: {
+            path?: string | null;
+            url?: string;
+        };
+        audio?: {
+            path?: string | null;
+            url?: string;
+        } | null;
+        notes?: string;
+        difficulty?: string;
+        default_language?: string;
+        target_text?: string;
+        type: CardActivityType;
+        grading_criteria?: string;
+        scoring_type?: string;
+        grading_method?: "simple" | "rubric" | "manual" | "standards_based";
+        feedback_types?: string[];
+        rubricId?: string;
+        prompt?: string;
+        title?: string;
+        passing_score?: number;
+        maxCharacters?: number;
+        answer?: string[];
+        choices?: {
+            value: string;
+            option: string;
+        }[];
+        MCQType?: string;
+        multipleAttemptsAllowed?: boolean;
+        allowRetries?: boolean;
+        question?: string;
+        respondTime?: number;
+        hidePrompt?: boolean;
+        videoUrl?: string;
+        link?: string;
+        text?: string;
+        isListenAloud?: boolean;
+        embedCode?: string;
+        attempt?: number;
+        correct?: number;
+        autoGrade?: boolean;
+        points?: number;
+        shuffle?: boolean;
+        translation?: string;
+        includeAIContext?: boolean;
+        media_area_context_ref?: string | null;
+        standardId?: string;
+        target_proficiency_level?: string;
+        allowTTS?: boolean;
+    }[], Error, {
+        cards: CardActivity[];
+    }, unknown>;
+};
+declare function getCardFromCache({ cardId, queryClient, }: {
+    cardId: string;
+    queryClient: QueryClient;
+}): CardActivityWithId | undefined;
+declare function updateCardInCache({ cardId, card, queryClient, }: {
+    cardId: string;
+    card: CardActivityWithId | null;
+    queryClient: QueryClient;
+}): void;
+
+declare const createCardRepo: () => {
+    createCard: (args_0: {
+        data: Partial<CardActivity>;
+    }) => Promise<{
+        id: string;
+    } & Partial<CardActivity>>;
+    createCards: (args_0: {
+        cards: CardActivity[];
+    }) => Promise<{
+        id: string;
+        owners: string[];
+        checked?: boolean;
+        completed?: boolean;
+        media_area_id?: string | null;
+        media_area_layout?: "left" | "right" | null;
+        score?: number;
+        verificationStatus?: VerificationCardStatus;
+        native_text?: string;
+        repeat?: number;
+        language?: string | null;
+        image?: {
+            path?: string | null;
+            url?: string;
+        };
+        audio?: {
+            path?: string | null;
+            url?: string;
+        } | null;
+        notes?: string;
+        difficulty?: string;
+        default_language?: string;
+        target_text?: string;
+        type: CardActivityType;
+        grading_criteria?: string;
+        scoring_type?: string;
+        grading_method?: "simple" | "rubric" | "manual" | "standards_based";
+        feedback_types?: string[];
+        rubricId?: string;
+        prompt?: string;
+        title?: string;
+        passing_score?: number;
+        maxCharacters?: number;
+        answer?: string[];
+        choices?: {
+            value: string;
+            option: string;
+        }[];
+        MCQType?: string;
+        multipleAttemptsAllowed?: boolean;
+        allowRetries?: boolean;
+        question?: string;
+        respondTime?: number;
+        hidePrompt?: boolean;
+        videoUrl?: string;
+        link?: string;
+        text?: string;
+        isListenAloud?: boolean;
+        embedCode?: string;
+        attempt?: number;
+        correct?: number;
+        autoGrade?: boolean;
+        points?: number;
+        shuffle?: boolean;
+        translation?: string;
+        includeAIContext?: boolean;
+        media_area_context_ref?: string | null;
+        standardId?: string;
+        target_proficiency_level?: string;
+        allowTTS?: boolean;
+    }[]>;
+    getCard: (params: {
+        cardId: string;
+    }) => Promise<CardActivityWithId | null>;
+};
+
+interface SetWithId extends Set {
+    id: string;
+}
+interface Set {
+    id: string;
+    language: string;
+    ownerName: string;
+    weights: Record<string, number>;
+    repeat?: number;
+    voice?: string;
+    averagePhraseLength?: number;
+    passing_score?: number;
+    organizations?: string[];
+    description: string;
+    image: {
+        url: string;
+        path: null | string;
+    };
+    additionalLanguages?: string[];
+    owners: string[];
+    name: string;
+    content: string[];
+    types: {
+        [key in CardActivityType]?: number;
+    };
+    defaultLanguage: string;
+    createdAt: FieldValue;
+    public: boolean;
+    defaultRubricId?: string;
+    difficulty?: string;
+    end_screen?: {
+        variant: 0 | 1 | 2;
+        title: string;
+        description: string;
+    };
+    mcAllowRetries?: boolean;
+    welcome_screen?: {
+        variant: 'colored' | 'blank';
+    };
+    poorFunctionalityWarning?: boolean;
+    status?: 'draft' | 'published';
+    subjects?: any[];
+    respondAllowRetries?: boolean;
+    respondAllowTTS?: boolean;
+    feedbackLanguage?: string;
+    respondMaxCharacters?: number;
+    respondMaxTime?: number;
+}
+
+declare const setsQueryKeys: {
+    all: string[];
+    one: (params: {
+        setId: string;
+    }) => string[];
+};
+declare const useSet: ({ setId, enabled }: {
+    setId: string;
+    enabled?: boolean;
+}) => _tanstack_react_query.UseQueryResult<SetWithId | null, Error>;
+declare function getSetFromCache({ setId, queryClient, }: {
+    setId: string | undefined;
+    queryClient: QueryClient;
+}): SetWithId | null | undefined;
+declare function updateSetInCache({ set, queryClient, }: {
+    set: SetWithId;
+    queryClient: QueryClient;
+}): void;
+
+declare const SETS_COLLECTION = "sets";
+type RefsSetsFirestore = `${typeof SETS_COLLECTION}/${string}`;
+declare const refsSetsFirestore: {
+    allSets: string;
+    set: (id: string) => `sets/${string}`;
+};
+
+declare const createSetRepo: () => {
+    getSet: (args_0: {
+        setId: string;
+    }) => Promise<SetWithId | null>;
+};
+
+declare const SPEAKABLE_NOTIFICATIONS: {
+    readonly NEW_ASSIGNMENT: "new_assignment";
+    readonly ASSESSMENT_SUBMITTED: "assessment_submitted";
+    readonly ASSESSMENT_SCORED: "assessment_scored";
+    readonly NEW_COMMENT: "NEW_COMMENT";
+};
+type SpeakableNotificationType = (typeof SPEAKABLE_NOTIFICATIONS)[keyof typeof SPEAKABLE_NOTIFICATIONS];
+declare const SpeakableNotificationTypes: {
+    NEW_ASSIGNMENT: string;
+    FEEDBACK_FROM_TEACHER: string;
+    MESSAGE_FROM_STUDENT: string;
+    PHRASE_MARKED_CORRECT: string;
+    STUDENT_PROGRESS: string;
+    PLAYLIST_FOLLOWERS: string;
+    PLAYLIST_PLAYS: string;
+    ASSESSMENT_SUBMITTED: string;
+    ASSESSMENT_SCORED: string;
+    NEW_COMMENT: string;
+};
+
+declare const useCreateNotification: () => {
+    createNotification: (type: SpeakableNotificationType, data: any) => Promise<any>;
+};
+
+type FsClient = ReturnType<typeof createFsClientBase>;
+declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
+    db: FirebaseInstance;
+    helpers: FirestoreHelpers;
+    httpsCallable: (name: string) => CallableFunction;
+    logEvent: (name: string, data: any) => void;
+}): {
+    assignmentRepo: {
+        getAssignment: (params: {
+            assignmentId: string;
+            currentUserId: string;
+            analyticType?: AssignmentAnalyticsType;
+            studentId?: string;
+        }) => Promise<AssignmentWithId | {
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+        } | null>;
+        attachScoresAssignment: (args_0: {
+            assignments: AssignmentWithId[];
+            analyticType: AssignmentAnalyticsType;
+            studentId?: string;
+            currentUserId: string;
+        }) => Promise<{
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+        }[]>;
+        getAssignmentScores: (args_0: {
+            assignmentId: string;
+            currentUserId: string;
+            analyticType?: AssignmentAnalyticsType;
+            studentId?: string;
+        }) => Promise<{
+            scores: unknown;
+            id: string;
+        } | undefined>;
+        getAllAssignments: () => Promise<AssignmentWithId[]>;
+    };
+    cardRepo: {
+        createCard: (args_0: {
+            data: Partial<CardActivity>;
+        }) => Promise<{
+            id: string;
+        } & Partial<CardActivity>>;
+        createCards: (args_0: {
+            cards: CardActivity[];
+        }) => Promise<{
+            id: string;
+            owners: string[];
+            checked?: boolean;
+            completed?: boolean;
+            media_area_id?: string | null;
+            media_area_layout?: "left" | "right" | null;
+            score?: number;
+            verificationStatus?: VerificationCardStatus;
+            native_text?: string;
+            repeat?: number;
+            language?: string | null;
+            image?: {
+                path?: string | null;
+                url?: string;
+            };
+            audio?: {
+                path?: string | null;
+                url?: string;
+            } | null;
+            notes?: string;
+            difficulty?: string;
+            default_language?: string;
+            target_text?: string;
+            type: CardActivityType;
+            grading_criteria?: string;
+            scoring_type?: string;
+            grading_method?: "simple" | "rubric" | "manual" | "standards_based";
+            feedback_types?: string[];
+            rubricId?: string;
+            prompt?: string;
+            title?: string;
+            passing_score?: number;
+            maxCharacters?: number;
+            answer?: string[];
+            choices?: {
+                value: string;
+                option: string;
+            }[];
+            MCQType?: string;
+            multipleAttemptsAllowed?: boolean;
+            allowRetries?: boolean;
+            question?: string;
+            respondTime?: number;
+            hidePrompt?: boolean;
+            videoUrl?: string;
+            link?: string;
+            text?: string;
+            isListenAloud?: boolean;
+            embedCode?: string;
+            attempt?: number;
+            correct?: number;
+            autoGrade?: boolean;
+            points?: number;
+            shuffle?: boolean;
+            translation?: string;
+            includeAIContext?: boolean;
+            media_area_context_ref?: string | null;
+            standardId?: string;
+            target_proficiency_level?: string;
+            allowTTS?: boolean;
+        }[]>;
+        getCard: (params: {
+            cardId: string;
+        }) => Promise<CardActivityWithId | null>;
+    };
+};
+
+interface UserProfile {
+    googleClassroomUserId: string;
+    image: {
+        url: string;
+        path: string;
+    };
+    displayName: string;
+}
+interface UserAuth {
+    uid: string;
+    email: string;
+    displayName: string | null;
+}
+interface Lti {
+    data: {
+        services: {
+            serviceKey: string;
+        };
+    };
+}
+interface User {
+    profile: UserProfile;
+    auth: UserAuth;
+    lti: Lti;
+    roles: string[];
+}
+
+declare const SpeakablePlanTypes: {
+    readonly basic: "basic";
+    readonly teacher_pro: "teacher_pro";
+    readonly school_starter: "school_starter";
+    readonly organization: "organization";
+    readonly starter: "starter";
+    readonly growth: "growth";
+    readonly professional: "professional";
+};
+
+interface Permissions {
+    loaded: boolean;
+    loading: boolean;
+    permissions: string[];
+    plan: keyof typeof SpeakablePlanTypes;
+    subscriptionId: string;
+    isInstitutionPlan: boolean;
+    type: string;
+    contact: string;
+    hasStudentPortfolios?: boolean;
+    refreshDate: string;
+    isStripePlan: boolean;
+    freeOrgTrialExpired?: boolean;
+}
+
+interface FsContext {
+    speakableApi: Awaited<FsClient>;
+    queryClient: QueryClient;
+    user: User;
+    permissions: Permissions;
+}
+declare const FsCtx: React.Context<FsContext | null>;
+declare function SpeakableProvider({ user, children, queryClient, permissions, fsClient, }: {
+    children: React.ReactNode;
+    fsClient: FsClient;
+    permissions: Permissions;
+    queryClient: QueryClient;
+    user: User;
+}): react_jsx_runtime.JSX.Element | null;
+declare function useSpeakableApi(): FsContext;
+
+declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData, }: {
+    id: string;
+    isAssignment: boolean;
+    onAssignmentSubmitted: (assignmentId: string) => void;
+    ltiData?: {
+        lineItemId?: string;
+        lti_id?: string;
+        serviceKey?: string;
+    };
+}): {
+    set: {
+        data: SetWithId | null | undefined;
+        query: _tanstack_react_query.UseQueryResult<SetWithId | null, Error>;
+    };
+    cards: {
+        data: Record<string, CardActivityWithId> | null;
+        query: _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>[];
+        cardsArray: CardActivityWithId[];
+    };
+    assignment: {
+        data: AssignmentWithId | {
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+        } | null | undefined;
+        query: _tanstack_react_query.UseQueryResult<AssignmentWithId | {
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+        } | null, Error>;
+    };
+    scores: {
+        data: ScoreWithId | undefined;
+        query: _tanstack_react_query.UseQueryResult<ScoreWithId, Error>;
+        actions: {
+            update: (data: Partial<Score>) => void;
+            clear: ({ cardId, wasCompleted, }: {
+                cardId: string;
+                wasCompleted?: boolean;
+            }) => void;
+            submit: () => Promise<{
+                success: boolean;
+                message: string;
+                error?: undefined;
+            } | {
+                success: boolean;
+                error: unknown;
+                message?: undefined;
+            }>;
+            updateCard: (cardId: string, cardScore: CardScore) => void;
+            logGradingStandardEntry: ({ cardId, gradingStandard, type, }: {
+                cardId: string;
+                gradingStandard: {
+                    level: string;
+                    justification: string;
+                };
+                type: "actfl" | "wida" | "custom";
+            }) => void;
+        };
+    };
+};
+
+declare const createFsClientNative: ({ db, httpsCallable, logEvent, }: Parameters<typeof createFsClientBase>[0]) => {
+    assignmentRepo: {
+        getAssignment: (params: {
+            assignmentId: string;
+            currentUserId: string;
+            analyticType?: AssignmentAnalyticsType;
+            studentId?: string;
+        }) => Promise<AssignmentWithId | {
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+        } | null>;
+        attachScoresAssignment: (args_0: {
+            assignments: AssignmentWithId[];
+            analyticType: AssignmentAnalyticsType;
+            studentId?: string;
+            currentUserId: string;
+        }) => Promise<{
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+        }[]>;
+        getAssignmentScores: (args_0: {
+            assignmentId: string;
+            currentUserId: string;
+            analyticType?: AssignmentAnalyticsType;
+            studentId?: string;
+        }) => Promise<{
+            scores: unknown;
+            id: string;
+        } | undefined>;
+        getAllAssignments: () => Promise<AssignmentWithId[]>;
+    };
+    cardRepo: {
+        createCard: (args_0: {
+            data: Partial<CardActivity>;
+        }) => Promise<{
+            id: string;
+        } & Partial<CardActivity>>;
+        createCards: (args_0: {
+            cards: CardActivity[];
+        }) => Promise<{
+            id: string;
+            owners: string[];
+            checked?: boolean;
+            completed?: boolean;
+            media_area_id?: string | null;
+            media_area_layout?: "left" | "right" | null;
+            score?: number;
+            verificationStatus?: VerificationCardStatus;
+            native_text?: string;
+            repeat?: number;
+            language?: string | null;
+            image?: {
+                path?: string | null;
+                url?: string;
+            };
+            audio?: {
+                path?: string | null;
+                url?: string;
+            } | null;
+            notes?: string;
+            difficulty?: string;
+            default_language?: string;
+            target_text?: string;
+            type: CardActivityType;
+            grading_criteria?: string;
+            scoring_type?: string;
+            grading_method?: "simple" | "rubric" | "manual" | "standards_based";
+            feedback_types?: string[];
+            rubricId?: string;
+            prompt?: string;
+            title?: string;
+            passing_score?: number;
+            maxCharacters?: number;
+            answer?: string[];
+            choices?: {
+                value: string;
+                option: string;
+            }[];
+            MCQType?: string;
+            multipleAttemptsAllowed?: boolean;
+            allowRetries?: boolean;
+            question?: string;
+            respondTime?: number;
+            hidePrompt?: boolean;
+            videoUrl?: string;
+            link?: string;
+            text?: string;
+            isListenAloud?: boolean;
+            embedCode?: string;
+            attempt?: number;
+            correct?: number;
+            autoGrade?: boolean;
+            points?: number;
+            shuffle?: boolean;
+            translation?: string;
+            includeAIContext?: boolean;
+            media_area_context_ref?: string | null;
+            standardId?: string;
+            target_proficiency_level?: string;
+            allowTTS?: boolean;
+        }[]>;
+        getCard: (params: {
+            cardId: string;
+        }) => Promise<CardActivityWithId | null>;
+    };
+};
+
+export { ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardActivity, CardActivityType, type CardActivityWithId, type CardScore, FeedbackTypesCard, FsCtx, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, REPEAT_CARD_ACTIVITY_TYPES, RESPOND_AUDIO_CARD_ACTIVITY_TYPES, RESPOND_CARD_ACTIVITY_TYPES, RESPOND_WRITE_CARD_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, createAssignmentRepo, createCardRepo, createFsClientNative as createFsClient, createSetRepo, getCardFromCache, getSetFromCache, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useAssignment, useCards, useCreateCard, useCreateCards, useCreateNotification, useSet, useSpeakableApi };