@speakableio/core 0.1.105 → 1.0.0

package/dist/everything.d.ts

@@ -0,0 +1,1348 @@
+export { A as ANALYTICS_EVENT_TYPES, W as WEB_BASE_URL } from './web.constants-qmx4rGyO.js';
+export { a as AI_ASSISTANT_PLANS, c as ANALYTICS_PLANS, b as ASSIGNMENT_SETTINGS_PLANS, A as AUTO_GRADING_PLANS, C as COMMENTS_PLANS, D as DISCOVER_PLANS, F as FEEDBACK_PLANS, d as FREE_PLAN, I as INTEGRATIONS_PLANS, M as MEDIA_AREA_PLANS, O as ORGANIZATION_PLAN, e as SCHOOL_STARTER, S as SPACES_PLANS, g as SpeakablePermissionsMap, h as SpeakablePlanHierarchy, f as SpeakablePlanTypes, T as TEACHER_PRO_PLAN } from './speakable-plans-Dq9nRefI.js';
+import { A as AssignmentWithId, C as CustomTimestamp, a as ActivityPageType, P as PageScore, S as Score, b as ScoreWithId, c as PageActivity, d as PageActivityWithId, F as FirestoreHelpers, e as CallableFunction } from './assignment.model-Bc61gBHl.js';
+export { f as Assignment, j as FirebaseInstance, k as FirestoreDB, M as MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES, g as REPEAT_PAGE_ACTIVITY_TYPES, i as RESPOND_AUDIO_PAGE_ACTIVITY_TYPES, R as RESPOND_PAGE_ACTIVITY_TYPES, h as RESPOND_WRITE_PAGE_ACTIVITY_TYPES } from './assignment.model-Bc61gBHl.js';
+import { SetWithId } from './models.js';
+export { Set } from './models.js';
+import { U as User, F as FsClientParams } from './index.web-DNYJV_41.js';
+export { a as FsCtx, P as Permissions, S as SpeakableProvider, c as createFsClient, u as useSpeakableApi } from './index.web-DNYJV_41.js';
+export { ActivityFeedbackAccess, InstitutionSubscription, Organization, OrganizationAccess, StudentTeacherPlanResult, activityFeedbackAccessQueryKeys, assignmentQueryKeys, cardsQueryKeys, getCardFromCache, getSetFromCache, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useActivityFeedbackAccess, useAssignment, useBaseOpenAI, useCards, useClearScore, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useGoogleClassroom, useOrganizationAccess, useScore, useSet, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore, useUpdateStudentVocab, useUserPlan } from './hooks.js';
+import * as _tanstack_react_query from '@tanstack/react-query';
+export { checkAssignmentAvailability, checkTypePageActivity, cleanString, debounce, defaultScore, getLabelPage, getPagePrompt, getPhraseLength, getRespondCardTool, getTotalCompletedCards, getWordHash, purify } from './utils.js';
+export { G as GradingStandard, a as addGradingStandardLog, e as logCreateAssignment, r as logFreePlanRespond, s as logFreePlanWrittenResponse, l as logGradingStandardLog, v as logMultipleChoiceError, u as logMultipleChoiceFail, t as logMultipleChoiceSuccess, c as logOpenActivityPreview, b as logOpenAssignment, h as logRepeatFail, g as logRepeatSuccess, m as logRespondError, j as logRespondFail, k as logRespondSubmitted, i as logRespondSuccess, f as logStartAssignment, d as logSubmitAssignment, q as logWrittenResponseError, o as logWrittenResponseFail, p as logWrittenResponseSubmitted, n as logWrittenResponseSuccess } from './analytics-Bj2i88Zk.js';
+import { A as AssignmentAnalyticsType } from './assignment.constants-BIKM6fYi.js';
+import { V as VerificationCardStatus } from './card.constants-DhKFipX3.js';
+import { a as SpeakableNotificationType } from './notification.constants-B72fb734.js';
+export { createAssignmentRepo, createCardRepo, createSetRepo } from './repos.js';
+import * as _firebase_firestore from '@firebase/firestore';
+import { Firestore, DocumentData, QueryConstraint, WithFieldValue, SetOptions } from 'firebase/firestore';
+import '@react-native-firebase/firestore';
+import 'react/jsx-runtime';
+import 'react';
+
+declare function useActivityTracker({ userId }: {
+    userId: string;
+}): {
+    trackActivity: ({ activityName, activityType, id, language, }: {
+        activityName: string;
+        activityType: "assignment" | "assessment" | "set";
+        id?: string;
+        language?: string;
+    }) => Promise<void>;
+};
+
+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;
+    }>;
+};
+
+declare const 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;
+    content?: string[];
+    weights?: Record<string, number>;
+    language?: string;
+    types?: { [key in ActivityPageType]?: number; };
+    aiEnabled?: boolean;
+    chat_experience?: boolean;
+}[]>;
+
+declare function clearScore(params: {
+    isAssignment: boolean;
+    cardId: string;
+    cardScores: PageScore;
+    userId: string;
+    activityId: string;
+}): Promise<{
+    update: Partial<Score>;
+    activityId: string;
+}>;
+
+declare const createScore: (params: {
+    isAssignment: boolean;
+    activityId: string;
+    userId: string;
+    scoreData: Score;
+}) => Promise<{
+    id: string;
+}>;
+
+declare function _getAllAssignments(): Promise<(AssignmentWithId & {
+    id: string;
+})[]>;
+declare const getAllAssignments: () => Promise<(AssignmentWithId & {
+    id: string;
+})[]>;
+
+declare const 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;
+    content?: string[];
+    weights?: Record<string, number>;
+    language?: string;
+    types?: { [key in ActivityPageType]?: number; };
+    aiEnabled?: boolean;
+    chat_experience?: boolean;
+} | null>;
+
+declare const getAssignmentScores: (args_0: {
+    assignmentId: string;
+    currentUserId: string;
+    analyticType?: AssignmentAnalyticsType;
+    studentId?: string;
+}) => Promise<{
+    scores: unknown;
+    id: string;
+} | undefined>;
+
+declare function getAssignmentScore({ userId, assignment, googleClassroomUserId, }: {
+    userId: string;
+    assignment: {
+        id: string;
+        courseId?: string;
+    };
+    googleClassroomUserId?: string;
+}): Promise<ScoreWithId>;
+declare function getPracticeScore({ userId, setId }: {
+    userId: string;
+    setId: string;
+}): Promise<ScoreWithId>;
+declare const getScore: (params: {
+    userId: string;
+    activityId: string;
+    courseId?: string;
+    googleClassroomUserId?: string;
+    isAssignment: boolean;
+}) => Promise<ScoreWithId>;
+
+declare const submitAssignmentScore: (args_0: {
+    cardIds: string[];
+    assignment: {
+        id: string;
+        name: string;
+        owners: string[];
+        courseId: string;
+        courseWorkId: string;
+        isAssessment: boolean;
+    };
+    weights: Record<string, number>;
+    userId: string;
+    status: Score["status"];
+    studentName: string;
+}) => Promise<{
+    success: boolean;
+    fieldsUpdated: Score;
+}>;
+declare function submitPracticeScore({ setId, userId, scores, }: {
+    userId: string;
+    setId: string;
+    scores: Score;
+}): Promise<{
+    success: boolean;
+    fieldsUpdated: Score;
+}>;
+
+declare const updateScore: (params: {
+    userId: string;
+    data: Partial<Score>;
+    isAssignment: boolean;
+    activityId: string;
+}) => Promise<void>;
+declare const updateCardScore: (params: {
+    userId: string;
+    cardId: string;
+    isAssignment: boolean;
+    activityId: string;
+    updates: {
+        cardScore: PageScore;
+        progress: number;
+        score: number;
+    };
+}) => Promise<void>;
+
+declare const createCard: (args_0: {
+    data: Partial<PageActivity>;
+}) => Promise<{
+    id: string;
+} & Partial<PageActivity>>;
+declare const createCards: (args_0: {
+    cards: PageActivity[];
+}) => 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: ActivityPageType;
+    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;
+    feedback_language?: string | null;
+    correct_answer?: string | null;
+    limit_attempts?: boolean;
+    max_attempts?: number;
+    rich_text?: string;
+}[]>;
+
+declare const getCard: (params: {
+    cardId: string;
+}) => Promise<PageActivityWithId | null>;
+
+declare const getVerificationStatus: (target_text: string, language: string) => Promise<VerificationCardStatus>;
+
+declare const createNotification: ({ data, type, userId, profile, }: {
+    type: SpeakableNotificationType;
+    data: any;
+    userId: string;
+    profile: User["profile"];
+}) => Promise<any>;
+
+declare const sendNotification: (sendTo: string[], notification: any) => Promise<any>;
+
+declare const getSet: (args_0: {
+    setId: string;
+}) => Promise<SetWithId | null>;
+
+declare const createFsClientNative: ({ db, httpsCallable, logEvent }: FsClientParams) => {
+    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;
+            content?: string[];
+            weights?: Record<string, number>;
+            language?: string;
+            types?: { [key in ActivityPageType]?: number; };
+            aiEnabled?: boolean;
+            chat_experience?: boolean;
+        } | 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;
+            content?: string[];
+            weights?: Record<string, number>;
+            language?: string;
+            types?: { [key in ActivityPageType]?: number; };
+            aiEnabled?: boolean;
+            chat_experience?: boolean;
+        }[]>;
+        getAssignmentScores: (args_0: {
+            assignmentId: string;
+            currentUserId: string;
+            analyticType?: AssignmentAnalyticsType;
+            studentId?: string;
+        }) => Promise<{
+            scores: unknown;
+            id: string;
+        } | undefined>;
+        getAllAssignments: () => Promise<(AssignmentWithId & {
+            id: string;
+        })[]>;
+    };
+    cardRepo: {
+        createCard: (args_0: {
+            data: Partial<PageActivity>;
+        }) => Promise<{
+            id: string;
+        } & Partial<PageActivity>>;
+        createCards: (args_0: {
+            cards: PageActivity[];
+        }) => 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: ActivityPageType;
+            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;
+            feedback_language?: string | null;
+            correct_answer?: string | null;
+            limit_attempts?: boolean;
+            max_attempts?: number;
+            rich_text?: string;
+        }[]>;
+        getCard: (params: {
+            cardId: string;
+        }) => Promise<PageActivityWithId | null>;
+    };
+};
+
+interface FirebaseConfig {
+    db: Firestore;
+    helpers: FirestoreHelpers;
+    httpsCallable: (name: string) => CallableFunction;
+    logEvent: (name: string, data: any) => void;
+}
+type FirebasePath = string;
+declare class FirebaseAPI {
+    private static instance;
+    private config;
+    private constructor();
+    static getInstance(): FirebaseAPI;
+    initialize(config: FirebaseConfig): void;
+    get db(): Firestore;
+    get helpers(): FirestoreHelpers;
+    get httpsCallable(): ((name: string) => CallableFunction) | undefined;
+    logEvent(name: string, data: any): void;
+    accessQueryConstraints(): {
+        query: typeof _firebase_firestore.query;
+        orderBy: typeof _firebase_firestore.orderBy;
+        limit: typeof _firebase_firestore.limit;
+        startAt: typeof _firebase_firestore.startAt;
+        startAfter: typeof _firebase_firestore.startAfter;
+        endAt: typeof _firebase_firestore.endAt;
+        endBefore: typeof _firebase_firestore.endBefore;
+        where: typeof _firebase_firestore.where;
+        increment: typeof _firebase_firestore.increment;
+    };
+    accessHelpers(): {
+        doc: (path: FirebasePath) => _firebase_firestore.DocumentReference<DocumentData, DocumentData>;
+        collection: (path: FirebasePath) => _firebase_firestore.CollectionReference<DocumentData, DocumentData>;
+        writeBatch: () => _firebase_firestore.WriteBatch;
+        serverTimestamp: typeof _firebase_firestore.serverTimestamp;
+        setDoc: typeof _firebase_firestore.setDoc;
+    };
+    getDoc<T>(path: FirebasePath): Promise<{
+        id: string;
+        data: T | null;
+    }>;
+    getDocs<T>(path: FirebasePath, ...queryConstraints: QueryConstraint[]): Promise<{
+        data: (T & {
+            id: string;
+        })[];
+        querySnapshot: _firebase_firestore.QuerySnapshot<DocumentData, DocumentData>;
+        empty: boolean;
+    }>;
+    addDoc<T extends WithFieldValue<DocumentData>>(path: FirebasePath, data: T): Promise<{
+        id: string;
+    } & T>;
+    setDoc<T extends WithFieldValue<DocumentData>>(path: FirebasePath, data: T, options?: SetOptions): Promise<void>;
+    updateDoc(path: FirebasePath, data: any): Promise<void>;
+    deleteDoc(path: FirebasePath): Promise<void>;
+    runTransaction<T>(updateFunction: (transaction: any) => Promise<T>): Promise<T>;
+    runBatch(operations: (() => Promise<void>)[]): Promise<void>;
+    writeBatch(): _firebase_firestore.WriteBatch;
+}
+declare const api: FirebaseAPI;
+
+export { ActivityPageType, AssignmentWithId, CallableFunction, type CreditContract, CustomTimestamp, FirebaseAPI, FirestoreHelpers, PageActivity, PageActivityWithId, PageScore, Score, ScoreWithId, SetWithId, User, _getAllAssignments, api, attachScoresAssignment, clearScore, createCard, createCards, createFsClientNative, createNotification, createScore, creditQueryKeys, getAllAssignments, getAssignment, getAssignmentScore, getAssignmentScores, getCard, getPracticeScore, getScore, getSet, getVerificationStatus, sendNotification, submitAssignmentScore, submitPracticeScore, updateCardScore, updateScore, useActivityTracker, useUserCredits };