@speakableio/core 1.0.49 → 1.0.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -92,6 +92,10 @@ interface MediaPageActivity {
92
92
  url: string;
93
93
  transcript?: string | null;
94
94
  }
95
+ declare enum ConversationPageMode {
96
+ VoiceAndText = "voice_and_text",
97
+ PhoneCall = "phone_call"
98
+ }
95
99
  interface PageActivity {
96
100
  owners: string[];
97
101
  checked?: boolean;
@@ -163,6 +167,14 @@ interface PageActivity {
163
167
  correct_answer_exact_match?: boolean;
164
168
  ai_context_block_ids?: string[];
165
169
  resolvedContext?: string;
170
+ goal?: string;
171
+ mode?: ConversationPageMode;
172
+ personality?: string;
173
+ voice?: string;
174
+ topic?: string;
175
+ vocab?: string[];
176
+ questions?: string[];
177
+ showHints?: boolean;
166
178
  }
167
179
  declare const enum ActivityPageType {
168
180
  READ_REPEAT = "READ_REPEAT",
@@ -181,6 +193,7 @@ declare const MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES: ActivityPageType[];
181
193
  declare const REPEAT_PAGE_ACTIVITY_TYPES: ActivityPageType[];
182
194
  declare const RESPOND_WRITE_PAGE_ACTIVITY_TYPES: ActivityPageType[];
183
195
  declare const RESPOND_AUDIO_PAGE_ACTIVITY_TYPES: ActivityPageType[];
196
+ declare const CONVERSATION_PAGE_ACTIVITY_TYPES: ActivityPageType[];
184
197
 
185
198
  declare const cardsQueryKeys: {
186
199
  all: string[];
@@ -267,6 +280,14 @@ declare function useCards({ cardIds, enabled, asObject, }: {
267
280
  correct_answer_exact_match?: boolean;
268
281
  ai_context_block_ids?: string[];
269
282
  resolvedContext?: string;
283
+ goal?: string;
284
+ mode?: ConversationPageMode;
285
+ personality?: string;
286
+ voice?: string;
287
+ topic?: string;
288
+ vocab?: string[];
289
+ questions?: string[];
290
+ showHints?: boolean;
270
291
  } | null, Error>[];
271
292
  };
272
293
  declare function useCreateCard(): {
@@ -349,6 +370,14 @@ declare function useCreateCards(): {
349
370
  correct_answer_exact_match?: boolean;
350
371
  ai_context_block_ids?: string[];
351
372
  resolvedContext?: string;
373
+ goal?: string;
374
+ mode?: ConversationPageMode;
375
+ personality?: string;
376
+ voice?: string;
377
+ topic?: string;
378
+ vocab?: string[];
379
+ questions?: string[];
380
+ showHints?: boolean;
352
381
  }[], Error, {
353
382
  cards: PageActivity[];
354
383
  }, unknown>;
@@ -437,6 +466,14 @@ declare function useGetCard({ cardId, enabled }: {
437
466
  correct_answer_exact_match?: boolean;
438
467
  ai_context_block_ids?: string[];
439
468
  resolvedContext?: string;
469
+ goal?: string;
470
+ mode?: ConversationPageMode;
471
+ personality?: string;
472
+ voice?: string;
473
+ topic?: string;
474
+ vocab?: string[];
475
+ questions?: string[];
476
+ showHints?: boolean;
440
477
  } | null, Error>;
441
478
 
442
479
  declare const createCardRepo: () => {
@@ -519,6 +556,14 @@ declare const createCardRepo: () => {
519
556
  correct_answer_exact_match?: boolean;
520
557
  ai_context_block_ids?: string[];
521
558
  resolvedContext?: string;
559
+ goal?: string;
560
+ mode?: ConversationPageMode;
561
+ personality?: string;
562
+ voice?: string;
563
+ topic?: string;
564
+ vocab?: string[];
565
+ questions?: string[];
566
+ showHints?: boolean;
522
567
  }[]>;
523
568
  getCard: (params: {
524
569
  cardId: string;
@@ -594,6 +639,14 @@ declare const createCardRepo: () => {
594
639
  correct_answer_exact_match?: boolean;
595
640
  ai_context_block_ids?: string[];
596
641
  resolvedContext?: string;
642
+ goal?: string;
643
+ mode?: ConversationPageMode;
644
+ personality?: string;
645
+ voice?: string;
646
+ topic?: string;
647
+ vocab?: string[];
648
+ questions?: string[];
649
+ showHints?: boolean;
597
650
  } | null>;
598
651
  };
599
652
 
@@ -1454,6 +1507,14 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
1454
1507
  correct_answer_exact_match?: boolean;
1455
1508
  ai_context_block_ids?: string[];
1456
1509
  resolvedContext?: string;
1510
+ goal?: string;
1511
+ mode?: ConversationPageMode;
1512
+ personality?: string;
1513
+ voice?: string;
1514
+ topic?: string;
1515
+ vocab?: string[];
1516
+ questions?: string[];
1517
+ showHints?: boolean;
1457
1518
  }[]>;
1458
1519
  getCard: (params: {
1459
1520
  cardId: string;
@@ -1529,6 +1590,14 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
1529
1590
  correct_answer_exact_match?: boolean;
1530
1591
  ai_context_block_ids?: string[];
1531
1592
  resolvedContext?: string;
1593
+ goal?: string;
1594
+ mode?: ConversationPageMode;
1595
+ personality?: string;
1596
+ voice?: string;
1597
+ topic?: string;
1598
+ vocab?: string[];
1599
+ questions?: string[];
1600
+ showHints?: boolean;
1532
1601
  } | null>;
1533
1602
  };
1534
1603
  };
@@ -1788,6 +1857,14 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
1788
1857
  correct_answer_exact_match?: boolean;
1789
1858
  ai_context_block_ids?: string[];
1790
1859
  resolvedContext?: string;
1860
+ goal?: string;
1861
+ mode?: ConversationPageMode;
1862
+ personality?: string;
1863
+ voice?: string;
1864
+ topic?: string;
1865
+ vocab?: string[];
1866
+ questions?: string[];
1867
+ showHints?: boolean;
1791
1868
  } | null, Error>[];
1792
1869
  cardsArray: PageActivityWithId[];
1793
1870
  };
@@ -3336,6 +3413,14 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
3336
3413
  correct_answer_exact_match?: boolean;
3337
3414
  ai_context_block_ids?: string[];
3338
3415
  resolvedContext?: string;
3416
+ goal?: string;
3417
+ mode?: ConversationPageMode;
3418
+ personality?: string;
3419
+ voice?: string;
3420
+ topic?: string;
3421
+ vocab?: string[];
3422
+ questions?: string[];
3423
+ showHints?: boolean;
3339
3424
  }[]>;
3340
3425
  getCard: (params: {
3341
3426
  cardId: string;
@@ -3411,8 +3496,16 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
3411
3496
  correct_answer_exact_match?: boolean;
3412
3497
  ai_context_block_ids?: string[];
3413
3498
  resolvedContext?: string;
3499
+ goal?: string;
3500
+ mode?: ConversationPageMode;
3501
+ personality?: string;
3502
+ voice?: string;
3503
+ topic?: string;
3504
+ vocab?: string[];
3505
+ questions?: string[];
3506
+ showHints?: boolean;
3414
3507
  } | null>;
3415
3508
  };
3416
3509
  };
3417
3510
 
3418
- 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, 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 };
3511
+ 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 CHANGED
@@ -1594,6 +1594,11 @@ import { useMutation as useMutation2, useQueries, useQuery as useQuery3 } from "
1594
1594
  import { useMemo } from "react";
1595
1595
 
1596
1596
  // src/domains/cards/card.model.ts
1597
+ var ConversationPageMode = /* @__PURE__ */ ((ConversationPageMode2) => {
1598
+ ConversationPageMode2["VoiceAndText"] = "voice_and_text";
1599
+ ConversationPageMode2["PhoneCall"] = "phone_call";
1600
+ return ConversationPageMode2;
1601
+ })(ConversationPageMode || {});
1597
1602
  var ActivityPageType = /* @__PURE__ */ ((ActivityPageType2) => {
1598
1603
  ActivityPageType2["READ_REPEAT"] = "READ_REPEAT";
1599
1604
  ActivityPageType2["READ_RESPOND"] = "READ_RESPOND";
@@ -1623,6 +1628,7 @@ var RESPOND_AUDIO_PAGE_ACTIVITY_TYPES = [
1623
1628
  "RESPOND" /* RESPOND */,
1624
1629
  "READ_RESPOND" /* READ_RESPOND */
1625
1630
  ];
1631
+ var CONVERSATION_PAGE_ACTIVITY_TYPES = ["CONVERSATION" /* CONVERSATION */];
1626
1632
 
1627
1633
  // src/domains/cards/card.constants.ts
1628
1634
  var FeedbackTypesCard = /* @__PURE__ */ ((FeedbackTypesCard2) => {
@@ -1999,7 +2005,9 @@ function extractTextFromRichText(richText) {
1999
2005
  }
2000
2006
  function getPagePrompt(card) {
2001
2007
  if (!card) return { has: false, text: "", rich_text: "", isTextEqualToRichText: false };
2002
- const { isMC, isRepeat, isRespond, isShortAnswer } = checkTypePageActivity(card == null ? void 0 : card.type);
2008
+ const { isMC, isRepeat, isRespond, isShortAnswer, isConversation } = checkTypePageActivity(
2009
+ card == null ? void 0 : card.type
2010
+ );
2003
2011
  const hidePrompt = (card == null ? void 0 : card.hidePrompt) === true;
2004
2012
  const createReturnObject = (text, richText) => {
2005
2013
  const plainText = text || "";
@@ -2014,6 +2022,9 @@ function getPagePrompt(card) {
2014
2022
  if (isRepeat) {
2015
2023
  return createReturnObject(card == null ? void 0 : card.target_text, card == null ? void 0 : card.rich_text);
2016
2024
  }
2025
+ if (isConversation) {
2026
+ return createReturnObject(card == null ? void 0 : card.goal, card == null ? void 0 : card.rich_text);
2027
+ }
2017
2028
  if (isRespond && !hidePrompt) {
2018
2029
  return createReturnObject(card == null ? void 0 : card.prompt, card == null ? void 0 : card.rich_text);
2019
2030
  }
@@ -3775,6 +3786,8 @@ export {
3775
3786
  BASE_MULTIPLE_CHOICE_FIELD_VALUES,
3776
3787
  BASE_REPEAT_FIELD_VALUES,
3777
3788
  BASE_RESPOND_FIELD_VALUES,
3789
+ CONVERSATION_PAGE_ACTIVITY_TYPES,
3790
+ ConversationPageMode,
3778
3791
  FeedbackTypesCard,
3779
3792
  FsCtx,
3780
3793
  LENIENCY_OPTIONS,