@speakableio/core 1.0.53 → 1.0.55

package/dist/index.web.d.mts

@@ -675,6 +675,12 @@ declare function getPagePrompt(card: PageActivityWithId | undefined): {
     text: string;
     rich_text: string;
     isTextEqualToRichText: boolean;
+    extraText: string;
+} | {
+    has: boolean;
+    text: string;
+    rich_text: string;
+    isTextEqualToRichText: boolean;
 };
 
 declare const getTotalCompletedCards: (pageScores: Score["cards"] | undefined) => number;
@@ -2986,6 +2992,44 @@ declare const useUpdateStudentVocab: (page: PageActivityWithId | null) => {
     studentVocabMarkVoiceFail: () => Promise<void>;
 };
 
+declare const SPEAKABLE_ANALYTICS: {
+    readonly VOICE_SUCCESS: "voice_success";
+    readonly VOICE_FALLBACK_SUCCESS: "voice_fallback_success";
+    readonly VOICE_FALLBACK_FAIL: "voice_fallback_fail";
+    readonly VOICE_FAIL: "voice_fail";
+    readonly RESPOND_CARD_SUCCESS: "respond_card_success";
+    readonly RESPOND_CARD_FAIL: "respond_card_fail";
+    readonly RESPOND_WRITE_CARD_SUCCESS: "respond_write_card_success";
+    readonly RESPOND_WRITE_CARD_FAIL: "respond_write_card_fail";
+    readonly RESPOND_WRITE_CARD_SUBMITTED: "respond_write_card_submitted";
+    readonly RESPOND_WRITE_CARD_ERROR: "respond_write_card_error";
+    readonly RESPOND_CARD_ERROR: "respond_card_error";
+    readonly RESPOND_CARD_SUBMITTED: "respond_card_submitted";
+    readonly RESPOND_FREE_PLAN: "respond_free_plan";
+    readonly RESPOND_WRITE_FREE_PLAN: "respond_write_free_plan";
+    readonly SUBMISSION: "assignment_submitted";
+    readonly ASSIGNMENT_STARTED: "assignment_started";
+    readonly CREATE_ASSIGNMENT: "create_assignment";
+    readonly MC_SUCCESS: "multiple_choice_success";
+    readonly MC_FAIL: "multiple_choice_fail";
+    readonly MC_ERROR: "multiple_choice_error";
+    readonly ACTFL_LEVEL: "actfl_level";
+    readonly WIDA_LEVEL: "wida_level";
+    readonly VIEW_SCORES_MODAL: "view_scores_modal";
+    readonly SHORT_ANSWER_SUCCESS: "short_answer_success";
+    readonly SHORT_ANSWER_FAIL: "short_answer_fail";
+    readonly SHORT_ANSWER_ERROR: "short_answer_error";
+    readonly RETRY: "retry";
+    readonly MESSAGE_SENT: "message_sent";
+    readonly MESSAGE_ERROR: "message_error";
+    readonly VIEW_DETAILS_CLICK: "view_details_click";
+    readonly TABS_CLICK: "tabs_click";
+    readonly VIEW_MEDIA: "view_media";
+    readonly VIEW_SCORES: "view_scores";
+    readonly VIEW_GRADING_METHOD: "view_grading_method";
+    readonly VIEW_FEEDBACK: "view_feedback";
+};
+
 declare const useBaseOpenAI: ({ onTranscriptSuccess, onTranscriptError, onCompletionSuccess, onCompletionError, aiEnabled, submitAudioResponse, uploadAudioAndGetTranscript, onGetAudioUrlAndTranscript, }: {
     onTranscriptSuccess: (transcript: string) => void;
     onTranscriptError: ({ type, message }: {
@@ -3519,4 +3563,4 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
     };
 };
 
-export { ActivityPageType, type Assignment, type AssignmentAnalyticsType$1 as AssignmentAnalyticsType, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, CONVERSATION_PAGE_ACTIVITY_TYPES, ConversationPageMode, type CreditContract, FeedbackTypesCard, FsCtx, type InstitutionSubscription, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES, type MediaPageActivity, type Organization, type OrganizationAccess, type PageActivity, type PageActivityWithId, type PageScore, REPEAT_PAGE_ACTIVITY_TYPES, RESPOND_AUDIO_PAGE_ACTIVITY_TYPES, RESPOND_PAGE_ACTIVITY_TYPES, RESPOND_WRITE_PAGE_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, checkIsConversationPage, checkIsMCPage, checkIsMediaPage, checkIsRepeatPage, checkIsRespondAudioPage, checkIsRespondPage, checkIsRespondWrittenPage, checkIsShortAnswerPage, checkTypePageActivity, cleanString, createAssignmentRepo, createCardRepo, createFsClientWeb as createFsClient, createSetRepo, creditQueryKeys, debounce, getCardFromCache, getLabelPage, getPageMediaData, getPagePrompt, getPhraseLength, getRespondCardTool, getSetFromCache, getSingleMediaPageData, getTotalCompletedCards, getTranscript, getTranscriptCycle, getWordHash, purify, refsCardsFiresotre, refsSetsFirestore, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useActivityFeedbackAccess, useAssignment, useBaseOpenAI, useCards, useClearScore, useClearScoreV2, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useOrganizationAccess, useScore, useSet, useSpeakableApi, useSpeakableTranscript, useSpeakableTranscriptCycle, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore, useUpdateStudentVocab, useUserCredits };
+export { ActivityPageType, type Assignment, type AssignmentAnalyticsType$1 as AssignmentAnalyticsType, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, CONVERSATION_PAGE_ACTIVITY_TYPES, ConversationPageMode, type CreditContract, FeedbackTypesCard, FsCtx, type InstitutionSubscription, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES, type MediaPageActivity, type Organization, type OrganizationAccess, type PageActivity, type PageActivityWithId, type PageScore, REPEAT_PAGE_ACTIVITY_TYPES, RESPOND_AUDIO_PAGE_ACTIVITY_TYPES, RESPOND_PAGE_ACTIVITY_TYPES, RESPOND_WRITE_PAGE_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_ANALYTICS, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, checkIsConversationPage, checkIsMCPage, checkIsMediaPage, checkIsRepeatPage, checkIsRespondAudioPage, checkIsRespondPage, checkIsRespondWrittenPage, checkIsShortAnswerPage, checkTypePageActivity, cleanString, createAssignmentRepo, createCardRepo, createFsClientWeb as createFsClient, createSetRepo, creditQueryKeys, debounce, getCardFromCache, getLabelPage, getPageMediaData, getPagePrompt, getPhraseLength, getRespondCardTool, getSetFromCache, getSingleMediaPageData, getTotalCompletedCards, getTranscript, getTranscriptCycle, getWordHash, purify, refsCardsFiresotre, refsSetsFirestore, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useActivityFeedbackAccess, useAssignment, useBaseOpenAI, useCards, useClearScore, useClearScoreV2, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useOrganizationAccess, useScore, useSet, useSpeakableApi, useSpeakableTranscript, useSpeakableTranscriptCycle, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore, useUpdateStudentVocab, useUserCredits };

package/dist/index.web.js

@@ -828,8 +828,10 @@ var logGradingStandardLog = (data) => {
 };
 
 // src/constants/analytics.constants.ts
-var ANALYTICS_EVENT_TYPES = {
+var SPEAKABLE_ANALYTICS = {
   VOICE_SUCCESS: "voice_success",
+  VOICE_FALLBACK_SUCCESS: "voice_fallback_success",
+  VOICE_FALLBACK_FAIL: "voice_fallback_fail",
   VOICE_FAIL: "voice_fail",
   RESPOND_CARD_SUCCESS: "respond_card_success",
   RESPOND_CARD_FAIL: "respond_card_fail",
@@ -875,20 +877,20 @@ var logOpenActivityPreview = (data = {}) => {
 var logSubmitAssignment = (data = {}) => {
   var _a, _b, _c;
   (_c = (_b = (_a = api).httpsCallable) == null ? void 0 : _b.call(_a, "handleCouresAnalyticsEvent")) == null ? void 0 : _c({
-    eventType: ANALYTICS_EVENT_TYPES.SUBMISSION,
+    eventType: SPEAKABLE_ANALYTICS.SUBMISSION,
     ...data
   });
-  api.logEvent(ANALYTICS_EVENT_TYPES.SUBMISSION, data);
+  api.logEvent(SPEAKABLE_ANALYTICS.SUBMISSION, data);
 };
 var logStartAssignment = (data = {}) => {
   var _a, _b, _c;
   if (data.courseId) {
     (_c = (_b = (_a = api).httpsCallable) == null ? void 0 : _b.call(_a, "handleCouresAnalyticsEvent")) == null ? void 0 : _c({
-      eventType: ANALYTICS_EVENT_TYPES.ASSIGNMENT_STARTED,
+      eventType: SPEAKABLE_ANALYTICS.ASSIGNMENT_STARTED,
       ...data
     });
   }
-  api.logEvent(ANALYTICS_EVENT_TYPES.ASSIGNMENT_STARTED, data);
+  api.logEvent(SPEAKABLE_ANALYTICS.ASSIGNMENT_STARTED, data);
 };
 
 // src/domains/assignment/utils/create-default-score.ts
@@ -2009,21 +2011,22 @@ function getPagePrompt(card) {
     card == null ? void 0 : card.type
   );
   const hidePrompt = (card == null ? void 0 : card.hidePrompt) === true;
-  const createReturnObject = (text, richText) => {
+  const createReturnObject = (text, richText, extraText) => {
     const plainText = text || "";
     const richTextPlain = extractTextFromRichText(richText);
     return {
       has: true,
       text: plainText,
       rich_text: richText || "",
-      isTextEqualToRichText: plainText.trim() === richTextPlain.trim()
+      isTextEqualToRichText: plainText.trim() === richTextPlain.trim(),
+      extraText: extraText || ""
     };
   };
   if (isRepeat) {
     return createReturnObject(card == null ? void 0 : card.target_text, card == null ? void 0 : card.rich_text);
   }
   if (isConversation) {
-    return createReturnObject(card == null ? void 0 : card.topic, card == null ? void 0 : card.rich_text);
+    return createReturnObject(card == null ? void 0 : card.prompt, card == null ? void 0 : card.rich_text, card == null ? void 0 : card.goal);
   }
   if (isRespond && !hidePrompt) {
     return createReturnObject(card == null ? void 0 : card.prompt, card == null ? void 0 : card.rich_text);
@@ -2038,7 +2041,8 @@ function getPagePrompt(card) {
     has: false,
     text: "",
     rich_text: "",
-    isTextEqualToRichText: false
+    isTextEqualToRichText: false,
+    extraText: ""
   };
 }
 
@@ -3797,6 +3801,7 @@ export {
   RESPOND_AUDIO_PAGE_ACTIVITY_TYPES,
   RESPOND_PAGE_ACTIVITY_TYPES,
   RESPOND_WRITE_PAGE_ACTIVITY_TYPES,
+  SPEAKABLE_ANALYTICS,
   SPEAKABLE_NOTIFICATIONS,
   STUDENT_LEVELS_OPTIONS,
   SpeakableNotificationTypes,