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", STRATEGY_STATE = "STRATEGY_STATE", USER_OUTCOME = "USER_OUTCOME", STRATEGY_LEARNING_STATE = "STRATEGY_LEARNING_STATE" } interface QualifiedCardID { courseID: string; cardID: string; } /** * 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[]; author: string; } 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; author: string; } /** 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 DocTypePrefixes: { readonly CARD: "c"; readonly DISPLAYABLE_DATA: "dd"; readonly TAG: "TAG"; readonly CARDRECORD: "cardH"; readonly SCHEDULED_CARD: "card_review_"; readonly DATASHAPE: "DATASHAPE"; readonly QUESTION: "QUESTION"; readonly VIEW: "VIEW"; readonly PEDAGOGY: "PEDAGOGY"; readonly NAVIGATION_STRATEGY: "NAVIGATION_STRATEGY"; readonly STRATEGY_STATE: "STRATEGY_STATE"; readonly USER_OUTCOME: "USER_OUTCOME"; readonly STRATEGY_LEARNING_STATE: "STRATEGY_LEARNING_STATE"; }; interface CardHistory { _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 CardHistory as C, DocType as D, type Field as F, GuestUsername as G, type QualifiedCardID as Q, type SkuilderCourseData as S, type TagStub as T, type Tag as a, DocTypePrefixes as b, type CardRecord as c, type QuestionRecord as d, type CardData as e, type CourseListData as f, type DisplayableData as g, type DataShapeData as h, type QuestionData as i, log as l };