@vue-skuilder/db 0.1.6 → 0.1.8-0

package/dist/index.d.ts

@@ -1,16 +1,199 @@
-import { S as StudySessionItem, c as StudyContentSource } from './userDB-D9EuWTp1.js';
-export { y as ActivityRecord, A as AdminDBInterface, h as AssignedCard, e as AssignedContent, g as AssignedCourse, f as AssignedTag, b as ClassroomDBInterface, v as ClassroomRegistration, u as ClassroomRegistrationDesignation, w as ClassroomRegistrationDoc, o as ContentSourceID, C as CourseDBInterface, q as CourseInfo, z as CourseRegistration, B as CourseRegistrationDoc, a as CoursesDBInterface, E as DocumentUpdater, D as ScheduledCard, d as StudentClassroomDBInterface, i as StudySessionFailedItem, j as StudySessionFailedNewItem, k as StudySessionFailedReviewItem, l as StudySessionNewItem, m as StudySessionReviewItem, T as TeacherClassroomDBInterface, x as UserConfig, s as UserCourseSetting, r as UserCourseSettings, U as UserDBInterface, t as UsrCrsDataInterface, p as getStudySource, n as isReview, F as newInterval } from './userDB-D9EuWTp1.js';
-import { D as DataLayerProvider } from './dataLayerProvider-BuntXkCs.js';
-import { C as CardRecord } from './types-legacy-WPe8CtO-.js';
-export { b as CardData, g as CardHistory, c as CourseListData, e as DataShapeData, d as DisplayableData, D as DocType, F as Field, G as GuestUsername, Q as QuestionData, h as QuestionRecord, S as SkuilderCourseData, T as Tag, a as TagStub, f as cardHistoryPrefix, l as log } from './types-legacy-WPe8CtO-.js';
+import { j as StudySessionItem, h as StudyContentSource } from './userDB-DusL7OXe.js';
+export { B as ActivityRecord, A as AdminDBInterface, s as AssignedCard, g as AssignedContent, r as AssignedCourse, q as AssignedTag, b as ClassroomDBInterface, x as ClassroomRegistration, w as ClassroomRegistrationDesignation, y as ClassroomRegistrationDoc, o as ContentSourceID, C as CourseDBInterface, c as CourseInfo, E as CourseRegistration, F as CourseRegistrationDoc, a as CoursesDBInterface, G as DocumentUpdater, f as ScheduledCard, i as StudentClassroomDBInterface, k as StudySessionFailedItem, l as StudySessionFailedNewItem, m as StudySessionFailedReviewItem, S as StudySessionNewItem, e as StudySessionReviewItem, T as TeacherClassroomDBInterface, z as UserConfig, u as UserCourseSetting, t as UserCourseSettings, U as UserDBInterface, v as UsrCrsDataInterface, p as getStudySource, n as isReview, H as newInterval } from './userDB-DusL7OXe.js';
+import { D as DataLayerProvider } from './dataLayerProvider-DqtNroSh.js';
+import { C as CardRecord } from './types-legacy-Birv-Jx6.js';
+export { b as CardData, g as CardHistory, c as CourseListData, e as DataShapeData, d as DisplayableData, D as DocType, f as DocTypePrefixes, F as Field, G as GuestUsername, Q as QuestionData, h as QuestionRecord, S as SkuilderCourseData, a as Tag, T as TagStub, l as log } from './types-legacy-Birv-Jx6.js';
 import { Loggable } from './core/index.js';
 export { BulkCardProcessorConfig, ContentNavigator, ImportResult, Navigators, areQuestionRecords, docIsDeleted, getCardHistoryID, importParsedCards, isQuestionRecord, parseCardHistoryID, validateProcessorConfig } from './core/index.js';
-import { S as StaticCourseManifest } from './types-D6SnlHPm.js';
-export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, a as PackedCourseData, P as PackerConfig } from './types-D6SnlHPm.js';
-export { CouchDBToStaticPacker } from './util/packer/index.js';
+import { S as StaticCourseManifest } from './types-BefDGkKa.js';
+export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, a as PackedCourseData, P as PackerConfig } from './types-BefDGkKa.js';
+import { F as FileSystemAdapter } from './index-CLL31bEy.js';
+export { C as CouchDBToStaticPacker, a as FileStats, b as FileSystemError } from './index-CLL31bEy.js';
 import '@vue-skuilder/common';
 import 'moment';
 
+interface MigrationOptions {
+    chunkBatchSize: number;
+    validateRoundTrip: boolean;
+    cleanupOnFailure: boolean;
+    timeout: number;
+}
+interface MigrationResult {
+    success: boolean;
+    documentsRestored: number;
+    attachmentsRestored: number;
+    designDocsRestored: number;
+    courseConfigRestored: number;
+    errors: string[];
+    warnings: string[];
+    migrationTime: number;
+    tempDatabaseName?: string;
+}
+interface ValidationResult {
+    valid: boolean;
+    documentCountMatch: boolean;
+    attachmentIntegrity: boolean;
+    viewFunctionality: boolean;
+    issues: ValidationIssue[];
+}
+interface ValidationIssue {
+    type: 'error' | 'warning';
+    category: 'documents' | 'attachments' | 'views' | 'metadata' | 'course_config';
+    message: string;
+    details?: any;
+}
+interface DocumentCounts {
+    [docType: string]: number;
+}
+interface RestoreProgress {
+    phase: 'manifest' | 'design_docs' | 'course_config' | 'documents' | 'attachments' | 'validation';
+    current: number;
+    total: number;
+    message: string;
+}
+interface StaticCourseValidation {
+    valid: boolean;
+    manifestExists: boolean;
+    chunksExist: boolean;
+    attachmentsExist: boolean;
+    errors: string[];
+    warnings: string[];
+    courseId?: string;
+    courseName?: string;
+}
+interface AggregatedDocument {
+    _id: string;
+    _attachments?: Record<string, any>;
+    docType: string;
+    [key: string]: any;
+}
+interface AttachmentUploadResult {
+    success: boolean;
+    attachmentName: string;
+    docId: string;
+    error?: string;
+}
+declare const DEFAULT_MIGRATION_OPTIONS: MigrationOptions;
+
+declare class StaticToCouchDBMigrator {
+    private options;
+    private progressCallback?;
+    private fs?;
+    constructor(options?: Partial<MigrationOptions>, fileSystemAdapter?: FileSystemAdapter);
+    /**
+     * Set a progress callback to receive updates during migration
+     */
+    setProgressCallback(callback: (progress: RestoreProgress) => void): void;
+    /**
+     * Migrate a static course to CouchDB
+     */
+    migrateCourse(staticPath: string, targetDB: PouchDB.Database): Promise<MigrationResult>;
+    /**
+     * Load and parse the manifest file
+     */
+    private loadManifest;
+    /**
+     * Restore design documents to CouchDB
+     */
+    private restoreDesignDocuments;
+    /**
+     * Aggregate documents from all chunks
+     */
+    private aggregateDocuments;
+    /**
+     * Load documents from a single chunk file
+     */
+    private loadChunk;
+    /**
+     * Upload documents to CouchDB in batches
+     */
+    private uploadDocuments;
+    /**
+     * Upload attachments from filesystem to CouchDB
+     */
+    private uploadAttachments;
+    /**
+     * Upload a single attachment file
+     */
+    private uploadSingleAttachment;
+    /**
+     * Restore CourseConfig document from manifest
+     */
+    private restoreCourseConfig;
+    /**
+     * Calculate expected document counts from manifest
+     */
+    private calculateExpectedCounts;
+    /**
+     * Clean up database after failed migration
+     */
+    private cleanupFailedMigration;
+    /**
+     * Report progress to callback if available
+     */
+    private reportProgress;
+    /**
+     * Check if a path is a local file path (vs URL)
+     */
+    private isLocalPath;
+}
+
+/**
+ * Validate that a static course directory contains all required files
+ */
+declare function validateStaticCourse(staticPath: string, fs?: FileSystemAdapter): Promise<StaticCourseValidation>;
+/**
+ * Validate the result of a migration by checking document counts and integrity
+ */
+declare function validateMigration(targetDB: PouchDB.Database, expectedCounts: DocumentCounts, manifest: StaticCourseManifest): Promise<ValidationResult>;
+
+/**
+ * Get the application data directory for the current platform
+ * Uses ~/.tuilder as requested by user for simplicity
+ */
+declare function getAppDataDirectory(): string;
+/**
+ * Ensure the application data directory exists
+ * Creates directory recursively if it doesn't exist
+ */
+declare function ensureAppDataDirectory(): Promise<string>;
+/**
+ * Get the full path for a PouchDB database file
+ * @param dbName - The database name (e.g., 'userdb-Colin')
+ */
+declare function getDbPath(dbName: string): string;
+/**
+ * Initialize data directory for PouchDB usage
+ * Should be called once at application startup
+ */
+declare function initializeDataDirectory(): Promise<void>;
+
+/**
+ * Initialize TUI logging - redirect console logs to file in Node.js
+ */
+declare function initializeTuiLogging(): void;
+/**
+ * Get the current log file path (for debugging)
+ */
+declare function getLogFilePath(): string | null;
+/**
+ * Show user-facing message (always visible in TUI)
+ */
+declare function showUserMessage(message: string): void;
+/**
+ * Show user-facing error (always visible in TUI)
+ */
+declare function showUserError(message: string): void;
+/**
+ * Logger object with standard log levels
+ */
+declare const logger: {
+    debug: (message: string, ...args: any[]) => void;
+    info: (message: string, ...args: any[]) => void;
+    warn: (message: string, ...args: any[]) => void;
+    error: (message: string, ...args: any[]) => void;
+};
+
 interface StudySessionRecord {
     card: {
         course_id: string;
@@ -95,6 +278,14 @@ declare class CourseLookup {
      * @returns
      */
     static add(courseName: string): Promise<string>;
+    /**
+     * 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 addWithId(courseId: string, courseName: string, disambiguator?: string): Promise<void>;
     /**
      * Removes a course from the index
      * @param courseID
@@ -139,4 +330,4 @@ declare function getDataLayer(): DataLayerProvider;
  */
 declare function _resetDataLayer(): Promise<void>;
 
-export { CardRecord, CourseLookup, type DataLayerConfig, DataLayerProvider, ENV, Loggable, SessionController, StaticCourseManifest, StudyContentSource, StudySessionItem, type StudySessionRecord, _resetDataLayer, getDataLayer, initializeDataLayer };
+export { type AggregatedDocument, type AttachmentUploadResult, CardRecord, CourseLookup, DEFAULT_MIGRATION_OPTIONS, type DataLayerConfig, DataLayerProvider, type DocumentCounts, ENV, FileSystemAdapter, Loggable, type MigrationOptions, type MigrationResult, type RestoreProgress, SessionController, StaticCourseManifest, type StaticCourseValidation, StaticToCouchDBMigrator, StudyContentSource, StudySessionItem, type StudySessionRecord, type ValidationIssue, type ValidationResult, _resetDataLayer, ensureAppDataDirectory, getAppDataDirectory, getDataLayer, getDbPath, getLogFilePath, initializeDataDirectory, initializeDataLayer, initializeTuiLogging, logger, showUserError, showUserMessage, validateMigration, validateStaticCourse };