@vue-skuilder/common 0.1.0 → 0.1.1

package/dist/db.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocType = void 0;
+exports.getCardHistoryID = getCardHistoryID;
+exports.parseCardHistoryID = parseCardHistoryID;
+exports.areQuestionRecords = areQuestionRecords;
+exports.isQuestionRecord = isQuestionRecord;
+var DocType;
+(function (DocType) {
+    DocType["DISPLAYABLE_DATA"] = "DISPLAYABLE_DATA";
+    DocType["CARD"] = "CARD";
+    DocType["DATASHAPE"] = "DATASHAPE";
+    DocType["QUESTIONTYPE"] = "QUESTION";
+    DocType["VIEW"] = "VIEW";
+    DocType["PEDAGOGY"] = "PEDAGOGY";
+    DocType["CARDRECORD"] = "CARDRECORD";
+    DocType["SCHEDULED_CARD"] = "SCHEDULED_CARD";
+    DocType["TAG"] = "TAG";
+})(DocType || (exports.DocType = DocType = {}));
+const cardHistoryPrefix = 'cardH';
+function getCardHistoryID(courseID, cardID) {
+    return `${cardHistoryPrefix}-${courseID}-${cardID}`;
+}
+function parseCardHistoryID(id) {
+    const split = id.split('-');
+    let error = '';
+    error += split.length === 3 ? '' : `\n\tgiven ID has incorrect number of '-' characters`;
+    error +=
+        split[0] === cardHistoryPrefix ? '' : `\n\tgiven ID does not start with ${cardHistoryPrefix}`;
+    if (split.length === 3 && split[0] === cardHistoryPrefix) {
+        return {
+            courseID: split[1],
+            cardID: split[2],
+        };
+    }
+    else {
+        throw new Error('parseCardHistory Error:' + error);
+    }
+}
+function areQuestionRecords(h) {
+    return isQuestionRecord(h.records[0]);
+}
+function isQuestionRecord(c) {
+    return c.userAnswer !== undefined;
+}
+//# sourceMappingURL=db.js.map

package/dist/db.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"db.js","sourceRoot":"","sources":["../src/db.ts"],"names":[],"mappings":"AAKA,MAAM,CAAN,IAAY,OAUX;AAVD,WAAY,OAAO;IACjB,gDAAqC,CAAA;IACrC,wBAAa,CAAA;IACb,kCAAuB,CAAA;IACvB,oCAAyB,CAAA;IACzB,wBAAa,CAAA;IACb,gCAAqB,CAAA;IACrB,oCAAyB,CAAA;IACzB,4CAAiC,CAAA;IACjC,sBAAW,CAAA;AACb,CAAC,EAVW,OAAO,KAAP,OAAO,QAUlB;AAiED,MAAM,iBAAiB,GAAG,OAAO,CAAC;AAElC,MAAM,UAAU,gBAAgB,CAAC,QAAgB,EAAE,MAAc;IAC/D,OAAO,GAAG,iBAAiB,IAAI,QAAQ,IAAI,MAAM,EAAE,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,EAAU;IAI3C,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,KAAK,GAAW,EAAE,CAAC;IACvB,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qDAAqD,CAAC;IACzF,KAAK;QACH,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oCAAoC,iBAAiB,EAAE,CAAC;IAEhG,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,iBAAiB,EAAE,CAAC;QACzD,OAAO;YACL,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;YAClB,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;SACjB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,KAAK,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAsED,MAAM,UAAU,kBAAkB,CAAC,CAA0B;IAC3D,OAAO,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,CAAa;IAC5C,OAAQ,CAAoB,CAAC,UAAU,KAAK,SAAS,CAAC;AACxD,CAAC"}

package/dist/db.mjs

@@ -0,0 +1,39 @@
+export var DocType;
+(function (DocType) {
+    DocType["DISPLAYABLE_DATA"] = "DISPLAYABLE_DATA";
+    DocType["CARD"] = "CARD";
+    DocType["DATASHAPE"] = "DATASHAPE";
+    DocType["QUESTIONTYPE"] = "QUESTION";
+    DocType["VIEW"] = "VIEW";
+    DocType["PEDAGOGY"] = "PEDAGOGY";
+    DocType["CARDRECORD"] = "CARDRECORD";
+    DocType["SCHEDULED_CARD"] = "SCHEDULED_CARD";
+    DocType["TAG"] = "TAG";
+})(DocType || (DocType = {}));
+const cardHistoryPrefix = 'cardH';
+export function getCardHistoryID(courseID, cardID) {
+    return `${cardHistoryPrefix}-${courseID}-${cardID}`;
+}
+export function parseCardHistoryID(id) {
+    const split = id.split('-');
+    let error = '';
+    error += split.length === 3 ? '' : `\n\tgiven ID has incorrect number of '-' characters`;
+    error +=
+        split[0] === cardHistoryPrefix ? '' : `\n\tgiven ID does not start with ${cardHistoryPrefix}`;
+    if (split.length === 3 && split[0] === cardHistoryPrefix) {
+        return {
+            courseID: split[1],
+            cardID: split[2],
+        };
+    }
+    else {
+        throw new Error('parseCardHistory Error:' + error);
+    }
+}
+export function areQuestionRecords(h) {
+    return isQuestionRecord(h.records[0]);
+}
+export function isQuestionRecord(c) {
+    return c.userAnswer !== undefined;
+}
+//# sourceMappingURL=db.js.map

package/dist/elo.d.ts

@@ -0,0 +1,44 @@
+export declare class EloRanker {
+    k: number;
+    constructor(k?: number);
+    setKFactor(k: number): void;
+    getKFactor(): number;
+    getExpected(a: number, b: number): number;
+    updateRating(expected: number, actual: number, current: number): number;
+}
+export type CourseElo = {
+    global: EloRank;
+    tags: {
+        [tagID: string]: EloRank;
+    };
+    misc: {
+        [eloID: string]: EloRank;
+    };
+};
+type EloRank = {
+    score: number;
+    count: number;
+};
+type Eloish = number | EloRank | CourseElo;
+export declare function blankCourseElo(): CourseElo;
+export declare function EloToNumber(elo: Eloish): number;
+export declare function toElo(elo: number | EloRank): EloRank;
+export declare function toCourseElo(elo: Eloish | undefined): CourseElo;
+export declare function isCourseElo(x: unknown): x is CourseElo;
+/**
+ * Calculates updated ELO scores for users and content after they interact
+ *
+ * @param userElo current ELO score of the user
+ * @param cardElo current ELO score of the card
+ * @param userScore user performance against the card in range [0,1]
+ * @param k optional scaling factor. Higher values -> larger score adjustments. Default 32.
+ * @returns
+ */
+export declare function adjustCourseScores(aElo: Eloish, bElo: Eloish, userScore: number, options?: {
+    globalOnly: boolean;
+}): {
+    userElo: CourseElo;
+    cardElo: CourseElo;
+};
+export {};
+//# sourceMappingURL=elo.d.ts.map

package/dist/elo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elo.d.ts","sourceRoot":"","sources":["../src/elo.ts"],"names":[],"mappings":"AAAA,qBAAa,SAAS;IACD,CAAC,EAAE,MAAM;gBAAT,CAAC,GAAE,MAAW;IAEjC,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAG3B,UAAU,IAAI,MAAM;IAIpB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM;IAGzC,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;CAGxE;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE;QACJ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAC;IACF,IAAI,EAAE;QACJ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAC;CACH,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;AAE3C,wBAAgB,cAAc,IAAI,SAAS,CAS1C;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAS/C;AACD,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CASpD;AACD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CA+B9D;AAED,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAMtD;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;IACR,UAAU,EAAE,OAAO,CAAC;CACrB,GACA;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,SAAS,CAAC;CACpB,CA+BA"}

package/dist/elo.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EloRanker = void 0;
+exports.blankCourseElo = blankCourseElo;
+exports.EloToNumber = EloToNumber;
+exports.toElo = toElo;
+exports.toCourseElo = toCourseElo;
+exports.isCourseElo = isCourseElo;
+exports.adjustCourseScores = adjustCourseScores;
+class EloRanker {
+    k;
+    constructor(k = 32) {
+        this.k = k;
+    }
+    setKFactor(k) {
+        this.k = k;
+    }
+    getKFactor() {
+        return this.k;
+    }
+    getExpected(a, b) {
+        return 1 / (1 + Math.pow(10, (b - a) / 400));
+    }
+    updateRating(expected, actual, current) {
+        return Math.round(current + this.k * (actual - expected));
+    }
+}
+exports.EloRanker = EloRanker;
+function blankCourseElo() {
+    return {
+        global: {
+            score: 990 + Math.round(Math.random() * 20),
+            count: 0,
+        },
+        tags: {},
+        misc: {},
+    };
+}
+function EloToNumber(elo) {
+    if (typeof elo === 'number') {
+        return elo;
+    }
+    else if (isCourseElo(elo)) {
+        return elo.global.score;
+    }
+    {
+        return elo.score;
+    }
+}
+function toElo(elo) {
+    if (typeof elo === 'number') {
+        return {
+            score: elo,
+            count: 0,
+        };
+    }
+    else {
+        return elo;
+    }
+}
+function toCourseElo(elo) {
+    if (typeof elo === 'string') {
+        throw new Error('unsuitiably typed input to toCourseElo');
+    }
+    if (typeof elo === 'number') {
+        return {
+            global: {
+                score: elo,
+                count: 0,
+            },
+            misc: {},
+            tags: {},
+        };
+    }
+    else if (isCourseElo(elo)) {
+        return elo;
+    }
+    else if (elo === undefined) {
+        return {
+            global: {
+                score: 995 + Math.random() * 10,
+                count: 0,
+            },
+            tags: {},
+            misc: {},
+        };
+    }
+    else {
+        return {
+            global: elo,
+            tags: {},
+            misc: {},
+        };
+    }
+}
+function isCourseElo(x) {
+    if (!x || typeof x !== 'object') {
+        return false;
+    }
+    return 'global' in x && 'tags' in x;
+}
+/**
+ * Calculates updated ELO scores for users and content after they interact
+ *
+ * @param userElo current ELO score of the user
+ * @param cardElo current ELO score of the card
+ * @param userScore user performance against the card in range [0,1]
+ * @param k optional scaling factor. Higher values -> larger score adjustments. Default 32.
+ * @returns
+ */
+function adjustCourseScores(aElo, bElo, userScore, options) {
+    if (userScore < 0 || userScore > 1) {
+        throw new Error(`ELO performance rating must be between 0 and 1 - received ${userScore}`);
+    }
+    const userElo = toCourseElo(aElo);
+    const cardElo = toCourseElo(bElo);
+    if (options == undefined || !options.globalOnly) {
+        // grade on each tag present for the card
+        Object.keys(cardElo.tags).forEach((k) => {
+            const userTagElo = userElo.tags[k]
+                ? userElo.tags[k]
+                : {
+                    count: 0,
+                    score: userElo.global.score, // todo: 1000?
+                };
+            const adjusted = adjustScores(userTagElo, cardElo.tags[k], userScore);
+            userElo.tags[k] = adjusted.userElo;
+            cardElo.tags[k] = adjusted.cardElo;
+        });
+    }
+    const adjusted = adjustScores(userElo.global, cardElo.global, userScore);
+    userElo.global = adjusted.userElo;
+    cardElo.global = adjusted.cardElo;
+    return {
+        userElo,
+        cardElo,
+    };
+}
+function adjustScores(userElo, cardElo, userScore) {
+    if (userScore < 0 || userScore > 1) {
+        throw new Error(`ELO performance rating must be between 0 and 1 - received ${userScore}`);
+    }
+    // todo: how to calculate here?
+    // todo: should / must these be equal?
+    // todo: 176 - these K values should be a fcn of `.count` values of userElo and cardElo
+    const userRanker = new EloRanker(16);
+    const cardRanker = new EloRanker(16);
+    const exp = userRanker.getExpected(userElo.score, cardElo.score);
+    const updatedUserElo = userRanker.updateRating(exp, userScore, userElo.score);
+    const updatedCardElo = cardRanker.updateRating(1 - exp, 1 - userScore, cardElo.score);
+    return {
+        userElo: {
+            score: updatedUserElo,
+            count: userElo.count + 1,
+        },
+        cardElo: {
+            score: updatedCardElo,
+            count: cardElo.count + 1,
+        },
+    };
+}
+//# sourceMappingURL=elo.js.map

package/dist/elo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elo.js","sourceRoot":"","sources":["../src/elo.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,SAAS;IACD;IAAnB,YAAmB,IAAY,EAAE;QAAd,MAAC,GAAD,CAAC,CAAa;IAAG,CAAC;IAErC,UAAU,CAAC,CAAS;QAClB,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;IACD,UAAU;QACR,OAAO,IAAI,CAAC,CAAC,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,CAAS,EAAE,CAAS;QAC9B,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,YAAY,CAAC,QAAgB,EAAE,MAAc,EAAE,OAAe;QAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC;IAC5D,CAAC;CACF;AAmBD,MAAM,UAAU,cAAc;IAC5B,OAAO;QACL,MAAM,EAAE;YACN,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC;YAC3C,KAAK,EAAE,CAAC;SACT;QACD,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAW;IACrC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;SAAM,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC;IAC1B,CAAC;IACD,CAAC;QACC,OAAO,GAAG,CAAC,KAAK,CAAC;IACnB,CAAC;AACH,CAAC;AACD,MAAM,UAAU,KAAK,CAAC,GAAqB;IACzC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACL,KAAK,EAAE,GAAG;YACV,KAAK,EAAE,CAAC;SACT,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC;AACD,MAAM,UAAU,WAAW,CAAC,GAAuB;IACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,GAAG;gBACV,KAAK,EAAE,CAAC;aACT;YACD,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,EAAE;SACT,CAAC;IACJ,CAAC;SAAM,IAAI,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;SAAM,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE;gBAC/B,KAAK,EAAE,CAAC;aACT;YACD,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,EAAE;SACT,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,OAAO;YACL,MAAM,EAAE,GAAG;YACX,IAAI,EAAE,EAAE;YACR,IAAI,EAAE,EAAE;SACT,CAAC;IACJ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAU;IACpC,IAAI,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,QAAQ,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAChC,IAAY,EACZ,IAAY,EACZ,SAAiB,EACjB,OAEC;IAKD,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,6DAA6D,SAAS,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,MAAM,OAAO,GAAc,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,OAAO,GAAc,WAAW,CAAC,IAAI,CAAC,CAAC;IAE7C,IAAI,OAAO,IAAI,SAAS,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QAChD,yCAAyC;QACzC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACtC,MAAM,UAAU,GAAY,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBACzC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjB,CAAC,CAAC;oBACE,KAAK,EAAE,CAAC;oBACR,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,cAAc;iBAC5C,CAAC;YACN,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YACtE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACzE,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;IAClC,OAAO,CAAC,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC;IAElC,OAAO;QACL,OAAO;QACP,OAAO;KACR,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,OAAgB,EAChB,OAAgB,EAChB,SAAiB;IAKjB,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,6DAA6D,SAAS,EAAE,CAAC,CAAC;IAC5F,CAAC;IAED,+BAA+B;IAC/B,sCAAsC;IACtC,uFAAuF;IACvF,MAAM,UAAU,GAAG,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC;IACrC,MAAM,UAAU,GAAG,IAAI,SAAS,CAAC,EAAE,CAAC,CAAC;IAErC,MAAM,GAAG,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAEjE,MAAM,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAC9E,MAAM,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IAEtF,OAAO;QACL,OAAO,EAAE;YACP,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC;SACzB;QACD,OAAO,EAAE;YACP,KAAK,EAAE,cAAc;YACrB,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC;SACzB;KACF,CAAC;AACJ,CAAC"}

package/dist/elo.mjs

@@ -0,0 +1,152 @@
+export class EloRanker {
+    k;
+    constructor(k = 32) {
+        this.k = k;
+    }
+    setKFactor(k) {
+        this.k = k;
+    }
+    getKFactor() {
+        return this.k;
+    }
+    getExpected(a, b) {
+        return 1 / (1 + Math.pow(10, (b - a) / 400));
+    }
+    updateRating(expected, actual, current) {
+        return Math.round(current + this.k * (actual - expected));
+    }
+}
+export function blankCourseElo() {
+    return {
+        global: {
+            score: 990 + Math.round(Math.random() * 20),
+            count: 0,
+        },
+        tags: {},
+        misc: {},
+    };
+}
+export function EloToNumber(elo) {
+    if (typeof elo === 'number') {
+        return elo;
+    }
+    else if (isCourseElo(elo)) {
+        return elo.global.score;
+    }
+    {
+        return elo.score;
+    }
+}
+export function toElo(elo) {
+    if (typeof elo === 'number') {
+        return {
+            score: elo,
+            count: 0,
+        };
+    }
+    else {
+        return elo;
+    }
+}
+export function toCourseElo(elo) {
+    if (typeof elo === 'string') {
+        throw new Error('unsuitiably typed input to toCourseElo');
+    }
+    if (typeof elo === 'number') {
+        return {
+            global: {
+                score: elo,
+                count: 0,
+            },
+            misc: {},
+            tags: {},
+        };
+    }
+    else if (isCourseElo(elo)) {
+        return elo;
+    }
+    else if (elo === undefined) {
+        return {
+            global: {
+                score: 995 + Math.random() * 10,
+                count: 0,
+            },
+            tags: {},
+            misc: {},
+        };
+    }
+    else {
+        return {
+            global: elo,
+            tags: {},
+            misc: {},
+        };
+    }
+}
+export function isCourseElo(x) {
+    if (!x || typeof x !== 'object') {
+        return false;
+    }
+    return 'global' in x && 'tags' in x;
+}
+/**
+ * Calculates updated ELO scores for users and content after they interact
+ *
+ * @param userElo current ELO score of the user
+ * @param cardElo current ELO score of the card
+ * @param userScore user performance against the card in range [0,1]
+ * @param k optional scaling factor. Higher values -> larger score adjustments. Default 32.
+ * @returns
+ */
+export function adjustCourseScores(aElo, bElo, userScore, options) {
+    if (userScore < 0 || userScore > 1) {
+        throw new Error(`ELO performance rating must be between 0 and 1 - received ${userScore}`);
+    }
+    const userElo = toCourseElo(aElo);
+    const cardElo = toCourseElo(bElo);
+    if (options == undefined || !options.globalOnly) {
+        // grade on each tag present for the card
+        Object.keys(cardElo.tags).forEach((k) => {
+            const userTagElo = userElo.tags[k]
+                ? userElo.tags[k]
+                : {
+                    count: 0,
+                    score: userElo.global.score, // todo: 1000?
+                };
+            const adjusted = adjustScores(userTagElo, cardElo.tags[k], userScore);
+            userElo.tags[k] = adjusted.userElo;
+            cardElo.tags[k] = adjusted.cardElo;
+        });
+    }
+    const adjusted = adjustScores(userElo.global, cardElo.global, userScore);
+    userElo.global = adjusted.userElo;
+    cardElo.global = adjusted.cardElo;
+    return {
+        userElo,
+        cardElo,
+    };
+}
+function adjustScores(userElo, cardElo, userScore) {
+    if (userScore < 0 || userScore > 1) {
+        throw new Error(`ELO performance rating must be between 0 and 1 - received ${userScore}`);
+    }
+    // todo: how to calculate here?
+    // todo: should / must these be equal?
+    // todo: 176 - these K values should be a fcn of `.count` values of userElo and cardElo
+    const userRanker = new EloRanker(16);
+    const cardRanker = new EloRanker(16);
+    const exp = userRanker.getExpected(userElo.score, cardElo.score);
+    const updatedUserElo = userRanker.updateRating(exp, userScore, userElo.score);
+    const updatedCardElo = cardRanker.updateRating(1 - exp, 1 - userScore, cardElo.score);
+    return {
+        userElo: {
+            score: updatedUserElo,
+            count: userElo.count + 1,
+        },
+        cardElo: {
+            score: updatedCardElo,
+            count: cardElo.count + 1,
+        },
+    };
+}
+//# sourceMappingURL=elo.js.map

package/dist/enums/DataShapeNames.d.ts

@@ -0,0 +1,27 @@
+export declare enum DataShapeName {
+    BLANK = "",
+    Basic = "Basic",
+    Blanks = "Blanks",
+    Default = "Default",
+    MATH_SingleDigitAddition = "SingleDigitAddition",
+    MATH_SingleDigitSubtraction = "SingleDigitSubtraction",
+    MATH_SingleDigitDivision = "SingleDigitDivision",
+    MATH_SingleDigitMultiplication = "SingleDigitMultiplication",
+    MATH_EqualityTest = "EqualityTest",
+    MATH_OneStepEquation = "OneStepEquation",
+    MATH_AngleCategorize = "AngleCategorize",
+    MATH_SupplimentaryAngles = "SupplimentaryAngles",
+    MATH_CountBy = "CountBy",
+    FRENCH_AudioParse = "AudioParse",
+    FRENCH_Vocab = "Vocab",
+    WORDWORK_Spelling = "WordWork_Spelling",
+    PIANO_Echo = "Piano_Echo",
+    PIANO_PlayNote = "Piano_PlayNote",
+    PITCH_chroma = "Pitch_chroma",
+    SIGHTSING_IdentifyKey = "SightSing_IdentifyKey",
+    CHESS_puzzle = "CHESS_puzzle",
+    CHESS_forks = "CHESS_forks",
+    TYPING_singleLetter = "TYPING_singleLetter",
+    TYPING_fallingLetters = "TYPING_fallingLetters"
+}
+//# sourceMappingURL=DataShapeNames.d.ts.map

package/dist/enums/DataShapeNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataShapeNames.d.ts","sourceRoot":"","sources":["../../src/enums/DataShapeNames.ts"],"names":[],"mappings":"AAAA,oBAAY,aAAa;IACvB,KAAK,KAAK;IAEV,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,OAAO,YAAY;IAGnB,wBAAwB,wBAAwB;IAChD,2BAA2B,2BAA2B;IACtD,wBAAwB,wBAAwB;IAChD,8BAA8B,8BAA8B;IAC5D,iBAAiB,iBAAiB;IAClC,oBAAoB,oBAAoB;IACxC,oBAAoB,oBAAoB;IACxC,wBAAwB,wBAAwB;IAChD,YAAY,YAAY;IAGxB,iBAAiB,eAAe;IAChC,YAAY,UAAU;IAGtB,iBAAiB,sBAAsB;IAGvC,UAAU,eAAe;IACzB,cAAc,mBAAmB;IAGjC,YAAY,iBAAiB;IAG7B,qBAAqB,0BAA0B;IAG/C,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAG3B,mBAAmB,wBAAwB;IAC3C,qBAAqB,0BAA0B;CAChD"}

package/dist/enums/DataShapeNames.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataShapeName = void 0;
+var DataShapeName;
+(function (DataShapeName) {
+    DataShapeName["BLANK"] = "";
+    // Shared base-course types
+    DataShapeName["Basic"] = "Basic";
+    DataShapeName["Blanks"] = "Blanks";
+    DataShapeName["Default"] = "Default";
+    // Math
+    DataShapeName["MATH_SingleDigitAddition"] = "SingleDigitAddition";
+    DataShapeName["MATH_SingleDigitSubtraction"] = "SingleDigitSubtraction";
+    DataShapeName["MATH_SingleDigitDivision"] = "SingleDigitDivision";
+    DataShapeName["MATH_SingleDigitMultiplication"] = "SingleDigitMultiplication";
+    DataShapeName["MATH_EqualityTest"] = "EqualityTest";
+    DataShapeName["MATH_OneStepEquation"] = "OneStepEquation";
+    DataShapeName["MATH_AngleCategorize"] = "AngleCategorize";
+    DataShapeName["MATH_SupplimentaryAngles"] = "SupplimentaryAngles";
+    DataShapeName["MATH_CountBy"] = "CountBy";
+    // French
+    DataShapeName["FRENCH_AudioParse"] = "AudioParse";
+    DataShapeName["FRENCH_Vocab"] = "Vocab";
+    // WordWork
+    DataShapeName["WORDWORK_Spelling"] = "WordWork_Spelling";
+    // Piano
+    DataShapeName["PIANO_Echo"] = "Piano_Echo";
+    DataShapeName["PIANO_PlayNote"] = "Piano_PlayNote";
+    // Pitch
+    DataShapeName["PITCH_chroma"] = "Pitch_chroma";
+    // SightSing
+    DataShapeName["SIGHTSING_IdentifyKey"] = "SightSing_IdentifyKey";
+    // Chess
+    DataShapeName["CHESS_puzzle"] = "CHESS_puzzle";
+    DataShapeName["CHESS_forks"] = "CHESS_forks";
+    // Typing
+    DataShapeName["TYPING_singleLetter"] = "TYPING_singleLetter";
+    DataShapeName["TYPING_fallingLetters"] = "TYPING_fallingLetters";
+})(DataShapeName || (exports.DataShapeName = DataShapeName = {}));
+//# sourceMappingURL=DataShapeNames.js.map

package/dist/enums/DataShapeNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataShapeNames.js","sourceRoot":"","sources":["../../src/enums/DataShapeNames.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,aA0CX;AA1CD,WAAY,aAAa;IACvB,2BAAU,CAAA;IACV,2BAA2B;IAC3B,gCAAe,CAAA;IACf,kCAAiB,CAAA;IACjB,oCAAmB,CAAA;IAEnB,OAAO;IACP,iEAAgD,CAAA;IAChD,uEAAsD,CAAA;IACtD,iEAAgD,CAAA;IAChD,6EAA4D,CAAA;IAC5D,mDAAkC,CAAA;IAClC,yDAAwC,CAAA;IACxC,yDAAwC,CAAA;IACxC,iEAAgD,CAAA;IAChD,yCAAwB,CAAA;IAExB,SAAS;IACT,iDAAgC,CAAA;IAChC,uCAAsB,CAAA;IAEtB,WAAW;IACX,wDAAuC,CAAA;IAEvC,QAAQ;IACR,0CAAyB,CAAA;IACzB,kDAAiC,CAAA;IAEjC,QAAQ;IACR,8CAA6B,CAAA;IAE7B,YAAY;IACZ,gEAA+C,CAAA;IAE/C,QAAQ;IACR,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAE3B,SAAS;IACT,4DAA2C,CAAA;IAC3C,gEAA+C,CAAA;AACjD,CAAC,EA1CW,aAAa,KAAb,aAAa,QA0CxB"}

package/dist/enums/DataShapeNames.mjs

@@ -0,0 +1,37 @@
+export var DataShapeName;
+(function (DataShapeName) {
+    DataShapeName["BLANK"] = "";
+    // Shared base-course types
+    DataShapeName["Basic"] = "Basic";
+    DataShapeName["Blanks"] = "Blanks";
+    DataShapeName["Default"] = "Default";
+    // Math
+    DataShapeName["MATH_SingleDigitAddition"] = "SingleDigitAddition";
+    DataShapeName["MATH_SingleDigitSubtraction"] = "SingleDigitSubtraction";
+    DataShapeName["MATH_SingleDigitDivision"] = "SingleDigitDivision";
+    DataShapeName["MATH_SingleDigitMultiplication"] = "SingleDigitMultiplication";
+    DataShapeName["MATH_EqualityTest"] = "EqualityTest";
+    DataShapeName["MATH_OneStepEquation"] = "OneStepEquation";
+    DataShapeName["MATH_AngleCategorize"] = "AngleCategorize";
+    DataShapeName["MATH_SupplimentaryAngles"] = "SupplimentaryAngles";
+    DataShapeName["MATH_CountBy"] = "CountBy";
+    // French
+    DataShapeName["FRENCH_AudioParse"] = "AudioParse";
+    DataShapeName["FRENCH_Vocab"] = "Vocab";
+    // WordWork
+    DataShapeName["WORDWORK_Spelling"] = "WordWork_Spelling";
+    // Piano
+    DataShapeName["PIANO_Echo"] = "Piano_Echo";
+    DataShapeName["PIANO_PlayNote"] = "Piano_PlayNote";
+    // Pitch
+    DataShapeName["PITCH_chroma"] = "Pitch_chroma";
+    // SightSing
+    DataShapeName["SIGHTSING_IdentifyKey"] = "SightSing_IdentifyKey";
+    // Chess
+    DataShapeName["CHESS_puzzle"] = "CHESS_puzzle";
+    DataShapeName["CHESS_forks"] = "CHESS_forks";
+    // Typing
+    DataShapeName["TYPING_singleLetter"] = "TYPING_singleLetter";
+    DataShapeName["TYPING_fallingLetters"] = "TYPING_fallingLetters";
+})(DataShapeName || (DataShapeName = {}));
+//# sourceMappingURL=DataShapeNames.js.map

package/dist/enums/FieldType.d.ts

@@ -0,0 +1,18 @@
+/**
+ * These are the defined types of user input that can hydrate a configured
+ * dataShape.
+ *
+ * These field types map to input elements and specific validation and processing functions.
+ */
+export declare enum FieldType {
+    STRING = "string",
+    NUMBER = "number",
+    INT = "int",
+    IMAGE = "image",
+    MARKDOWN = "markdown",
+    AUDIO = "audio",
+    MIDI = "midi",
+    MEDIA_UPLOADS = "uploads",
+    CHESS_PUZZLE = "chess_puzzle"
+}
+//# sourceMappingURL=FieldType.d.ts.map

package/dist/enums/FieldType.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FieldType.d.ts","sourceRoot":"","sources":["../../src/enums/FieldType.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,aAAa,YAAY;IACzB,YAAY,iBAAiB;CAC9B"}

package/dist/enums/FieldType.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldType = void 0;
+/**
+ * These are the defined types of user input that can hydrate a configured
+ * dataShape.
+ *
+ * These field types map to input elements and specific validation and processing functions.
+ */
+var FieldType;
+(function (FieldType) {
+    FieldType["STRING"] = "string";
+    FieldType["NUMBER"] = "number";
+    FieldType["INT"] = "int";
+    FieldType["IMAGE"] = "image";
+    FieldType["MARKDOWN"] = "markdown";
+    FieldType["AUDIO"] = "audio";
+    FieldType["MIDI"] = "midi";
+    FieldType["MEDIA_UPLOADS"] = "uploads";
+    FieldType["CHESS_PUZZLE"] = "chess_puzzle";
+})(FieldType || (exports.FieldType = FieldType = {}));
+//# sourceMappingURL=FieldType.js.map

package/dist/enums/FieldType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FieldType.js","sourceRoot":"","sources":["../../src/enums/FieldType.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAUX;AAVD,WAAY,SAAS;IACnB,8BAAiB,CAAA;IACjB,8BAAiB,CAAA;IACjB,wBAAW,CAAA;IACX,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,0BAAa,CAAA;IACb,sCAAyB,CAAA;IACzB,0CAA6B,CAAA;AAC/B,CAAC,EAVW,SAAS,KAAT,SAAS,QAUpB"}

package/dist/enums/FieldType.mjs

@@ -0,0 +1,19 @@
+/**
+ * These are the defined types of user input that can hydrate a configured
+ * dataShape.
+ *
+ * These field types map to input elements and specific validation and processing functions.
+ */
+export var FieldType;
+(function (FieldType) {
+    FieldType["STRING"] = "string";
+    FieldType["NUMBER"] = "number";
+    FieldType["INT"] = "int";
+    FieldType["IMAGE"] = "image";
+    FieldType["MARKDOWN"] = "markdown";
+    FieldType["AUDIO"] = "audio";
+    FieldType["MIDI"] = "midi";
+    FieldType["MEDIA_UPLOADS"] = "uploads";
+    FieldType["CHESS_PUZZLE"] = "chess_puzzle";
+})(FieldType || (FieldType = {}));
+//# sourceMappingURL=FieldType.js.map

package/dist/enums/index.d.ts

@@ -0,0 +1,3 @@
+export * from './DataShapeNames.js';
+export * from './FieldType.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/enums/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/enums/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC"}