@vue-skuilder/db 0.1.6 → 0.1.7

package/dist/{types-D6SnlHPm.d.ts → types-BvzcRAys.d.ts}

@@ -1,5 +1,5 @@
 import { CourseConfig } from '@vue-skuilder/common';
-import { D as DocType } from './types-legacy-WPe8CtO-.js';
+import { D as DocType } from './types-legacy-CtrmkOLu.js';
 
 interface StaticCourseManifest {
     version: string;

package/dist/{types-DPRvCrIk.d.mts → types-CQQ80R5N.d.mts}

@@ -1,5 +1,5 @@
 import { CourseConfig } from '@vue-skuilder/common';
-import { D as DocType } from './types-legacy-WPe8CtO-.mjs';
+import { D as DocType } from './types-legacy-CtrmkOLu.mjs';
 
 interface StaticCourseManifest {
     version: string;

package/dist/{types-legacy-WPe8CtO-.d.mts → types-legacy-CtrmkOLu.d.mts}

@@ -136,4 +136,4 @@ interface QuestionRecord extends CardRecord, Evaluation {
     priorAttemps: number;
 }
 
-export { type CardRecord as C, DocType as D, type Field as F, GuestUsername as G, type QuestionData as Q, type SkuilderCourseData as S, type Tag as T, type TagStub as a, type CardData as b, type CourseListData as c, type DisplayableData as d, type DataShapeData as e, cardHistoryPrefix as f, type CardHistory as g, type QuestionRecord as h, log as l };
+export { type CardRecord as C, DocType as D, type Field as F, GuestUsername as G, type QuestionData as Q, type SkuilderCourseData as S, type TagStub as T, type Tag as a, type CardData as b, type CourseListData as c, type DisplayableData as d, type DataShapeData as e, cardHistoryPrefix as f, type CardHistory as g, type QuestionRecord as h, log as l };

package/dist/{types-legacy-WPe8CtO-.d.ts → types-legacy-CtrmkOLu.d.ts}

@@ -136,4 +136,4 @@ interface QuestionRecord extends CardRecord, Evaluation {
     priorAttemps: number;
 }
 
-export { type CardRecord as C, DocType as D, type Field as F, GuestUsername as G, type QuestionData as Q, type SkuilderCourseData as S, type Tag as T, type TagStub as a, type CardData as b, type CourseListData as c, type DisplayableData as d, type DataShapeData as e, cardHistoryPrefix as f, type CardHistory as g, type QuestionRecord as h, log as l };
+export { type CardRecord as C, DocType as D, type Field as F, GuestUsername as G, type QuestionData as Q, type SkuilderCourseData as S, type TagStub as T, type Tag as a, type CardData as b, type CourseListData as c, type DisplayableData as d, type DataShapeData as e, cardHistoryPrefix as f, type CardHistory as g, type QuestionRecord as h, log as l };

package/dist/{userDB-31gsvxyd.d.mts → userDB-7fM4tpgr.d.mts}

@@ -1,6 +1,6 @@
 import { CourseConfig, ClassroomConfig, CourseElo, Status, SkuilderCourseData as SkuilderCourseData$1, DataShape } from '@vue-skuilder/common';
 import { Moment } from 'moment';
-import { S as SkuilderCourseData, D as DocType, a as TagStub, T as Tag, g as CardHistory, C as CardRecord } from './types-legacy-WPe8CtO-.mjs';
+import { S as SkuilderCourseData, D as DocType, T as TagStub, a as Tag, g as CardHistory, C as CardRecord } from './types-legacy-CtrmkOLu.mjs';
 
 /**
  * Admin functionality
@@ -490,4 +490,4 @@ interface ClassroomRegistrationDoc {
     registrations: ClassroomRegistration[];
 }
 
-export { type AdminDBInterface as A, type CourseRegistrationDoc as B, type CourseDBInterface as C, type ScheduledCard as D, type DocumentUpdater as E, newInterval as F, type DataLayerResult as G, type ContentNavigationStrategyData as H, type StudySessionItem as S, type TeacherClassroomDBInterface as T, type UserDBInterface as U, type CoursesDBInterface as a, type ClassroomDBInterface as b, type StudyContentSource as c, type StudentClassroomDBInterface as d, type AssignedContent as e, type AssignedTag as f, type AssignedCourse as g, type AssignedCard as h, type StudySessionFailedItem as i, type StudySessionFailedNewItem as j, type StudySessionFailedReviewItem as k, type StudySessionNewItem as l, type StudySessionReviewItem as m, isReview as n, type ContentSourceID as o, getStudySource as p, type CourseInfo as q, type UserCourseSettings as r, type UserCourseSetting as s, type UsrCrsDataInterface as t, type ClassroomRegistrationDesignation as u, type ClassroomRegistration as v, type ClassroomRegistrationDoc as w, type UserConfig as x, type ActivityRecord as y, type CourseRegistration as z };
+export { type AdminDBInterface as A, type ActivityRecord as B, type CourseDBInterface as C, type DataLayerResult as D, type CourseRegistration as E, type CourseRegistrationDoc as F, type DocumentUpdater as G, newInterval as H, type StudySessionNewItem as S, type TeacherClassroomDBInterface as T, type UserDBInterface as U, type CoursesDBInterface as a, type ClassroomDBInterface as b, type CourseInfo as c, type ContentNavigationStrategyData as d, type StudySessionReviewItem as e, type ScheduledCard as f, type AssignedContent as g, type StudyContentSource as h, type StudentClassroomDBInterface as i, type StudySessionItem as j, type StudySessionFailedItem as k, type StudySessionFailedNewItem as l, type StudySessionFailedReviewItem as m, isReview as n, type ContentSourceID as o, getStudySource as p, type AssignedTag as q, type AssignedCourse as r, type AssignedCard as s, type UserCourseSettings as t, type UserCourseSetting as u, type UsrCrsDataInterface as v, type ClassroomRegistrationDesignation as w, type ClassroomRegistration as x, type ClassroomRegistrationDoc as y, type UserConfig as z };

package/dist/{userDB-D9EuWTp1.d.ts → userDB-DUY63VMN.d.ts}

@@ -1,6 +1,6 @@
 import { CourseConfig, ClassroomConfig, CourseElo, Status, SkuilderCourseData as SkuilderCourseData$1, DataShape } from '@vue-skuilder/common';
 import { Moment } from 'moment';
-import { S as SkuilderCourseData, D as DocType, a as TagStub, T as Tag, g as CardHistory, C as CardRecord } from './types-legacy-WPe8CtO-.js';
+import { S as SkuilderCourseData, D as DocType, T as TagStub, a as Tag, g as CardHistory, C as CardRecord } from './types-legacy-CtrmkOLu.js';
 
 /**
  * Admin functionality
@@ -490,4 +490,4 @@ interface ClassroomRegistrationDoc {
     registrations: ClassroomRegistration[];
 }
 
-export { type AdminDBInterface as A, type CourseRegistrationDoc as B, type CourseDBInterface as C, type ScheduledCard as D, type DocumentUpdater as E, newInterval as F, type DataLayerResult as G, type ContentNavigationStrategyData as H, type StudySessionItem as S, type TeacherClassroomDBInterface as T, type UserDBInterface as U, type CoursesDBInterface as a, type ClassroomDBInterface as b, type StudyContentSource as c, type StudentClassroomDBInterface as d, type AssignedContent as e, type AssignedTag as f, type AssignedCourse as g, type AssignedCard as h, type StudySessionFailedItem as i, type StudySessionFailedNewItem as j, type StudySessionFailedReviewItem as k, type StudySessionNewItem as l, type StudySessionReviewItem as m, isReview as n, type ContentSourceID as o, getStudySource as p, type CourseInfo as q, type UserCourseSettings as r, type UserCourseSetting as s, type UsrCrsDataInterface as t, type ClassroomRegistrationDesignation as u, type ClassroomRegistration as v, type ClassroomRegistrationDoc as w, type UserConfig as x, type ActivityRecord as y, type CourseRegistration as z };
+export { type AdminDBInterface as A, type ActivityRecord as B, type CourseDBInterface as C, type DataLayerResult as D, type CourseRegistration as E, type CourseRegistrationDoc as F, type DocumentUpdater as G, newInterval as H, type StudySessionNewItem as S, type TeacherClassroomDBInterface as T, type UserDBInterface as U, type CoursesDBInterface as a, type ClassroomDBInterface as b, type CourseInfo as c, type ContentNavigationStrategyData as d, type StudySessionReviewItem as e, type ScheduledCard as f, type AssignedContent as g, type StudyContentSource as h, type StudentClassroomDBInterface as i, type StudySessionItem as j, type StudySessionFailedItem as k, type StudySessionFailedNewItem as l, type StudySessionFailedReviewItem as m, isReview as n, type ContentSourceID as o, getStudySource as p, type AssignedTag as q, type AssignedCourse as r, type AssignedCard as s, type UserCourseSettings as t, type UserCourseSetting as u, type UsrCrsDataInterface as v, type ClassroomRegistrationDesignation as w, type ClassroomRegistration as x, type ClassroomRegistrationDoc as y, type UserConfig as z };

package/dist/util/packer/index.d.mts

@@ -1,7 +1,7 @@
-import { P as PackerConfig, a as PackedCourseData } from '../../types-DPRvCrIk.mjs';
-export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, S as StaticCourseManifest } from '../../types-DPRvCrIk.mjs';
+import { P as PackerConfig, a as PackedCourseData } from '../../types-CQQ80R5N.mjs';
+export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, S as StaticCourseManifest } from '../../types-CQQ80R5N.mjs';
 import '@vue-skuilder/common';
-import '../../types-legacy-WPe8CtO-.mjs';
+import '../../types-legacy-CtrmkOLu.mjs';
 import 'moment';
 
 declare class CouchDBToStaticPacker {

package/dist/util/packer/index.d.ts

@@ -1,7 +1,7 @@
-import { P as PackerConfig, a as PackedCourseData } from '../../types-D6SnlHPm.js';
-export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, S as StaticCourseManifest } from '../../types-D6SnlHPm.js';
+import { P as PackerConfig, a as PackedCourseData } from '../../types-BvzcRAys.js';
+export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, S as StaticCourseManifest } from '../../types-BvzcRAys.js';
 import '@vue-skuilder/common';
-import '../../types-legacy-WPe8CtO-.js';
+import '../../types-legacy-CtrmkOLu.js';
 import 'moment';
 
 declare class CouchDBToStaticPacker {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Database layer for vue-skuilder",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@nilock2/pouchdb-authentication": "^1.0.2",
-    "@vue-skuilder/common": "0.1.6",
+    "@vue-skuilder/common": "0.1.7",
     "moment": "^2.29.4",
     "pouchdb": "^9.0.0",
     "pouchdb-find": "^9.0.0"

package/src/factory.ts

@@ -1,6 +1,7 @@
 // db/src/factory.ts
 
 import { DataLayerProvider } from './core/interfaces';
+import { BaseUser } from './impl/common';
 import { logger } from './util/logger';
 import { StaticCourseManifest } from './util/packer/types';
 
@@ -53,6 +54,30 @@ export async function initializeDataLayer(config: DataLayerConfig): Promise<Data
     ENV.COUCHDB_USERNAME = config.options.COUCHDB_USERNAME;
     ENV.COUCHDB_PASSWORD = config.options.COUCHDB_PASSWORD;
 
+    if (
+      config.options.COUCHDB_PASSWORD &&
+      config.options.COUCHDB_USERNAME &&
+      typeof window !== 'undefined'
+    ) {
+      // Dynamic import to avoid loading both implementations when only one is needed
+      const { CouchDBSyncStrategy } = await import('./impl/couch/CouchDBSyncStrategy');
+
+      // Create a sync strategy instance and authenticate
+      const syncStrategy = new CouchDBSyncStrategy();
+
+      const user = await BaseUser.instance(syncStrategy, config.options.COUCHDB_USERNAME);
+      const authResult = await user.login(
+        config.options.COUCHDB_USERNAME,
+        config.options.COUCHDB_PASSWORD
+      );
+
+      if (authResult.ok) {
+        logger.info(`Successfully authenticated as ${config.options.COUCHDB_USERNAME}`);
+      } else {
+        logger.warn(`Authentication failed: ${authResult.error}`);
+      }
+    }
+
     // Dynamic import to avoid loading both implementations when only one is needed
     const { CouchDataLayerProvider } = await import('./impl/couch/PouchDataLayerProvider');
     dataLayerInstance = new CouchDataLayerProvider(config.options.COURSE_IDS);

package/src/impl/common/BaseUserDB.ts

@@ -112,7 +112,11 @@ Currently logged-in as ${this._username}.`
     if (result.status === Status.ok) {
       log(`Account created successfully, updating username to ${username}`);
       this._username = username;
-      localStorage.removeItem('dbUUID');
+      try {
+        localStorage.removeItem('dbUUID');
+      } catch (e) {
+        logger.warn('localStorage not available (Node.js environment):', e);
+      }
       await this.init();
     }
 
@@ -126,16 +130,23 @@ Currently logged-in as ${this._username}.`
       throw new Error('Authentication not supported by current sync strategy');
     }
 
-    if (!this._username.startsWith(GuestUsername)) {
-      throw new Error(`Cannot change accounts while logged in.
-      Log out of account ${this.getUsername()} before logging in as ${username}.`);
+    if (!this._username.startsWith(GuestUsername) && this._username != username) {
+      if (this._username != username) {
+        throw new Error(`Cannot change accounts while logged in.
+        Log out of account ${this.getUsername()} before logging in as ${username}.`);
+      }
+      logger.warn(`User ${this._username} is already logged in, but executing login again.`);
     }
 
     const loginResult = await this.syncStrategy.authenticate!(username, password);
     if (loginResult.ok) {
       log(`Logged in as ${username}`);
       this._username = username;
-      localStorage.removeItem('dbUUID');
+      try {
+        localStorage.removeItem('dbUUID');
+      } catch (e) {
+        logger.warn('localStorage not available (Node.js environment):', e);
+      }
       await this.init();
     }
     return loginResult;
@@ -590,6 +601,13 @@ Currently logged-in as ${this._username}.`
 
   private async init() {
     BaseUser._initialized = false;
+
+    // Skip admin user
+    if (this._username === 'admin') {
+      BaseUser._initialized = true;
+      return;
+    }
+
     this.setDBandQ();
 
     this.syncStrategy.startSync(this.localDB, this.remoteDB);
@@ -614,6 +632,11 @@ Currently logged-in as ${this._username}.`
   ];
 
   private async applyDesignDocs() {
+    if (this._username === 'admin') {
+      // Skip admin user
+      return;
+    }
+
     for (const doc of BaseUser.designDocs) {
       try {
         // Try to get existing doc
@@ -633,7 +656,7 @@ Currently logged-in as ${this._username}.`
           }
         }
       } catch (error: unknown) {
-        if (error instanceof Error && error.name === 'conflict') {
+        if ((error as any).name && (error as any).name === 'conflict') {
           logger.warn(`Design doc ${doc._id} update conflict - will retry`);
           // Wait a bit and try again
           await new Promise((resolve) => setTimeout(resolve, 1000));

package/src/impl/common/userDBHelpers.ts

@@ -8,6 +8,7 @@ export const REVIEW_PREFIX: string = 'card_review_';
 export const REVIEW_TIME_FORMAT: string = 'YYYY-MM-DD--kk:mm:ss-SSS';
 
 import pouch from '../couch/pouchdb-setup';
+import { getDbPath } from '../../util/dataDirectory';
 
 const log = (s: any) => {
   logger.info(s);
@@ -94,7 +95,16 @@ export function getLocalUserDB(username: string): PouchDB.Database {
   //   adapter = 'memory';
   // }
 
-  return new pouch(`userdb-${username}`, {});
+  const dbName = `userdb-${username}`;
+  
+  // Use proper data directory in Node.js, browser will use IndexedDB
+  if (typeof window === 'undefined') {
+    // Node.js environment - use filesystem with proper app data directory
+    return new pouch(getDbPath(dbName), {});
+  } else {
+    // Browser environment - use default (IndexedDB)
+    return new pouch(dbName, {});
+  }
 }
 
 /**

package/src/impl/couch/courseLookupDB.ts

@@ -97,6 +97,30 @@ export default class CourseLookup {
     return resp.id;
   }
 
+  /**
+   * Adds a new course to the lookup database with a specific courseID
+   * @param courseId The specific course ID to use
+   * @param courseName The course name
+   * @param disambiguator Optional disambiguator
+   * @returns Promise<void>
+   */
+  static async addWithId(
+    courseId: string, 
+    courseName: string, 
+    disambiguator?: string
+  ): Promise<void> {
+    const doc: Omit<CourseLookupDoc, '_rev'> = {
+      _id: courseId,
+      name: courseName,
+    };
+    
+    if (disambiguator) {
+      doc.disambiguator = disambiguator;
+    }
+
+    await CourseLookup._db.put(doc);
+  }
+
   /**
    * Removes a course from the index
    * @param courseID

package/src/util/dataDirectory.test.ts

@@ -0,0 +1,53 @@
+// Test suite for cross-platform data directory utilities
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import * as os from 'os';
+import * as path from 'path';
+import { getAppDataDirectory, getDbPath, ensureAppDataDirectory } from './dataDirectory';
+
+describe('dataDirectory utilities', () => {
+  const originalHomedir = os.homedir;
+  const testHome = '/test/home';
+
+  beforeEach(() => {
+    // Mock os.homedir for consistent testing
+    (os as any).homedir = () => testHome;
+  });
+
+  afterEach(() => {
+    // Restore original function
+    os.homedir = originalHomedir;
+  });
+
+  describe('getAppDataDirectory', () => {
+    it('should return correct path using home directory', () => {
+      const result = getAppDataDirectory();
+      expect(result).toBe(path.join(testHome, '.tuilder'));
+    });
+  });
+
+  describe('getDbPath', () => {
+    it('should return correct database path', () => {
+      const dbName = 'userdb-testuser';
+      const result = getDbPath(dbName);
+      expect(result).toBe(path.join(testHome, '.tuilder', dbName));
+    });
+
+    it('should handle special characters in username', () => {
+      const dbName = 'userdb-test@user.com';
+      const result = getDbPath(dbName);
+      expect(result).toBe(path.join(testHome, '.tuilder', dbName));
+    });
+  });
+
+  describe('ensureAppDataDirectory', () => {
+    it('should handle path creation gracefully', async () => {
+      // Note: This test doesn't actually create directories since we're testing logic
+      // In a real test environment, you'd want to use a temp directory
+      expect(typeof ensureAppDataDirectory).toBe('function');
+      
+      // Test the function exists and returns a promise
+      const result = ensureAppDataDirectory();
+      expect(result).toBeInstanceOf(Promise);
+    });
+  });
+});

package/src/util/dataDirectory.ts

@@ -0,0 +1,52 @@
+// Cross-platform data directory utilities for PouchDB
+// Provides OS-appropriate application data directories
+
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+import { logger } from './tuiLogger';
+
+/**
+ * Get the application data directory for the current platform
+ * Uses ~/.tuilder as requested by user for simplicity
+ */
+export function getAppDataDirectory(): string {
+  return path.join(os.homedir(), '.tuilder');
+}
+
+/**
+ * Ensure the application data directory exists
+ * Creates directory recursively if it doesn't exist
+ */
+export async function ensureAppDataDirectory(): Promise<string> {
+  const appDataDir = getAppDataDirectory();
+  
+  try {
+    await fs.promises.mkdir(appDataDir, { recursive: true });
+  } catch (err: any) {
+    if (err.code !== 'EEXIST') {
+      throw new Error(`Failed to create app data directory ${appDataDir}: ${err.message}`);
+    }
+  }
+  
+  return appDataDir;
+}
+
+/**
+ * Get the full path for a PouchDB database file
+ * @param dbName - The database name (e.g., 'userdb-Colin')
+ */
+export function getDbPath(dbName: string): string {
+  return path.join(getAppDataDirectory(), dbName);
+}
+
+/**
+ * Initialize data directory for PouchDB usage
+ * Should be called once at application startup
+ */
+export async function initializeDataDirectory(): Promise<void> {
+  await ensureAppDataDirectory();
+  
+  // Log initialization
+  logger.info(`PouchDB data directory initialized: ${getAppDataDirectory()}`);
+}

package/src/util/index.ts

@@ -1,2 +1,5 @@
 export * from './Loggable';
 export * from './packer';
+export * from './migrator';
+export * from './dataDirectory';
+export * from './tuiLogger';

package/src/util/migrator/FileSystemAdapter.ts

@@ -0,0 +1,59 @@
+// packages/db/src/util/migrator/FileSystemAdapter.ts
+
+/**
+ * Abstraction for file system operations needed by the migrator.
+ * This allows dependency injection of file system operations,
+ * avoiding bundling issues with Node.js fs module.
+ */
+export interface FileSystemAdapter {
+  /**
+   * Read a text file and return its contents as a string
+   */
+  readFile(filePath: string): Promise<string>;
+
+  /**
+   * Read a binary file and return its contents as a Buffer
+   */
+  readBinary(filePath: string): Promise<Buffer>;
+
+  /**
+   * Check if a file or directory exists
+   */
+  exists(filePath: string): Promise<boolean>;
+
+  /**
+   * Get file/directory statistics
+   */
+  stat(filePath: string): Promise<FileStats>;
+
+  /**
+   * Join path segments into a complete path
+   */
+  joinPath(...segments: string[]): string;
+
+  /**
+   * Check if a path is absolute
+   */
+  isAbsolute(filePath: string): boolean;
+}
+
+export interface FileStats {
+  isDirectory(): boolean;
+  isFile(): boolean;
+  size: number;
+}
+
+/**
+ * Error thrown when file system operations fail
+ */
+export class FileSystemError extends Error {
+  constructor(
+    message: string,
+    public readonly operation: string,
+    public readonly filePath: string,
+    public readonly cause?: Error
+  ) {
+    super(message);
+    this.name = 'FileSystemError';
+  }
+}