@speakableio/core 0.1.65 → 0.1.66

package/dist/index.web.d.mts

@@ -3,7 +3,7 @@ import React from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
 import { FirebaseFirestoreTypes, Timestamp } from '@react-native-firebase/firestore';
-import { Firestore, getDoc, getDocs, addDoc, setDoc, updateDoc, deleteDoc, runTransaction, writeBatch, doc, collection, query, serverTimestamp, orderBy, limit, startAt, startAfter, endAt, endBefore, where, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
+import { Firestore, getDoc, getDocs, addDoc, setDoc, updateDoc, deleteDoc, runTransaction, writeBatch, doc, collection, query, serverTimestamp, orderBy, limit, startAt, startAfter, endAt, endBefore, where, increment, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
 
 type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
 interface FirestoreHelpers {
@@ -26,6 +26,7 @@ interface FirestoreHelpers {
     endAt: typeof endAt;
     endBefore: typeof endBefore;
     where: typeof where;
+    increment: typeof increment;
 }
 type CustomTimestamp = Timestamp | Timestamp$1;
 type CallableFunction<T = any, R = any> = (data: T) => Promise<R>;
@@ -1228,6 +1229,7 @@ declare function debounce<T extends (...args: any[]) => Promise<any>>(func: T, w
 declare const purify: (word: string) => string;
 declare const cleanString: (words: string) => string | string[];
 declare const getWordHash: (word: string, language: string) => string;
+declare function getPhraseLength(phrase: string, input?: string): number;
 
 declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData, }: {
     id: string;
@@ -2310,6 +2312,18 @@ declare const useOrganizationAccess: () => {
     promise: Promise<OrganizationAccess>;
 };
 
+declare const useUpdateStudentVocab: (page: PageActivityWithId | null) => {
+    markVoiceSuccess: undefined;
+    markVoiceFail: undefined;
+    studentVocabMarkVoiceSuccess?: undefined;
+    studentVocabMarkVoiceFail?: undefined;
+} | {
+    studentVocabMarkVoiceSuccess: () => Promise<void>;
+    studentVocabMarkVoiceFail: () => Promise<void>;
+    markVoiceSuccess?: undefined;
+    markVoiceFail?: undefined;
+};
+
 declare const useBaseOpenAI: ({ onTranscriptSuccess, onTranscriptError, onCompletionSuccess, onCompletionError, aiEnabled, submitAudioResponse, uploadAudioAndGetTranscript, }: {
     onTranscriptSuccess: (transcript: string) => void;
     onTranscriptError: ({ type, message }: {
@@ -2721,4 +2735,4 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
     };
 };
 
-export { ActivityPageType, type Assignment, 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 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, getPagePrompt, 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 CreditContract, FeedbackTypesCard, FsCtx, type InstitutionSubscription, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_PAGE_ACTIVITY_TYPES, 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, getPagePrompt, getPhraseLength, 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, useUpdateStudentVocab, useUserCredits };

package/dist/index.web.js

@@ -95,7 +95,7 @@ var FirebaseAPI = class _FirebaseAPI {
     (_a = this.config) == null ? void 0 : _a.logEvent(name, data);
   }
   accessQueryConstraints() {
-    const { query: query2, orderBy: orderBy2, limit: limit2, startAt: startAt2, startAfter: startAfter2, endAt: endAt2, endBefore: endBefore2, where: where2 } = this.helpers;
+    const { query: query2, orderBy: orderBy2, limit: limit2, startAt: startAt2, startAfter: startAfter2, endAt: endAt2, endBefore: endBefore2, where: where2, increment: increment2 } = this.helpers;
     return {
       query: query2,
       orderBy: orderBy2,
@@ -104,7 +104,8 @@ var FirebaseAPI = class _FirebaseAPI {
       startAfter: startAfter2,
       endAt: endAt2,
       endBefore: endBefore2,
-      where: where2
+      where: where2,
+      increment: increment2
     };
   }
   accessHelpers() {
@@ -1669,6 +1670,13 @@ var getWordHash = (word, language) => {
   console.log("wordHash core library", wordHash);
   return wordHash;
 };
+function getPhraseLength(phrase, input) {
+  if (Array.isArray(phrase) && phrase.includes(input)) {
+    return phrase[phrase.indexOf(input)].split(" ").length;
+  } else {
+    return phrase ? phrase.split(" ").length : 0;
+  }
+}
 
 // src/domains/cards/services/get-card-verification-status.service.ts
 var charactarLanguages = ["zh", "ja", "ko"];
@@ -2675,6 +2683,91 @@ var getOrganizationAccess = async (email) => {
   }
 };
 
+// src/hooks/useUpdateStudentVoc.ts
+var useUpdateStudentVocab = (page) => {
+  const { user } = useSpeakableApi();
+  const currentUserId = user == null ? void 0 : user.auth.uid;
+  if (!page || !currentUserId || !page.target_text || !page.language) {
+    return {
+      markVoiceSuccess: void 0,
+      markVoiceFail: void 0
+    };
+  }
+  const getDataObject = () => {
+    var _a, _b;
+    const { serverTimestamp: serverTimestamp2 } = api.accessHelpers();
+    const language = (_a = page.language) != null ? _a : "en";
+    const word = (_b = page.target_text) != null ? _b : "";
+    const phrase_length = getPhraseLength(word);
+    const wordHash = getWordHash(word, language);
+    const docPath = `users/${currentUserId}/vocab/${wordHash}`;
+    const communityPath = `checked-pronunciations/${wordHash}`;
+    const id = `${language}-${cleanString(word)}`;
+    const data = {
+      id,
+      word,
+      words: (word == null ? void 0 : word.split(" ")) || [],
+      wordHash,
+      language,
+      lastSeen: serverTimestamp2(),
+      phrase_length
+    };
+    return {
+      docPath,
+      communityPath,
+      data
+    };
+  };
+  const markVoiceSuccess = async () => {
+    const { docPath, communityPath, data } = getDataObject();
+    const { increment: increment2 } = api.accessQueryConstraints();
+    const { serverTimestamp: serverTimestamp2 } = api.accessHelpers();
+    data.voiceSuccess = increment2(1);
+    try {
+      await api.updateDoc(docPath, data);
+    } catch (error) {
+      if (error instanceof Error && error.message === "not-found") {
+        data.firstSeen = serverTimestamp2();
+        await api.setDoc(docPath, data);
+      } else {
+        console.log(error);
+      }
+    }
+    try {
+      data.pronunciations = increment2(1);
+      await api.setDoc(communityPath, data, { merge: true });
+    } catch (error) {
+      console.log(error);
+    }
+  };
+  const markVoiceFail = async () => {
+    const { docPath, communityPath, data } = getDataObject();
+    const { increment: increment2 } = api.accessQueryConstraints();
+    const { serverTimestamp: serverTimestamp2 } = api.accessHelpers();
+    data.voiceFail = increment2(1);
+    try {
+      await api.updateDoc(docPath, data);
+    } catch (error) {
+      if (error instanceof Error && error.message === "not-found") {
+        data.firstSeen = serverTimestamp2();
+        await api.setDoc(docPath, data);
+      } else {
+        console.log(error);
+      }
+    }
+    try {
+      data.fails = increment2(1);
+      await api.setDoc(communityPath, data, { merge: true });
+    } catch (error) {
+      console.log(error);
+    }
+  };
+  return {
+    studentVocabMarkVoiceSuccess: markVoiceSuccess,
+    studentVocabMarkVoiceFail: markVoiceFail
+  };
+};
+
 // src/hooks/useActivityFeedbackAccess.ts
 import { useQuery as useQuery7 } from "@tanstack/react-query";
 var activityFeedbackAccessQueryKeys = {
@@ -3014,7 +3107,8 @@ import {
   startAfter,
   endAt,
   endBefore,
-  where
+  where,
+  increment
 } from "firebase/firestore";
 
 // src/lib/create-firebase-client.ts
@@ -3062,7 +3156,8 @@ var createFsClientWeb = ({ db, httpsCallable, logEvent }) => {
       startAfter,
       endAt,
       endBefore,
-      where
+      where,
+      increment
     }
   });
 };
@@ -3104,6 +3199,7 @@ export {
   debounce,
   getCardFromCache,
   getPagePrompt,
+  getPhraseLength,
   getRespondCardTool,
   getSetFromCache,
   getWordHash,
@@ -3132,6 +3228,7 @@ export {
   useSubmitPracticeScore,
   useUpdateCardScore,
   useUpdateScore,
+  useUpdateStudentVocab,
   useUserCredits
 };
 //# sourceMappingURL=index.web.js.map