@vue-skuilder/db 0.1.4 → 0.1.5

package/dist/types-B0GJsjOr.d.ts

@@ -0,0 +1,47 @@
+import { CourseConfig } from '@vue-skuilder/common';
+import { D as DocType } from './types-legacy-CTsJvvxI.js';
+
+interface StaticCourseManifest {
+    version: string;
+    courseId: string;
+    courseName: string;
+    courseConfig: CourseConfig | null;
+    lastUpdated: string;
+    documentCount: number;
+    chunks: ChunkMetadata[];
+    indices: IndexMetadata[];
+    designDocs: DesignDocument[];
+}
+interface ChunkMetadata {
+    id: string;
+    docType: DocType;
+    startKey: string;
+    endKey: string;
+    documentCount: number;
+    path: string;
+}
+interface IndexMetadata {
+    name: string;
+    type: 'btree' | 'hash' | 'spatial';
+    path: string;
+}
+interface DesignDocument {
+    _id: string;
+    views: {
+        [viewName: string]: {
+            map: string;
+            reduce?: string;
+        };
+    };
+}
+interface PackerConfig {
+    chunkSize: number;
+    includeAttachments: boolean;
+}
+interface PackedCourseData {
+    manifest: StaticCourseManifest;
+    chunks: Map<string, any[]>;
+    indices: Map<string, any>;
+}
+
+export type { ChunkMetadata as C, DesignDocument as D, IndexMetadata as I, PackerConfig as P, StaticCourseManifest as S, PackedCourseData as a };

package/dist/types-DIgj8pP7.d.mts

@@ -0,0 +1,47 @@
+import { CourseConfig } from '@vue-skuilder/common';
+import { D as DocType } from './types-legacy-CTsJvvxI.mjs';
+
+interface StaticCourseManifest {
+    version: string;
+    courseId: string;
+    courseName: string;
+    courseConfig: CourseConfig | null;
+    lastUpdated: string;
+    documentCount: number;
+    chunks: ChunkMetadata[];
+    indices: IndexMetadata[];
+    designDocs: DesignDocument[];
+}
+interface ChunkMetadata {
+    id: string;
+    docType: DocType;
+    startKey: string;
+    endKey: string;
+    documentCount: number;
+    path: string;
+}
+interface IndexMetadata {
+    name: string;
+    type: 'btree' | 'hash' | 'spatial';
+    path: string;
+}
+interface DesignDocument {
+    _id: string;
+    views: {
+        [viewName: string]: {
+            map: string;
+            reduce?: string;
+        };
+    };
+}
+interface PackerConfig {
+    chunkSize: number;
+    includeAttachments: boolean;
+}
+interface PackedCourseData {
+    manifest: StaticCourseManifest;
+    chunks: Map<string, any[]>;
+    indices: Map<string, any>;
+}
+
+export type { ChunkMetadata as C, DesignDocument as D, IndexMetadata as I, PackerConfig as P, StaticCourseManifest as S, PackedCourseData as a };

package/dist/types-legacy-CTsJvvxI.d.mts

@@ -0,0 +1,137 @@
+import { CourseElo, Evaluation, Answer } from '@vue-skuilder/common';
+import { Moment } from 'moment';
+
+declare const GuestUsername: string;
+declare const log: (message: string) => void;
+declare enum DocType {
+    DISPLAYABLE_DATA = "DISPLAYABLE_DATA",
+    CARD = "CARD",
+    DATASHAPE = "DATASHAPE",
+    QUESTIONTYPE = "QUESTION",
+    VIEW = "VIEW",
+    PEDAGOGY = "PEDAGOGY",
+    CARDRECORD = "CARDRECORD",
+    SCHEDULED_CARD = "SCHEDULED_CARD",
+    TAG = "TAG",
+    NAVIGATION_STRATEGY = "NAVIGATION_STRATEGY"
+}
+/**
+ * Interface for all data on course content and pedagogy stored
+ * in the c/pouch database.
+ */
+interface SkuilderCourseData {
+    course: string;
+    docType: DocType;
+}
+interface Tag extends SkuilderCourseData {
+    docType: DocType.TAG;
+    name: string;
+    snippet: string;
+    wiki: string;
+    taggedCards: PouchDB.Core.DocumentId[];
+}
+interface TagStub {
+    name: string;
+    snippet: string;
+    count: number;
+}
+interface CardData extends SkuilderCourseData {
+    docType: DocType.CARD;
+    id_displayable_data: PouchDB.Core.DocumentId[];
+    id_view: PouchDB.Core.DocumentId;
+    elo: CourseElo;
+}
+/** A list of populated courses in the DB */
+interface CourseListData extends PouchDB.Core.Response {
+    courses: string[];
+}
+/**
+ * The data used to hydrate viewable components (questions, info, etc)
+ */
+interface DisplayableData extends SkuilderCourseData {
+    docType: DocType.DISPLAYABLE_DATA;
+    author?: string;
+    id_datashape: PouchDB.Core.DocumentId;
+    data: Field[];
+    _attachments?: {
+        [index: string]: PouchDB.Core.FullAttachment;
+    };
+}
+interface Field {
+    data: unknown;
+    name: string;
+}
+interface DataShapeData extends SkuilderCourseData {
+    docType: DocType.DATASHAPE;
+    _id: PouchDB.Core.DocumentId;
+    questionTypes: PouchDB.Core.DocumentId[];
+}
+interface QuestionData extends SkuilderCourseData {
+    docType: DocType.QUESTIONTYPE;
+    _id: PouchDB.Core.DocumentId;
+    viewList: string[];
+    dataShapeList: PouchDB.Core.DocumentId[];
+}
+declare const cardHistoryPrefix = "cardH";
+interface CardHistory<T extends CardRecord> {
+    _id: PouchDB.Core.DocumentId;
+    /**
+     * The CouchDB id of the card
+     */
+    cardID: PouchDB.Core.DocumentId;
+    /**
+     * The ID of the course
+     */
+    courseID: string;
+    /**
+     * The to-date largest interval between successful
+     * card reviews. `0` indicates no successful reviews.
+     */
+    bestInterval: number;
+    /**
+     * The number of times that a card has been
+     * failed in review
+     */
+    lapses: number;
+    /**
+     * The number of consecutive successful impressions
+     * on this card
+     */
+    streak: number;
+    records: T[];
+}
+interface CardRecord {
+    /**
+     * The CouchDB id of the card
+     */
+    cardID: string;
+    /**
+     * The ID of the course
+     */
+    courseID: string;
+    /**
+     * Number of milliseconds that the user spent before dismissing
+     * the card (ie, "I've read this" or "here is my answer")
+     *
+     * //TODO: this (sometimes?) wants to be replaced with a rich
+     *         recording of user activity in working the question
+     */
+    timeSpent: number;
+    /**
+     * The date-time that the card was rendered. timeStamp + timeSpent will give the
+     * time of user submission.
+     */
+    timeStamp: Moment;
+}
+interface QuestionRecord extends CardRecord, Evaluation {
+    userAnswer: Answer;
+    /**
+     * The number of incorrect user submissions prededing this submisstion.
+     *
+     * eg, if a user is asked 7*6=__, submitting 46, 48, 42 will result in three
+     * records being created having 0, 1, and 2 as their recorded 'priorAttempts' values
+     */
+    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 };

package/dist/types-legacy-CTsJvvxI.d.ts

@@ -0,0 +1,137 @@
+import { CourseElo, Evaluation, Answer } from '@vue-skuilder/common';
+import { Moment } from 'moment';
+
+declare const GuestUsername: string;
+declare const log: (message: string) => void;
+declare enum DocType {
+    DISPLAYABLE_DATA = "DISPLAYABLE_DATA",
+    CARD = "CARD",
+    DATASHAPE = "DATASHAPE",
+    QUESTIONTYPE = "QUESTION",
+    VIEW = "VIEW",
+    PEDAGOGY = "PEDAGOGY",
+    CARDRECORD = "CARDRECORD",
+    SCHEDULED_CARD = "SCHEDULED_CARD",
+    TAG = "TAG",
+    NAVIGATION_STRATEGY = "NAVIGATION_STRATEGY"
+}
+/**
+ * Interface for all data on course content and pedagogy stored
+ * in the c/pouch database.
+ */
+interface SkuilderCourseData {
+    course: string;
+    docType: DocType;
+}
+interface Tag extends SkuilderCourseData {
+    docType: DocType.TAG;
+    name: string;
+    snippet: string;
+    wiki: string;
+    taggedCards: PouchDB.Core.DocumentId[];
+}
+interface TagStub {
+    name: string;
+    snippet: string;
+    count: number;
+}
+interface CardData extends SkuilderCourseData {
+    docType: DocType.CARD;
+    id_displayable_data: PouchDB.Core.DocumentId[];
+    id_view: PouchDB.Core.DocumentId;
+    elo: CourseElo;
+}
+/** A list of populated courses in the DB */
+interface CourseListData extends PouchDB.Core.Response {
+    courses: string[];
+}
+/**
+ * The data used to hydrate viewable components (questions, info, etc)
+ */
+interface DisplayableData extends SkuilderCourseData {
+    docType: DocType.DISPLAYABLE_DATA;
+    author?: string;
+    id_datashape: PouchDB.Core.DocumentId;
+    data: Field[];
+    _attachments?: {
+        [index: string]: PouchDB.Core.FullAttachment;
+    };
+}
+interface Field {
+    data: unknown;
+    name: string;
+}
+interface DataShapeData extends SkuilderCourseData {
+    docType: DocType.DATASHAPE;
+    _id: PouchDB.Core.DocumentId;
+    questionTypes: PouchDB.Core.DocumentId[];
+}
+interface QuestionData extends SkuilderCourseData {
+    docType: DocType.QUESTIONTYPE;
+    _id: PouchDB.Core.DocumentId;
+    viewList: string[];
+    dataShapeList: PouchDB.Core.DocumentId[];
+}
+declare const cardHistoryPrefix = "cardH";
+interface CardHistory<T extends CardRecord> {
+    _id: PouchDB.Core.DocumentId;
+    /**
+     * The CouchDB id of the card
+     */
+    cardID: PouchDB.Core.DocumentId;
+    /**
+     * The ID of the course
+     */
+    courseID: string;
+    /**
+     * The to-date largest interval between successful
+     * card reviews. `0` indicates no successful reviews.
+     */
+    bestInterval: number;
+    /**
+     * The number of times that a card has been
+     * failed in review
+     */
+    lapses: number;
+    /**
+     * The number of consecutive successful impressions
+     * on this card
+     */
+    streak: number;
+    records: T[];
+}
+interface CardRecord {
+    /**
+     * The CouchDB id of the card
+     */
+    cardID: string;
+    /**
+     * The ID of the course
+     */
+    courseID: string;
+    /**
+     * Number of milliseconds that the user spent before dismissing
+     * the card (ie, "I've read this" or "here is my answer")
+     *
+     * //TODO: this (sometimes?) wants to be replaced with a rich
+     *         recording of user activity in working the question
+     */
+    timeSpent: number;
+    /**
+     * The date-time that the card was rendered. timeStamp + timeSpent will give the
+     * time of user submission.
+     */
+    timeStamp: Moment;
+}
+interface QuestionRecord extends CardRecord, Evaluation {
+    userAnswer: Answer;
+    /**
+     * The number of incorrect user submissions prededing this submisstion.
+     *
+     * eg, if a user is asked 7*6=__, submitting 46, 48, 42 will result in three
+     * records being created having 0, 1, and 2 as their recorded 'priorAttempts' values
+     */
+    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 };

package/dist/{index-QMtzQI65.d.mts → userDB-C5dcuRZs.d.ts}

@@ -1,5 +1,6 @@
-import { CourseConfig, ClassroomConfig, CourseElo, Evaluation, Answer, Status, SkuilderCourseData as SkuilderCourseData$1, DataShape, ParsedCard } from '@vue-skuilder/common';
+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-CTsJvvxI.js';
 
 /**
  * Admin functionality
@@ -181,139 +182,6 @@ interface ContentBase {
     courseID: string;
 }
 
-declare const GuestUsername: string;
-declare const log: (message: string) => void;
-declare enum DocType {
-    DISPLAYABLE_DATA = "DISPLAYABLE_DATA",
-    CARD = "CARD",
-    DATASHAPE = "DATASHAPE",
-    QUESTIONTYPE = "QUESTION",
-    VIEW = "VIEW",
-    PEDAGOGY = "PEDAGOGY",
-    CARDRECORD = "CARDRECORD",
-    SCHEDULED_CARD = "SCHEDULED_CARD",
-    TAG = "TAG",
-    NAVIGATION_STRATEGY = "NAVIGATION_STRATEGY"
-}
-/**
- * Interface for all data on course content and pedagogy stored
- * in the c/pouch database.
- */
-interface SkuilderCourseData {
-    course: string;
-    docType: DocType;
-}
-interface Tag extends SkuilderCourseData {
-    docType: DocType.TAG;
-    name: string;
-    snippet: string;
-    wiki: string;
-    taggedCards: PouchDB.Core.DocumentId[];
-}
-interface TagStub {
-    name: string;
-    snippet: string;
-    count: number;
-}
-interface CardData extends SkuilderCourseData {
-    docType: DocType.CARD;
-    id_displayable_data: PouchDB.Core.DocumentId[];
-    id_view: PouchDB.Core.DocumentId;
-    elo: CourseElo;
-}
-/** A list of populated courses in the DB */
-interface CourseListData extends PouchDB.Core.Response {
-    courses: string[];
-}
-/**
- * The data used to hydrate viewable components (questions, info, etc)
- */
-interface DisplayableData extends SkuilderCourseData {
-    docType: DocType.DISPLAYABLE_DATA;
-    author?: string;
-    id_datashape: PouchDB.Core.DocumentId;
-    data: Field[];
-    _attachments?: {
-        [index: string]: PouchDB.Core.FullAttachment;
-    };
-}
-interface Field {
-    data: unknown;
-    name: string;
-}
-interface DataShapeData extends SkuilderCourseData {
-    docType: DocType.DATASHAPE;
-    _id: PouchDB.Core.DocumentId;
-    questionTypes: PouchDB.Core.DocumentId[];
-}
-interface QuestionData extends SkuilderCourseData {
-    docType: DocType.QUESTIONTYPE;
-    _id: PouchDB.Core.DocumentId;
-    viewList: string[];
-    dataShapeList: PouchDB.Core.DocumentId[];
-}
-declare const cardHistoryPrefix = "cardH";
-interface CardHistory<T extends CardRecord> {
-    _id: PouchDB.Core.DocumentId;
-    /**
-     * The CouchDB id of the card
-     */
-    cardID: PouchDB.Core.DocumentId;
-    /**
-     * The ID of the course
-     */
-    courseID: string;
-    /**
-     * The to-date largest interval between successful
-     * card reviews. `0` indicates no successful reviews.
-     */
-    bestInterval: number;
-    /**
-     * The number of times that a card has been
-     * failed in review
-     */
-    lapses: number;
-    /**
-     * The number of consecutive successful impressions
-     * on this card
-     */
-    streak: number;
-    records: T[];
-}
-interface CardRecord {
-    /**
-     * The CouchDB id of the card
-     */
-    cardID: string;
-    /**
-     * The ID of the course
-     */
-    courseID: string;
-    /**
-     * Number of milliseconds that the user spent before dismissing
-     * the card (ie, "I've read this" or "here is my answer")
-     *
-     * //TODO: this (sometimes?) wants to be replaced with a rich
-     *         recording of user activity in working the question
-     */
-    timeSpent: number;
-    /**
-     * The date-time that the card was rendered. timeStamp + timeSpent will give the
-     * time of user submission.
-     */
-    timeStamp: Moment;
-}
-interface QuestionRecord extends CardRecord, Evaluation {
-    userAnswer: Answer;
-    /**
-     * The number of incorrect user submissions prededing this submisstion.
-     *
-     * eg, if a user is asked 7*6=__, submitting 46, 48, 42 will result in three
-     * records being created having 0, 1, and 2 as their recorded 'priorAttempts' values
-     */
-    priorAttemps: number;
-}
-
 interface DataLayerResult {
     status: Status;
     message: string;
@@ -471,12 +339,6 @@ interface CourseDBInterface extends NavigationStrategyManager {
     }[]>;
 }
 
-declare abstract class Loggable {
-    protected abstract readonly _className: string;
-    protected log(...args: unknown[]): void;
-    protected error(...args: unknown[]): void;
-}
-
 type Update<T> = Partial<T> | ((x: T) => T);
 
 interface DocumentUpdater {
@@ -621,114 +483,4 @@ interface ClassroomRegistrationDoc {
     registrations: ClassroomRegistration[];
 }
 
-/**
- * Main factory interface for data access
- */
-interface DataLayerProvider {
-    /**
-     * Get the user database interface
-     */
-    getUserDB(): UserDBInterface;
-    /**
-     * Get a course database interface
-     */
-    getCourseDB(courseId: string): CourseDBInterface;
-    /**
-     * Get the courses-lookup interface
-     */
-    getCoursesDB(): CoursesDBInterface;
-    /**
-     * Get a classroom database interface
-     */
-    getClassroomDB(classId: string, type: 'student' | 'teacher'): Promise<ClassroomDBInterface>;
-    /**
-     * Get the admin database interface
-     */
-    getAdminDB(): AdminDBInterface;
-    /**
-     * Initialize the data layer
-     */
-    initialize(): Promise<void>;
-    /**
-     * Teardown the data layer
-     */
-    teardown(): Promise<void>;
-}
-
-declare function areQuestionRecords(h: CardHistory<CardRecord>): h is CardHistory<QuestionRecord>;
-declare function isQuestionRecord(c: CardRecord): c is QuestionRecord;
-declare function getCardHistoryID(courseID: string, cardID: string): PouchDB.Core.DocumentId;
-declare function parseCardHistoryID(id: string): {
-    courseID: string;
-    cardID: string;
-};
-interface PouchDBError extends Error {
-    error?: string;
-    reason?: string;
-}
-declare function docIsDeleted(e: PouchDBError): boolean;
-
-declare enum Navigators {
-    ELO = "elo"
-}
-/**
- * A content-navigator provides runtime steering of study sessions.
- */
-declare abstract class ContentNavigator implements StudyContentSource {
-    /**
-     *
-     * @param user
-     * @param strategyData
-     * @returns the runtime object used to steer a study session.
-     */
-    static create(user: UserDBInterface, course: CourseDBInterface, strategyData: ContentNavigationStrategyData): Promise<ContentNavigator>;
-    abstract getPendingReviews(): Promise<(StudySessionReviewItem & ScheduledCard)[]>;
-    abstract getNewCards(n?: number): Promise<StudySessionNewItem[]>;
-}
-
-/**
- * Interface representing the result of a bulk import operation for a single card
- */
-interface ImportResult {
-    /** The original text input for the card */
-    originalText: string;
-    /** Status of the import operation */
-    status: 'success' | 'error';
-    /** Message describing the result or error */
-    message: string;
-    /** ID of the newly created card (only for success) */
-    cardId?: string;
-}
-/**
- * Configuration for the bulk card processor
- */
-interface BulkCardProcessorConfig {
-    /** The data shape to use for the cards */
-    dataShape: DataShape;
-    /** The course code used for adding notes */
-    courseCode: string;
-    /** The username of the current user */
-    userName: string;
-}
-
-/**
- * Processes multiple cards from bulk text input
- *
- * @param parsedCards - Array of parsed cards to import
- * @param courseDB - Course database interface
- * @param config - Configuration for the card processor
- * @returns Array of import results
- */
-declare function importParsedCards(parsedCards: ParsedCard[], courseDB: CourseDBInterface, config: BulkCardProcessorConfig): Promise<ImportResult[]>;
-/**
- * Validates the configuration for bulk card processing
- *
- * @param config - Configuration to validate
- * @returns Object with validation result and error message if any
- */
-declare function validateProcessorConfig(config: Partial<BulkCardProcessorConfig>): {
-    isValid: boolean;
-    errorMessage?: string;
-};
-
-export { getCardHistoryID as $, type AdminDBInterface as A, type SkuilderCourseData as B, type CardRecord as C, type DataLayerProvider as D, type Tag as E, type TagStub as F, GuestUsername as G, type CardData as H, type CourseListData as I, type DisplayableData as J, type Field as K, Loggable as L, type DataShapeData as M, cardHistoryPrefix as N, type CardHistory as O, type QuestionRecord as P, type QuestionData as Q, type UserConfig as R, type StudySessionItem as S, type TeacherClassroomDBInterface as T, type UserDBInterface as U, type ActivityRecord as V, type CourseRegistration as W, type CourseRegistrationDoc as X, type ScheduledCard as Y, areQuestionRecords as Z, isQuestionRecord as _, type StudyContentSource as a, parseCardHistoryID as a0, docIsDeleted as a1, Navigators as a2, ContentNavigator as a3, importParsedCards as a4, validateProcessorConfig as a5, type ImportResult as a6, type BulkCardProcessorConfig as a7, type DocumentUpdater as a8, newInterval as a9, type ClassroomDBInterface as b, type StudentClassroomDBInterface as c, type AssignedContent as d, type AssignedTag as e, type AssignedCourse as f, type AssignedCard as g, type StudySessionFailedItem as h, type StudySessionFailedNewItem as i, type StudySessionFailedReviewItem as j, type StudySessionNewItem as k, type StudySessionReviewItem as l, isReview as m, type ContentSourceID as n, getStudySource as o, type CoursesDBInterface as p, type CourseInfo as q, type CourseDBInterface as r, type UserCourseSettings as s, type UserCourseSetting as t, type UsrCrsDataInterface as u, type ClassroomRegistrationDesignation as v, type ClassroomRegistration as w, type ClassroomRegistrationDoc as x, log as y, DocType as z };
+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 };