@speakableio/core 1.0.48 → 1.0.50

package/dist/index.web.d.mts

@@ -92,6 +92,10 @@ interface MediaPageActivity {
     url: string;
     transcript?: string | null;
 }
+declare enum ConversationPageMode {
+    VoiceAndText = "voice_and_text",
+    PhoneCall = "phone_call"
+}
 interface PageActivity {
     owners: string[];
     checked?: boolean;
@@ -163,6 +167,14 @@ interface PageActivity {
     correct_answer_exact_match?: boolean;
     ai_context_block_ids?: string[];
     resolvedContext?: string;
+    goal?: string;
+    mode?: ConversationPageMode;
+    personality?: string;
+    voice?: string;
+    topic?: string;
+    vocab?: string[];
+    questions?: string[];
+    showHints?: boolean;
 }
 declare const enum ActivityPageType {
     READ_REPEAT = "READ_REPEAT",
@@ -173,13 +185,15 @@ declare const enum ActivityPageType {
     RESPOND_WRITE = "RESPOND_WRITE",
     MULTIPLE_CHOICE = "MULTIPLE_CHOICE",
     MEDIA_PAGE = "MEDIA_PAGE",
-    SHORT_ANSWER = "SHORT_ANSWER"
+    SHORT_ANSWER = "SHORT_ANSWER",
+    CONVERSATION = "CONVERSATION"
 }
 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[];
+declare const CONVERSATION_PAGE_ACTIVITY_TYPES: ActivityPageType[];
 
 declare const cardsQueryKeys: {
     all: string[];
@@ -266,6 +280,14 @@ declare function useCards({ cardIds, enabled, asObject, }: {
         correct_answer_exact_match?: boolean;
         ai_context_block_ids?: string[];
         resolvedContext?: string;
+        goal?: string;
+        mode?: ConversationPageMode;
+        personality?: string;
+        voice?: string;
+        topic?: string;
+        vocab?: string[];
+        questions?: string[];
+        showHints?: boolean;
     } | null, Error>[];
 };
 declare function useCreateCard(): {
@@ -348,6 +370,14 @@ declare function useCreateCards(): {
         correct_answer_exact_match?: boolean;
         ai_context_block_ids?: string[];
         resolvedContext?: string;
+        goal?: string;
+        mode?: ConversationPageMode;
+        personality?: string;
+        voice?: string;
+        topic?: string;
+        vocab?: string[];
+        questions?: string[];
+        showHints?: boolean;
     }[], Error, {
         cards: PageActivity[];
     }, unknown>;
@@ -436,6 +466,14 @@ declare function useGetCard({ cardId, enabled }: {
     correct_answer_exact_match?: boolean;
     ai_context_block_ids?: string[];
     resolvedContext?: string;
+    goal?: string;
+    mode?: ConversationPageMode;
+    personality?: string;
+    voice?: string;
+    topic?: string;
+    vocab?: string[];
+    questions?: string[];
+    showHints?: boolean;
 } | null, Error>;
 
 declare const createCardRepo: () => {
@@ -518,6 +556,14 @@ declare const createCardRepo: () => {
         correct_answer_exact_match?: boolean;
         ai_context_block_ids?: string[];
         resolvedContext?: string;
+        goal?: string;
+        mode?: ConversationPageMode;
+        personality?: string;
+        voice?: string;
+        topic?: string;
+        vocab?: string[];
+        questions?: string[];
+        showHints?: boolean;
     }[]>;
     getCard: (params: {
         cardId: string;
@@ -593,6 +639,14 @@ declare const createCardRepo: () => {
         correct_answer_exact_match?: boolean;
         ai_context_block_ids?: string[];
         resolvedContext?: string;
+        goal?: string;
+        mode?: ConversationPageMode;
+        personality?: string;
+        voice?: string;
+        topic?: string;
+        vocab?: string[];
+        questions?: string[];
+        showHints?: boolean;
     } | null>;
 };
 
@@ -603,6 +657,7 @@ declare function checkIsRespondWrittenPage(cardType: ActivityPageType | undefine
 declare function checkIsRespondAudioPage(cardType: ActivityPageType | undefined): boolean;
 declare const checkIsMediaPage: (cardType: ActivityPageType | undefined) => boolean;
 declare const checkIsShortAnswerPage: (cardType: ActivityPageType | undefined) => boolean;
+declare const checkIsConversationPage: (cardType: ActivityPageType | undefined) => boolean;
 declare const checkTypePageActivity: (cardType: ActivityPageType | undefined) => {
     isRespondAudio: boolean;
     isRespondWritten: boolean;
@@ -612,6 +667,7 @@ declare const checkTypePageActivity: (cardType: ActivityPageType | undefined) =>
     isMediaPage: boolean;
     isShortAnswer: boolean;
     hasSomeType: boolean;
+    isConversation: boolean;
 };
 
 declare function getPagePrompt(card: PageActivityWithId | undefined): {
@@ -1451,6 +1507,14 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             correct_answer_exact_match?: boolean;
             ai_context_block_ids?: string[];
             resolvedContext?: string;
+            goal?: string;
+            mode?: ConversationPageMode;
+            personality?: string;
+            voice?: string;
+            topic?: string;
+            vocab?: string[];
+            questions?: string[];
+            showHints?: boolean;
         }[]>;
         getCard: (params: {
             cardId: string;
@@ -1526,6 +1590,14 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             correct_answer_exact_match?: boolean;
             ai_context_block_ids?: string[];
             resolvedContext?: string;
+            goal?: string;
+            mode?: ConversationPageMode;
+            personality?: string;
+            voice?: string;
+            topic?: string;
+            vocab?: string[];
+            questions?: string[];
+            showHints?: boolean;
         } | null>;
     };
 };
@@ -1785,6 +1857,14 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
             correct_answer_exact_match?: boolean;
             ai_context_block_ids?: string[];
             resolvedContext?: string;
+            goal?: string;
+            mode?: ConversationPageMode;
+            personality?: string;
+            voice?: string;
+            topic?: string;
+            vocab?: string[];
+            questions?: string[];
+            showHints?: boolean;
         } | null, Error>[];
         cardsArray: PageActivityWithId[];
     };
@@ -3333,6 +3413,14 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             correct_answer_exact_match?: boolean;
             ai_context_block_ids?: string[];
             resolvedContext?: string;
+            goal?: string;
+            mode?: ConversationPageMode;
+            personality?: string;
+            voice?: string;
+            topic?: string;
+            vocab?: string[];
+            questions?: string[];
+            showHints?: boolean;
         }[]>;
         getCard: (params: {
             cardId: string;
@@ -3408,8 +3496,16 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             correct_answer_exact_match?: boolean;
             ai_context_block_ids?: string[];
             resolvedContext?: string;
+            goal?: string;
+            mode?: ConversationPageMode;
+            personality?: string;
+            voice?: string;
+            topic?: string;
+            vocab?: string[];
+            questions?: string[];
+            showHints?: boolean;
         } | null>;
     };
 };
 
-export { ActivityPageType, type Assignment, type AssignmentAnalyticsType$1 as AssignmentAnalyticsType, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, 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, 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_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

@@ -1594,6 +1594,11 @@ import { useMutation as useMutation2, useQueries, useQuery as useQuery3 } from "
 import { useMemo } from "react";
 
 // src/domains/cards/card.model.ts
+var ConversationPageMode = /* @__PURE__ */ ((ConversationPageMode2) => {
+  ConversationPageMode2["VoiceAndText"] = "voice_and_text";
+  ConversationPageMode2["PhoneCall"] = "phone_call";
+  return ConversationPageMode2;
+})(ConversationPageMode || {});
 var ActivityPageType = /* @__PURE__ */ ((ActivityPageType2) => {
   ActivityPageType2["READ_REPEAT"] = "READ_REPEAT";
   ActivityPageType2["READ_RESPOND"] = "READ_RESPOND";
@@ -1604,6 +1609,7 @@ var ActivityPageType = /* @__PURE__ */ ((ActivityPageType2) => {
   ActivityPageType2["MULTIPLE_CHOICE"] = "MULTIPLE_CHOICE";
   ActivityPageType2["MEDIA_PAGE"] = "MEDIA_PAGE";
   ActivityPageType2["SHORT_ANSWER"] = "SHORT_ANSWER";
+  ActivityPageType2["CONVERSATION"] = "CONVERSATION";
   return ActivityPageType2;
 })(ActivityPageType || {});
 var RESPOND_PAGE_ACTIVITY_TYPES = [
@@ -1622,6 +1628,7 @@ var RESPOND_AUDIO_PAGE_ACTIVITY_TYPES = [
   "RESPOND" /* RESPOND */,
   "READ_RESPOND" /* READ_RESPOND */
 ];
+var CONVERSATION_PAGE_ACTIVITY_TYPES = ["CONVERSATION" /* CONVERSATION */];
 
 // src/domains/cards/card.constants.ts
 var FeedbackTypesCard = /* @__PURE__ */ ((FeedbackTypesCard2) => {
@@ -1951,6 +1958,10 @@ var checkIsShortAnswerPage = (cardType) => {
   if (cardType === void 0) return false;
   return cardType === "SHORT_ANSWER" /* SHORT_ANSWER */;
 };
+var checkIsConversationPage = (cardType) => {
+  if (cardType === void 0) return false;
+  return cardType === "CONVERSATION" /* CONVERSATION */;
+};
 var checkTypePageActivity = (cardType) => {
   const isRespondAudio = checkIsRespondAudioPage(cardType);
   const isRespondWritten = checkIsRespondWrittenPage(cardType);
@@ -1959,7 +1970,8 @@ var checkTypePageActivity = (cardType) => {
   const isRepeat = checkIsRepeatPage(cardType);
   const isMediaPage = checkIsMediaPage(cardType);
   const isShortAnswer = checkIsShortAnswerPage(cardType);
-  const isNoOneOfThem = !isRespond && !isMC && !isRepeat && !isMediaPage && !isShortAnswer;
+  const isConversation = checkIsConversationPage(cardType);
+  const isNoOneOfThem = !isRespond && !isMC && !isRepeat && !isMediaPage && !isShortAnswer && !isConversation;
   if (isNoOneOfThem) {
     return {
       isRespondAudio: false,
@@ -1969,7 +1981,8 @@ var checkTypePageActivity = (cardType) => {
       isRepeat: true,
       isMediaPage: false,
       isShortAnswer: false,
-      hasSomeType: false
+      hasSomeType: false,
+      isConversation: false
     };
   }
   return {
@@ -1980,7 +1993,8 @@ var checkTypePageActivity = (cardType) => {
     isRepeat,
     isMediaPage,
     isShortAnswer,
-    hasSomeType: true
+    hasSomeType: true,
+    isConversation
   };
 };
 
@@ -1991,7 +2005,9 @@ function extractTextFromRichText(richText) {
 }
 function getPagePrompt(card) {
   if (!card) return { has: false, text: "", rich_text: "", isTextEqualToRichText: false };
-  const { isMC, isRepeat, isRespond, isShortAnswer } = checkTypePageActivity(card == null ? void 0 : card.type);
+  const { isMC, isRepeat, isRespond, isShortAnswer, isConversation } = checkTypePageActivity(
+    card == null ? void 0 : card.type
+  );
   const hidePrompt = (card == null ? void 0 : card.hidePrompt) === true;
   const createReturnObject = (text, richText) => {
     const plainText = text || "";
@@ -2006,6 +2022,9 @@ function getPagePrompt(card) {
   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.goal, card == null ? void 0 : card.rich_text);
+  }
   if (isRespond && !hidePrompt) {
     return createReturnObject(card == null ? void 0 : card.prompt, card == null ? void 0 : card.rich_text);
   }
@@ -3767,6 +3786,8 @@ export {
   BASE_MULTIPLE_CHOICE_FIELD_VALUES,
   BASE_REPEAT_FIELD_VALUES,
   BASE_RESPOND_FIELD_VALUES,
+  CONVERSATION_PAGE_ACTIVITY_TYPES,
+  ConversationPageMode,
   FeedbackTypesCard,
   FsCtx,
   LENIENCY_OPTIONS,
@@ -3783,6 +3804,7 @@ export {
   VerificationCardStatus,
   assignmentQueryKeys,
   cardsQueryKeys,
+  checkIsConversationPage,
   checkIsMCPage,
   checkIsMediaPage,
   checkIsRepeatPage,