@speakableio/core 1.0.7 → 1.0.9

package/dist/index.web.d.mts

@@ -153,30 +153,16 @@ interface PageActivity {
     max_attempts?: number;
     rich_text?: string;
 }
-declare enum ActivityPageType {
+declare const 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"
+    SHORT_ANSWER = "SHORT_ANSWER"
 }
 declare const RESPOND_PAGE_ACTIVITY_TYPES: ActivityPageType[];
 declare const MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES: ActivityPageType[];
@@ -197,7 +183,76 @@ declare function useCards({ cardIds, enabled, asObject, }: {
 }): {
     cards: PageActivityWithId[];
     cardsObject: Record<string, PageActivityWithId> | null;
-    cardsQueries: _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>[];
+    cardsQueries: _tanstack_react_query.UseQueryResult<{
+        id: string;
+        data: {
+            type: ActivityPageType;
+            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;
+            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;
+        };
+    } | null, Error>[];
 };
 declare function useCreateCard(): {
     mutationCreateCard: _tanstack_react_query.UseMutationResult<{
@@ -289,7 +344,76 @@ declare function updateCardInCache({ cardId, card, queryClient, }: {
 declare function useGetCard({ cardId, enabled }: {
     cardId: string;
     enabled?: boolean;
-}): _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>;
+}): _tanstack_react_query.UseQueryResult<{
+    id: string;
+    data: {
+        type: ActivityPageType;
+        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;
+        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;
+    };
+} | null, Error>;
 
 declare const createCardRepo: () => {
     createCard: (args_0: {
@@ -368,7 +492,76 @@ declare const createCardRepo: () => {
     }[]>;
     getCard: (params: {
         cardId: string;
-    }) => Promise<PageActivityWithId | null>;
+    }) => Promise<{
+        id: string;
+        data: {
+            type: ActivityPageType;
+            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;
+            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;
+        };
+    } | null>;
 };
 
 declare function checkIsRepeatPage(cardType: ActivityPageType | undefined): boolean;
@@ -386,6 +579,7 @@ declare const checkTypePageActivity: (cardType: ActivityPageType | undefined) =>
     isRepeat: boolean;
     isMediaPage: boolean;
     isShortAnswer: boolean;
+    hasSomeType: boolean;
 };
 
 declare function getPagePrompt(card: PageActivityWithId | undefined): {
@@ -585,6 +779,7 @@ interface PageScore {
     }[];
     target_proficiency_level?: string;
     hint?: string[];
+    reviewed?: boolean;
 }
 
 declare enum AssignmentAnalyticsType {
@@ -1173,7 +1368,76 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
         }[]>;
         getCard: (params: {
             cardId: string;
-        }) => Promise<PageActivityWithId | null>;
+        }) => Promise<{
+            id: string;
+            data: {
+                type: ActivityPageType;
+                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;
+                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;
+            };
+        } | null>;
     };
 };
 
@@ -1346,7 +1610,76 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
     };
     cards: {
         data: Record<string, PageActivityWithId> | null;
-        query: _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>[];
+        query: _tanstack_react_query.UseQueryResult<{
+            id: string;
+            data: {
+                type: ActivityPageType;
+                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;
+                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;
+            };
+        } | null, Error>[];
         cardsArray: PageActivityWithId[];
     };
     assignment: {
@@ -2853,7 +3186,76 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
         }[]>;
         getCard: (params: {
             cardId: string;
-        }) => Promise<PageActivityWithId | null>;
+        }) => Promise<{
+            id: string;
+            data: {
+                type: ActivityPageType;
+                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;
+                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;
+            };
+        } | null>;
     };
 };
 

package/dist/index.web.js

@@ -1512,6 +1512,36 @@ function useSubmitPracticeScore() {
 import { useMutation as useMutation2, useQueries, useQuery as useQuery3 } from "@tanstack/react-query";
 import { useMemo } from "react";
 
+// src/domains/cards/card.model.ts
+var ActivityPageType = /* @__PURE__ */ ((ActivityPageType2) => {
+  ActivityPageType2["READ_REPEAT"] = "READ_REPEAT";
+  ActivityPageType2["READ_RESPOND"] = "READ_RESPOND";
+  ActivityPageType2["FREE_RESPONSE"] = "FREE_RESPONSE";
+  ActivityPageType2["REPEAT"] = "REPEAT";
+  ActivityPageType2["RESPOND"] = "RESPOND";
+  ActivityPageType2["RESPOND_WRITE"] = "RESPOND_WRITE";
+  ActivityPageType2["MULTIPLE_CHOICE"] = "MULTIPLE_CHOICE";
+  ActivityPageType2["MEDIA_PAGE"] = "MEDIA_PAGE";
+  ActivityPageType2["SHORT_ANSWER"] = "SHORT_ANSWER";
+  return ActivityPageType2;
+})(ActivityPageType || {});
+var RESPOND_PAGE_ACTIVITY_TYPES = [
+  "READ_RESPOND" /* READ_RESPOND */,
+  "RESPOND" /* RESPOND */,
+  "RESPOND_WRITE" /* RESPOND_WRITE */,
+  "FREE_RESPONSE" /* FREE_RESPONSE */
+];
+var MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES = ["MULTIPLE_CHOICE" /* MULTIPLE_CHOICE */];
+var REPEAT_PAGE_ACTIVITY_TYPES = ["READ_REPEAT" /* READ_REPEAT */, "REPEAT" /* REPEAT */];
+var RESPOND_WRITE_PAGE_ACTIVITY_TYPES = [
+  "RESPOND_WRITE" /* RESPOND_WRITE */,
+  "FREE_RESPONSE" /* FREE_RESPONSE */
+];
+var RESPOND_AUDIO_PAGE_ACTIVITY_TYPES = [
+  "RESPOND" /* RESPOND */,
+  "READ_RESPOND" /* READ_RESPOND */
+];
+
 // src/domains/cards/card.constants.ts
 var FeedbackTypesCard = /* @__PURE__ */ ((FeedbackTypesCard2) => {
   FeedbackTypesCard2["SuggestedResponse"] = "suggested_response";
@@ -1615,57 +1645,21 @@ async function _getCard(params) {
   const ref = refsCardsFiresotre.card(params.cardId);
   const response = await api.getDoc(ref);
   if (!response.data) return null;
-  return response.data;
+  const type = response.data.type || "READ_REPEAT" /* READ_REPEAT */;
+  const cardsMapped = {
+    ...response.data,
+    type
+  };
+  return {
+    id: response.id,
+    data: cardsMapped
+  };
 }
 var getCard = withErrorHandler(_getCard, "getCard");
 
 // src/domains/cards/services/create-card.service.ts
 import { v4 } from "uuid";
 
-// src/domains/cards/card.model.ts
-var ActivityPageType = /* @__PURE__ */ ((ActivityPageType2) => {
-  ActivityPageType2["READ_REPEAT"] = "READ_REPEAT";
-  ActivityPageType2["VIDEO"] = "VIDEO";
-  ActivityPageType2["TEXT"] = "TEXT";
-  ActivityPageType2["READ_RESPOND"] = "READ_RESPOND";
-  ActivityPageType2["FREE_RESPONSE"] = "FREE_RESPONSE";
-  ActivityPageType2["REPEAT"] = "REPEAT";
-  ActivityPageType2["RESPOND"] = "RESPOND";
-  ActivityPageType2["RESPOND_WRITE"] = "RESPOND_WRITE";
-  ActivityPageType2["TEXT_TO_SPEECH"] = "TEXT_TO_SPEECH";
-  ActivityPageType2["MULTIPLE_CHOICE"] = "MULTIPLE_CHOICE";
-  ActivityPageType2["PODCAST"] = "PODCAST";
-  ActivityPageType2["MEDIA_PAGE"] = "MEDIA_PAGE";
-  ActivityPageType2["WRITE"] = "WRITE";
-  ActivityPageType2["SHORT_ANSWER"] = "SHORT_ANSWER";
-  ActivityPageType2["SHORT_STORY"] = "SHORT_STORY";
-  ActivityPageType2["SPEAK"] = "SPEAK";
-  ActivityPageType2["CONVERSATION"] = "CONVERSATION";
-  ActivityPageType2["CONVERSATION_WRITE"] = "CONVERSATION_WRITE";
-  ActivityPageType2["DIALOGUE"] = "DIALOGUE";
-  ActivityPageType2["INSTRUCTION"] = "INSTRUCTION";
-  ActivityPageType2["LISTEN"] = "LISTEN";
-  ActivityPageType2["READ"] = "READ";
-  ActivityPageType2["ANSWER"] = "ANSWER";
-  return ActivityPageType2;
-})(ActivityPageType || {});
-var RESPOND_PAGE_ACTIVITY_TYPES = [
-  "READ_RESPOND" /* READ_RESPOND */,
-  "RESPOND" /* RESPOND */,
-  "RESPOND_WRITE" /* RESPOND_WRITE */,
-  "FREE_RESPONSE" /* FREE_RESPONSE */
-];
-var MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES = ["MULTIPLE_CHOICE" /* MULTIPLE_CHOICE */];
-var REPEAT_PAGE_ACTIVITY_TYPES = ["READ_REPEAT" /* READ_REPEAT */, "REPEAT" /* REPEAT */];
-var RESPOND_WRITE_PAGE_ACTIVITY_TYPES = [
-  "RESPOND_WRITE" /* RESPOND_WRITE */,
-  "FREE_RESPONSE" /* FREE_RESPONSE */
-];
-var RESPOND_AUDIO_PAGE_ACTIVITY_TYPES = [
-  "RESPOND" /* RESPOND */,
-  "READ_RESPOND" /* READ_RESPOND */
-];
-
 // src/utils/text-utils.ts
 import sha1 from "js-sha1";
 var purify = (word) => {
@@ -1887,6 +1881,19 @@ var checkTypePageActivity = (cardType) => {
   const isRepeat = checkIsRepeatPage(cardType);
   const isMediaPage = checkIsMediaPage(cardType);
   const isShortAnswer = checkIsShortAnswerPage(cardType);
+  const isNoOneOfThem = !isRespond && !isMC && !isRepeat && !isMediaPage && !isShortAnswer;
+  if (isNoOneOfThem) {
+    return {
+      isRespondAudio: false,
+      isRespondWritten: false,
+      isRespond: false,
+      isMC: false,
+      isRepeat: true,
+      isMediaPage: false,
+      isShortAnswer: false,
+      hasSomeType: false
+    };
+  }
   return {
     isRespondAudio,
     isRespondWritten,
@@ -1894,7 +1901,8 @@ var checkTypePageActivity = (cardType) => {
     isMC,
     isRepeat,
     isMediaPage,
-    isShortAnswer
+    isShortAnswer,
+    hasSomeType: true
   };
 };