@vue-skuilder/db 0.1.14-2 → 0.1.15

package/dist/impl/static/index.d.mts

@@ -22,6 +22,7 @@ declare class StaticDataLayerProvider implements DataLayerProvider {
     private initialized;
     private courseUnpackers;
     private manifests;
+    private dependencyNameToCourseId;
     constructor(config: Partial<StaticDataLayerConfig>);
     private resolveCourseDependencies;
     initialize(): Promise<void>;
@@ -173,7 +174,8 @@ declare class StaticCourseDB implements CourseDBInterface {
 
 declare class StaticCoursesDB implements CoursesDBInterface {
     private manifests;
-    constructor(manifests: Record<string, StaticCourseManifest>);
+    private dependencyNameToCourseId?;
+    constructor(manifests: Record<string, StaticCourseManifest>, dependencyNameToCourseId?: Map<string, string> | undefined);
     getCourseConfig(courseId: string): Promise<CourseConfig>;
     getCourseList(): Promise<CourseConfig[]>;
     disambiguateCourse(_courseId: string, _disambiguator: string): Promise<void>;

package/dist/impl/static/index.d.ts

@@ -22,6 +22,7 @@ declare class StaticDataLayerProvider implements DataLayerProvider {
     private initialized;
     private courseUnpackers;
     private manifests;
+    private dependencyNameToCourseId;
     constructor(config: Partial<StaticDataLayerConfig>);
     private resolveCourseDependencies;
     initialize(): Promise<void>;
@@ -173,7 +174,8 @@ declare class StaticCourseDB implements CourseDBInterface {
 
 declare class StaticCoursesDB implements CoursesDBInterface {
     private manifests;
-    constructor(manifests: Record<string, StaticCourseManifest>);
+    private dependencyNameToCourseId?;
+    constructor(manifests: Record<string, StaticCourseManifest>, dependencyNameToCourseId?: Map<string, string> | undefined);
     getCourseConfig(courseId: string): Promise<CourseConfig>;
     getCourseList(): Promise<CourseConfig[]>;
     disambiguateCourse(_courseId: string, _disambiguator: string): Promise<void>;

package/dist/impl/static/index.js

@@ -281,6 +281,33 @@ var init_updateQueue = __esm({
       // Database for read operations
       writeDB;
       // Database for write operations (local-first)
+      /**
+       * Queues an update for a document and applies it with conflict resolution.
+       *
+       * @param id - Document ID to update
+       * @param update - Partial object or function that transforms the document
+       * @returns Promise resolving to the updated document
+       *
+       * @throws {PouchError} with status 404 if document doesn't exist
+       *
+       * @remarks
+       * **Error Handling Pattern:**
+       * - This method does NOT create documents if they don't exist
+       * - Callers are responsible for handling 404 errors and creating documents
+       * - This design maintains separation of concerns (UpdateQueue handles conflicts, callers handle lifecycle)
+       *
+       * @example
+       * ```typescript
+       * try {
+       *   await updateQueue.update(docId, (doc) => ({ ...doc, field: newValue }));
+       * } catch (e) {
+       *   if ((e as PouchError).status === 404) {
+       *     // Create the document with initial values
+       *     await db.put({ _id: docId, field: newValue, ...initialFields });
+       *   }
+       * }
+       * ```
+       */
       update(id, update) {
         logger.debug(`Update requested on doc: ${id}`);
         if (this.pendingUpdates[id]) {
@@ -313,7 +340,6 @@ var init_updateQueue = __esm({
             for (let i = 0; i < MAX_RETRIES; i++) {
               try {
                 const doc = await this.readDB.get(id);
-                logger.debug(`Retrieved doc: ${id}`);
                 let updatedDoc = { ...doc };
                 const updatesToApply = [...this.pendingUpdates[id]];
                 for (const update of updatesToApply) {
@@ -327,7 +353,6 @@ var init_updateQueue = __esm({
                   }
                 }
                 await this.writeDB.put(updatedDoc);
-                logger.debug(`Put doc: ${id}`);
                 this.pendingUpdates[id].splice(0, updatesToApply.length);
                 if (this.pendingUpdates[id].length === 0) {
                   this.inprogressUpdates[id] = false;
@@ -342,6 +367,7 @@ var init_updateQueue = __esm({
                   await new Promise((res) => setTimeout(res, 50 * Math.random()));
                 } else if (e.name === "not_found" && i === 0) {
                   logger.warn(`Update failed for ${id} - does not exist. Throwing to caller.`);
+                  delete this.inprogressUpdates[id];
                   throw e;
                 } else {
                   delete this.inprogressUpdates[id];
@@ -1506,12 +1532,22 @@ Currently logged-in as ${this._username}.`
       }
       /**
        * Logs a record of the user's interaction with the card and returns the card's
-       * up-to-date history
+       * up-to-date history.
+       *
+       * **Automatic Initialization:**
+       * If this is the user's first interaction with the card (CardHistory doesn't exist),
+       * this method automatically creates the CardHistory document with initial values
+       * (lapses: 0, streak: 0, bestInterval: 0).
+       *
+       * **Error Handling:**
+       * - Handles 404 errors by creating initial CardHistory document
+       * - Re-throws all other errors from UpdateQueue
        *
        * // [ ] #db-refactor extract to a smaller scope - eg, UserStudySession
        *
-       * @param record the recent recorded interaction between user and card
+       * @param record - The recent recorded interaction between user and card
        * @returns The updated state of the card's CardHistory data
+       * @throws Error if document creation fails or non-404 database error occurs
        */
       async putCardRecord(record) {
         const cardHistoryID = getCardHistoryID(record.courseID, record.cardID);
@@ -2598,11 +2634,18 @@ var init_coursesDB = __esm({
     "use strict";
     init_logger();
     StaticCoursesDB = class {
-      constructor(manifests) {
+      constructor(manifests, dependencyNameToCourseId) {
         this.manifests = manifests;
+        this.dependencyNameToCourseId = dependencyNameToCourseId;
       }
       async getCourseConfig(courseId) {
-        const manifest = this.manifests[courseId];
+        let manifest = this.manifests[courseId];
+        if (!manifest && this.dependencyNameToCourseId) {
+          const mappedCourseId = this.dependencyNameToCourseId.get(courseId);
+          if (mappedCourseId) {
+            manifest = this.manifests[mappedCourseId];
+          }
+        }
         if (!manifest) {
           logger.warn(`Course manifest for ${courseId} not found`);
           throw new Error(`Course ${courseId} not found`);
@@ -2700,6 +2743,8 @@ var init_StaticDataLayerProvider = __esm({
       initialized = false;
       courseUnpackers = /* @__PURE__ */ new Map();
       manifests = {};
+      // Mapping from dependency name to actual courseId for backwards compatibility
+      dependencyNameToCourseId = /* @__PURE__ */ new Map();
       constructor(config) {
         this.config = {
           localStoragePrefix: config.localStoragePrefix || "skuilder-static",
@@ -2727,10 +2772,15 @@ var init_StaticDataLayerProvider = __esm({
                 throw new Error(`Failed to fetch final content manifest for ${courseName} at ${finalManifestUrl}`);
               }
               const finalManifest = await finalManifestResponse.json();
-              this.manifests[courseName] = finalManifest;
+              const courseId = finalManifest.courseId || finalManifest.courseConfig?.courseID;
+              if (!courseId) {
+                throw new Error(`Course manifest for ${courseName} missing courseId`);
+              }
+              this.manifests[courseId] = finalManifest;
               const unpacker = new StaticDataUnpacker(finalManifest, baseUrl);
-              this.courseUnpackers.set(courseName, unpacker);
-              logger.info(`[StaticDataLayerProvider] Successfully resolved and prepared course: ${courseName}`);
+              this.courseUnpackers.set(courseId, unpacker);
+              this.dependencyNameToCourseId.set(courseName, courseId);
+              logger.info(`[StaticDataLayerProvider] Successfully resolved and prepared course: ${courseName} (courseId: ${courseId})`);
             }
           } catch (e) {
             logger.error(`[StaticDataLayerProvider] Failed to resolve dependency ${courseName}:`, e);
@@ -2753,15 +2803,23 @@ var init_StaticDataLayerProvider = __esm({
         return BaseUser.Dummy(syncStrategy);
       }
       getCourseDB(courseId) {
-        const unpacker = this.courseUnpackers.get(courseId);
+        let unpacker = this.courseUnpackers.get(courseId);
+        let actualCourseId = courseId;
+        if (!unpacker) {
+          const mappedCourseId = this.dependencyNameToCourseId.get(courseId);
+          if (mappedCourseId) {
+            unpacker = this.courseUnpackers.get(mappedCourseId);
+            actualCourseId = mappedCourseId;
+          }
+        }
         if (!unpacker) {
           throw new Error(`Course ${courseId} not found or failed to initialize in static data layer.`);
         }
-        const manifest = this.manifests[courseId];
-        return new StaticCourseDB(courseId, unpacker, this.getUserDB(), manifest);
+        const manifest = this.manifests[actualCourseId];
+        return new StaticCourseDB(actualCourseId, unpacker, this.getUserDB(), manifest);
       }
       getCoursesDB() {
-        return new StaticCoursesDB(this.manifests);
+        return new StaticCoursesDB(this.manifests, this.dependencyNameToCourseId);
       }
       async getClassroomDB(_classId, _type) {
         throw new Error("Classrooms not supported in static mode");