@speakableio/core 0.1.103 → 0.1.106

package/dist/index.native.d.mts

@@ -1,591 +0,0 @@
-import { FirebaseFirestoreTypes, Timestamp } from '@react-native-firebase/firestore';
-import { Firestore, getDoc, getDocs, addDoc, setDoc, updateDoc, deleteDoc, runTransaction, writeBatch, doc, collection, query, serverTimestamp, orderBy, limit, startAt, startAfter, endAt, endBefore, where, increment, Timestamp as Timestamp$1 } from 'firebase/firestore';
-
-declare enum VerificationCardStatus {
-    VERIFIED = "VERIFIED",
-    WARNING = "WARNING",
-    NOT_RECOMMENDED = "NOT_RECOMMENDED",
-    NOT_WORKING = "NOT_WORKING",
-    NOT_CHECKED = "NOT_CHECKED"
-}
-
-interface PageActivityWithId extends PageActivity {
-    id: string;
-}
-interface PageActivity {
-    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 enum ActivityPageType {
-    READ_REPEAT = "READ_REPEAT",
-    VIDEO = "VIDEO",
-    TEXT = "TEXT",
-    READ_RESPOND = "READ_RESPOND",
-    FREE_RESPONSE = "FREE_RESPONSE",
-    REPEAT = "REPEAT",
-    RESPOND = "RESPOND",
-    RESPOND_WRITE = "RESPOND_WRITE",
-    TEXT_TO_SPEECH = "TEXT_TO_SPEECH",
-    MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
-    PODCAST = "PODCAST",
-    MEDIA_PAGE = "MEDIA_PAGE",
-    WRITE = "WRITE",
-    SHORT_ANSWER = "SHORT_ANSWER",
-    SHORT_STORY = "SHORT_STORY",
-    SPEAK = "SPEAK",
-    CONVERSATION = "CONVERSATION",
-    CONVERSATION_WRITE = "CONVERSATION_WRITE",
-    DIALOGUE = "DIALOGUE",
-    INSTRUCTION = "INSTRUCTION",
-    LISTEN = "LISTEN",
-    READ = "READ",
-    ANSWER = "ANSWER"
-}
-
-type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
-interface FirestoreHelpers {
-    getDoc: typeof getDoc;
-    getDocs: typeof getDocs;
-    addDoc: typeof addDoc;
-    setDoc: typeof setDoc;
-    updateDoc: typeof updateDoc;
-    deleteDoc: typeof deleteDoc;
-    runTransaction: typeof runTransaction;
-    writeBatch: typeof writeBatch;
-    doc: typeof doc;
-    collection: typeof collection;
-    query: typeof query;
-    serverTimestamp: typeof serverTimestamp;
-    orderBy: typeof orderBy;
-    limit: typeof limit;
-    startAt: typeof startAt;
-    startAfter: typeof startAfter;
-    endAt: typeof endAt;
-    endBefore: typeof endBefore;
-    where: typeof where;
-    increment: typeof increment;
-}
-type CustomTimestamp = Timestamp | Timestamp$1;
-type CallableFunction<T = any, R = any> = (data: T) => Promise<R>;
-
-interface Assignment {
-    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;
-    isAvailable: boolean;
-    ltiDeeplink?: string;
-    content?: string[];
-    weights?: Record<string, number>;
-    language?: string;
-    types?: {
-        [key in ActivityPageType]?: number;
-    };
-    aiEnabled?: boolean;
-    chat_experience?: boolean;
-}
-interface AssignmentWithId extends Assignment {
-    id: string;
-    isAvailable: boolean;
-    scores?: unknown;
-}
-
-declare enum AssignmentAnalyticsType {
-    Macro = "macro",
-    Gradebook = "gradebook",
-    Cards = "cards",
-    Student = "student",
-    StudentSummary = "student_summary",
-    All = "all"
-}
-
-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 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>;
-    };
-};
-
-export { createFsClientNative as createFsClient };