@speakableio/core 0.1.106 → 1.0.0

package/dist/hooks.d.ts

@@ -1,10 +1,11 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
-import { A as AssignmentWithId, b as CustomTimestamp, c as ActivityPageType, S as ScoreWithId, e as Score, f as PageScore, d as PageActivityWithId, P as PageActivity } from './assignment.model-DLMWAp0Y.js';
+import { A as AssignmentWithId, C as CustomTimestamp, a as ActivityPageType, e as ScoreWithId, S as Score, f as PageScore, b as PageActivityWithId, P as PageActivity } from './assignment.model-Bm9gE2YK.js';
 import { A as AssignmentAnalyticsType } from './assignment.constants-BIKM6fYi.js';
-import { V as VerificationCardStatus } from './card.constants-DhKFipX3.js';
-import { S as SpeakableNotificationType } from './notification.constants-Da4-_0kX.js';
 import { SetWithId } from './models.js';
+import { V as VerificationCardStatus } from './card.constants-DhKFipX3.js';
+import { a as SpeakableNotificationType } from './notification.constants-B72fb734.js';
+import { S as SpeakablePlanTypes } from './speakable-plans-BjWWEWrQ.js';
 import '@react-native-firebase/firestore';
 import 'firebase/firestore';
 
@@ -161,6 +162,421 @@ declare function useSubmitPracticeScore(): {
     isLoading: boolean;
 };
 
+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, PageActivityWithId> | null;
+        query: _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>[];
+        cardsArray: PageActivityWithId[];
+    };
+    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;
+            content?: string[];
+            weights?: Record<string, number>;
+            language?: string;
+            types?: { [key in ActivityPageType]?: number; };
+            aiEnabled?: boolean;
+            chat_experience?: boolean;
+        } | 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;
+            content?: string[];
+            weights?: Record<string, number>;
+            language?: string;
+            types?: { [key in ActivityPageType]?: number; };
+            aiEnabled?: boolean;
+            chat_experience?: boolean;
+        } | 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: PageScore) => void;
+            logGradingStandardEntry: ({ cardId, gradingStandard, type, }: {
+                cardId: string;
+                gradingStandard: {
+                    level: string;
+                    justification: string;
+                };
+                type: "actfl" | "wida" | "custom";
+            }) => void;
+        };
+    };
+};
+
+interface StudentTeacherPlanResult {
+    studentId: string;
+    teachers: {
+        teacherId: string;
+        teacherName: string;
+        teacherEmail: string;
+        plan: string;
+        hasActiveTeamPlan: boolean;
+        hasActiveOrgPlan: boolean;
+        hasUnlimitedAccess: boolean;
+    }[];
+    hasTeacherWithTeamPlan: boolean;
+    hasTeacherWithOrgPlan: boolean;
+    hasTeacherWithUnlimitedAccess: boolean;
+    canAccessFeedback: boolean;
+    reason?: string;
+}
+interface ActivityFeedbackAccess {
+    canAccessFeedback: boolean;
+    reason?: string;
+    isUnlimited: boolean;
+    accessType: 'ai_enabled' | 'teacher_preview' | 'student_with_teacher_plan' | 'none';
+}
+declare const activityFeedbackAccessQueryKeys: {
+    activityFeedbackAccess: (args: {
+        aiEnabled: boolean;
+        isActivityRoute: boolean;
+    }) => readonly ["activityFeedbackAccess", ...boolean[]];
+};
+/**
+ * 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 useBaseOpenAI: ({ onTranscriptSuccess, onTranscriptError, onCompletionSuccess, onCompletionError, aiEnabled, submitAudioResponse, uploadAudioAndGetTranscript, onGetAudioUrlAndTranscript, }: {
+    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<{
+        transcript: string;
+        audioUrl: string;
+    }>;
+    onGetAudioUrlAndTranscript?: (args: {
+        transcript?: string;
+        audioUrl?: string;
+    }) => void;
+}) => {
+    submitAudioResponse: (audio: string) => Promise<{
+        url: string;
+        fileName: string;
+    }>;
+    uploadAudioAndGetTranscript: (audio: string, language: string) => Promise<{
+        transcript: string;
+        audioUrl: string;
+    }>;
+    getTranscript: (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;
+    }>;
+};
+
+declare const useGoogleClassroom: () => {
+    submitAssignmentToGoogleClassroom: ({ assignment, scores, googleUserId, }: {
+        assignment: {
+            id: string;
+            name: string;
+            owners: string[];
+            courseId: string;
+            courseWorkId: string;
+            isAssessment: boolean;
+            maxPoints: number;
+        };
+        scores: Score;
+        googleUserId?: string | null;
+    }) => Promise<any>;
+};
+
 declare const cardsQueryKeys: {
     all: string[];
     one: (params: {
@@ -291,4 +707,205 @@ declare function updateSetInCache({ set, queryClient, }: {
     queryClient: QueryClient;
 }): void;
 
-export { assignmentQueryKeys, cardsQueryKeys, getCardFromCache, getSetFromCache, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useAssignment, useCards, useClearScore, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useScore, useSet, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore };
+declare function useUserPlan(): {
+    userPlan: "basic" | "teacher_pro" | "school_starter" | "organization" | "starter" | "growth" | "professional";
+    loaded: boolean;
+    isFreePlan: boolean;
+    isTeacherProPlan: boolean;
+    isOrganizationPlan: boolean;
+    isSchoolStarter: boolean;
+    checkIsFreePlan: (plan: keyof typeof SpeakablePlanTypes) => plan is "basic";
+    checkIsTeacherProPlan: (plan: keyof typeof SpeakablePlanTypes) => plan is "teacher_pro" | "starter";
+    checkIsOrganizationPlan: (plan: keyof typeof SpeakablePlanTypes) => plan is "organization" | "growth" | "professional";
+};
+
+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 useUpdateStudentVocab: (page: PageActivityWithId | null) => {
+    studentVocabMarkVoiceSuccess: undefined;
+    studentVocabMarkVoiceFail: undefined;
+} | {
+    studentVocabMarkVoiceSuccess: () => Promise<void>;
+    studentVocabMarkVoiceFail: () => Promise<void>;
+};
+
+export { type ActivityFeedbackAccess, type InstitutionSubscription, type Organization, type OrganizationAccess, type 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 };