@vue-skuilder/db 0.1.1

package/dist/index.d.mts

@@ -0,0 +1,133 @@
+import { S as StudySessionItem, C as CardRecord, L as Loggable, a as StudyContentSource, D as DataLayerProvider } from './index-QMtzQI65.mjs';
+export { V as ActivityRecord, A as AdminDBInterface, g as AssignedCard, d as AssignedContent, f as AssignedCourse, e as AssignedTag, a7 as BulkCardProcessorConfig, H as CardData, O as CardHistory, b as ClassroomDBInterface, w as ClassroomRegistration, v as ClassroomRegistrationDesignation, x as ClassroomRegistrationDoc, a3 as ContentNavigator, n as ContentSourceID, r as CourseDBInterface, q as CourseInfo, I as CourseListData, W as CourseRegistration, X as CourseRegistrationDoc, p as CoursesDBInterface, M as DataShapeData, J as DisplayableData, z as DocType, a8 as DocumentUpdater, K as Field, G as GuestUsername, a6 as ImportResult, a2 as Navigators, Q as QuestionData, P as QuestionRecord, Y as ScheduledCard, B as SkuilderCourseData, c as StudentClassroomDBInterface, h as StudySessionFailedItem, i as StudySessionFailedNewItem, j as StudySessionFailedReviewItem, k as StudySessionNewItem, l as StudySessionReviewItem, E as Tag, F as TagStub, T as TeacherClassroomDBInterface, R as UserConfig, t as UserCourseSetting, s as UserCourseSettings, U as UserDBInterface, u as UsrCrsDataInterface, Z as areQuestionRecords, N as cardHistoryPrefix, a1 as docIsDeleted, $ as getCardHistoryID, o as getStudySource, a4 as importParsedCards, _ as isQuestionRecord, m as isReview, y as log, a9 as newInterval, a0 as parseCardHistoryID, a5 as validateProcessorConfig } from './index-QMtzQI65.mjs';
+import '@vue-skuilder/common';
+import 'moment';
+
+interface StudySessionRecord {
+    card: {
+        course_id: string;
+        card_id: string;
+        card_elo: number;
+    };
+    item: StudySessionItem;
+    records: CardRecord[];
+}
+declare class SessionController extends Loggable {
+    _className: string;
+    private sources;
+    private _sessionRecord;
+    set sessionRecord(r: StudySessionRecord[]);
+    private reviewQ;
+    private newQ;
+    private failedQ;
+    private _currentCard;
+    /**
+     * Indicates whether the session has been initialized - eg, the
+     * queues have been populated.
+     */
+    private _isInitialized;
+    private startTime;
+    private endTime;
+    private _secondsRemaining;
+    get secondsRemaining(): number;
+    get report(): string;
+    get detailedReport(): string;
+    private _intervalHandle;
+    /**
+     *
+     */
+    constructor(sources: StudyContentSource[], time: number);
+    private tick;
+    /**
+     * Returns a rough, erring toward conservative, guess at
+     * the amount of time the failed cards queue will require
+     * to clean up.
+     *
+     * (seconds)
+     */
+    private estimateCleanupTime;
+    /**
+     * Extremely rough, conservative, estimate of amound of time to complete
+     * all scheduled reviews
+     */
+    private estimateReviewTime;
+    prepareSession(): Promise<void>;
+    addTime(seconds: number): void;
+    get failedCount(): number;
+    toString(): string;
+    reportString(): string;
+    private getScheduledReviews;
+    private getNewCards;
+    private nextNewCard;
+    nextCard(action?: 'dismiss-success' | 'dismiss-failed' | 'marked-failed' | 'dismiss-error'): StudySessionItem | null;
+    private dismissCurrentCard;
+}
+
+interface CourseLookupDoc {
+    _id: string;
+    _rev: string;
+    name: string;
+    disambiguator?: string;
+}
+/**
+ * A Lookup table of existant courses. Each docID in this DB correspondes to a
+ * course database whose name is `coursedb-{docID}`
+ */
+declare class CourseLookup {
+    private static _dbInstance;
+    /**
+     * Static getter for the PouchDB database instance.
+     * Connects using ENV variables and caches the instance.
+     * Throws an error if required ENV variables are not set.
+     */
+    private static get _db();
+    /**
+     * Adds a new course to the lookup database, and returns the courseID
+     * @param courseName
+     * @returns
+     */
+    static add(courseName: string): Promise<string>;
+    /**
+     * Removes a course from the index
+     * @param courseID
+     */
+    static delete(courseID: string): Promise<PouchDB.Core.Response>;
+    static allCourses(): Promise<CourseLookupDoc[]>;
+    static updateDisambiguator(courseID: string, disambiguator?: string): Promise<PouchDB.Core.Response>;
+    static isCourse(courseID: string): Promise<boolean>;
+}
+
+interface DBEnv {
+    COUCHDB_SERVER_URL: string;
+    COUCHDB_SERVER_PROTOCOL: string;
+    COUCHDB_USERNAME?: string;
+    COUCHDB_PASSWORD?: string;
+}
+declare const ENV: DBEnv;
+interface DataLayerConfig {
+    type: 'pouch' | 'static';
+    options: {
+        staticContentPath?: string;
+        localStoragePrefix?: string;
+        COUCHDB_SERVER_URL?: string;
+        COUCHDB_SERVER_PROTOCOL?: string;
+        COUCHDB_USERNAME?: string;
+        COUCHDB_PASSWORD?: string;
+        COURSE_IDS?: string[];
+    };
+}
+/**
+ * Initialize the data layer with the specified configuration
+ */
+declare function initializeDataLayer(config: DataLayerConfig): Promise<DataLayerProvider>;
+/**
+ * Get the initialized data layer instance
+ * @throws Error if not initialized
+ */
+declare function getDataLayer(): DataLayerProvider;
+/**
+ * Reset the data layer (primarily for testing)
+ */
+declare function _resetDataLayer(): Promise<void>;
+
+export { CardRecord, CourseLookup, type DataLayerConfig, DataLayerProvider, ENV, Loggable, SessionController, StudyContentSource, StudySessionItem, type StudySessionRecord, _resetDataLayer, getDataLayer, initializeDataLayer };

package/dist/index.d.ts

@@ -0,0 +1,133 @@
+import { S as StudySessionItem, C as CardRecord, L as Loggable, a as StudyContentSource, D as DataLayerProvider } from './index-QMtzQI65.js';
+export { V as ActivityRecord, A as AdminDBInterface, g as AssignedCard, d as AssignedContent, f as AssignedCourse, e as AssignedTag, a7 as BulkCardProcessorConfig, H as CardData, O as CardHistory, b as ClassroomDBInterface, w as ClassroomRegistration, v as ClassroomRegistrationDesignation, x as ClassroomRegistrationDoc, a3 as ContentNavigator, n as ContentSourceID, r as CourseDBInterface, q as CourseInfo, I as CourseListData, W as CourseRegistration, X as CourseRegistrationDoc, p as CoursesDBInterface, M as DataShapeData, J as DisplayableData, z as DocType, a8 as DocumentUpdater, K as Field, G as GuestUsername, a6 as ImportResult, a2 as Navigators, Q as QuestionData, P as QuestionRecord, Y as ScheduledCard, B as SkuilderCourseData, c as StudentClassroomDBInterface, h as StudySessionFailedItem, i as StudySessionFailedNewItem, j as StudySessionFailedReviewItem, k as StudySessionNewItem, l as StudySessionReviewItem, E as Tag, F as TagStub, T as TeacherClassroomDBInterface, R as UserConfig, t as UserCourseSetting, s as UserCourseSettings, U as UserDBInterface, u as UsrCrsDataInterface, Z as areQuestionRecords, N as cardHistoryPrefix, a1 as docIsDeleted, $ as getCardHistoryID, o as getStudySource, a4 as importParsedCards, _ as isQuestionRecord, m as isReview, y as log, a9 as newInterval, a0 as parseCardHistoryID, a5 as validateProcessorConfig } from './index-QMtzQI65.js';
+import '@vue-skuilder/common';
+import 'moment';
+
+interface StudySessionRecord {
+    card: {
+        course_id: string;
+        card_id: string;
+        card_elo: number;
+    };
+    item: StudySessionItem;
+    records: CardRecord[];
+}
+declare class SessionController extends Loggable {
+    _className: string;
+    private sources;
+    private _sessionRecord;
+    set sessionRecord(r: StudySessionRecord[]);
+    private reviewQ;
+    private newQ;
+    private failedQ;
+    private _currentCard;
+    /**
+     * Indicates whether the session has been initialized - eg, the
+     * queues have been populated.
+     */
+    private _isInitialized;
+    private startTime;
+    private endTime;
+    private _secondsRemaining;
+    get secondsRemaining(): number;
+    get report(): string;
+    get detailedReport(): string;
+    private _intervalHandle;
+    /**
+     *
+     */
+    constructor(sources: StudyContentSource[], time: number);
+    private tick;
+    /**
+     * Returns a rough, erring toward conservative, guess at
+     * the amount of time the failed cards queue will require
+     * to clean up.
+     *
+     * (seconds)
+     */
+    private estimateCleanupTime;
+    /**
+     * Extremely rough, conservative, estimate of amound of time to complete
+     * all scheduled reviews
+     */
+    private estimateReviewTime;
+    prepareSession(): Promise<void>;
+    addTime(seconds: number): void;
+    get failedCount(): number;
+    toString(): string;
+    reportString(): string;
+    private getScheduledReviews;
+    private getNewCards;
+    private nextNewCard;
+    nextCard(action?: 'dismiss-success' | 'dismiss-failed' | 'marked-failed' | 'dismiss-error'): StudySessionItem | null;
+    private dismissCurrentCard;
+}
+
+interface CourseLookupDoc {
+    _id: string;
+    _rev: string;
+    name: string;
+    disambiguator?: string;
+}
+/**
+ * A Lookup table of existant courses. Each docID in this DB correspondes to a
+ * course database whose name is `coursedb-{docID}`
+ */
+declare class CourseLookup {
+    private static _dbInstance;
+    /**
+     * Static getter for the PouchDB database instance.
+     * Connects using ENV variables and caches the instance.
+     * Throws an error if required ENV variables are not set.
+     */
+    private static get _db();
+    /**
+     * Adds a new course to the lookup database, and returns the courseID
+     * @param courseName
+     * @returns
+     */
+    static add(courseName: string): Promise<string>;
+    /**
+     * Removes a course from the index
+     * @param courseID
+     */
+    static delete(courseID: string): Promise<PouchDB.Core.Response>;
+    static allCourses(): Promise<CourseLookupDoc[]>;
+    static updateDisambiguator(courseID: string, disambiguator?: string): Promise<PouchDB.Core.Response>;
+    static isCourse(courseID: string): Promise<boolean>;
+}
+
+interface DBEnv {
+    COUCHDB_SERVER_URL: string;
+    COUCHDB_SERVER_PROTOCOL: string;
+    COUCHDB_USERNAME?: string;
+    COUCHDB_PASSWORD?: string;
+}
+declare const ENV: DBEnv;
+interface DataLayerConfig {
+    type: 'pouch' | 'static';
+    options: {
+        staticContentPath?: string;
+        localStoragePrefix?: string;
+        COUCHDB_SERVER_URL?: string;
+        COUCHDB_SERVER_PROTOCOL?: string;
+        COUCHDB_USERNAME?: string;
+        COUCHDB_PASSWORD?: string;
+        COURSE_IDS?: string[];
+    };
+}
+/**
+ * Initialize the data layer with the specified configuration
+ */
+declare function initializeDataLayer(config: DataLayerConfig): Promise<DataLayerProvider>;
+/**
+ * Get the initialized data layer instance
+ * @throws Error if not initialized
+ */
+declare function getDataLayer(): DataLayerProvider;
+/**
+ * Reset the data layer (primarily for testing)
+ */
+declare function _resetDataLayer(): Promise<void>;
+
+export { CardRecord, CourseLookup, type DataLayerConfig, DataLayerProvider, ENV, Loggable, SessionController, StudyContentSource, StudySessionItem, type StudySessionRecord, _resetDataLayer, getDataLayer, initializeDataLayer };