@vue-skuilder/db 0.1.7 → 0.1.8-1

package/dist/core/index.mjs

@@ -80,7 +80,7 @@ var init_logger = __esm({
 });
 
 // src/core/types/types-legacy.ts
-var GuestUsername, log, DocType, cardHistoryPrefix;
+var GuestUsername, log, DocType, DocTypePrefixes;
 var init_types_legacy = __esm({
   "src/core/types/types-legacy.ts"() {
     "use strict";
@@ -102,7 +102,19 @@ var init_types_legacy = __esm({
       DocType2["NAVIGATION_STRATEGY"] = "NAVIGATION_STRATEGY";
       return DocType2;
     })(DocType || {});
-    cardHistoryPrefix = "cardH";
+    DocTypePrefixes = {
+      ["CARD" /* CARD */]: "c",
+      ["DISPLAYABLE_DATA" /* DISPLAYABLE_DATA */]: "dd",
+      ["TAG" /* TAG */]: "TAG",
+      ["CARDRECORD" /* CARDRECORD */]: "cardH",
+      ["SCHEDULED_CARD" /* SCHEDULED_CARD */]: "card_review_",
+      // Add other doctypes here as they get prefixed IDs
+      ["DATASHAPE" /* DATASHAPE */]: "DATASHAPE",
+      ["QUESTION" /* QUESTIONTYPE */]: "QUESTION",
+      ["VIEW" /* VIEW */]: "VIEW",
+      ["PEDAGOGY" /* PEDAGOGY */]: "PEDAGOGY",
+      ["NAVIGATION_STRATEGY" /* NAVIGATION_STRATEGY */]: "NAVIGATION_STRATEGY"
+    };
   }
 });
 
@@ -114,16 +126,16 @@ function isQuestionRecord(c) {
   return c.userAnswer !== void 0;
 }
 function getCardHistoryID(courseID, cardID) {
-  return `${cardHistoryPrefix}-${courseID}-${cardID}`;
+  return `${DocTypePrefixes["CARDRECORD" /* CARDRECORD */]}-${courseID}-${cardID}`;
 }
 function parseCardHistoryID(id) {
   const split = id.split("-");
   let error = "";
   error += split.length === 3 ? "" : `
 	given ID has incorrect number of '-' characters`;
-  error += split[0] === cardHistoryPrefix ? "" : `
-	given ID does not start with ${cardHistoryPrefix}`;
-  if (split.length === 3 && split[0] === cardHistoryPrefix) {
+  error += split[0] === DocTypePrefixes["CARDRECORD" /* CARDRECORD */] ? "" : `
+	given ID does not start with ${DocTypePrefixes["CARDRECORD" /* CARDRECORD */]}`;
+  if (split.length === 3 && split[0] === DocTypePrefixes["CARDRECORD" /* CARDRECORD */]) {
     return {
       courseID: split[1],
       cardID: split[2]
@@ -216,11 +228,11 @@ function scheduleCardReviewLocal(userDB, review) {
   const now = moment.utc();
   logger.info(`Scheduling for review in: ${review.time.diff(now, "h") / 24} days`);
   void userDB.put({
-    _id: REVIEW_PREFIX + review.time.format(REVIEW_TIME_FORMAT),
+    _id: DocTypePrefixes["SCHEDULED_CARD" /* SCHEDULED_CARD */] + review.time.format(REVIEW_TIME_FORMAT),
     cardId: review.card_id,
-    reviewTime: review.time,
+    reviewTime: review.time.toISOString(),
     courseId: review.course_id,
-    scheduledAt: now,
+    scheduledAt: now.toISOString(),
     scheduledFor: review.scheduledFor,
     schedulingAgentId: review.schedulingAgentId
   });
@@ -236,14 +248,14 @@ async function removeScheduledCardReviewLocal(userDB, reviewDocID) {
 ${JSON.stringify(err)}`);
   });
 }
-var REVIEW_PREFIX, REVIEW_TIME_FORMAT, log2;
+var REVIEW_TIME_FORMAT, log2;
 var init_userDBHelpers = __esm({
   "src/impl/common/userDBHelpers.ts"() {
     "use strict";
+    init_core();
     init_logger();
     init_pouchdb_setup();
     init_dataDirectory();
-    REVIEW_PREFIX = "card_review_";
     REVIEW_TIME_FORMAT = "YYYY-MM-DD--kk:mm:ss-SSS";
     log2 = (s) => {
       logger.info(s);
@@ -278,7 +290,10 @@ var init_updateQueue = __esm({
       _className = "UpdateQueue";
       pendingUpdates = {};
       inprogressUpdates = {};
-      db;
+      readDB;
+      // Database for read operations
+      writeDB;
+      // Database for write operations (local-first)
       update(id, update) {
         logger.debug(`Update requested on doc: ${id}`);
         if (this.pendingUpdates[id]) {
@@ -288,24 +303,25 @@ var init_updateQueue = __esm({
         }
         return this.applyUpdates(id);
       }
-      constructor(db) {
+      constructor(readDB, writeDB) {
         super();
-        this.db = db;
+        this.readDB = readDB;
+        this.writeDB = writeDB || readDB;
         logger.debug(`UpdateQ initialized...`);
-        void this.db.info().then((i) => {
+        void this.readDB.info().then((i) => {
           logger.debug(`db info: ${JSON.stringify(i)}`);
         });
       }
       async applyUpdates(id) {
         logger.debug(`Applying updates on doc: ${id}`);
         if (this.inprogressUpdates[id]) {
-          await this.db.info();
+          await this.readDB.info();
           return this.applyUpdates(id);
         } else {
           if (this.pendingUpdates[id] && this.pendingUpdates[id].length > 0) {
             this.inprogressUpdates[id] = true;
             try {
-              let doc = await this.db.get(id);
+              let doc = await this.readDB.get(id);
               logger.debug(`Retrieved doc: ${id}`);
               while (this.pendingUpdates[id].length !== 0) {
                 const update = this.pendingUpdates[id].splice(0, 1)[0];
@@ -318,7 +334,7 @@ var init_updateQueue = __esm({
                   };
                 }
               }
-              await this.db.put(doc);
+              await this.writeDB.put(doc);
               logger.debug(`Put doc: ${id}`);
               if (this.pendingUpdates[id].length === 0) {
                 this.inprogressUpdates[id] = false;
@@ -344,6 +360,60 @@ var init_updateQueue = __esm({
   }
 });
 
+// src/impl/couch/user-course-relDB.ts
+import moment2 from "moment";
+var UsrCrsData;
+var init_user_course_relDB = __esm({
+  "src/impl/couch/user-course-relDB.ts"() {
+    "use strict";
+    init_logger();
+    UsrCrsData = class {
+      user;
+      _courseId;
+      constructor(user, courseId) {
+        this.user = user;
+        this._courseId = courseId;
+      }
+      async getReviewsForcast(daysCount) {
+        const time = moment2.utc().add(daysCount, "days");
+        return this.getReviewstoDate(time);
+      }
+      async getPendingReviews() {
+        const now = moment2.utc();
+        return this.getReviewstoDate(now);
+      }
+      async getScheduledReviewCount() {
+        return (await this.getPendingReviews()).length;
+      }
+      async getCourseSettings() {
+        const regDoc = await this.user.getCourseRegistrationsDoc();
+        const crsDoc = regDoc.courses.find((c) => c.courseID === this._courseId);
+        if (crsDoc && crsDoc.settings) {
+          return crsDoc.settings;
+        } else {
+          logger.warn(`no settings found during lookup on course ${this._courseId}`);
+          return {};
+        }
+      }
+      updateCourseSettings(updates) {
+        if ("updateCourseSettings" in this.user) {
+          void this.user.updateCourseSettings(this._courseId, updates);
+        }
+      }
+      async getReviewstoDate(targetDate) {
+        const allReviews = await this.user.getPendingReviews(this._courseId);
+        logger.debug(
+          `Fetching ${this.user.getUsername()}'s scheduled reviews for course ${this._courseId}.`
+        );
+        return allReviews.filter((review) => {
+          const reviewTime = moment2.utc(review.reviewTime);
+          return targetDate.isAfter(reviewTime);
+        });
+      }
+    };
+  }
+});
+
 // src/impl/couch/clientCache.ts
 async function GET_CACHED(k, f) {
   if (CLIENT_CACHE[k]) {
@@ -367,10 +437,12 @@ var init_clientCache = __esm({
 import { NameSpacer } from "@vue-skuilder/common";
 import { blankCourseElo, toCourseElo } from "@vue-skuilder/common";
 import { prepareNote55 } from "@vue-skuilder/common";
+import { v4 as uuidv4 } from "uuid";
 async function addNote55(courseID, codeCourse, shape, data, author, tags, uploads, elo = blankCourseElo()) {
   const db = getCourseDB(courseID);
   const payload = prepareNote55(courseID, codeCourse, shape, data, author, tags, uploads);
-  const result = await db.post(payload);
+  const _id = `${DocTypePrefixes["DISPLAYABLE_DATA" /* DISPLAYABLE_DATA */]}-${uuidv4()}`;
+  const result = await db.put({ ...payload, _id });
   const dataShapeId = NameSpacer.getDataShapeString({
     course: codeCourse,
     dataShape: shape.name
@@ -441,7 +513,9 @@ async function createCard(questionViewName, courseID, dsDescriptor, noteID, tags
 }
 async function addCard(courseID, course, id_displayable_data, id_view, elo, tags, author) {
   const db = getCourseDB(courseID);
-  const card = await db.post({
+  const _id = `${DocTypePrefixes["CARD" /* CARD */]}-${uuidv4()}`;
+  const card = await db.put({
+    _id,
     course,
     id_displayable_data,
     id_view,
@@ -1193,7 +1267,7 @@ ${above.rows.map((r) => `	${r.id}-${r.key}
 });
 
 // src/impl/couch/classroomDB.ts
-import moment2 from "moment";
+import moment3 from "moment";
 var CLASSROOM_CONFIG, ClassroomDBBase, StudentClassroomDB;
 var init_classroomDB2 = __esm({
   "src/impl/couch/classroomDB.ts"() {
@@ -1293,9 +1367,9 @@ var init_classroomDB2 = __esm({
       }
       async getNewCards() {
         const activeCards = await this._user.getActiveCards();
-        const now = moment2.utc();
+        const now = moment3.utc();
         const assigned = await this.getAssignedContent();
-        const due = assigned.filter((c) => now.isAfter(moment2.utc(c.activeOn, REVIEW_TIME_FORMAT2)));
+        const due = assigned.filter((c) => now.isAfter(moment3.utc(c.activeOn, REVIEW_TIME_FORMAT2)));
         logger.info(`Due content: ${JSON.stringify(due)}`);
         let ret = [];
         for (let i = 0; i < due.length; i++) {
@@ -1373,7 +1447,7 @@ var init_CouchDBSyncStrategy = __esm({
 });
 
 // src/impl/couch/index.ts
-import moment3 from "moment";
+import moment4 from "moment";
 import process2 from "process";
 function getCourseDB2(courseID) {
   return new pouchdb_setup_default(
@@ -1407,7 +1481,7 @@ function getStartAndEndKeys2(key) {
     endkey: key + "\uFFF0"
   };
 }
-var isBrowser, GUEST_LOCAL_DB, localUserDB, pouchDBincludeCredentialsConfig, REVIEW_PREFIX2, REVIEW_TIME_FORMAT2;
+var isBrowser, GUEST_LOCAL_DB, localUserDB, pouchDBincludeCredentialsConfig, REVIEW_TIME_FORMAT2;
 var init_couch = __esm({
   "src/impl/couch/index.ts"() {
     "use strict";
@@ -1433,78 +1507,10 @@ var init_couch = __esm({
         return pouchdb_setup_default.fetch(url, opts);
       }
     };
-    REVIEW_PREFIX2 = "card_review_";
     REVIEW_TIME_FORMAT2 = "YYYY-MM-DD--kk:mm:ss-SSS";
   }
 });
 
-// src/impl/couch/user-course-relDB.ts
-import moment4 from "moment";
-var UsrCrsData;
-var init_user_course_relDB = __esm({
-  "src/impl/couch/user-course-relDB.ts"() {
-    "use strict";
-    init_couch();
-    init_courseDB();
-    init_logger();
-    UsrCrsData = class {
-      user;
-      course;
-      _courseId;
-      constructor(user, courseId) {
-        this.user = user;
-        this.course = new CourseDB(courseId, async () => this.user);
-        this._courseId = courseId;
-      }
-      async getReviewsForcast(daysCount) {
-        const time = moment4.utc().add(daysCount, "days");
-        return this.getReviewstoDate(time);
-      }
-      async getPendingReviews() {
-        const now = moment4.utc();
-        return this.getReviewstoDate(now);
-      }
-      async getScheduledReviewCount() {
-        return (await this.getPendingReviews()).length;
-      }
-      async getCourseSettings() {
-        const regDoc = await this.user.getCourseRegistrationsDoc();
-        const crsDoc = regDoc.courses.find((c) => c.courseID === this._courseId);
-        if (crsDoc && crsDoc.settings) {
-          return crsDoc.settings;
-        } else {
-          logger.warn(`no settings found during lookup on course ${this._courseId}`);
-          return {};
-        }
-      }
-      updateCourseSettings(updates) {
-        void this.user.updateCourseSettings(this._courseId, updates);
-      }
-      async getReviewstoDate(targetDate) {
-        const keys = getStartAndEndKeys2(REVIEW_PREFIX2);
-        const reviews = await this.user.remote().allDocs({
-          startkey: keys.startkey,
-          endkey: keys.endkey,
-          include_docs: true
-        });
-        logger.debug(
-          `Fetching ${this.user.getUsername()}'s scheduled reviews for course ${this._courseId}.`
-        );
-        return reviews.rows.filter((r) => {
-          if (r.id.startsWith(REVIEW_PREFIX2)) {
-            const date = moment4.utc(r.id.substr(REVIEW_PREFIX2.length), REVIEW_TIME_FORMAT2);
-            if (targetDate.isAfter(date)) {
-              if (this._courseId === void 0 || r.doc.courseId === this._courseId) {
-                return true;
-              }
-            }
-          }
-        }).map((r) => r.doc);
-      }
-    };
-  }
-});
-
 // src/impl/common/BaseUserDB.ts
 import { Status as Status3 } from "@vue-skuilder/common";
 import moment5 from "moment";
@@ -1600,10 +1606,11 @@ async function dropUserFromClassroom(user, classID) {
 async function getUserClassrooms(user) {
   return getOrCreateClassroomRegistrationsDoc(user);
 }
-var log3, cardHistoryPrefix2, BaseUser, userCoursesDoc, userClassroomsDoc;
+var log3, BaseUser, userCoursesDoc, userClassroomsDoc;
 var init_BaseUserDB = __esm({
   "src/impl/common/BaseUserDB.ts"() {
     "use strict";
+    init_core();
     init_util();
     init_types_legacy();
     init_logger();
@@ -1614,7 +1621,6 @@ var init_BaseUserDB = __esm({
     log3 = (s) => {
       logger.info(s);
     };
-    cardHistoryPrefix2 = "cardH-";
     BaseUser = class _BaseUser {
       static _instance;
       static _initialized = false;
@@ -1635,11 +1641,13 @@ var init_BaseUserDB = __esm({
       isLoggedIn() {
         return !this._username.startsWith(GuestUsername);
       }
-      remoteDB;
       remote() {
         return this.remoteDB;
       }
       localDB;
+      remoteDB;
+      writeDB;
+      // Database to use for write operations (local-first approach)
       updateQueue;
       async createAccount(username, password) {
         if (!this.syncStrategy.canCreateAccount()) {
@@ -1703,8 +1711,8 @@ Currently logged-in as ${this._username}.`
           const allDocs = await localDB.allDocs({ include_docs: false });
           const docsToDelete = allDocs.rows.filter((row) => {
             const id = row.id;
-            return id.startsWith(cardHistoryPrefix2) || // Card interaction history
-            id.startsWith(REVIEW_PREFIX) || // Scheduled reviews
+            return id.startsWith(DocTypePrefixes["CARDRECORD" /* CARDRECORD */]) || // Card interaction history
+            id.startsWith(DocTypePrefixes["SCHEDULED_CARD" /* SCHEDULED_CARD */]) || // Scheduled reviews
             id === _BaseUser.DOC_IDS.COURSE_REGISTRATIONS || // Course registrations
             id === _BaseUser.DOC_IDS.CLASSROOM_REGISTRATIONS || // Classroom registrations
             id === _BaseUser.DOC_IDS.CONFIG;
@@ -1773,7 +1781,7 @@ Currently logged-in as ${this._username}.`
        *
        */
       async getActiveCards() {
-        const keys = getStartAndEndKeys(REVIEW_PREFIX);
+        const keys = getStartAndEndKeys(DocTypePrefixes["SCHEDULED_CARD" /* SCHEDULED_CARD */]);
         const reviews = await this.remoteDB.allDocs({
           startkey: keys.startkey,
           endkey: keys.endkey,
@@ -1845,7 +1853,7 @@ Currently logged-in as ${this._username}.`
         }
       }
       async getReviewstoDate(targetDate, course_id) {
-        const keys = getStartAndEndKeys(REVIEW_PREFIX);
+        const keys = getStartAndEndKeys(DocTypePrefixes["SCHEDULED_CARD" /* SCHEDULED_CARD */]);
         const reviews = await this.remoteDB.allDocs({
           startkey: keys.startkey,
           endkey: keys.endkey,
@@ -1855,8 +1863,11 @@ Currently logged-in as ${this._username}.`
           `Fetching ${this._username}'s scheduled reviews${course_id ? ` for course ${course_id}` : ""}.`
         );
         return reviews.rows.filter((r) => {
-          if (r.id.startsWith(REVIEW_PREFIX)) {
-            const date = moment5.utc(r.id.substr(REVIEW_PREFIX.length), REVIEW_TIME_FORMAT);
+          if (r.id.startsWith(DocTypePrefixes["SCHEDULED_CARD" /* SCHEDULED_CARD */])) {
+            const date = moment5.utc(
+              r.id.substr(DocTypePrefixes["SCHEDULED_CARD" /* SCHEDULED_CARD */].length),
+              REVIEW_TIME_FORMAT
+            );
             if (targetDate.isAfter(date)) {
               if (course_id === void 0 || r.doc.courseId === course_id) {
                 return true;
@@ -1971,7 +1982,8 @@ Currently logged-in as ${this._username}.`
         const defaultConfig = {
           _id: _BaseUser.DOC_IDS.CONFIG,
           darkMode: false,
-          likesConfetti: false
+          likesConfetti: false,
+          sessionTimeLimit: 5
         };
         try {
           const cfg = await this.localDB.get(_BaseUser.DOC_IDS.CONFIG);
@@ -2044,7 +2056,8 @@ Currently logged-in as ${this._username}.`
       setDBandQ() {
         this.localDB = getLocalUserDB(this._username);
         this.remoteDB = this.syncStrategy.setupRemoteDB(this._username);
-        this.updateQueue = new UpdateQueue(this.localDB);
+        this.writeDB = this.syncStrategy.getWriteDB ? this.syncStrategy.getWriteDB(this._username) : this.localDB;
+        this.updateQueue = new UpdateQueue(this.localDB, this.writeDB);
       }
       async init() {
         _BaseUser._initialized = false;
@@ -2162,8 +2175,8 @@ Currently logged-in as ${this._username}.`
               streak: 0,
               bestInterval: 0
             };
-            void this.remoteDB.put(initCardHistory);
-            return initCardHistory;
+            const putResult = await this.writeDB.put(initCardHistory);
+            return { ...initCardHistory, _rev: putResult.rev };
           } else {
             throw new Error(`putCardRecord failed because of:
   name:${reason.name}
@@ -2198,7 +2211,7 @@ Currently logged-in as ${this._username}.`
             const deletePromises = duplicateDocIds.map(async (docId) => {
               try {
                 const doc = await this.remoteDB.get(docId);
-                await this.remoteDB.remove(doc);
+                await this.writeDB.remove(doc);
                 log3(`Successfully removed duplicate review: ${docId}`);
               } catch (error) {
                 log3(`Failed to remove duplicate review ${docId}: ${error}`);
@@ -2220,7 +2233,7 @@ Currently logged-in as ${this._username}.`
        * @param course_id optional specification of individual course
        */
       async getSeenCards(course_id) {
-        let prefix = cardHistoryPrefix2;
+        let prefix = DocTypePrefixes["CARDRECORD" /* CARDRECORD */];
         if (course_id) {
           prefix += course_id;
         }
@@ -2229,8 +2242,8 @@ Currently logged-in as ${this._username}.`
         });
         const ret = [];
         docs.rows.forEach((row) => {
-          if (row.id.startsWith(cardHistoryPrefix2)) {
-            ret.push(row.id.substr(cardHistoryPrefix2.length));
+          if (row.id.startsWith(DocTypePrefixes["CARDRECORD" /* CARDRECORD */])) {
+            ret.push(row.id.substr(DocTypePrefixes["CARDRECORD" /* CARDRECORD */].length));
           }
         });
         return ret;
@@ -2242,7 +2255,7 @@ Currently logged-in as ${this._username}.`
       async getHistory() {
         const cards = await filterAllDocsByPrefix(
           this.remoteDB,
-          cardHistoryPrefix2,
+          DocTypePrefixes["CARDRECORD" /* CARDRECORD */],
           {
             include_docs: true,
             attachments: false
@@ -2283,7 +2296,7 @@ Currently logged-in as ${this._username}.`
         } catch (e) {
           const err = e;
           if (err.status === 404) {
-            await this.remoteDB.put({
+            await this.writeDB.put({
               _id: _BaseUser.DOC_IDS.CLASSROOM_REGISTRATIONS,
               registrations: []
             });
@@ -2331,10 +2344,10 @@ Currently logged-in as ${this._username}.`
         }
       }
       async scheduleCardReview(review) {
-        return scheduleCardReviewLocal(this.remoteDB, review);
+        return scheduleCardReviewLocal(this.writeDB, review);
       }
       async removeScheduledCardReview(reviewId) {
-        return removeScheduledCardReviewLocal(this.remoteDB, reviewId);
+        return removeScheduledCardReviewLocal(this.writeDB, reviewId);
       }
       async registerForClassroom(_classId, _registerAs) {
         return registerUserForClassroom(this._username, _classId, _registerAs);
@@ -2598,11 +2611,11 @@ init_core();
 export {
   ContentNavigator,
   DocType,
+  DocTypePrefixes,
   GuestUsername,
   Loggable,
   Navigators,
   areQuestionRecords,
-  cardHistoryPrefix,
   docIsDeleted,
   getCardHistoryID,
   getStudySource,