@speakableio/core 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speakableio/core",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Speakable-io/speakable-core.git"
@@ -86,4 +86,4 @@
   "dependencies": {
     "dayjs": "^1.11.13"
   }
-}
+}

package/dist/analytics-Bj2i88Zk.d.ts

@@ -1,89 +0,0 @@
-import { FieldValue } from 'firebase/firestore';
-
-interface GradingStandard {
-    type: 'actfl' | 'wida' | 'custom';
-    customStandardId?: string | undefined;
-    dateMade: FieldValue;
-    courseId?: string;
-    assignmentId?: string;
-    teacherId?: string;
-    cardId: string;
-    setId: string;
-    level: string;
-    justification: string;
-    prompt: string;
-    transcript: string;
-    audioUrl?: string;
-    responseType: 'spoken' | 'written';
-    language: string;
-}
-declare const addGradingStandardLog: (gradingStandard: GradingStandard, userId: string) => Promise<void>;
-
-declare const logGradingStandardLog: (data: {
-    type: GradingStandard["type"];
-    level?: GradingStandard["level"];
-    courseId?: GradingStandard["courseId"];
-}) => void;
-
-declare const logOpenAssignment: (data?: {}) => void;
-declare const logOpenActivityPreview: (data?: {}) => void;
-declare const logSubmitAssignment: (data?: {}) => void;
-declare const logCreateAssignment: (data?: {}) => void;
-declare const logStartAssignment: (data?: {}) => void;
-
-declare const logRepeatSuccess: (data?: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRepeatFail: (data?: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondSuccess: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondFail: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondSubmitted: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondError: (errorDetails: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logWrittenResponseSuccess: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logWrittenResponseFail: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logWrittenResponseSubmitted: (data?: {}) => void;
-declare const logWrittenResponseError: (errorDetails: Record<string, unknown>) => void;
-declare const logFreePlanRespond: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logFreePlanWrittenResponse: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logMultipleChoiceSuccess: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logMultipleChoiceFail: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logMultipleChoiceError: (errorDetails: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-
-export { type GradingStandard as G, addGradingStandardLog as a, logOpenAssignment as b, logOpenActivityPreview as c, logSubmitAssignment as d, logCreateAssignment as e, logStartAssignment as f, logRepeatSuccess as g, logRepeatFail as h, logRespondSuccess as i, logRespondFail as j, logRespondSubmitted as k, logGradingStandardLog as l, logRespondError as m, logWrittenResponseSuccess as n, logWrittenResponseFail as o, logWrittenResponseSubmitted as p, logWrittenResponseError as q, logFreePlanRespond as r, logFreePlanWrittenResponse as s, logMultipleChoiceSuccess as t, logMultipleChoiceFail as u, logMultipleChoiceError as v };

package/dist/analytics.d.ts

@@ -1,88 +0,0 @@
-import { FieldValue } from 'firebase/firestore';
-
-interface GradingStandard {
-    type: 'actfl' | 'wida' | 'custom';
-    customStandardId?: string | undefined;
-    dateMade: FieldValue;
-    courseId?: string;
-    assignmentId?: string;
-    teacherId?: string;
-    cardId: string;
-    setId: string;
-    level: string;
-    justification: string;
-    prompt: string;
-    transcript: string;
-    audioUrl?: string;
-    responseType: 'spoken' | 'written';
-    language: string;
-}
-
-declare const logGradingStandardLog: (data: {
-    type: GradingStandard["type"];
-    level?: GradingStandard["level"];
-    courseId?: GradingStandard["courseId"];
-}) => void;
-
-declare const logOpenAssignment: (data?: {}) => void;
-declare const logOpenActivityPreview: (data?: {}) => void;
-declare const logSubmitAssignment: (data?: {}) => void;
-declare const logCreateAssignment: (data?: {}) => void;
-declare const logStartAssignment: (data?: {}) => void;
-
-declare const logRepeatSuccess: (data?: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRepeatFail: (data?: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondSuccess: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondFail: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondSubmitted: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logRespondError: (errorDetails: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logWrittenResponseSuccess: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logWrittenResponseFail: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logWrittenResponseSubmitted: (data?: {}) => void;
-declare const logWrittenResponseError: (errorDetails: Record<string, unknown>) => void;
-declare const logFreePlanRespond: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logFreePlanWrittenResponse: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logMultipleChoiceSuccess: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logMultipleChoiceFail: (data: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-declare const logMultipleChoiceError: (errorDetails: {
-    courseId?: string;
-    [key: string]: any;
-}) => void;
-
-export { logCreateAssignment, logFreePlanRespond, logFreePlanWrittenResponse, logGradingStandardLog, logMultipleChoiceError, logMultipleChoiceFail, logMultipleChoiceSuccess, logOpenActivityPreview, logOpenAssignment, logRepeatFail, logRepeatSuccess, logRespondError, logRespondFail, logRespondSubmitted, logRespondSuccess, logStartAssignment, logSubmitAssignment, logWrittenResponseError, logWrittenResponseFail, logWrittenResponseSubmitted, logWrittenResponseSuccess };

package/dist/assignment.constants-BIKM6fYi.d.ts

@@ -1,32 +0,0 @@
-declare enum AssignmentAnalyticsType {
-    Macro = "macro",
-    Gradebook = "gradebook",
-    Cards = "cards",
-    Student = "student",
-    StudentSummary = "student_summary",
-    All = "all"
-}
-declare const ASSIGNMENT_ANALYTICS_TYPES: AssignmentAnalyticsType[];
-declare const ASSIGNMENTS_COLLECTION = "assignments";
-declare const ANALYTICS_SUBCOLLECTION = "analytics";
-declare const SCORES_SUBCOLLECTION = "scores";
-type RefsAssignmentFiresotre = `${typeof ASSIGNMENTS_COLLECTION}/${string}${`/${typeof ANALYTICS_SUBCOLLECTION}/${string}` | `/${typeof SCORES_SUBCOLLECTION}/${string}` | ''}`;
-declare const refsAssignmentFiresotre: {
-    allAssignments: () => string;
-    assignment: (params: {
-        id: string;
-    }) => `assignments/${string}`;
-    assignmentAllAnalytics: (params: {
-        id: string;
-    }) => `assignments/${string}/analytics`;
-    assignmentAnalytics: (params: {
-        id: string;
-        type: string;
-    }) => `assignments/${string}/analytics/${string}`;
-    assignmentScores: (params: {
-        id: string;
-        userId: string;
-    }) => `assignments/${string}/scores/${string}`;
-};
-
-export { AssignmentAnalyticsType as A, type RefsAssignmentFiresotre as R, ASSIGNMENT_ANALYTICS_TYPES as a, refsAssignmentFiresotre as r };

package/dist/assignment.model-BRS4h8gX.d.ts

@@ -1,301 +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';
-import { V as VerificationCardStatus } from './card.constants-DhKFipX3.js';
-
-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"
-}
-declare const RESPOND_PAGE_ACTIVITY_TYPES: ActivityPageType[];
-declare const MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES: ActivityPageType[];
-declare const REPEAT_PAGE_ACTIVITY_TYPES: ActivityPageType[];
-declare const RESPOND_WRITE_PAGE_ACTIVITY_TYPES: ActivityPageType[];
-declare const RESPOND_AUDIO_PAGE_ACTIVITY_TYPES: ActivityPageType[];
-
-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;
-}
-interface Score {
-    userId: string;
-    owners: string[];
-    progress: number;
-    score: number;
-    cards?: {
-        [cardId: string]: PageScore;
-    };
-    courseId?: string;
-    firstLoad?: boolean;
-    googleClassroomUserId?: string;
-    skippedCards?: number;
-    lastPlayed?: CustomTimestamp;
-    startDate?: CustomTimestamp;
-    submissionDate?: CustomTimestamp;
-    status?: 'SUBMITTED' | 'PENDING_REVIEW' | 'IN_PROGRESS' | 'FINALIZED';
-    submitted?: boolean;
-    successfulCards?: number;
-    total_voiceSuccess?: number;
-    total_voice_attempts?: number;
-    total_words_spoken?: number;
-    history?: PageScore[];
-    attempts?: number;
-    assignmentId?: string;
-    setId?: string;
-}
-interface ScoreWithId extends Score {
-    id: string;
-}
-interface PageScore {
-    voiceSuccess?: number;
-    voiceAttempts?: number;
-    voiceFail?: number;
-    completed?: boolean;
-    attempts?: number;
-    correct?: number;
-    success?: boolean;
-    aiSuccess?: boolean;
-    grading_method?: 'simple' | 'rubric' | 'manual' | 'standards_based' | null;
-    grammar_insights?: {
-        type?: string;
-        justification?: string;
-        error?: boolean;
-        correction?: string;
-    }[];
-    promptSuccess?: boolean;
-    score?: number;
-    simple_grading?: {
-        justification?: string;
-        success?: boolean;
-    };
-    suggested_response?: string;
-    summary?: string;
-    transcript?: string | null;
-    errors?: any;
-    improvedResponse?: string;
-    audio?: string | null;
-    actfl?: {
-        justification: string;
-        level: string;
-        key_indicators?: string[];
-    };
-    wida?: {
-        justification: string;
-        level: string;
-        key_indicators?: string[];
-    };
-    earned_points?: number;
-    fileName?: string | null;
-    max_points?: number;
-    passing_score?: number;
-    rubric?: {
-        description: string;
-        justification: string;
-        maxPoints: number;
-        score: number;
-        score_title: string;
-        title: string;
-    }[] | null;
-    scoring_type?: string;
-    history?: PageScore[];
-    media_area_opened?: boolean;
-    noFeedbackAvailable?: boolean;
-    proficiency_level?: {
-        standardId: string;
-        level: string;
-        justification: string;
-        key_indicators?: string[];
-    };
-    status?: string | null;
-    transcriptError?: boolean;
-    feedbackError?: boolean;
-    totalTrys?: {
-        markedCorrect?: boolean;
-        selectedOption?: string | string[];
-        attemptedAt?: CustomTimestamp;
-        messageAttemptId?: string;
-    }[];
-    tryAgain?: boolean;
-    updatedAt?: CustomTimestamp;
-    messageAttemptId?: string;
-    unmetCriteria?: {
-        criterion: string;
-        suggestion: string;
-        explanation: string;
-    }[];
-    meetsCriteria?: boolean;
-    actionableSteps?: string[];
-    rubric_results?: {
-        title: string;
-        score: number;
-        score_title: string;
-        justification: string;
-        maxPoints: number;
-        description: string;
-    }[];
-    target_proficiency_level?: string;
-    hint?: string[];
-}
-
-export { type AssignmentWithId as A, type CallableFunction as C, type FirebaseInstance as F, MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES as M, type PageActivity as P, RESPOND_PAGE_ACTIVITY_TYPES as R, type Score as S, type FirestoreHelpers as a, type CustomTimestamp as b, ActivityPageType as c, type PageActivityWithId as d, type ScoreWithId as e, type PageScore as f, type Assignment as g, REPEAT_PAGE_ACTIVITY_TYPES as h, RESPOND_WRITE_PAGE_ACTIVITY_TYPES as i, RESPOND_AUDIO_PAGE_ACTIVITY_TYPES as j };