@speakableio/core 0.1.99 → 0.1.101

package/dist/hooks.d.mts

@@ -0,0 +1,294 @@
+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-Bcbxx8oI.mjs';
+import { A as AssignmentAnalyticsType } from './assignment.constants-BIKM6fYi.mjs';
+import { V as VerificationCardStatus } from './card.constants-DhKFipX3.mjs';
+import { a as SpeakableNotificationType } from './notification.constants-B72fb734.mjs';
+import { SetWithId } from './models.mjs';
+import '@react-native-firebase/firestore';
+import 'firebase/firestore';
+
+declare const assignmentQueryKeys: {
+    all: readonly ["assignments"];
+    byId: (id: string) => readonly ["assignments", string];
+    list: () => readonly ["assignments", "list"];
+};
+declare function useAssignment({ assignmentId, enabled, analyticType, userId, }: {
+    assignmentId: string;
+    enabled?: boolean;
+    analyticType?: AssignmentAnalyticsType;
+    userId: string;
+}): _tanstack_react_query.UseQueryResult<AssignmentWithId | {
+    scores: any;
+    id: string;
+    isAvailable: boolean;
+    name: string;
+    description: string;
+    scheduledTime?: string | null;
+    dueTime?: {
+        hours: number;
+        minutes: number;
+        nanos: number;
+    };
+    speakableio: boolean;
+    owners: string[];
+    image: {
+        path: string | null;
+        url: string;
+    };
+    dueDate: {
+        day: number;
+        month: number;
+        year: number;
+    };
+    teacherName: string;
+    courseWorkId: string | null;
+    dueDateTimestamp: CustomTimestamp;
+    scheduledTimeTimestamp: number;
+    active: boolean;
+    voice: string | null;
+    setId: string;
+    dateMade: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    maxPoints: number;
+    courseId: string;
+    isAssessment: boolean;
+    ltiDeeplink?: string;
+    content?: string[];
+    weights?: Record<string, number>;
+    language?: string;
+    types?: { [key in ActivityPageType]?: number; };
+    aiEnabled?: boolean;
+    chat_experience?: boolean;
+} | null, Error>;
+
+declare const scoreQueryKeys: {
+    all: readonly ["scores"];
+    byId: (id: string) => readonly ["scores", string];
+    list: () => readonly ["scores", "list"];
+};
+declare function useScore({ isAssignment, activityId, userId, courseId, enabled, googleClassroomUserId, }: {
+    userId: string;
+    isAssignment: boolean;
+    activityId: string;
+    courseId?: string;
+    enabled?: boolean;
+    googleClassroomUserId?: string;
+}): _tanstack_react_query.UseQueryResult<ScoreWithId, Error>;
+declare function useUpdateScore(): {
+    mutationUpdateScore: _tanstack_react_query.UseMutationResult<Promise<void>, Error, {
+        userId: string;
+        data: Partial<Score>;
+        isAssignment: boolean;
+        activityId: string;
+    }, {
+        previousData: Partial<Score> | undefined;
+    }>;
+};
+declare function useUpdateCardScore({ isAssignment, activityId, userId, cardIds, weights, }: {
+    isAssignment: boolean;
+    userId: string;
+    activityId: string;
+    cardIds: string[];
+    weights: Record<string, number>;
+}): {
+    mutationUpdateCardScore: _tanstack_react_query.UseMutationResult<{
+        cardId: string;
+        scoresUpdated: Score;
+    }, Error, {
+        cardId: string;
+        cardScore: PageScore;
+    }, void>;
+};
+declare function useClearScore(): {
+    mutationClearScore: _tanstack_react_query.UseMutationResult<{
+        update: Partial<Score>;
+        activityId: string;
+    }, Error, {
+        isAssignment: boolean;
+        cardId: string;
+        cardScores: PageScore;
+        userId: string;
+        activityId: string;
+    }, unknown>;
+};
+declare function useSubmitAssignmentScore({ onAssignmentSubmitted, studentName, }: {
+    onAssignmentSubmitted: (assignmentId: string) => void;
+    studentName: string;
+}): {
+    submitAssignmentScore: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+        message: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        error: unknown;
+        message?: undefined;
+    }, Error, {
+        assignment: {
+            id: string;
+            name: string;
+            owners: string[];
+            courseId: string;
+            courseWorkId: string;
+            isAssessment: boolean;
+            maxPoints: number;
+        };
+        userId: string;
+        cardIds: string[];
+        weights: Record<string, number>;
+        scores: Score;
+        status: "FINALIZED" | "IN_PROGRESS" | "PENDING_REVIEW";
+    }, unknown>;
+    isLoading: boolean;
+};
+declare function useSubmitPracticeScore(): {
+    submitPracticeScore: _tanstack_react_query.UseMutateAsyncFunction<{
+        success: boolean;
+        message: string;
+        error?: undefined;
+    } | {
+        success: boolean;
+        error: unknown;
+        message?: undefined;
+    }, Error, {
+        setId: string;
+        userId: string;
+        scores: Score;
+    }, unknown>;
+    isLoading: boolean;
+};
+
+declare const cardsQueryKeys: {
+    all: string[];
+    one: (params: {
+        cardId: string;
+    }) => string[];
+};
+declare function useCards({ cardIds, enabled, asObject, }: {
+    cardIds: string[];
+    enabled: boolean;
+    asObject?: boolean;
+}): {
+    cards: PageActivityWithId[];
+    cardsObject: Record<string, PageActivityWithId> | null;
+    cardsQueries: _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>[];
+};
+declare function useCreateCard(): {
+    mutationCreateCard: _tanstack_react_query.UseMutationResult<{
+        id: string;
+    } & Partial<PageActivity>, Error, {
+        data: Partial<PageActivity>;
+    }, unknown>;
+};
+declare function useCreateCards(): {
+    mutationCreateCards: _tanstack_react_query.UseMutationResult<{
+        id: string;
+        owners: string[];
+        checked?: boolean;
+        completed?: boolean;
+        media_area_id?: string | null;
+        media_area_layout?: "left" | "right" | null;
+        score?: number;
+        verificationStatus?: VerificationCardStatus;
+        native_text?: string;
+        repeat?: number;
+        language?: string | null;
+        image?: {
+            path?: string | null;
+            url?: string;
+        };
+        audio?: {
+            path?: string | null;
+            url?: string;
+        } | null;
+        notes?: string;
+        difficulty?: string;
+        default_language?: string;
+        target_text?: string;
+        type: 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;
+    }[], Error, {
+        cards: PageActivity[];
+    }, unknown>;
+};
+declare function getCardFromCache({ cardId, queryClient, }: {
+    cardId: string;
+    queryClient: QueryClient;
+}): PageActivityWithId | undefined;
+declare function updateCardInCache({ cardId, card, queryClient, }: {
+    cardId: string;
+    card: PageActivityWithId | null;
+    queryClient: QueryClient;
+}): void;
+declare function useGetCard({ cardId, enabled }: {
+    cardId: string;
+    enabled?: boolean;
+}): _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>;
+
+declare const useCreateNotification: () => {
+    createNotification: (type: SpeakableNotificationType, data: any) => Promise<any>;
+};
+
+declare const setsQueryKeys: {
+    all: string[];
+    one: (params: {
+        setId: string;
+    }) => string[];
+};
+declare const useSet: ({ setId, enabled }: {
+    setId: string;
+    enabled?: boolean;
+}) => _tanstack_react_query.UseQueryResult<SetWithId | null, Error>;
+declare function getSetFromCache({ setId, queryClient, }: {
+    setId: string | undefined;
+    queryClient: QueryClient;
+}): SetWithId | null | undefined;
+declare function updateSetInCache({ set, queryClient, }: {
+    set: SetWithId;
+    queryClient: QueryClient;
+}): void;
+
+export { assignmentQueryKeys, cardsQueryKeys, getCardFromCache, getSetFromCache, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useAssignment, useCards, useClearScore, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useScore, useSet, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore };