@speakableio/core 1.0.35 → 1.0.37

package/dist/index.web.d.mts

@@ -97,6 +97,7 @@ interface PageActivity {
     media?: {
         type: 'image' | 'video' | 'link';
         url: string;
+        transcript?: string | null;
     } | null;
     score?: number;
     verificationStatus?: VerificationCardStatus;
@@ -157,6 +158,8 @@ interface PageActivity {
     limit_attempts?: boolean;
     max_attempts?: number;
     rich_text?: string;
+    feedbackOff?: boolean;
+    correct_answer_exact_match?: boolean;
 }
 declare const enum ActivityPageType {
     READ_REPEAT = "READ_REPEAT",
@@ -200,6 +203,7 @@ declare function useCards({ cardIds, enabled, asObject, }: {
         media?: {
             type: "image" | "video" | "link";
             url: string;
+            transcript?: string | null;
         } | null;
         score?: number;
         verificationStatus?: VerificationCardStatus;
@@ -259,6 +263,8 @@ declare function useCards({ cardIds, enabled, asObject, }: {
         limit_attempts?: boolean;
         max_attempts?: number;
         rich_text?: string;
+        feedbackOff?: boolean;
+        correct_answer_exact_match?: boolean;
     } | null, Error>[];
 };
 declare function useCreateCard(): {
@@ -280,6 +286,7 @@ declare function useCreateCards(): {
         media?: {
             type: "image" | "video" | "link";
             url: string;
+            transcript?: string | null;
         } | null;
         score?: number;
         verificationStatus?: VerificationCardStatus;
@@ -340,6 +347,8 @@ declare function useCreateCards(): {
         limit_attempts?: boolean;
         max_attempts?: number;
         rich_text?: string;
+        feedbackOff?: boolean;
+        correct_answer_exact_match?: boolean;
     }[], Error, {
         cards: PageActivity[];
     }, unknown>;
@@ -368,6 +377,7 @@ declare function useGetCard({ cardId, enabled }: {
     media?: {
         type: "image" | "video" | "link";
         url: string;
+        transcript?: string | null;
     } | null;
     score?: number;
     verificationStatus?: VerificationCardStatus;
@@ -427,6 +437,8 @@ declare function useGetCard({ cardId, enabled }: {
     limit_attempts?: boolean;
     max_attempts?: number;
     rich_text?: string;
+    feedbackOff?: boolean;
+    correct_answer_exact_match?: boolean;
 } | null, Error>;
 
 declare const createCardRepo: () => {
@@ -448,6 +460,7 @@ declare const createCardRepo: () => {
         media?: {
             type: "image" | "video" | "link";
             url: string;
+            transcript?: string | null;
         } | null;
         score?: number;
         verificationStatus?: VerificationCardStatus;
@@ -508,6 +521,8 @@ declare const createCardRepo: () => {
         limit_attempts?: boolean;
         max_attempts?: number;
         rich_text?: string;
+        feedbackOff?: boolean;
+        correct_answer_exact_match?: boolean;
     }[]>;
     getCard: (params: {
         cardId: string;
@@ -523,6 +538,7 @@ declare const createCardRepo: () => {
         media?: {
             type: "image" | "video" | "link";
             url: string;
+            transcript?: string | null;
         } | null;
         score?: number;
         verificationStatus?: VerificationCardStatus;
@@ -582,6 +598,8 @@ declare const createCardRepo: () => {
         limit_attempts?: boolean;
         max_attempts?: number;
         rich_text?: string;
+        feedbackOff?: boolean;
+        correct_answer_exact_match?: boolean;
     } | null>;
 };
 
@@ -617,6 +635,18 @@ declare const getLabelPage: (pageType: ActivityPageType | undefined) => {
     long: string;
 };
 
+/**
+ * Get the media data for a page
+ * @param page - The page to get the media data for
+ * @returns The media data for the page
+
+ * - direction: The direction of the media area
+ * - mode: The mode of the media area
+ * - singleMedia: The single media data for the page
+ * - isMediaPage: Whether the page is a media page
+ * - hasMediaData: Whether the page has some kind of media data
+ * - mediaAreaId: The id of the media area
+ */
 declare function getPageMediaData(page: PageActivityWithId): {
     direction: "left" | "right";
     mode: "single" | "media_area" | "none" | null;
@@ -624,17 +654,21 @@ declare function getPageMediaData(page: PageActivityWithId): {
         rawObject: {
             type: "image" | "video" | "link";
             url: string;
+            transcript?: string | null;
         };
         type: "image" | "video" | "link";
         content: string;
     } | undefined;
     isMediaPage: boolean;
-    hasMediaData: string | boolean;
+    hasMediaData: boolean;
+    mediaAreaId: string | undefined;
+    shouldRenderMediaArea: boolean;
 };
 declare function getSingleMediaPageData(page: PageActivityWithId): {
     rawObject: {
         type: "image" | "video" | "link";
         url: string;
+        transcript?: string | null;
     };
     type: "image" | "video" | "link";
     content: string;
@@ -1375,6 +1409,7 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             media?: {
                 type: "image" | "video" | "link";
                 url: string;
+                transcript?: string | null;
             } | null;
             score?: number;
             verificationStatus?: VerificationCardStatus;
@@ -1435,6 +1470,8 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             limit_attempts?: boolean;
             max_attempts?: number;
             rich_text?: string;
+            feedbackOff?: boolean;
+            correct_answer_exact_match?: boolean;
         }[]>;
         getCard: (params: {
             cardId: string;
@@ -1450,6 +1487,7 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             media?: {
                 type: "image" | "video" | "link";
                 url: string;
+                transcript?: string | null;
             } | null;
             score?: number;
             verificationStatus?: VerificationCardStatus;
@@ -1509,6 +1547,8 @@ declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
             limit_attempts?: boolean;
             max_attempts?: number;
             rich_text?: string;
+            feedbackOff?: boolean;
+            correct_answer_exact_match?: boolean;
         } | null>;
     };
 };
@@ -1708,6 +1748,7 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
             media?: {
                 type: "image" | "video" | "link";
                 url: string;
+                transcript?: string | null;
             } | null;
             score?: number;
             verificationStatus?: VerificationCardStatus;
@@ -1767,6 +1808,8 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData,
             limit_attempts?: boolean;
             max_attempts?: number;
             rich_text?: string;
+            feedbackOff?: boolean;
+            correct_answer_exact_match?: boolean;
         } | null, Error>[];
         cardsArray: PageActivityWithId[];
     };
@@ -3254,6 +3297,7 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             media?: {
                 type: "image" | "video" | "link";
                 url: string;
+                transcript?: string | null;
             } | null;
             score?: number;
             verificationStatus?: VerificationCardStatus;
@@ -3314,6 +3358,8 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             limit_attempts?: boolean;
             max_attempts?: number;
             rich_text?: string;
+            feedbackOff?: boolean;
+            correct_answer_exact_match?: boolean;
         }[]>;
         getCard: (params: {
             cardId: string;
@@ -3329,6 +3375,7 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             media?: {
                 type: "image" | "video" | "link";
                 url: string;
+                transcript?: string | null;
             } | null;
             score?: number;
             verificationStatus?: VerificationCardStatus;
@@ -3388,6 +3435,8 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
             limit_attempts?: boolean;
             max_attempts?: number;
             rich_text?: string;
+            feedbackOff?: boolean;
+            correct_answer_exact_match?: boolean;
         } | null>;
     };
 };

package/dist/index.web.js

@@ -2109,18 +2109,22 @@ var getLabelPage = (pageType) => {
 
 // src/domains/cards/utils/get-page-media-data.ts
 function getPageMediaData(page) {
-  var _a, _b;
+  var _a, _b, _c, _d;
   const direction = (_a = page.media_area_layout) != null ? _a : "left";
   const { isMediaPage } = checkTypePageActivity(page.type);
   const mode = (_b = page.media_mode) != null ? _b : page.media_area_id ? "media_area" : null;
   const singleMedia = getSingleMediaPageData(page);
-  const hasMediaData = !!page.media_area_id || page.media_area_context_ref || singleMedia !== void 0;
+  const mediaAreaId = (_d = (_c = page.media_area_id) != null ? _c : page.media_area_context_ref) != null ? _d : void 0;
+  const shouldRenderMediaArea = isMediaPage || mode === "media_area" || !(page == null ? void 0 : page.media_mode) && mediaAreaId != null;
+  const hasMediaData = !!page.media_area_id || !!page.media_area_context_ref || singleMedia !== void 0;
   return {
     direction,
     mode,
     singleMedia,
     isMediaPage,
-    hasMediaData
+    hasMediaData,
+    mediaAreaId,
+    shouldRenderMediaArea
   };
 }
 function getSingleMediaPageData(page) {