@vue-skuilder/db 0.2.18 → 0.2.20

package/dist/{SyncStrategy-BJMZq3WO.d.cts → SyncStrategy-CCU1H81I.d.cts}

@@ -48,17 +48,23 @@ interface SyncStrategy {
      *
      * @param localDB The local PouchDB instance
      * @param remoteDB The remote PouchDB instance
-     * @returns Count of documents written locally
+     * @returns Count of documents written locally, and — only when the pull is
+     *   known to have landed the remote's complete current state — the sequence
+     *   it corresponds to, for startSync() to resume from. Omitted means "no
+     *   safe shortcut, walk from the checkpoint".
      */
     hydrate?(localDB: PouchDB.Database, remoteDB: PouchDB.Database): Promise<{
         docsWritten: number;
+        lastSeq?: string | number;
     }>;
     /**
      * Start synchronization between local and remote databases
      * @param localDB The local PouchDB instance
      * @param remoteDB The remote PouchDB instance
+     * @param since Sequence to start the pull from, as returned by a hydrate()
+     *   in the same session. Omit to resume from the stored checkpoint.
      */
-    startSync(localDB: PouchDB.Database, remoteDB: PouchDB.Database): void;
+    startSync(localDB: PouchDB.Database, remoteDB: PouchDB.Database, since?: string | number): void;
     /**
      * Stop synchronization (optional - for cleanup)
      */

package/dist/{SyncStrategy-BJMZq3WO.d.ts → SyncStrategy-CCU1H81I.d.ts}

@@ -48,17 +48,23 @@ interface SyncStrategy {
      *
      * @param localDB The local PouchDB instance
      * @param remoteDB The remote PouchDB instance
-     * @returns Count of documents written locally
+     * @returns Count of documents written locally, and — only when the pull is
+     *   known to have landed the remote's complete current state — the sequence
+     *   it corresponds to, for startSync() to resume from. Omitted means "no
+     *   safe shortcut, walk from the checkpoint".
      */
     hydrate?(localDB: PouchDB.Database, remoteDB: PouchDB.Database): Promise<{
         docsWritten: number;
+        lastSeq?: string | number;
     }>;
     /**
      * Start synchronization between local and remote databases
      * @param localDB The local PouchDB instance
      * @param remoteDB The remote PouchDB instance
+     * @param since Sequence to start the pull from, as returned by a hydrate()
+     *   in the same session. Omit to resume from the stored checkpoint.
      */
-    startSync(localDB: PouchDB.Database, remoteDB: PouchDB.Database): void;
+    startSync(localDB: PouchDB.Database, remoteDB: PouchDB.Database, since?: string | number): void;
     /**
      * Stop synchronization (optional - for cleanup)
      */

package/dist/{contentSource-CudEz5Tm.d.ts → contentSource-BDRX_YYJ.d.ts}

@@ -514,14 +514,26 @@ interface UserDBReader {
     getUsername(): string;
     isLoggedIn(): boolean;
     /**
-     * How far this device's local mirror of the user's data can be trusted.
+     * How far this device's local mirror of the user's data can be trusted,
+     * as of right now.
      *
      * Reads answer from the local mirror, so on a device that has never synced
      * this account "document not found" does not mean "no such data". Anything
      * that would otherwise interpret an empty read as a new user should check
      * for `failed` first. See {@link UserHydrationStatus}.
+     *
+     * Can return `hydrating`; use {@link awaitHydration} to decide on a settled
+     * answer instead of a snapshot.
      */
     hydrationStatus(): UserHydrationStatus;
+    /**
+     * The hydration status once settled — never `hydrating`.
+     *
+     * Resolves immediately unless a pull is in flight. Prefer this over
+     * hydrationStatus() wherever the answer gates behaviour, such as a route
+     * guard that may run while a login is still completing.
+     */
+    awaitHydration(): Promise<UserHydrationStatus>;
     /**
      * Get user configuration
      */

package/dist/{contentSource-CBqZCoGU.d.cts → contentSource-D-LQYFyx.d.cts}

@@ -514,14 +514,26 @@ interface UserDBReader {
     getUsername(): string;
     isLoggedIn(): boolean;
     /**
-     * How far this device's local mirror of the user's data can be trusted.
+     * How far this device's local mirror of the user's data can be trusted,
+     * as of right now.
      *
      * Reads answer from the local mirror, so on a device that has never synced
      * this account "document not found" does not mean "no such data". Anything
      * that would otherwise interpret an empty read as a new user should check
      * for `failed` first. See {@link UserHydrationStatus}.
+     *
+     * Can return `hydrating`; use {@link awaitHydration} to decide on a settled
+     * answer instead of a snapshot.
      */
     hydrationStatus(): UserHydrationStatus;
+    /**
+     * The hydration status once settled — never `hydrating`.
+     *
+     * Resolves immediately unless a pull is in flight. Prefer this over
+     * hydrationStatus() wherever the answer gates behaviour, such as a route
+     * guard that may run while a login is still completing.
+     */
+    awaitHydration(): Promise<UserHydrationStatus>;
     /**
      * Get user configuration
      */

package/dist/core/index.d.cts

@@ -1,6 +1,6 @@
-import { ab as LearnableWeight, M as UserOutcomeRecord, ac as OrchestrationContext, W as WeightedCard, U as UserDBInterface, C as CourseDBInterface, R as ReplanHints, a1 as StrategyContribution } from '../contentSource-CBqZCoGU.cjs';
-export { K as ActivityRecord, A as AdminDBInterface, v as AssignedCard, g as AssignedContent, u as AssignedCourse, t as AssignedTag, a8 as CardGenerator, aa as CardGeneratorFactory, c as ClassroomDBInterface, F as ClassroomRegistration, E as ClassroomRegistrationDesignation, H as ClassroomRegistrationDoc, e as ContentNavigationStrategyData, f as ContentNavigator, q as ContentSourceID, d as CourseInfo, L as CourseRegistration, s as CourseRegistrationDoc, b as CoursesDBInterface, a9 as GeneratorContext, G as GeneratorResult, P as HYDRATION_MARKER_ID, Q as HydrationMarker, V as NavigatorConstructor, a4 as NavigatorRole, a5 as NavigatorRoles, a3 as Navigators, j as ScheduledCard, I as SessionTrackingData, i as StudentClassroomDBInterface, h as StudyContentSource, k as StudySessionFailedItem, l as StudySessionFailedNewItem, m as StudySessionFailedReviewItem, S as StudySessionItem, n as StudySessionNewItem, o as StudySessionReviewItem, T as TeacherClassroomDBInterface, J as UserConfig, z as UserCourseSetting, y as UserCourseSettings, x as UserDBAuthenticator, a as UserDBReader, w as UserDBWriter, N as UserHydrationState, O as UserHydrationStatus, B as UsrCrsDataInterface, ad as computeDeviation, af as computeEffectiveWeight, ae as computeSpread, ag as createOrchestrationContext, a2 as getCardOrigin, Y as getRegisteredNavigator, $ as getRegisteredNavigatorNames, _ as getRegisteredNavigatorRole, r as getStudySource, Z as hasRegisteredNavigator, a0 as initializeNavigatorRegistry, a7 as isFilter, a6 as isGenerator, p as isReview, X as registerNavigator } from '../contentSource-CBqZCoGU.cjs';
-export { D as DataLayerProvider } from '../dataLayerProvider-BBA8tJNx.cjs';
+import { ab as LearnableWeight, M as UserOutcomeRecord, ac as OrchestrationContext, W as WeightedCard, U as UserDBInterface, C as CourseDBInterface, R as ReplanHints, a1 as StrategyContribution } from '../contentSource-D-LQYFyx.cjs';
+export { K as ActivityRecord, A as AdminDBInterface, v as AssignedCard, g as AssignedContent, u as AssignedCourse, t as AssignedTag, a8 as CardGenerator, aa as CardGeneratorFactory, c as ClassroomDBInterface, F as ClassroomRegistration, E as ClassroomRegistrationDesignation, H as ClassroomRegistrationDoc, e as ContentNavigationStrategyData, f as ContentNavigator, q as ContentSourceID, d as CourseInfo, L as CourseRegistration, s as CourseRegistrationDoc, b as CoursesDBInterface, a9 as GeneratorContext, G as GeneratorResult, P as HYDRATION_MARKER_ID, Q as HydrationMarker, V as NavigatorConstructor, a4 as NavigatorRole, a5 as NavigatorRoles, a3 as Navigators, j as ScheduledCard, I as SessionTrackingData, i as StudentClassroomDBInterface, h as StudyContentSource, k as StudySessionFailedItem, l as StudySessionFailedNewItem, m as StudySessionFailedReviewItem, S as StudySessionItem, n as StudySessionNewItem, o as StudySessionReviewItem, T as TeacherClassroomDBInterface, J as UserConfig, z as UserCourseSetting, y as UserCourseSettings, x as UserDBAuthenticator, a as UserDBReader, w as UserDBWriter, N as UserHydrationState, O as UserHydrationStatus, B as UsrCrsDataInterface, ad as computeDeviation, af as computeEffectiveWeight, ae as computeSpread, ag as createOrchestrationContext, a2 as getCardOrigin, Y as getRegisteredNavigator, $ as getRegisteredNavigatorNames, _ as getRegisteredNavigatorRole, r as getStudySource, Z as hasRegisteredNavigator, a0 as initializeNavigatorRegistry, a7 as isFilter, a6 as isGenerator, p as isReview, X as registerNavigator } from '../contentSource-D-LQYFyx.cjs';
+export { D as DataLayerProvider } from '../dataLayerProvider-Dd2UcCif.cjs';
 import { D as DocType, d as QuestionRecord, b as DocTypePrefixes, C as CardHistory, c as CardRecord } from '../types-legacy-4tlwHnXo.cjs';
 export { e as CardData, f as CourseListData, h as DataShapeData, g as DisplayableData, F as Field, G as GuestUsername, Q as QualifiedCardID, i as QuestionData, S as SkuilderCourseData, a as Tag, T as TagStub, l as log } from '../types-legacy-4tlwHnXo.cjs';
 import { DataShape, ParsedCard } from '@vue-skuilder/common';

package/dist/core/index.d.ts

@@ -1,6 +1,6 @@
-import { ab as LearnableWeight, M as UserOutcomeRecord, ac as OrchestrationContext, W as WeightedCard, U as UserDBInterface, C as CourseDBInterface, R as ReplanHints, a1 as StrategyContribution } from '../contentSource-CudEz5Tm.js';
-export { K as ActivityRecord, A as AdminDBInterface, v as AssignedCard, g as AssignedContent, u as AssignedCourse, t as AssignedTag, a8 as CardGenerator, aa as CardGeneratorFactory, c as ClassroomDBInterface, F as ClassroomRegistration, E as ClassroomRegistrationDesignation, H as ClassroomRegistrationDoc, e as ContentNavigationStrategyData, f as ContentNavigator, q as ContentSourceID, d as CourseInfo, L as CourseRegistration, s as CourseRegistrationDoc, b as CoursesDBInterface, a9 as GeneratorContext, G as GeneratorResult, P as HYDRATION_MARKER_ID, Q as HydrationMarker, V as NavigatorConstructor, a4 as NavigatorRole, a5 as NavigatorRoles, a3 as Navigators, j as ScheduledCard, I as SessionTrackingData, i as StudentClassroomDBInterface, h as StudyContentSource, k as StudySessionFailedItem, l as StudySessionFailedNewItem, m as StudySessionFailedReviewItem, S as StudySessionItem, n as StudySessionNewItem, o as StudySessionReviewItem, T as TeacherClassroomDBInterface, J as UserConfig, z as UserCourseSetting, y as UserCourseSettings, x as UserDBAuthenticator, a as UserDBReader, w as UserDBWriter, N as UserHydrationState, O as UserHydrationStatus, B as UsrCrsDataInterface, ad as computeDeviation, af as computeEffectiveWeight, ae as computeSpread, ag as createOrchestrationContext, a2 as getCardOrigin, Y as getRegisteredNavigator, $ as getRegisteredNavigatorNames, _ as getRegisteredNavigatorRole, r as getStudySource, Z as hasRegisteredNavigator, a0 as initializeNavigatorRegistry, a7 as isFilter, a6 as isGenerator, p as isReview, X as registerNavigator } from '../contentSource-CudEz5Tm.js';
-export { D as DataLayerProvider } from '../dataLayerProvider-C9WgkBzR.js';
+import { ab as LearnableWeight, M as UserOutcomeRecord, ac as OrchestrationContext, W as WeightedCard, U as UserDBInterface, C as CourseDBInterface, R as ReplanHints, a1 as StrategyContribution } from '../contentSource-BDRX_YYJ.js';
+export { K as ActivityRecord, A as AdminDBInterface, v as AssignedCard, g as AssignedContent, u as AssignedCourse, t as AssignedTag, a8 as CardGenerator, aa as CardGeneratorFactory, c as ClassroomDBInterface, F as ClassroomRegistration, E as ClassroomRegistrationDesignation, H as ClassroomRegistrationDoc, e as ContentNavigationStrategyData, f as ContentNavigator, q as ContentSourceID, d as CourseInfo, L as CourseRegistration, s as CourseRegistrationDoc, b as CoursesDBInterface, a9 as GeneratorContext, G as GeneratorResult, P as HYDRATION_MARKER_ID, Q as HydrationMarker, V as NavigatorConstructor, a4 as NavigatorRole, a5 as NavigatorRoles, a3 as Navigators, j as ScheduledCard, I as SessionTrackingData, i as StudentClassroomDBInterface, h as StudyContentSource, k as StudySessionFailedItem, l as StudySessionFailedNewItem, m as StudySessionFailedReviewItem, S as StudySessionItem, n as StudySessionNewItem, o as StudySessionReviewItem, T as TeacherClassroomDBInterface, J as UserConfig, z as UserCourseSetting, y as UserCourseSettings, x as UserDBAuthenticator, a as UserDBReader, w as UserDBWriter, N as UserHydrationState, O as UserHydrationStatus, B as UsrCrsDataInterface, ad as computeDeviation, af as computeEffectiveWeight, ae as computeSpread, ag as createOrchestrationContext, a2 as getCardOrigin, Y as getRegisteredNavigator, $ as getRegisteredNavigatorNames, _ as getRegisteredNavigatorRole, r as getStudySource, Z as hasRegisteredNavigator, a0 as initializeNavigatorRegistry, a7 as isFilter, a6 as isGenerator, p as isReview, X as registerNavigator } from '../contentSource-BDRX_YYJ.js';
+export { D as DataLayerProvider } from '../dataLayerProvider-Dpshuql4.js';
 import { D as DocType, d as QuestionRecord, b as DocTypePrefixes, C as CardHistory, c as CardRecord } from '../types-legacy-4tlwHnXo.js';
 export { e as CardData, f as CourseListData, h as DataShapeData, g as DisplayableData, F as Field, G as GuestUsername, Q as QualifiedCardID, i as QuestionData, S as SkuilderCourseData, a as Tag, T as TagStub, l as log } from '../types-legacy-4tlwHnXo.js';
 import { DataShape, ParsedCard } from '@vue-skuilder/common';

package/dist/core/index.js

@@ -6919,16 +6919,44 @@ var init_BaseUserDB = __esm({
       // Database to use for write operations (local-first approach)
       updateQueue;
       _hydration = { state: "not-required" };
+      /** In-flight hydration, so concurrent callers can wait for a real answer. */
+      _hydrationPromise = null;
       /**
-       * How far the local mirror can be trusted. See {@link UserHydrationStatus}.
+       * Sequence the local mirror was filled to by a hydration that succeeded in
+       * THIS init(), handed to startSync() so the live pull can skip history it
+       * would otherwise re-walk. Undefined whenever there is no such guarantee —
+       * hydration skipped, not required, or failed. Never persisted; see the
+       * `since` note in CouchDBSyncStrategy.startSync().
+       */
+      _hydratedSeq;
+      /**
+       * How far the local mirror can be trusted, RIGHT NOW. See
+       * {@link UserHydrationStatus}.
        *
-       * Consumers that would otherwise read a 404 as "new user" — onboarding
-       * gates, first-run experiences, progress dashboards — should check for
-       * `failed` and present a retry affordance rather than an empty state.
+       * This is a snapshot, and during login it can legitimately read
+       * `hydrating` — prefer awaitHydration() anywhere a decision hangs on the
+       * answer.
        */
       hydrationStatus() {
         return { ...this._hydration };
       }
+      /**
+       * The hydration status once it has settled — never `hydrating`.
+       *
+       * Resolves immediately unless a pull is in flight. Exists for callers that
+       * must decide something (a route guard, a first-run branch) and would
+       * otherwise sample `hydrating` and guess. Since init() is awaited by both
+       * app startup and login(), that only happens when something navigates
+       * concurrently with a login still in progress — a window that stretches to
+       * HYDRATION_TIMEOUT_MS on a slow connection.
+       */
+      async awaitHydration() {
+        try {
+          await this._hydrationPromise;
+        } catch {
+        }
+        return this.hydrationStatus();
+      }
       /**
        * Whether a missing document may be treated as genuinely absent, allowing
        * callers to create it with defaults.
@@ -7385,8 +7413,9 @@ Currently logged-in as ${this._username}.`
         }
         this.syncStrategy.stopSync?.();
         this.setDBandQ();
-        await this.hydrateLocalMirror();
-        this.syncStrategy.startSync(this.localDB, this.remoteDB);
+        this._hydrationPromise = this.hydrateLocalMirror();
+        await this._hydrationPromise;
+        this.syncStrategy.startSync(this.localDB, this.remoteDB, this._hydratedSeq);
         this.applyDesignDocs().catch((error) => {
           log3(`Error in applyDesignDocs background task: ${error}`);
           if (error && typeof error === "object") {
@@ -7414,6 +7443,7 @@ Currently logged-in as ${this._username}.`
        * ceiling). Callers decide what a failure means for them.
        */
       async hydrateLocalMirror() {
+        this._hydratedSeq = void 0;
         if (this.localDB.name === this.remoteDB.name || !this.syncStrategy.hydrate) {
           this._hydration = { state: "not-required" };
           return;
@@ -7425,11 +7455,12 @@ Currently logged-in as ${this._username}.`
         this._hydration = { state: "hydrating" };
         const start = Date.now();
         try {
-          const { docsWritten } = await withTimeout(
+          const { docsWritten, lastSeq } = await withTimeout(
             this.syncStrategy.hydrate(this.localDB, this.remoteDB),
             HYDRATION_TIMEOUT_MS,
             `Hydration of local mirror for ${this._username}`
           );
+          this._hydratedSeq = lastSeq;
           await this.writeHydrationMarker();
           this._hydration = {
             state: "hydrated",