@vue-skuilder/db 0.1.7 → 0.1.8-0

package/dist/index-CLL31bEy.d.ts

@@ -0,0 +1,137 @@
+import { P as PackerConfig, a as PackedCourseData, S as StaticCourseManifest } from './types-BefDGkKa.js';
+
+/**
+ * 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.
+ */
+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>;
+    /**
+     * Write text data to a file
+     */
+    writeFile(filePath: string, data: string | Buffer): Promise<void>;
+    /**
+     * Write JSON data to a file with formatting
+     */
+    writeJson(filePath: string, data: any, options?: {
+        spaces?: number;
+    }): Promise<void>;
+    /**
+     * Ensure a directory exists, creating it and parent directories if needed
+     */
+    ensureDir(dirPath: string): Promise<void>;
+    /**
+     * Join path segments into a complete path
+     */
+    joinPath(...segments: string[]): string;
+    /**
+     * Get the directory name of a path
+     */
+    dirname(filePath: string): string;
+    /**
+     * Check if a path is absolute
+     */
+    isAbsolute(filePath: string): boolean;
+}
+interface FileStats {
+    isDirectory(): boolean;
+    isFile(): boolean;
+    size: number;
+}
+/**
+ * Error thrown when file system operations fail
+ */
+declare class FileSystemError extends Error {
+    readonly operation: string;
+    readonly filePath: string;
+    readonly cause?: Error | undefined;
+    constructor(message: string, operation: string, filePath: string, cause?: Error | undefined);
+}
+
+declare class CouchDBToStaticPacker {
+    private config;
+    private sourceDB;
+    constructor(config?: Partial<PackerConfig>);
+    /**
+     * Pack a CouchDB course database into static data structures
+     */
+    packCourse(sourceDB: PouchDB.Database, courseId: string): Promise<PackedCourseData>;
+    /**
+     * Pack a CouchDB course database and write the static files to disk
+     */
+    packCourseToFiles(sourceDB: PouchDB.Database, courseId: string, outputDir: string, fsAdapter: FileSystemAdapter): Promise<{
+        manifest: StaticCourseManifest;
+        filesWritten: number;
+        attachmentsFound: number;
+    }>;
+    /**
+     * Write packed course data to files using FileSystemAdapter
+     */
+    private writePackedDataToFiles;
+    private extractCourseConfig;
+    private extractDesignDocs;
+    private extractDocumentsByType;
+    private createChunks;
+    private prepareChunkData;
+    private buildIndices;
+    private buildEloIndex;
+    private buildTagIndex;
+    /**
+     * Build view index by querying CouchDB views directly instead of parsing map functions
+     */
+    private buildViewIndex;
+    /**
+     * Format CouchDB view results for static consumption
+     */
+    private formatViewResults;
+    /**
+     * Format ELO view results - convert to sorted array format
+     */
+    private formatEloViewIndex;
+    /**
+     * Format tags view results - convert to tag mapping format
+     */
+    private formatTagsViewIndex;
+    /**
+     * Format inexperience view results - convert to experience-based format
+     */
+    private formatInexperienceViewIndex;
+    /**
+     * Format generic view results - fallback for unknown views
+     */
+    private formatGenericViewIndex;
+    /**
+     * Extract all attachments from documents and download binary data
+     */
+    private extractAllAttachments;
+    /**
+     * Extract attachments for a single document
+     */
+    private extractDocumentAttachments;
+    /**
+     * Transform attachment stubs to include file paths
+     */
+    private transformAttachmentStubs;
+    /**
+     * Get file extension from content type
+     */
+    private getFileExtension;
+}
+
+export { CouchDBToStaticPacker as C, type FileSystemAdapter as F, type FileStats as a, FileSystemError as b };

package/dist/index-CUNnL38E.d.mts

@@ -0,0 +1,137 @@
+import { P as PackerConfig, a as PackedCourseData, S as StaticCourseManifest } from './types-DC-ckZug.mjs';
+
+/**
+ * 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.
+ */
+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>;
+    /**
+     * Write text data to a file
+     */
+    writeFile(filePath: string, data: string | Buffer): Promise<void>;
+    /**
+     * Write JSON data to a file with formatting
+     */
+    writeJson(filePath: string, data: any, options?: {
+        spaces?: number;
+    }): Promise<void>;
+    /**
+     * Ensure a directory exists, creating it and parent directories if needed
+     */
+    ensureDir(dirPath: string): Promise<void>;
+    /**
+     * Join path segments into a complete path
+     */
+    joinPath(...segments: string[]): string;
+    /**
+     * Get the directory name of a path
+     */
+    dirname(filePath: string): string;
+    /**
+     * Check if a path is absolute
+     */
+    isAbsolute(filePath: string): boolean;
+}
+interface FileStats {
+    isDirectory(): boolean;
+    isFile(): boolean;
+    size: number;
+}
+/**
+ * Error thrown when file system operations fail
+ */
+declare class FileSystemError extends Error {
+    readonly operation: string;
+    readonly filePath: string;
+    readonly cause?: Error | undefined;
+    constructor(message: string, operation: string, filePath: string, cause?: Error | undefined);
+}
+
+declare class CouchDBToStaticPacker {
+    private config;
+    private sourceDB;
+    constructor(config?: Partial<PackerConfig>);
+    /**
+     * Pack a CouchDB course database into static data structures
+     */
+    packCourse(sourceDB: PouchDB.Database, courseId: string): Promise<PackedCourseData>;
+    /**
+     * Pack a CouchDB course database and write the static files to disk
+     */
+    packCourseToFiles(sourceDB: PouchDB.Database, courseId: string, outputDir: string, fsAdapter: FileSystemAdapter): Promise<{
+        manifest: StaticCourseManifest;
+        filesWritten: number;
+        attachmentsFound: number;
+    }>;
+    /**
+     * Write packed course data to files using FileSystemAdapter
+     */
+    private writePackedDataToFiles;
+    private extractCourseConfig;
+    private extractDesignDocs;
+    private extractDocumentsByType;
+    private createChunks;
+    private prepareChunkData;
+    private buildIndices;
+    private buildEloIndex;
+    private buildTagIndex;
+    /**
+     * Build view index by querying CouchDB views directly instead of parsing map functions
+     */
+    private buildViewIndex;
+    /**
+     * Format CouchDB view results for static consumption
+     */
+    private formatViewResults;
+    /**
+     * Format ELO view results - convert to sorted array format
+     */
+    private formatEloViewIndex;
+    /**
+     * Format tags view results - convert to tag mapping format
+     */
+    private formatTagsViewIndex;
+    /**
+     * Format inexperience view results - convert to experience-based format
+     */
+    private formatInexperienceViewIndex;
+    /**
+     * Format generic view results - fallback for unknown views
+     */
+    private formatGenericViewIndex;
+    /**
+     * Extract all attachments from documents and download binary data
+     */
+    private extractAllAttachments;
+    /**
+     * Extract attachments for a single document
+     */
+    private extractDocumentAttachments;
+    /**
+     * Transform attachment stubs to include file paths
+     */
+    private transformAttachmentStubs;
+    /**
+     * Get file extension from content type
+     */
+    private getFileExtension;
+}
+
+export { CouchDBToStaticPacker as C, type FileSystemAdapter as F, type FileStats as a, FileSystemError as b };

package/dist/index.d.mts

@@ -1,13 +1,14 @@
-import { j as StudySessionItem, h as StudyContentSource } from './userDB-7fM4tpgr.mjs';
-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-7fM4tpgr.mjs';
-import { D as DataLayerProvider } from './dataLayerProvider-BbW9EnZK.mjs';
-import { C as CardRecord } from './types-legacy-CtrmkOLu.mjs';
-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, a as Tag, T as TagStub, f as cardHistoryPrefix, l as log } from './types-legacy-CtrmkOLu.mjs';
+import { j as StudySessionItem, h as StudyContentSource } from './userDB-C33Hzjgn.mjs';
+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-C33Hzjgn.mjs';
+import { D as DataLayerProvider } from './dataLayerProvider-BInqI_RF.mjs';
+import { C as CardRecord } from './types-legacy-Birv-Jx6.mjs';
+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.mjs';
 import { Loggable } from './core/index.mjs';
 export { BulkCardProcessorConfig, ContentNavigator, ImportResult, Navigators, areQuestionRecords, docIsDeleted, getCardHistoryID, importParsedCards, isQuestionRecord, parseCardHistoryID, validateProcessorConfig } from './core/index.mjs';
-import { S as StaticCourseManifest } from './types-CQQ80R5N.mjs';
-export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, a as PackedCourseData, P as PackerConfig } from './types-CQQ80R5N.mjs';
-export { CouchDBToStaticPacker } from './util/packer/index.mjs';
+import { S as StaticCourseManifest } from './types-DC-ckZug.mjs';
+export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, a as PackedCourseData, P as PackerConfig } from './types-DC-ckZug.mjs';
+import { F as FileSystemAdapter } from './index-CUNnL38E.mjs';
+export { C as CouchDBToStaticPacker, a as FileStats, b as FileSystemError } from './index-CUNnL38E.mjs';
 import '@vue-skuilder/common';
 import 'moment';
 
@@ -74,52 +75,6 @@ interface AttachmentUploadResult {
 }
 declare const DEFAULT_MIGRATION_OPTIONS: MigrationOptions;
 
-/**
- * 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.
- */
-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;
-}
-interface FileStats {
-    isDirectory(): boolean;
-    isFile(): boolean;
-    size: number;
-}
-/**
- * Error thrown when file system operations fail
- */
-declare class FileSystemError extends Error {
-    readonly operation: string;
-    readonly filePath: string;
-    readonly cause?: Error | undefined;
-    constructor(message: string, operation: string, filePath: string, cause?: Error | undefined);
-}
-
 declare class StaticToCouchDBMigrator {
     private options;
     private progressCallback?;
@@ -375,4 +330,4 @@ declare function getDataLayer(): DataLayerProvider;
  */
 declare function _resetDataLayer(): Promise<void>;
 
-export { type AggregatedDocument, type AttachmentUploadResult, CardRecord, CourseLookup, DEFAULT_MIGRATION_OPTIONS, type DataLayerConfig, DataLayerProvider, type DocumentCounts, ENV, type FileStats, type FileSystemAdapter, FileSystemError, 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 };
+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 };

package/dist/index.d.ts

@@ -1,13 +1,14 @@
-import { j as StudySessionItem, h as StudyContentSource } from './userDB-DUY63VMN.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-DUY63VMN.js';
-import { D as DataLayerProvider } from './dataLayerProvider-6stCgDME.js';
-import { C as CardRecord } from './types-legacy-CtrmkOLu.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, a as Tag, T as TagStub, f as cardHistoryPrefix, l as log } from './types-legacy-CtrmkOLu.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-BvzcRAys.js';
-export { A as AttachmentData, C as ChunkMetadata, D as DesignDocument, I as IndexMetadata, a as PackedCourseData, P as PackerConfig } from './types-BvzcRAys.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';
 
@@ -74,52 +75,6 @@ interface AttachmentUploadResult {
 }
 declare const DEFAULT_MIGRATION_OPTIONS: MigrationOptions;
 
-/**
- * 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.
- */
-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;
-}
-interface FileStats {
-    isDirectory(): boolean;
-    isFile(): boolean;
-    size: number;
-}
-/**
- * Error thrown when file system operations fail
- */
-declare class FileSystemError extends Error {
-    readonly operation: string;
-    readonly filePath: string;
-    readonly cause?: Error | undefined;
-    constructor(message: string, operation: string, filePath: string, cause?: Error | undefined);
-}
-
 declare class StaticToCouchDBMigrator {
     private options;
     private progressCallback?;
@@ -375,4 +330,4 @@ declare function getDataLayer(): DataLayerProvider;
  */
 declare function _resetDataLayer(): Promise<void>;
 
-export { type AggregatedDocument, type AttachmentUploadResult, CardRecord, CourseLookup, DEFAULT_MIGRATION_OPTIONS, type DataLayerConfig, DataLayerProvider, type DocumentCounts, ENV, type FileStats, type FileSystemAdapter, FileSystemError, 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 };
+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 };