@vived/app 4.28.1 → 4.28.2

package/lib/Components/Question/Adapters/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./questionAnswerAdapter";
+export * from "./questionChallengeAdapter";

package/lib/Components/Question/Adapters/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./questionAnswerAdapter"), exports);
+__exportStar(require("./questionChallengeAdapter"), exports);

package/lib/Components/Question/Adapters/questionAnswerAdapter.d.ts

@@ -0,0 +1,3 @@
+import { PmAdapter } from "../../../Types";
+import { QuestionAnswerVM } from "../PM/QuestionAnswerPM";
+export declare const questionAnswerAdapter: PmAdapter<QuestionAnswerVM>;

package/lib/Components/Question/Adapters/questionAnswerAdapter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.questionAnswerAdapter = void 0;
+const QuestionAnswerPM_1 = require("../PM/QuestionAnswerPM");
+exports.questionAnswerAdapter = {
+    defaultVM: QuestionAnswerPM_1.defaultQuestionChallengeAnswerVM,
+    subscribe: (id, appObjects, setVM) => {
+        if (!id)
+            return;
+        const pm = QuestionAnswerPM_1.QuestionAnswerPM.getByID(id, appObjects);
+        if (!pm) {
+            appObjects.submitError("questionAnswerAdapter", "Unable to find QuestionAnswerPM");
+            return;
+        }
+        pm.addView(setVM);
+    },
+    unsubscribe: (id, appObjects, setVM) => {
+        if (!id)
+            return;
+        const pm = QuestionAnswerPM_1.QuestionAnswerPM.getByID(id, appObjects);
+        if (!pm) {
+            appObjects.submitError("questionAnswerAdapter", "Unable to find QuestionAnswerPM");
+            return;
+        }
+        pm.removeView(setVM);
+    },
+};

package/lib/Components/Question/Adapters/questionChallengeAdapter.d.ts

@@ -0,0 +1,3 @@
+import { SingletonPmAdapter } from "../../../Types";
+import { QuestionChallengeVM } from "../PM/QuestionChallengePM";
+export declare const questionChallengeAdapter: SingletonPmAdapter<QuestionChallengeVM>;

package/lib/Components/Question/Adapters/questionChallengeAdapter.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.questionChallengeAdapter = void 0;
+const QuestionChallengePM_1 = require("../PM/QuestionChallengePM");
+exports.questionChallengeAdapter = {
+    defaultVM: QuestionChallengePM_1.defaultQuestionChallengeVM,
+    subscribe: (appObjects, setVM) => {
+        const pm = QuestionChallengePM_1.QuestionChallengePM.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("questionChallengeAdapter", "Unable to find QuestionChallengePM");
+            return;
+        }
+        pm.addView(setVM);
+    },
+    unsubscribe: (appObjects, setVM) => {
+        const pm = QuestionChallengePM_1.QuestionChallengePM.get(appObjects);
+        if (!pm) {
+            appObjects.submitError("questionChallengeAdapter", "Unable to find QuestionChallengePM");
+            return;
+        }
+        pm.removeView(setVM);
+    },
+};

package/lib/Components/Question/Factories/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./setupQuestionAnswer";
+export * from "./setupQuestionChallenge";

package/lib/Components/Question/Factories/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./setupQuestionAnswer"), exports);
+__exportStar(require("./setupQuestionChallenge"), exports);

package/lib/Components/Question/Factories/setupQuestionAnswer.d.ts

@@ -0,0 +1,3 @@
+import { AppObjectRepo } from "../../../AppObject";
+import { QuestionAnswerEntity } from "../Entities";
+export declare function setupQuestionAnswer(appObjects: AppObjectRepo, id?: string): QuestionAnswerEntity;

package/lib/Components/Question/Factories/setupQuestionAnswer.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupQuestionAnswer = void 0;
+const Utilities_1 = require("../../../Utilities");
+const Entities_1 = require("../Entities");
+const PM_1 = require("../PM");
+const UC_1 = require("../UC");
+function setupQuestionAnswer(appObjects, id) {
+    const idToUse = id !== null && id !== void 0 ? id : Utilities_1.generateUniqueID();
+    const ao = appObjects.getOrCreate(idToUse);
+    const answerEntity = Entities_1.makeQuestionAnswerEntity(ao);
+    UC_1.makeSetAnswerFeedbackUC(ao);
+    UC_1.makeSetAnswerTextUC(ao);
+    UC_1.makeToggleQuestionChallengeAnswerIsCorrectUC(ao);
+    PM_1.makeQuestionAnswerPM(ao);
+    return answerEntity;
+}
+exports.setupQuestionAnswer = setupQuestionAnswer;

package/lib/Components/Question/Factories/setupQuestionChallenge.d.ts

@@ -0,0 +1,3 @@
+import { AppObjectRepo } from "../../../AppObject";
+import { QuestionEntity } from "../Entities";
+export declare function setupQuestionChallenge(appObjects: AppObjectRepo): QuestionEntity;

package/lib/Components/Question/Factories/setupQuestionChallenge.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupQuestionChallenge = void 0;
+const Entities_1 = require("../Entities");
+const PM_1 = require("../PM");
+const UC_1 = require("../UC");
+const setupQuestionAnswer_1 = require("./setupQuestionAnswer");
+function setupQuestionChallenge(appObjects) {
+    const ao = appObjects.getOrCreate("QuestionChallenge");
+    const questionEntity = Entities_1.makeQuestionEntity(ao);
+    UC_1.makeAddQuestionAnswerUC(ao);
+    UC_1.makeDeleteQuestionAnswerUC(ao);
+    UC_1.makeSubmitQuestionAnswerUC(ao);
+    new UC_1.SerializeQuestionChallenge(ao);
+    UC_1.makeValidateQuestionChallengeStateUC(ao);
+    PM_1.makeQuestionChallengePM(ao);
+    questionEntity.answerFactory = (id) => setupQuestionAnswer_1.setupQuestionAnswer(appObjects, id);
+    return questionEntity;
+}
+exports.setupQuestionChallenge = setupQuestionChallenge;

package/lib/Components/Question/Mocks/QuestionAnswerPmMock.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="jest" />
+import { AppObject } from "../../../AppObject";
+import { QuestionAnswerPM } from "../PM/QuestionAnswerPM";
+export declare class QuestionAnswerPmMock extends QuestionAnswerPM {
+    vmsAreEqual: jest.Mock<any, any>;
+    constructor(appObject: AppObject);
+}

package/lib/Components/Question/Mocks/QuestionAnswerPmMock.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuestionAnswerPmMock = void 0;
+const QuestionAnswerPM_1 = require("../PM/QuestionAnswerPM");
+class QuestionAnswerPmMock extends QuestionAnswerPM_1.QuestionAnswerPM {
+    constructor(appObject) {
+        super(appObject, QuestionAnswerPM_1.QuestionAnswerPM.type);
+        this.vmsAreEqual = jest.fn();
+    }
+}
+exports.QuestionAnswerPmMock = QuestionAnswerPmMock;

package/lib/Components/Question/Mocks/QuestionChallengePmMock.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="jest" />
+import { AppObject, AppObjectRepo } from "../../../AppObject";
+import { QuestionChallengePM } from "../PM/QuestionChallengePM";
+export declare class QuestionChallengePmMock extends QuestionChallengePM {
+    vmsAreEqual: jest.Mock<any, any>;
+    constructor(appObject: AppObject);
+}
+export declare function makeQuestionChallengePmMock(appObjects: AppObjectRepo): QuestionChallengePmMock;

package/lib/Components/Question/Mocks/QuestionChallengePmMock.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeQuestionChallengePmMock = exports.QuestionChallengePmMock = void 0;
+const QuestionChallengePM_1 = require("../PM/QuestionChallengePM");
+class QuestionChallengePmMock extends QuestionChallengePM_1.QuestionChallengePM {
+    constructor(appObject) {
+        super(appObject, QuestionChallengePM_1.QuestionChallengePM.type);
+        this.vmsAreEqual = jest.fn();
+    }
+}
+exports.QuestionChallengePmMock = QuestionChallengePmMock;
+function makeQuestionChallengePmMock(appObjects) {
+    return new QuestionChallengePmMock(appObjects.getOrCreate("QuestionChallengePmMock"));
+}
+exports.makeQuestionChallengePmMock = makeQuestionChallengePmMock;

package/lib/Components/Question/Mocks/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./MockQuestionAnswerEntity";
 export * from "./MockValidateQuestion";
+export * from "./QuestionAnswerPmMock";
+export * from "./QuestionChallengePmMock";

package/lib/Components/Question/Mocks/index.js

@@ -12,3 +12,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./MockQuestionAnswerEntity"), exports);
 __exportStar(require("./MockValidateQuestion"), exports);
+__exportStar(require("./QuestionAnswerPmMock"), exports);
+__exportStar(require("./QuestionChallengePmMock"), exports);

package/lib/Components/Question/PM/QuestionAnswerPM.d.ts

@@ -1,3 +1,4 @@
+import { AppObjectRepo } from "../../../AppObject";
 import { AppObject } from "../../../AppObject/AppObject";
 import { AppObjectPM } from "../../../AppObject/AppObjectPM";
 export declare const defaultQuestionChallengeAnswerVM: QuestionAnswerVM;
@@ -8,12 +9,9 @@ export interface QuestionAnswerVM {
     textValidation?: string;
     feedbackValidation?: string;
 }
-export declare class QuestionAnswerPM extends AppObjectPM<QuestionAnswerVM> {
+export declare abstract class QuestionAnswerPM extends AppObjectPM<QuestionAnswerVM> {
     static readonly type = "QuestionAnswerPM";
     static get(appObject: AppObject): QuestionAnswerPM | undefined;
-    private answer?;
-    vmsAreEqual(a: QuestionAnswerVM, b: QuestionAnswerVM): boolean;
-    dispose: () => void;
-    private onAnswerChange;
-    constructor(appObject: AppObject);
+    static getByID(id: string, appObjects: AppObjectRepo): QuestionAnswerPM | undefined;
 }
+export declare function makeQuestionAnswerPM(appObject: AppObject): QuestionAnswerPM;

package/lib/Components/Question/PM/QuestionAnswerPM.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionAnswerPM = exports.defaultQuestionChallengeAnswerVM = void 0;
+exports.makeQuestionAnswerPM = exports.QuestionAnswerPM = exports.defaultQuestionChallengeAnswerVM = void 0;
 const AppObjectPM_1 = require("../../../AppObject/AppObjectPM");
 const QuestionAnswerEntity_1 = require("../Entities/QuestionAnswerEntity");
 exports.defaultQuestionChallengeAnswerVM = {
@@ -9,6 +9,22 @@ exports.defaultQuestionChallengeAnswerVM = {
     isCorrect: false,
 };
 class QuestionAnswerPM extends AppObjectPM_1.AppObjectPM {
+    static get(appObject) {
+        return appObject.getComponent(QuestionAnswerPM.type);
+    }
+    static getByID(id, appObjects) {
+        var _a;
+        return (_a = appObjects
+            .get(id)) === null || _a === void 0 ? void 0 : _a.getComponent(QuestionAnswerPM.type);
+    }
+}
+exports.QuestionAnswerPM = QuestionAnswerPM;
+QuestionAnswerPM.type = "QuestionAnswerPM";
+function makeQuestionAnswerPM(appObject) {
+    return new QuestionAnswerPMImp(appObject);
+}
+exports.makeQuestionAnswerPM = makeQuestionAnswerPM;
+class QuestionAnswerPMImp extends QuestionAnswerPM {
     constructor(appObject) {
         super(appObject, QuestionAnswerPM.type);
         this.dispose = () => {
@@ -29,17 +45,16 @@ class QuestionAnswerPM extends AppObjectPM_1.AppObjectPM {
             };
             this.doUpdateView(vm);
         };
-        this.answer = appObject.getComponent(QuestionAnswerEntity_1.QuestionAnswerEntity.type);
         if (this.answer) {
             this.answer.addChangeObserver(this.onAnswerChange);
             this.onAnswerChange();
         }
         else {
-            this.warn("QuestionAnswerPM has been added to an app object that does not have QuestionAnswerEntity");
+            this.error("QuestionAnswerPM has been added to an app object that does not have QuestionAnswerEntity");
         }
     }
-    static get(appObject) {
-        return appObject.getComponent(QuestionAnswerPM.type);
+    get answer() {
+        return this.getCachedLocalComponent(QuestionAnswerEntity_1.QuestionAnswerEntity.type);
     }
     vmsAreEqual(a, b) {
         if (a.answerText !== b.answerText)
@@ -55,5 +70,3 @@ class QuestionAnswerPM extends AppObjectPM_1.AppObjectPM {
         return true;
     }
 }
-exports.QuestionAnswerPM = QuestionAnswerPM;
-QuestionAnswerPM.type = "QuestionAnswerPM";

package/lib/Components/Question/PM/QuestionChallengePM.d.ts

@@ -9,13 +9,8 @@ export interface QuestionChallengeVM {
     reviewFeedback: string;
     validationMessage?: string;
 }
-export declare class QuestionChallengePM extends AppObjectPM<QuestionChallengeVM> {
+export declare abstract class QuestionChallengePM extends AppObjectPM<QuestionChallengeVM> {
     static readonly type = "QuestionChallengePM";
     static get: (appObjects: AppObjectRepo) => QuestionChallengePM | undefined;
-    private questionEntity?;
-    private baseAppState?;
-    private onEntityChange;
-    vmsAreEqual(a: QuestionChallengeVM, b: QuestionChallengeVM): boolean;
-    dispose: () => void;
-    constructor(appObject: AppObject);
 }
+export declare function makeQuestionChallengePM(appObject: AppObject): QuestionChallengePM;

package/lib/Components/Question/PM/QuestionChallengePM.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionChallengePM = exports.defaultQuestionChallengeVM = exports.SLIDE_TEXT_CANNOT_BE_FALSY = void 0;
+exports.makeQuestionChallengePM = exports.QuestionChallengePM = exports.defaultQuestionChallengeVM = exports.SLIDE_TEXT_CANNOT_BE_FALSY = void 0;
 const AppObject_1 = require("../../../AppObject");
 const AppObjectPM_1 = require("../../../AppObject/AppObjectPM");
 const BaseApp_1 = require("../../BaseApp");
@@ -12,6 +12,15 @@ exports.defaultQuestionChallengeVM = {
     reviewFeedback: "",
 };
 class QuestionChallengePM extends AppObjectPM_1.AppObjectPM {
+}
+exports.QuestionChallengePM = QuestionChallengePM;
+QuestionChallengePM.type = "QuestionChallengePM";
+QuestionChallengePM.get = (appObjects) => AppObject_1.getSingletonComponent(QuestionChallengePM.type, appObjects);
+function makeQuestionChallengePM(appObject) {
+    return new QuestionChallengePMImp(appObject);
+}
+exports.makeQuestionChallengePM = makeQuestionChallengePM;
+class QuestionChallengePMImp extends QuestionChallengePM {
     constructor(appObject) {
         super(appObject, QuestionChallengePM.type);
         this.onEntityChange = () => {
@@ -39,24 +48,28 @@ class QuestionChallengePM extends AppObjectPM_1.AppObjectPM {
             (_a = this.questionEntity) === null || _a === void 0 ? void 0 : _a.removeChangeObserver(this.onEntityChange);
             (_b = this.baseAppState) === null || _b === void 0 ? void 0 : _b.removeChangeObserver(this.onEntityChange);
         };
-        this.baseAppState = BaseApp_1.BaseAppState.get(this.appObjects);
         if (!this.baseAppState) {
-            this.warn("QuestionChallengePM has been added to an app object that does not have BaseAppStateEntity");
+            this.error("Unable to find BaseAppStateEntity");
             return;
         }
         else {
             this.baseAppState.addChangeObserver(this.onEntityChange);
             this.onEntityChange();
         }
-        this.questionEntity = appObject.getComponent(QuestionEntity_1.QuestionEntity.type);
         if (this.questionEntity) {
             this.questionEntity.addChangeObserver(this.onEntityChange);
             this.onEntityChange();
         }
         else {
-            this.warn("QuestionChallengePM has been added to an app object that does not have QuestionEntity");
+            this.error("Unable to find QuestionEntity");
         }
     }
+    get questionEntity() {
+        return this.getCachedSingleton(QuestionEntity_1.QuestionEntity.type);
+    }
+    get baseAppState() {
+        return this.getCachedSingleton(BaseApp_1.BaseAppState.type);
+    }
     vmsAreEqual(a, b) {
         if (a.gotItRight !== b.gotItRight)
             return false;
@@ -74,6 +87,3 @@ class QuestionChallengePM extends AppObjectPM_1.AppObjectPM {
         return idsMatch;
     }
 }
-exports.QuestionChallengePM = QuestionChallengePM;
-QuestionChallengePM.type = "QuestionChallengePM";
-QuestionChallengePM.get = (appObjects) => AppObject_1.getSingletonComponent(QuestionChallengePM.type, appObjects);

package/lib/Components/Question/index.d.ts

@@ -1,5 +1,7 @@
+export * from "./Adapters";
 export * from "./Controllers";
 export * from "./Entities";
+export * from "./Factories";
 export * from "./Mocks";
 export * from "./PM";
 export * from "./UC";

package/lib/Components/Question/index.js

@@ -10,8 +10,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Adapters"), exports);
 __exportStar(require("./Controllers"), exports);
 __exportStar(require("./Entities"), exports);
+__exportStar(require("./Factories"), exports);
 __exportStar(require("./Mocks"), exports);
 __exportStar(require("./PM"), exports);
 __exportStar(require("./UC"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vived/app",
-  "version": "4.28.1",
+  "version": "4.28.2",
   "description": "Public package for the VIVED Learning App system",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",