@speakableio/core 1.0.0 → 1.0.2

package/dist/utils.js

@@ -1,646 +0,0 @@
-// src/constants/all-langs.json
-var all_langs_default = {
-  af: "Afrikaans",
-  sq: "Albanian",
-  am: "Amharic",
-  ar: "Arabic",
-  hy: "Armenian",
-  az: "Azerbaijani",
-  eu: "Basque",
-  be: "Belarusian",
-  bn: "Bengali",
-  bs: "Bosnian",
-  bg: "Bulgarian",
-  ca: "Catalan",
-  ceb: "Cebuano",
-  zh: "Chinese",
-  co: "Corsican",
-  hr: "Croatian",
-  cs: "Czech",
-  da: "Danish",
-  nl: "Dutch",
-  en: "English",
-  eo: "Esperanto",
-  et: "Estonian",
-  fi: "Finnish",
-  fr: "French",
-  fy: "Frisian",
-  gl: "Galician",
-  ka: "Georgian",
-  de: "German",
-  el: "Greek",
-  gu: "Gujarati",
-  ht: "Haitian Creole",
-  ha: "Hausa",
-  haw: "Hawaiian",
-  he: "Hebrew",
-  hi: "Hindi",
-  hmn: "Hmong",
-  hu: "Hungarian",
-  is: "Icelandic",
-  ig: "Igbo",
-  id: "Indonesian",
-  ga: "Irish",
-  it: "Italian",
-  ja: "Japanese",
-  jv: "Javanese",
-  kn: "Kannada",
-  kk: "Kazakh",
-  km: "Khmer",
-  ko: "Korean",
-  ku: "Kurdish",
-  ky: "Kyrgyz",
-  lo: "Lao",
-  la: "Latin",
-  lv: "Latvian",
-  lt: "Lithuanian",
-  lb: "Luxembourgish",
-  mk: "Macedonian",
-  mg: "Malagasy",
-  ms: "Malay",
-  ml: "Malayalam",
-  mt: "Maltese",
-  mi: "Maori",
-  mr: "Marathi",
-  mn: "Mongolian",
-  my: "Myanmar (Burmese)",
-  ne: "Nepali",
-  no: "Norwegian",
-  ny: "Nyanja (Chichewa)",
-  ps: "Pashto",
-  fa: "Persian",
-  pl: "Polish",
-  pt: "Portuguese",
-  pa: "Punjabi",
-  ro: "Romanian",
-  ru: "Russian",
-  sm: "Samoan",
-  gd: "Scots Gaelic",
-  sr: "Serbian",
-  st: "Sesotho",
-  sn: "Shona",
-  sd: "Sindhi",
-  si: "Sinhala (Sinhalese)",
-  sk: "Slovak",
-  sl: "Slovenian",
-  so: "Somali",
-  es: "Spanish",
-  su: "Sundanese",
-  sw: "Swahili",
-  sv: "Swedish",
-  tl: "Tagalog (Filipino)",
-  tg: "Tajik",
-  ta: "Tamil",
-  te: "Telugu",
-  th: "Thai",
-  tr: "Turkish",
-  uk: "Ukrainian",
-  ur: "Urdu",
-  uz: "Uzbek",
-  vi: "Vietnamese",
-  cy: "Welsh",
-  xh: "Xhosa",
-  yi: "Yiddish",
-  yo: "Yoruba",
-  zu: "Zulu"
-};
-
-// src/utils/ai/get-respond-card-tool.ts
-var getRespondCardTool = ({
-  language,
-  standard = "actfl"
-}) => {
-  const lang = all_langs_default[language] || "English";
-  const tool = {
-    tool_choice: {
-      type: "function",
-      function: { name: "get_feedback" }
-    },
-    tools: [
-      {
-        type: "function",
-        function: {
-          name: "get_feedback",
-          description: "Get feedback on a student's response",
-          parameters: {
-            type: "object",
-            required: [
-              "success",
-              "score",
-              "score_justification",
-              "errors",
-              "improvedResponse",
-              "compliments"
-            ],
-            properties: {
-              success: {
-                type: "boolean",
-                description: "Mark true if  the student's response was on-topic and generally demonstrated understanding. A few grammar mistakes are acceptable. Mark false if the student's response was off-topic or did not demonstrate understanding."
-              },
-              errors: {
-                type: "array",
-                items: {
-                  type: "object",
-                  required: ["error", "grammar_error_type", "correction", "justification"],
-                  properties: {
-                    error: {
-                      type: "string",
-                      description: "The grammatical error in the student's response."
-                    },
-                    correction: {
-                      type: "string",
-                      description: "The suggested correction to the error"
-                    },
-                    justification: {
-                      type: "string",
-                      description: `An explanation of the rationale behind the suggested correction. WRITE THIS IN ${lang}!`
-                    },
-                    grammar_error_type: {
-                      type: "string",
-                      enum: [
-                        "subjVerbAgree",
-                        "tenseErrors",
-                        "articleMisuse",
-                        "prepositionErrors",
-                        "adjNounAgree",
-                        "pronounErrors",
-                        "wordOrder",
-                        "verbConjugation",
-                        "pluralization",
-                        "negationErrors",
-                        "modalVerbMisuse",
-                        "relativeClause",
-                        "auxiliaryVerb",
-                        "complexSentenceAgreement",
-                        "idiomaticExpression",
-                        "registerInconsistency",
-                        "voiceMisuse"
-                      ],
-                      description: "The type of grammatical error found. It should be one of the following categories: subject-verb agreement, tense errors, article misuse, preposition errors, adjective-noun agreement, pronoun errors, word order, verb conjugation, pluralization errors, negation errors, modal verb misuse, relative clause errors, auxiliary verb misuse, complex sentence agreement, idiomatic expression, register inconsistency, or voice misuse"
-                    }
-                  }
-                },
-                description: "An array of objects, each representing a grammatical error in the student's response. Each object should have the following properties: error, grammar_error_type, correction, and justification. If there were no errors, return an empty array."
-              },
-              compliments: {
-                type: "array",
-                items: {
-                  type: "string"
-                },
-                description: `An array of strings, each representing something the student did well. Each string should be WRITTEN IN  ${lang}!`
-              },
-              improvedResponse: {
-                type: "string",
-                description: "An improved response with proper grammar and more detail, if applicable."
-              },
-              score: {
-                type: "number",
-                description: "A score between 0 and 100, reflecting the overall quality of the response"
-              },
-              score_justification: {
-                type: "string",
-                description: "An explanation of the rationale behind the assigned score, considering both accuracy and fluency"
-              }
-            }
-          }
-        }
-      }
-    ]
-  };
-  if (standard === "wida") {
-    const wida_level = {
-      type: "number",
-      enum: [1, 2, 3, 4, 5, 6],
-      description: `The student's WIDA (World-Class Instructional Design and Assessment) proficiency level. Choose one of the following options: 1, 2, 3, 4, 5, 6 which corresponds to
-				
-				1 - Entering
-				2 - Emerging
-				3 - Developing
-				4 - Expanding
-				5 - Bridging
-				6 - Reaching
-				
-			This is an estimate based on the level of the student's response. Use the descriptions of the WIDA speaking standards to guide your decision.
-				`
-    };
-    const wida_justification = {
-      type: "string",
-      description: `An explanation of the rationale behind the assigned WIDA level of the response, considering both accuracy and fluency. WRITE THIS IN ENGLISH!`
-    };
-    tool.tools[0].function.parameters.required.push("wida_level");
-    tool.tools[0].function.parameters.required.push("wida_justification");
-    tool.tools[0].function.parameters.properties.wida_level = wida_level;
-    tool.tools[0].function.parameters.properties.wida_justification = wida_justification;
-  } else {
-    const actfl_level = {
-      type: "string",
-      enum: ["NL", "NM", "NH", "IL", "IM", "IH", "AL", "AM", "AH", "S", "D"],
-      description: "The student's ACTFL (American Council on the Teaching of Foreign Languages) proficiency level. Choose one of the following options: NL, NM, NH, IL, IM, IH, AL, AM, AH, S, or D"
-    };
-    const actfl_justification = {
-      type: "string",
-      description: "An explanation of the rationale behind the assigned ACTFL level, considering both accuracy and fluency"
-    };
-    tool.tools[0].function.parameters.required.push("actfl_level");
-    tool.tools[0].function.parameters.required.push("actfl_justification");
-    tool.tools[0].function.parameters.properties.actfl_level = actfl_level;
-    tool.tools[0].function.parameters.properties.actfl_justification = actfl_justification;
-  }
-  return tool;
-};
-
-// src/utils/debounce.utils.ts
-function debounce(func, waitFor) {
-  let timeoutId;
-  return (...args) => new Promise((resolve, reject) => {
-    if (timeoutId) {
-      clearTimeout(timeoutId);
-    }
-    timeoutId = setTimeout(async () => {
-      try {
-        const result = await func(...args);
-        resolve(result);
-      } catch (error) {
-        reject(error);
-      }
-    }, waitFor);
-  });
-}
-
-// src/utils/text-utils.ts
-import sha1 from "js-sha1";
-var purify = (word) => {
-  return word.normalize("NFD").replace(/\/([^" "]*)/g, "").replace(/\([^()]*\)/g, "").replace(/（[^()]*）/g, "").replace(/[\u0300-\u036f]/g, "").replace(/[-]/g, " ").replace(/[.,/#!¡¿？؟。，.?$%^&*;:{}=\-_`~()’'…\s]/g, "").replace(/\s\s+/g, " ").toLowerCase().trim();
-};
-var cleanString = (words) => {
-  const splitWords = words == null ? void 0 : words.split("+");
-  if (splitWords && splitWords.length === 1) {
-    const newWord = purify(words);
-    return newWord;
-  } else if (splitWords && splitWords.length > 1) {
-    const split = splitWords.map((w) => purify(w));
-    return split;
-  } else {
-    return "";
-  }
-};
-var getWordHash = (word, language) => {
-  const cleanedWord = cleanString(word);
-  const wordHash = sha1(`${language}-${cleanedWord}`);
-  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/assignment/utils/check-assignment-availability.ts
-import dayjs from "dayjs";
-var checkAssignmentAvailability = (scheduledTime) => {
-  if (!scheduledTime) return true;
-  const scheduledDate = typeof scheduledTime === "string" ? dayjs(scheduledTime) : dayjs(scheduledTime.toDate());
-  if (!scheduledDate.isValid()) return true;
-  return dayjs().isAfter(scheduledDate);
-};
-
-// src/lib/firebase/api.ts
-var FirebaseAPI = class _FirebaseAPI {
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
-  constructor() {
-    this.config = null;
-  }
-  static getInstance() {
-    if (!_FirebaseAPI.instance) {
-      _FirebaseAPI.instance = new _FirebaseAPI();
-    }
-    return _FirebaseAPI.instance;
-  }
-  initialize(config) {
-    this.config = config;
-  }
-  get db() {
-    if (!this.config) throw new Error("Firebase API not initialized");
-    return this.config.db;
-  }
-  get helpers() {
-    if (!this.config) throw new Error("Firebase API not initialized");
-    return this.config.helpers;
-  }
-  get httpsCallable() {
-    var _a;
-    return (_a = this.config) == null ? void 0 : _a.httpsCallable;
-  }
-  logEvent(name, data) {
-    var _a;
-    (_a = this.config) == null ? void 0 : _a.logEvent(name, data);
-  }
-  accessQueryConstraints() {
-    const { query, orderBy, limit, startAt, startAfter, endAt, endBefore, where, increment } = this.helpers;
-    return {
-      query,
-      orderBy,
-      limit,
-      startAt,
-      startAfter,
-      endAt,
-      endBefore,
-      where,
-      increment
-    };
-  }
-  accessHelpers() {
-    const { doc, collection, writeBatch, serverTimestamp, setDoc } = this.helpers;
-    return {
-      doc: (path) => doc(this.db, path),
-      collection: (path) => collection(this.db, path),
-      writeBatch: () => writeBatch(this.db),
-      serverTimestamp,
-      setDoc
-    };
-  }
-  async getDoc(path) {
-    const { getDoc, doc } = this.helpers;
-    const docRef = doc(this.db, path);
-    const docSnap = await getDoc(docRef);
-    const data = docSnap.exists() ? {
-      ...docSnap.data(),
-      id: docSnap.id
-    } : null;
-    return {
-      id: docSnap.id,
-      data
-    };
-  }
-  async getDocs(path, ...queryConstraints) {
-    const { getDocs, query, collection } = this.helpers;
-    const collectionRef = collection(this.db, path);
-    const q = queryConstraints.length > 0 ? query(collectionRef, ...queryConstraints) : collectionRef;
-    const querySnapshot = await getDocs(q);
-    const data = querySnapshot.docs.map((doc) => ({
-      data: doc.data(),
-      id: doc.id
-    }));
-    return {
-      data,
-      querySnapshot,
-      empty: querySnapshot.empty
-    };
-  }
-  async addDoc(path, data) {
-    const { addDoc, collection } = this.helpers;
-    const collectionRef = collection(this.db, path);
-    const docRef = await addDoc(collectionRef, data);
-    return {
-      ...data,
-      id: docRef.id
-    };
-  }
-  async setDoc(path, data, options = {}) {
-    const { setDoc, doc } = this.helpers;
-    const docRef = doc(this.db, path);
-    await setDoc(docRef, data, options);
-  }
-  async updateDoc(path, data) {
-    const { updateDoc, doc } = this.helpers;
-    const docRef = doc(this.db, path);
-    await updateDoc(docRef, data);
-  }
-  async deleteDoc(path) {
-    const { deleteDoc, doc } = this.helpers;
-    const docRef = doc(this.db, path);
-    await deleteDoc(docRef);
-  }
-  async runTransaction(updateFunction) {
-    const { runTransaction } = this.helpers;
-    return runTransaction(this.db, updateFunction);
-  }
-  async runBatch(operations) {
-    const { writeBatch } = this.helpers;
-    const batch = writeBatch(this.db);
-    await Promise.all(operations.map((op) => op()));
-    await batch.commit();
-  }
-  writeBatch() {
-    const { writeBatch } = this.helpers;
-    const batch = writeBatch(this.db);
-    return batch;
-  }
-};
-var api = FirebaseAPI.getInstance();
-
-// src/domains/assignment/utils/create-default-score.ts
-var defaultScore = (props) => {
-  const { serverTimestamp } = api.accessHelpers();
-  const score = {
-    progress: 0,
-    score: 0,
-    startDate: serverTimestamp(),
-    status: "IN_PROGRESS",
-    submitted: false,
-    cards: {},
-    lastPlayed: serverTimestamp(),
-    owners: props.owners,
-    userId: props.userId
-  };
-  if (props.googleClassroomUserId) {
-    score.googleClassroomUserId = props.googleClassroomUserId;
-  }
-  if (props.courseId) {
-    score.courseId = props.courseId;
-  }
-  return score;
-};
-
-// src/domains/cards/card.model.ts
-var RESPOND_PAGE_ACTIVITY_TYPES = [
-  "READ_RESPOND" /* READ_RESPOND */,
-  "RESPOND" /* RESPOND */,
-  "RESPOND_WRITE" /* RESPOND_WRITE */,
-  "FREE_RESPONSE" /* FREE_RESPONSE */
-];
-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_PAGE_ACTIVITY_TYPES = [
-  "RESPOND" /* RESPOND */,
-  "READ_RESPOND" /* READ_RESPOND */
-];
-
-// 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/cards/utils/get-page-prompt.ts
-function extractTextFromRichText(richText) {
-  if (!richText) return "";
-  return richText.replace(/<[^>]*>/g, "").replace(/&nbsp;/g, " ").replace(/&amp;/g, "&").replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&quot;/g, '"').replace(/&#39;/g, "'").trim();
-}
-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 hidePrompt = (card == null ? void 0 : card.hidePrompt) === true;
-  const createReturnObject = (text, richText) => {
-    const plainText = text || "";
-    const richTextPlain = extractTextFromRichText(richText);
-    return {
-      has: true,
-      text: plainText,
-      rich_text: richText || "",
-      isTextEqualToRichText: plainText.trim() === richTextPlain.trim()
-    };
-  };
-  if (isRepeat) {
-    return createReturnObject(card == null ? void 0 : card.target_text, 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);
-  }
-  if (isMC) {
-    return createReturnObject(card == null ? void 0 : card.question, card == null ? void 0 : card.rich_text);
-  }
-  if (isShortAnswer && !hidePrompt) {
-    return createReturnObject(card == null ? void 0 : card.prompt, card == null ? void 0 : card.rich_text);
-  }
-  return {
-    has: false,
-    text: "",
-    rich_text: "",
-    isTextEqualToRichText: false
-  };
-}
-
-// src/domains/cards/utils/get-completed-pages.ts
-var getTotalCompletedCards = (pageScores) => {
-  return Object.values(pageScores != null ? pageScores : {}).reduce((acc, cardScore) => {
-    var _a, _b;
-    if (((_b = (_a = cardScore.completed) != null ? _a : cardScore.score) != null ? _b : cardScore.score === 0) && !cardScore.media_area_opened) {
-      acc++;
-    }
-    return acc;
-  }, 0);
-};
-
-// src/domains/cards/utils/get-label-page.ts
-var labels = {
-  repeat: {
-    short: "Repeat",
-    long: "Listen & Repeat"
-  },
-  mc: {
-    short: "Multiple Choice",
-    long: "Multiple Choice"
-  },
-  mediaPage: {
-    short: "Media Page",
-    long: "Media Page"
-  },
-  shortAnswer: {
-    short: "Short Answer",
-    long: "Short Answer"
-  },
-  respondWritten: {
-    short: "Open Response",
-    long: "Written Open Response"
-  },
-  respondAudio: {
-    short: "Open Response",
-    long: "Spoken Open Response"
-  }
-};
-var getLabelPage = (pageType) => {
-  if (!pageType) {
-    return {
-      short: "",
-      long: ""
-    };
-  }
-  const { isRepeat, isMC, isMediaPage, isShortAnswer, isRespondWritten, isRespondAudio } = checkTypePageActivity(pageType);
-  if (isRepeat) {
-    return labels.repeat;
-  }
-  if (isMC) {
-    return labels.mc;
-  }
-  if (isMediaPage) {
-    return labels.mediaPage;
-  }
-  if (isShortAnswer) {
-    return labels.shortAnswer;
-  }
-  if (isRespondWritten) {
-    return labels.respondWritten;
-  }
-  if (isRespondAudio) {
-    return labels.respondAudio;
-  }
-  return {
-    short: "",
-    long: ""
-  };
-};
-export {
-  checkAssignmentAvailability,
-  checkTypePageActivity,
-  cleanString,
-  debounce,
-  defaultScore,
-  getLabelPage,
-  getPagePrompt,
-  getPhraseLength,
-  getRespondCardTool,
-  getTotalCompletedCards,
-  getWordHash,
-  purify
-};
-//# sourceMappingURL=utils.js.map