@speakableio/core 0.1.106 → 1.0.0

package/dist/index.web-DNYJV_41.d.ts

@@ -0,0 +1,469 @@
+import { V as VerificationCardStatus } from './card.constants-DhKFipX3.js';
+import { j as FirebaseInstance, F as FirestoreHelpers, e as CallableFunction, A as AssignmentWithId, C as CustomTimestamp, a as ActivityPageType, c as PageActivity, d as PageActivityWithId } from './assignment.model-Bc61gBHl.js';
+import { A as AssignmentAnalyticsType } from './assignment.constants-BIKM6fYi.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { QueryClient } from '@tanstack/react-query';
+import { f as SpeakablePlanTypes } from './speakable-plans-Dq9nRefI.js';
+
+type FsClient = ReturnType<typeof createFsClientBase>;
+type FsClientParams = Omit<Parameters<typeof createFsClientBase>[0], 'helpers'>;
+declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
+    db: FirebaseInstance;
+    helpers: FirestoreHelpers;
+    httpsCallable: (name: string) => CallableFunction;
+    logEvent: (name: string, data: any) => void;
+}): {
+    assignmentRepo: {
+        getAssignment: (params: {
+            assignmentId: string;
+            currentUserId: string;
+            analyticType?: AssignmentAnalyticsType;
+            studentId?: string;
+        }) => Promise<AssignmentWithId | {
+            scores: any;
+            id: string;
+            isAvailable: boolean;
+            name: string;
+            description: string;
+            scheduledTime?: string | null;
+            dueTime?: {
+                hours: number;
+                minutes: number;
+                nanos: number;
+            };
+            speakableio: boolean;
+            owners: string[];
+            image: {
+                path: string | null;
+                url: string;
+            };
+            dueDate: {
+                day: number;
+                month: number;
+                year: number;
+            };
+            teacherName: string;
+            courseWorkId: string | null;
+            dueDateTimestamp: CustomTimestamp;
+            scheduledTimeTimestamp: number;
+            active: boolean;
+            voice: string | null;
+            setId: string;
+            dateMade: {
+                seconds: number;
+                nanoseconds: number;
+            };
+            maxPoints: number;
+            courseId: string;
+            isAssessment: boolean;
+            ltiDeeplink?: string;
+            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>;
+    };
+};
+
+declare const createFsClientWeb: ({ 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 UserProfile {
+    googleClassroomUserId: string;
+    image: {
+        url: string;
+        path: string;
+    };
+    displayName: string;
+    isTeacher?: boolean;
+    isStudent?: boolean;
+    roles?: string[];
+}
+interface UserAuth {
+    uid: string;
+    email: string;
+    displayName: string | null;
+}
+interface Lti {
+    data: {
+        services: {
+            serviceKey: string;
+        };
+    };
+}
+interface User {
+    profile: UserProfile;
+    auth: UserAuth;
+    lti: Lti;
+    roles: string[];
+}
+
+interface Permissions {
+    loaded: boolean;
+    loading: boolean;
+    permissions: string[];
+    plan: keyof typeof SpeakablePlanTypes;
+    subscriptionId: string;
+    isInstitutionPlan: boolean;
+    type: string;
+    contact: string;
+    hasStudentPortfolios?: boolean;
+    refreshDate: string;
+    isStripePlan: boolean;
+    freeOrgTrialExpired?: boolean;
+}
+
+interface FsContext {
+    speakableApi: Awaited<FsClient>;
+    queryClient: QueryClient;
+    user: User;
+    permissions: Permissions;
+}
+declare const FsCtx: React.Context<FsContext | null>;
+declare function SpeakableProvider({ user, children, queryClient, permissions, fsClient, }: {
+    children: React.ReactNode;
+    fsClient: FsClient;
+    permissions: Permissions;
+    queryClient: QueryClient;
+    user: User;
+}): react_jsx_runtime.JSX.Element | null;
+declare function useSpeakableApi(): FsContext;
+
+export { type FsClientParams as F, type Permissions as P, SpeakableProvider as S, type User as U, FsCtx as a, createFsClientWeb as c, useSpeakableApi as u };