@speakableio/core 0.1.32 → 0.1.34

package/dist/index.web.d.mts

@@ -3,7 +3,7 @@ import React from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
 import { FirebaseFirestoreTypes, Timestamp } from '@react-native-firebase/firestore';
-import { Firestore, getDoc, getDocs, addDoc, setDoc, updateDoc, deleteDoc, runTransaction, writeBatch, doc, collection, query, serverTimestamp, orderBy, limit, startAt, startAfter, endAt, endBefore, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
+import { Firestore, getDoc, getDocs, addDoc, setDoc, updateDoc, deleteDoc, runTransaction, writeBatch, doc, collection, query, serverTimestamp, orderBy, limit, startAt, startAfter, endAt, endBefore, where, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
 
 type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
 interface FirestoreHelpers {
@@ -25,6 +25,7 @@ interface FirestoreHelpers {
     startAfter: typeof startAfter;
     endAt: typeof endAt;
     endBefore: typeof endBefore;
+    where: typeof where;
 }
 type CustomTimestamp = Timestamp | Timestamp$1;
 type CallableFunction<T = any, R = any> = (data: T) => Promise<R>;
@@ -277,7 +278,9 @@ declare const createAssignmentRepo: () => {
         scores: unknown;
         id: string;
     } | undefined>;
-    getAllAssignments: () => Promise<AssignmentWithId[]>;
+    getAllAssignments: () => Promise<(AssignmentWithId & {
+        id: string;
+    })[]>;
 };
 
 declare const assignmentQueryKeys: {
@@ -872,7 +875,9 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             scores: unknown;
             id: string;
         } | undefined>;
-        getAllAssignments: () => Promise<AssignmentWithId[]>;
+        getAllAssignments: () => Promise<(AssignmentWithId & {
+            id: string;
+        })[]>;
     };
     cardRepo: {
         createCard: (args_0: {
@@ -957,6 +962,9 @@ interface UserProfile {
         path: string;
     };
     displayName: string;
+    isTeacher?: boolean;
+    isStudent?: boolean;
+    roles?: string[];
 }
 interface UserAuth {
     uid: string;
@@ -1018,6 +1026,87 @@ declare function SpeakableProvider({ user, children, queryClient, permissions, f
 }): react_jsx_runtime.JSX.Element | null;
 declare function useSpeakableApi(): FsContext;
 
+declare const getRespondCardTool: ({ language, standard, }: {
+    language: string;
+    standard: string;
+}) => {
+    tool_choice: {
+        type: string;
+        function: {
+            name: string;
+        };
+    };
+    tools: {
+        type: string;
+        function: {
+            name: string;
+            description: string;
+            parameters: {
+                type: string;
+                required: string[];
+                properties: {
+                    success: {
+                        type: string;
+                        description: string;
+                    };
+                    errors: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            properties: {
+                                error: {
+                                    type: string;
+                                    description: string;
+                                };
+                                correction: {
+                                    type: string;
+                                    description: string;
+                                };
+                                justification: {
+                                    type: string;
+                                    description: string;
+                                };
+                                grammar_error_type: {
+                                    type: string;
+                                    enum: string[];
+                                    description: string;
+                                };
+                            };
+                        };
+                        description: string;
+                    };
+                    compliments: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                        description: string;
+                    };
+                    improvedResponse: {
+                        type: string;
+                        description: string;
+                    };
+                    score: {
+                        type: string;
+                        description: string;
+                    };
+                    score_justification: {
+                        type: string;
+                        description: string;
+                    };
+                };
+            };
+        };
+    }[];
+};
+
+declare function debounce<T extends (...args: any[]) => Promise<any>>(func: T, waitFor: number): (...args: Parameters<T>) => Promise<ReturnType<T>>;
+
+declare const purify: (word: string) => string;
+declare const cleanString: (words: string) => string | string[];
+declare const getWordHash: (word: string, language: string) => string;
+
 declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData, }: {
     id: string;
     isAssignment: boolean;
@@ -1154,6 +1243,1173 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
     };
 };
 
+interface CreditContract {
+    allocationSource: string;
+    createdAt: string;
+    creditsAllocatedThisPeriod: number;
+    effectivePlanId: string;
+    email: string;
+    isUnlimited: boolean;
+    lastUpdatedAt: string;
+    ownerType: string;
+    periodStart: string;
+    periodEnd: string;
+    planTermEndTimestamp: string | null;
+    sourceDetails: Record<string, unknown>;
+    creditsAvailable?: number;
+    topOffCreditsAvailable?: number;
+}
+declare const creditQueryKeys: {
+    userCredits: (uid: string) => readonly ["userCredits", string];
+};
+declare const useUserCredits: () => {
+    data: {
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    };
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }>;
+} | {
+    data: {
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    };
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }>;
+} | {
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }>;
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }>;
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }>;
+} | {
+    data: {
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    };
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<{
+        id: string;
+        userId: string;
+        email: string;
+        effectivePlanId: string;
+        status: string;
+        isUnlimited: boolean;
+        creditsAvailable: number;
+        creditsAllocatedThisPeriod: number;
+        topOffCreditsAvailable: number;
+        topOffCreditsTotal: number;
+        allocationSource: string;
+        sourceDetails: {};
+        periodStart: null;
+        periodEnd: null;
+        planTermEndTimestamp: null;
+        ownerType: string;
+        createdAt: string;
+        lastUpdatedAt: string;
+    } | {
+        totalCreditsAvailable: number;
+        allocationSource: string;
+        createdAt: string;
+        creditsAllocatedThisPeriod: number;
+        effectivePlanId: string;
+        email: string;
+        isUnlimited: boolean;
+        lastUpdatedAt: string;
+        ownerType: string;
+        periodStart: string;
+        periodEnd: string;
+        planTermEndTimestamp: string | null;
+        sourceDetails: Record<string, unknown>;
+        creditsAvailable?: number;
+        topOffCreditsAvailable?: number;
+        id: string;
+        userId?: undefined;
+        status?: undefined;
+        topOffCreditsTotal?: undefined;
+    }>;
+};
+
+interface OrganizationAccess {
+    hasUnlimitedAccess: boolean;
+    subscriptionId: string | null;
+    organizationId: string | null;
+    organizationName: string | null;
+    subscriptionEndDate: Date | null;
+    accessType: 'organization' | 'individual' | 'institution_subscriptions';
+}
+interface InstitutionSubscription {
+    id: string;
+    institutionId: string;
+    name: string;
+    plan: string;
+    endDate: Date;
+}
+interface Organization {
+    id: string;
+    name: string;
+    members: string[];
+    masterSubscriptionStatus: string;
+    masterSubscriptionId: string;
+    masterSubscriptionEndDate: Date;
+}
+declare const useOrganizationAccess: () => {
+    data: OrganizationAccess;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<OrganizationAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<OrganizationAccess>;
+} | {
+    data: OrganizationAccess;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<OrganizationAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<OrganizationAccess>;
+} | {
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<OrganizationAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<OrganizationAccess>;
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<OrganizationAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<OrganizationAccess>;
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<OrganizationAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<OrganizationAccess>;
+} | {
+    data: OrganizationAccess;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<OrganizationAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<OrganizationAccess>;
+};
+
+declare const useBaseOpenAI: ({ onTranscriptSuccess, onTranscriptError, onCompletionSuccess, onCompletionError, aiEnabled, submitAudioResponse, uploadAudioAndGetTranscript, }: {
+    onTranscriptSuccess: (transcript: string) => void;
+    onTranscriptError: ({ type, message }: {
+        type: string;
+        message: string;
+    }) => void;
+    onCompletionSuccess: (completion: any) => void;
+    onCompletionError: ({ type, message }: {
+        type: string;
+        message: string;
+    }) => void;
+    aiEnabled: boolean;
+    submitAudioResponse: (audio: string) => Promise<{
+        url: string;
+        fileName: string;
+    }>;
+    uploadAudioAndGetTranscript: (audio: string, language: string) => Promise<string>;
+}) => {
+    submitAudioResponse: (audio: string) => Promise<{
+        url: string;
+        fileName: string;
+    }>;
+    uploadAudioAndGetTranscript: (audio: string, language: string) => Promise<string>;
+    getTransctipt: (audioUrl: string, language: string) => Promise<string>;
+    getFreeResponseCompletion: (messages: string[], isFreeResponse: boolean, feedbackLanguage: string, gradingStandard?: string) => Promise<any>;
+    getFeedback: ({ cardId, language, writtenResponse, audio, autoGrade, file, }: {
+        cardId: string;
+        language: string;
+        writtenResponse: string | null;
+        audio: string | null;
+        autoGrade: boolean;
+        file: string | null;
+    }) => Promise<{
+        noFeedbackAvailable: boolean;
+        success: boolean;
+        reason: string;
+        accessType: "ai_enabled" | "teacher_preview" | "student_with_teacher_plan" | "none";
+    } | {
+        noFeedbackAvailable: boolean;
+        success: boolean;
+        reason: string;
+        accessType: string;
+        aiSuccess: boolean;
+    }>;
+};
+
+interface ActivityFeedbackAccess {
+    canAccessFeedback: boolean;
+    reason?: string;
+    isUnlimited: boolean;
+    accessType: 'ai_enabled' | 'teacher_preview' | 'student_with_teacher_plan' | 'none';
+}
+/**
+ * Hook to check feedback permissions for both students and teachers
+ *
+ * Permission Logic:
+ * 1. aiEnabled: true → Allow feedback access always (highest priority)
+ * 2. Teachers on /activity route → Always allowed (ADMIN role)
+ * 3. Students on /activity route → Need teacher with active plan (team/org)
+ *
+ * @param params - Parameters for permission checking
+ * @returns Feedback permissions information
+ */
+declare const useActivityFeedbackAccess: ({ aiEnabled, isActivityRoute, }: {
+    aiEnabled?: boolean;
+    isActivityRoute?: boolean;
+}) => {
+    data: ActivityFeedbackAccess;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: true;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ActivityFeedbackAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<ActivityFeedbackAccess>;
+} | {
+    data: ActivityFeedbackAccess;
+    error: null;
+    isError: false;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: false;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ActivityFeedbackAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<ActivityFeedbackAccess>;
+} | {
+    data: undefined;
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "error";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ActivityFeedbackAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<ActivityFeedbackAccess>;
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoading: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ActivityFeedbackAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<ActivityFeedbackAccess>;
+} | {
+    data: undefined;
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isLoading: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ActivityFeedbackAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<ActivityFeedbackAccess>;
+} | {
+    data: ActivityFeedbackAccess;
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoading: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    dataUpdatedAt: number;
+    errorUpdatedAt: number;
+    failureCount: number;
+    failureReason: Error | null;
+    errorUpdateCount: number;
+    isFetched: boolean;
+    isFetchedAfterMount: boolean;
+    isFetching: boolean;
+    isInitialLoading: boolean;
+    isPaused: boolean;
+    isRefetching: boolean;
+    isStale: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<ActivityFeedbackAccess, Error>>;
+    fetchStatus: _tanstack_react_query.FetchStatus;
+    promise: Promise<ActivityFeedbackAccess>;
+};
+
 declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParams) => {
     assignmentRepo: {
         getAssignment: (params: {
@@ -1259,7 +2515,9 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             scores: unknown;
             id: string;
         } | undefined>;
-        getAllAssignments: () => Promise<AssignmentWithId[]>;
+        getAllAssignments: () => Promise<(AssignmentWithId & {
+            id: string;
+        })[]>;
     };
     cardRepo: {
         createCard: (args_0: {
@@ -1337,4 +2595,4 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
     };
 };
 
-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, createFsClientWeb as createFsClient, createSetRepo, getCardFromCache, getSetFromCache, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useAssignment, useCards, useCreateCard, useCreateCards, useCreateNotification, useSet, useSpeakableApi };
+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, type CreditContract, FeedbackTypesCard, FsCtx, type InstitutionSubscription, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, type Organization, type OrganizationAccess, 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, cleanString, createAssignmentRepo, createCardRepo, createFsClientWeb as createFsClient, createSetRepo, creditQueryKeys, debounce, getCardFromCache, getRespondCardTool, getSetFromCache, getWordHash, purify, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useActivityFeedbackAccess, useAssignment, useBaseOpenAI, useCards, useCreateCard, useCreateCards, useCreateNotification, useOrganizationAccess, useSet, useSpeakableApi, useUserCredits };