@speakableio/core 0.1.60 → 0.1.62

package/dist/index.native.d.mts

@@ -478,10 +478,10 @@ declare const refsCardsFiresotre: {
     card: (id: string) => `flashcards/${string}`;
 };
 
-interface CardActivityWithId extends CardActivity {
+interface PageActivityWithId extends PageActivity {
     id: string;
 }
-interface CardActivity {
+interface PageActivity {
     owners: string[];
     checked?: boolean;
     completed?: boolean;
@@ -504,7 +504,7 @@ interface CardActivity {
     difficulty?: string;
     default_language?: string;
     target_text?: string;
-    type: CardActivityType;
+    type: ActivityPageType;
     grading_criteria?: string;
     scoring_type?: string;
     grading_method?: 'simple' | 'rubric' | 'manual' | 'standards_based';
@@ -542,7 +542,7 @@ interface CardActivity {
     target_proficiency_level?: string;
     allowTTS?: boolean;
 }
-declare const enum CardActivityType {
+declare const enum ActivityPageType {
     READ_REPEAT = "READ_REPEAT",
     VIDEO = "VIDEO",
     TEXT = "TEXT",
@@ -567,12 +567,11 @@ declare const enum CardActivityType {
     READ = "READ",
     ANSWER = "ANSWER"
 }
-declare const RESPOND_CARD_ACTIVITY_TYPES: CardActivityType[];
-declare const MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES: CardActivityType[];
-declare const REPEAT_CARD_ACTIVITY_TYPES: CardActivityType[];
-declare const RESPOND_WRITE_CARD_ACTIVITY_TYPES: CardActivityType[];
-declare const RESPOND_AUDIO_CARD_ACTIVITY_TYPES: CardActivityType[];
-declare const ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY: CardActivityType[];
+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 cardsQueryKeys: {
     all: string[];
@@ -585,15 +584,15 @@ declare function useCards({ cardIds, enabled, asObject, }: {
     enabled: boolean;
     asObject?: boolean;
 }): {
-    cards: CardActivityWithId[];
-    cardsObject: Record<string, CardActivityWithId> | null;
-    cardsQueries: _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>[];
+    cards: PageActivityWithId[];
+    cardsObject: Record<string, PageActivityWithId> | null;
+    cardsQueries: _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>[];
 };
 declare function useCreateCard(): {
     mutationCreateCard: _tanstack_react_query.UseMutationResult<{
         id: string;
-    } & Partial<CardActivity>, Error, {
-        data: Partial<CardActivity>;
+    } & Partial<PageActivity>, Error, {
+        data: Partial<PageActivity>;
     }, unknown>;
 };
 declare function useCreateCards(): {
@@ -621,7 +620,7 @@ declare function useCreateCards(): {
         difficulty?: string;
         default_language?: string;
         target_text?: string;
-        type: CardActivityType;
+        type: ActivityPageType;
         grading_criteria?: string;
         scoring_type?: string;
         grading_method?: "simple" | "rubric" | "manual" | "standards_based";
@@ -659,31 +658,31 @@ declare function useCreateCards(): {
         target_proficiency_level?: string;
         allowTTS?: boolean;
     }[], Error, {
-        cards: CardActivity[];
+        cards: PageActivity[];
     }, unknown>;
 };
 declare function getCardFromCache({ cardId, queryClient, }: {
     cardId: string;
     queryClient: QueryClient;
-}): CardActivityWithId | undefined;
+}): PageActivityWithId | undefined;
 declare function updateCardInCache({ cardId, card, queryClient, }: {
     cardId: string;
-    card: CardActivityWithId | null;
+    card: PageActivityWithId | null;
     queryClient: QueryClient;
 }): void;
 declare function useGetCard({ cardId, enabled }: {
     cardId: string;
     enabled?: boolean;
-}): _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>;
+}): _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>;
 
 declare const createCardRepo: () => {
     createCard: (args_0: {
-        data: Partial<CardActivity>;
+        data: Partial<PageActivity>;
     }) => Promise<{
         id: string;
-    } & Partial<CardActivity>>;
+    } & Partial<PageActivity>>;
     createCards: (args_0: {
-        cards: CardActivity[];
+        cards: PageActivity[];
     }) => Promise<{
         id: string;
         owners: string[];
@@ -708,7 +707,7 @@ declare const createCardRepo: () => {
         difficulty?: string;
         default_language?: string;
         target_text?: string;
-        type: CardActivityType;
+        type: ActivityPageType;
         grading_criteria?: string;
         scoring_type?: string;
         grading_method?: "simple" | "rubric" | "manual" | "standards_based";
@@ -748,7 +747,24 @@ declare const createCardRepo: () => {
     }[]>;
     getCard: (params: {
         cardId: string;
-    }) => Promise<CardActivityWithId | null>;
+    }) => Promise<PageActivityWithId | null>;
+};
+
+declare function checkIsRepeatPage(cardType: ActivityPageType | undefined): boolean;
+declare function checkIsMCPage(cardType: ActivityPageType | undefined): boolean;
+declare function checkIsRespondPage(cardType: ActivityPageType | undefined): boolean;
+declare function checkIsRespondWrittenPage(cardType: ActivityPageType | undefined): boolean;
+declare function checkIsRespondAudioPage(cardType: ActivityPageType | undefined): boolean;
+declare const checkIsMediaPage: (cardType: ActivityPageType | undefined) => boolean;
+declare const checkIsShortAnswerPage: (cardType: ActivityPageType | undefined) => boolean;
+declare const checkTypePageActivity: (cardType: ActivityPageType | undefined) => {
+    isRespondAudio: boolean;
+    isRespondWritten: boolean;
+    isRespond: boolean;
+    isMC: boolean;
+    isRepeat: boolean;
+    isMediaPage: boolean;
+    isShortAnswer: boolean;
 };
 
 interface SetWithId extends Set {
@@ -774,7 +790,7 @@ interface Set {
     name: string;
     content: string[];
     types: {
-        [key in CardActivityType]?: number;
+        [key in ActivityPageType]?: number;
     };
     defaultLanguage: string;
     createdAt: FieldValue;
@@ -974,12 +990,12 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
     };
     cardRepo: {
         createCard: (args_0: {
-            data: Partial<CardActivity>;
+            data: Partial<PageActivity>;
         }) => Promise<{
             id: string;
-        } & Partial<CardActivity>>;
+        } & Partial<PageActivity>>;
         createCards: (args_0: {
-            cards: CardActivity[];
+            cards: PageActivity[];
         }) => Promise<{
             id: string;
             owners: string[];
@@ -1004,7 +1020,7 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             difficulty?: string;
             default_language?: string;
             target_text?: string;
-            type: CardActivityType;
+            type: ActivityPageType;
             grading_criteria?: string;
             scoring_type?: string;
             grading_method?: "simple" | "rubric" | "manual" | "standards_based";
@@ -1044,7 +1060,7 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
         }[]>;
         getCard: (params: {
             cardId: string;
-        }) => Promise<CardActivityWithId | null>;
+        }) => Promise<PageActivityWithId | null>;
     };
 };
 
@@ -1215,9 +1231,9 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
         query: _tanstack_react_query.UseQueryResult<SetWithId | null, Error>;
     };
     cards: {
-        data: Record<string, CardActivityWithId> | null;
-        query: _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>[];
-        cardsArray: CardActivityWithId[];
+        data: Record<string, PageActivityWithId> | null;
+        query: _tanstack_react_query.UseQueryResult<PageActivityWithId | null, Error>[];
+        cardsArray: PageActivityWithId[];
     };
     assignment: {
         data: AssignmentWithId | {
@@ -2614,12 +2630,12 @@ declare const createFsClientNative: ({ db, httpsCallable, logEvent }: FsClientPa
     };
     cardRepo: {
         createCard: (args_0: {
-            data: Partial<CardActivity>;
+            data: Partial<PageActivity>;
         }) => Promise<{
             id: string;
-        } & Partial<CardActivity>>;
+        } & Partial<PageActivity>>;
         createCards: (args_0: {
-            cards: CardActivity[];
+            cards: PageActivity[];
         }) => Promise<{
             id: string;
             owners: string[];
@@ -2644,7 +2660,7 @@ declare const createFsClientNative: ({ db, httpsCallable, logEvent }: FsClientPa
             difficulty?: string;
             default_language?: string;
             target_text?: string;
-            type: CardActivityType;
+            type: ActivityPageType;
             grading_criteria?: string;
             scoring_type?: string;
             grading_method?: "simple" | "rubric" | "manual" | "standards_based";
@@ -2684,8 +2700,8 @@ declare const createFsClientNative: ({ db, httpsCallable, logEvent }: FsClientPa
         }[]>;
         getCard: (params: {
             cardId: string;
-        }) => Promise<CardActivityWithId | null>;
+        }) => Promise<PageActivityWithId | null>;
     };
 };
 
-export { ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardActivity, CardActivityType, type CardActivityWithId, type CardScore, type CreditContract, FeedbackTypesCard, FsCtx, type InstitutionSubscription, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, type Organization, type OrganizationAccess, REPEAT_CARD_ACTIVITY_TYPES, RESPOND_AUDIO_CARD_ACTIVITY_TYPES, RESPOND_CARD_ACTIVITY_TYPES, RESPOND_WRITE_CARD_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, cleanString, createAssignmentRepo, createCardRepo, createFsClientNative as createFsClient, createSetRepo, creditQueryKeys, debounce, getCardFromCache, getRespondCardTool, getSetFromCache, getWordHash, purify, refsCardsFiresotre, refsSetsFirestore, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useActivityFeedbackAccess, useAssignment, useBaseOpenAI, useCards, useClearScore, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useOrganizationAccess, useScore, useSet, useSpeakableApi, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore, useUserCredits };
+export { ActivityPageType, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardScore, type CreditContract, FeedbackTypesCard, FsCtx, type InstitutionSubscription, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES, type Organization, type OrganizationAccess, type PageActivity, type PageActivityWithId, 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, createFsClientNative as createFsClient, createSetRepo, creditQueryKeys, debounce, getCardFromCache, getRespondCardTool, getSetFromCache, getWordHash, purify, refsCardsFiresotre, refsSetsFirestore, scoreQueryKeys, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useActivityFeedbackAccess, useAssignment, useBaseOpenAI, useCards, useClearScore, useCreateCard, useCreateCards, useCreateNotification, useGetCard, useOrganizationAccess, useScore, useSet, useSpeakableApi, useSubmitAssignmentScore, useSubmitPracticeScore, useUpdateCardScore, useUpdateScore, useUserCredits };

package/dist/index.native.mjs

@@ -1603,57 +1603,48 @@ var getCard = withErrorHandler(_getCard, "getCard");
 import { v4 } from "uuid";
 
 // src/domains/cards/card.model.ts
-var CardActivityType = /* @__PURE__ */ ((CardActivityType2) => {
-  CardActivityType2["READ_REPEAT"] = "READ_REPEAT";
-  CardActivityType2["VIDEO"] = "VIDEO";
-  CardActivityType2["TEXT"] = "TEXT";
-  CardActivityType2["READ_RESPOND"] = "READ_RESPOND";
-  CardActivityType2["FREE_RESPONSE"] = "FREE_RESPONSE";
-  CardActivityType2["REPEAT"] = "REPEAT";
-  CardActivityType2["RESPOND"] = "RESPOND";
-  CardActivityType2["RESPOND_WRITE"] = "RESPOND_WRITE";
-  CardActivityType2["TEXT_TO_SPEECH"] = "TEXT_TO_SPEECH";
-  CardActivityType2["MULTIPLE_CHOICE"] = "MULTIPLE_CHOICE";
-  CardActivityType2["PODCAST"] = "PODCAST";
-  CardActivityType2["MEDIA_PAGE"] = "MEDIA_PAGE";
-  CardActivityType2["WRITE"] = "WRITE";
-  CardActivityType2["SHORT_ANSWER"] = "SHORT_ANSWER";
-  CardActivityType2["SHORT_STORY"] = "SHORT_STORY";
-  CardActivityType2["SPEAK"] = "SPEAK";
-  CardActivityType2["CONVERSATION"] = "CONVERSATION";
-  CardActivityType2["CONVERSATION_WRITE"] = "CONVERSATION_WRITE";
-  CardActivityType2["DIALOGUE"] = "DIALOGUE";
-  CardActivityType2["INSTRUCTION"] = "INSTRUCTION";
-  CardActivityType2["LISTEN"] = "LISTEN";
-  CardActivityType2["READ"] = "READ";
-  CardActivityType2["ANSWER"] = "ANSWER";
-  return CardActivityType2;
-})(CardActivityType || {});
-var RESPOND_CARD_ACTIVITY_TYPES = [
+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_CARD_ACTIVITY_TYPES = ["MULTIPLE_CHOICE" /* MULTIPLE_CHOICE */];
-var REPEAT_CARD_ACTIVITY_TYPES = ["READ_REPEAT" /* READ_REPEAT */, "REPEAT" /* REPEAT */];
-var RESPOND_WRITE_CARD_ACTIVITY_TYPES = [
+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_CARD_ACTIVITY_TYPES = [
+var RESPOND_AUDIO_PAGE_ACTIVITY_TYPES = [
   "RESPOND" /* RESPOND */,
   "READ_RESPOND" /* READ_RESPOND */
 ];
-var ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY = [
-  "REPEAT" /* REPEAT */,
-  "RESPOND" /* RESPOND */,
-  "READ_REPEAT" /* READ_REPEAT */,
-  "READ_RESPOND" /* READ_RESPOND */,
-  "FREE_RESPONSE" /* FREE_RESPONSE */,
-  "RESPOND_WRITE" /* RESPOND_WRITE */,
-  "MULTIPLE_CHOICE" /* MULTIPLE_CHOICE */
-];
 
 // src/utils/text-utils.ts
 import sha1 from "js-sha1";
@@ -1832,6 +1823,54 @@ var createCardRepo = () => {
   };
 };
 
+// src/domains/cards/utils/check-page-type.ts
+function checkIsRepeatPage(cardType) {
+  if (cardType === void 0) return false;
+  return REPEAT_PAGE_ACTIVITY_TYPES.includes(cardType);
+}
+function checkIsMCPage(cardType) {
+  if (cardType === void 0) return false;
+  return MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES.includes(cardType);
+}
+function checkIsRespondPage(cardType) {
+  if (cardType === void 0) return false;
+  return RESPOND_PAGE_ACTIVITY_TYPES.includes(cardType);
+}
+function checkIsRespondWrittenPage(cardType) {
+  if (cardType === void 0) return false;
+  return RESPOND_WRITE_PAGE_ACTIVITY_TYPES.includes(cardType);
+}
+function checkIsRespondAudioPage(cardType) {
+  if (cardType === void 0) return false;
+  return RESPOND_AUDIO_PAGE_ACTIVITY_TYPES.includes(cardType);
+}
+var checkIsMediaPage = (cardType) => {
+  if (cardType === void 0) return false;
+  return cardType === "MEDIA_PAGE" /* MEDIA_PAGE */;
+};
+var checkIsShortAnswerPage = (cardType) => {
+  if (cardType === void 0) return false;
+  return cardType === "SHORT_ANSWER" /* SHORT_ANSWER */;
+};
+var checkTypePageActivity = (cardType) => {
+  const isRespondAudio = checkIsRespondAudioPage(cardType);
+  const isRespondWritten = checkIsRespondWrittenPage(cardType);
+  const isRespond = checkIsRespondPage(cardType);
+  const isMC = checkIsMCPage(cardType);
+  const isRepeat = checkIsRepeatPage(cardType);
+  const isMediaPage = checkIsMediaPage(cardType);
+  const isShortAnswer = checkIsShortAnswerPage(cardType);
+  return {
+    isRespondAudio,
+    isRespondWritten,
+    isRespond,
+    isMC,
+    isRepeat,
+    isMediaPage,
+    isShortAnswer
+  };
+};
+
 // src/domains/sets/set.hooks.ts
 import { useQuery as useQuery4 } from "@tanstack/react-query";
 
@@ -2993,20 +3032,19 @@ var createFsClientNative = ({ db, httpsCallable, logEvent }) => {
   });
 };
 export {
-  ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY,
+  ActivityPageType,
   BASE_MULTIPLE_CHOICE_FIELD_VALUES,
   BASE_REPEAT_FIELD_VALUES,
   BASE_RESPOND_FIELD_VALUES,
-  CardActivityType,
   FeedbackTypesCard,
   FsCtx,
   LENIENCY_OPTIONS,
   LeniencyCard,
-  MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES,
-  REPEAT_CARD_ACTIVITY_TYPES,
-  RESPOND_AUDIO_CARD_ACTIVITY_TYPES,
-  RESPOND_CARD_ACTIVITY_TYPES,
-  RESPOND_WRITE_CARD_ACTIVITY_TYPES,
+  MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES,
+  REPEAT_PAGE_ACTIVITY_TYPES,
+  RESPOND_AUDIO_PAGE_ACTIVITY_TYPES,
+  RESPOND_PAGE_ACTIVITY_TYPES,
+  RESPOND_WRITE_PAGE_ACTIVITY_TYPES,
   SPEAKABLE_NOTIFICATIONS,
   STUDENT_LEVELS_OPTIONS,
   SpeakableNotificationTypes,
@@ -3014,6 +3052,14 @@ export {
   VerificationCardStatus,
   assignmentQueryKeys,
   cardsQueryKeys,
+  checkIsMCPage,
+  checkIsMediaPage,
+  checkIsRepeatPage,
+  checkIsRespondAudioPage,
+  checkIsRespondPage,
+  checkIsRespondWrittenPage,
+  checkIsShortAnswerPage,
+  checkTypePageActivity,
   cleanString,
   createAssignmentRepo,
   createCardRepo,