@vived/app 4.4.0 → 4.5.0

package/lib/Components/Question/Entities/QuestionAnswerEntity.d.ts

@@ -1,10 +1,11 @@
 import { AppObject } from "../../../AppObject/AppObject";
 import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
-export declare const EMPTY_TEXT_VALIDATION_MESSAGE = "Question answer text cannot be empty";
+export declare const EMPTY_TEXT_VALIDATION_MESSAGE = "Answer text is required.";
 export declare const MAX_QUESTION_LENGTH = 40;
 export declare const LONG_TEXT_VALIDATION_MESSAGE: string;
 export declare const MAX_FEEDBACK_LENGTH = 200;
 export declare const LONG_FEEDBACK_VALIDATION_MESSAGE: string;
+export declare const FEEDBACK_STRING_CANNOT_BE_0_CHARACTERS = "Feedback string cannot be 0 characters.";
 export declare abstract class QuestionAnswerEntity extends AppObjectEntity {
     static readonly type = "QuestionAnswerEntity";
     abstract readonly id: string;

package/lib/Components/Question/Entities/QuestionAnswerEntity.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeQuestionAnswerEntity = exports.QuestionAnswerEntity = exports.LONG_FEEDBACK_VALIDATION_MESSAGE = exports.MAX_FEEDBACK_LENGTH = exports.LONG_TEXT_VALIDATION_MESSAGE = exports.MAX_QUESTION_LENGTH = exports.EMPTY_TEXT_VALIDATION_MESSAGE = void 0;
+exports.makeQuestionAnswerEntity = exports.QuestionAnswerEntity = exports.FEEDBACK_STRING_CANNOT_BE_0_CHARACTERS = exports.LONG_FEEDBACK_VALIDATION_MESSAGE = exports.MAX_FEEDBACK_LENGTH = exports.LONG_TEXT_VALIDATION_MESSAGE = exports.MAX_QUESTION_LENGTH = exports.EMPTY_TEXT_VALIDATION_MESSAGE = void 0;
 const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
 const Entities_1 = require("../../../Entities");
-exports.EMPTY_TEXT_VALIDATION_MESSAGE = "Question answer text cannot be empty";
+exports.EMPTY_TEXT_VALIDATION_MESSAGE = "Answer text is required.";
 exports.MAX_QUESTION_LENGTH = 40;
-exports.LONG_TEXT_VALIDATION_MESSAGE = `Question answer text is limited to ${exports.MAX_QUESTION_LENGTH} characters`;
+exports.LONG_TEXT_VALIDATION_MESSAGE = `Answer text may not exceed ${exports.MAX_QUESTION_LENGTH} characters.`;
 exports.MAX_FEEDBACK_LENGTH = 200;
-exports.LONG_FEEDBACK_VALIDATION_MESSAGE = `Feedback text is limited to ${exports.MAX_FEEDBACK_LENGTH} characters`;
+exports.LONG_FEEDBACK_VALIDATION_MESSAGE = `Answer feedback may not exceed ${exports.MAX_FEEDBACK_LENGTH} characters.`;
+exports.FEEDBACK_STRING_CANNOT_BE_0_CHARACTERS = "Feedback string cannot be 0 characters.";
 class QuestionAnswerEntity extends AppObjectEntity_1.AppObjectEntity {
 }
 exports.QuestionAnswerEntity = QuestionAnswerEntity;
@@ -51,7 +52,10 @@ class QuestionAnswerEntityImp extends QuestionAnswerEntity {
         this.memoizedFeedback.val = val;
     }
     get feedbackValidationMessage() {
-        if (this.feedbackText.length > exports.MAX_FEEDBACK_LENGTH) {
+        if (this.feedbackText.length === 0) {
+            return exports.FEEDBACK_STRING_CANNOT_BE_0_CHARACTERS;
+        }
+        else if (this.feedbackText.length > exports.MAX_FEEDBACK_LENGTH) {
             return exports.LONG_FEEDBACK_VALIDATION_MESSAGE;
         }
         else {

package/lib/Components/Question/Entities/QuestionEntity.d.ts

@@ -2,7 +2,7 @@ import { AppObject } from "../../../AppObject/AppObject";
 import { AppObjectEntity } from "../../../AppObject/AppObjectEntity";
 import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
 import { QuestionAnswerEntity } from "./QuestionAnswerEntity";
-export declare const VALIDATION_NO_CORRECT = "At least one answer must be marked as correct";
+export declare const VALIDATION_NO_CORRECT = "At least one answer must be correct.";
 export declare const VALIDATION_NOT_ENOUGH_ANSWERS = "Question must have at least two answers";
 export declare abstract class QuestionEntity extends AppObjectEntity {
     static readonly type = "QuestionEntity";

package/lib/Components/Question/Entities/QuestionEntity.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.makeQuestionEntity = exports.QuestionEntity = exports.VALIDATION_NOT_ENOUGH_ANSWERS = exports.VALIDATION_NO_CORRECT = void 0;
 const AppObject_1 = require("../../../AppObject");
 const AppObjectEntity_1 = require("../../../AppObject/AppObjectEntity");
-exports.VALIDATION_NO_CORRECT = "At least one answer must be marked as correct";
+exports.VALIDATION_NO_CORRECT = "At least one answer must be correct.";
 exports.VALIDATION_NOT_ENOUGH_ANSWERS = "Question must have at least two answers";
 class QuestionEntity extends AppObjectEntity_1.AppObjectEntity {
 }
@@ -97,21 +97,14 @@ class QuestionChallengeImp extends QuestionEntity {
             return exports.VALIDATION_NOT_ENOUGH_ANSWERS;
         }
         let hasCorrect = false;
-        let answerValidationMsg;
         this.answerLookup.forEach((ans) => {
             if (ans.isCorrect) {
                 hasCorrect = true;
             }
-            if (ans.textValidationMessage) {
-                answerValidationMsg = ans.textValidationMessage;
-            }
-            if (ans.feedbackValidationMessage) {
-                answerValidationMsg = ans.feedbackValidationMessage;
-            }
         });
         if (!hasCorrect) {
             return exports.VALIDATION_NO_CORRECT;
         }
-        return answerValidationMsg;
+        return;
     }
 }

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

@@ -1,6 +1,7 @@
 import { AppObject } from "../../../AppObject/AppObject";
 import { AppObjectPM } from "../../../AppObject/AppObjectPM";
 import { AppObjectRepo } from "../../../AppObject/AppObjectRepo";
+export declare const SLIDE_TEXT_CANNOT_BE_FALSY = "Slide text is required.";
 export declare const defaultQuestionChallengeVM: QuestionChallengeVM;
 export interface QuestionChallengeVM {
     gotItRight: boolean;
@@ -12,6 +13,7 @@ export declare 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;

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

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionChallengePM = exports.defaultQuestionChallengeVM = void 0;
+exports.QuestionChallengePM = exports.defaultQuestionChallengeVM = exports.SLIDE_TEXT_CANNOT_BE_FALSY = void 0;
 const AppObject_1 = require("../../../AppObject");
 const AppObjectPM_1 = require("../../../AppObject/AppObjectPM");
+const App_1 = require("../../App");
 const QuestionEntity_1 = require("../Entities/QuestionEntity");
+exports.SLIDE_TEXT_CANNOT_BE_FALSY = "Slide text is required.";
 exports.defaultQuestionChallengeVM = {
     answerIds: [],
     gotItRight: false,
@@ -13,23 +15,39 @@ class QuestionChallengePM extends AppObjectPM_1.AppObjectPM {
     constructor(appObject) {
         super(appObject, QuestionChallengePM.type);
         this.onEntityChange = () => {
+            if (!this.baseAppState)
+                return;
             if (!this.questionEntity)
                 return;
+            let slideTextValidationMessage;
+            if (this.baseAppState.slideText.length === 0) {
+                slideTextValidationMessage = exports.SLIDE_TEXT_CANNOT_BE_FALSY;
+            }
             const { gotItRight } = this.questionEntity;
             const answerIds = this.questionEntity.getAllAnswers().map((ans) => ans.id);
             const vm = {
                 gotItRight,
                 answerIds,
                 reviewFeedback: this.questionEntity.reviewFeedback,
-                validationMessage: this.questionEntity.validationMessage,
+                validationMessage: slideTextValidationMessage !== null && slideTextValidationMessage !== void 0 ? slideTextValidationMessage : this.questionEntity.validationMessage,
             };
             this.doUpdateView(vm);
         };
         this.dispose = () => {
-            var _a;
+            var _a, _b;
             super.dispose();
             (_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 = App_1.BaseAppState.get(this.appObjects);
+        if (!this.baseAppState) {
+            this.warn("QuestionChallengePM has been added to an app object that does not have 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);

package/lib/Components/Question/UC/ValidateQuestionChallengeStateUC.d.ts

@@ -0,0 +1,19 @@
+import { AppObject, AppObjectRepo, AppObjectUC } from "../../../AppObject";
+export declare abstract class ValidateQuestionChallengeStateUC extends AppObjectUC {
+    static readonly type = "ValidateQuestionChallengeStateUC";
+    SLIDE_TEXT_CANNOT_BE_FALSY: string;
+    IF_QUESTION_AT_LEAST_TWO_ANSWERS: string;
+    QUESTION_CHALLENGE_NO_CORRECT_ANSWER: string;
+    ANSWER_STRING_CANNOT_BE_0_CHARACTERS: string;
+    FEEDBACK_STRING_CANNOT_BE_LONGER_THAN_200_CHARACTERS: string;
+    ANSWER_STRING_CANNOT_BE_LONGER_THAN_40_CHARACTERS: string;
+    abstract validate(): string | undefined;
+    static get: (appObjects: AppObjectRepo) => ValidateQuestionChallengeStateUC | undefined;
+}
+export declare function makeValidateQuestionChallengeStateUC(appObject: AppObject): ValidateQuestionChallengeStateUC;
+export declare class ValidateQuestionChallengeStateImp extends ValidateQuestionChallengeStateUC {
+    private baseAppState?;
+    private questionEntity?;
+    validate(): string | undefined;
+    constructor(appObject: AppObject);
+}

package/lib/Components/Question/UC/ValidateQuestionChallengeStateUC.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidateQuestionChallengeStateImp = exports.makeValidateQuestionChallengeStateUC = exports.ValidateQuestionChallengeStateUC = void 0;
+const AppObject_1 = require("../../../AppObject");
+const App_1 = require("../../App");
+const Entities_1 = require("../Entities");
+class ValidateQuestionChallengeStateUC extends AppObject_1.AppObjectUC {
+    constructor() {
+        super(...arguments);
+        this.SLIDE_TEXT_CANNOT_BE_FALSY = "Slide text is required.";
+        this.IF_QUESTION_AT_LEAST_TWO_ANSWERS = "A question must have at lest two answers.";
+        this.QUESTION_CHALLENGE_NO_CORRECT_ANSWER = "At least one answer must be correct.";
+        this.ANSWER_STRING_CANNOT_BE_0_CHARACTERS = "Answer text is required.";
+        this.FEEDBACK_STRING_CANNOT_BE_LONGER_THAN_200_CHARACTERS = "Answer feedback may not exceed 200 characters.";
+        this.ANSWER_STRING_CANNOT_BE_LONGER_THAN_40_CHARACTERS = "Answer text may not exceed 40 characters.";
+    }
+}
+exports.ValidateQuestionChallengeStateUC = ValidateQuestionChallengeStateUC;
+ValidateQuestionChallengeStateUC.type = "ValidateQuestionChallengeStateUC";
+ValidateQuestionChallengeStateUC.get = (appObjects) => AppObject_1.getSingletonComponent(ValidateQuestionChallengeStateUC.type, appObjects);
+function makeValidateQuestionChallengeStateUC(appObject) {
+    return new ValidateQuestionChallengeStateImp(appObject);
+}
+exports.makeValidateQuestionChallengeStateUC = makeValidateQuestionChallengeStateUC;
+class ValidateQuestionChallengeStateImp extends ValidateQuestionChallengeStateUC {
+    constructor(appObject) {
+        super(appObject, ValidateQuestionChallengeStateUC.type);
+        this.baseAppState = App_1.BaseAppState.get(this.appObjects);
+        if (!this.baseAppState) {
+            this.warn("ToggleQuestionChallengeAnswerIsCorrectUC has been added to an app object that does not have BaseAppSateEntity");
+            return;
+        }
+        this.questionEntity = Entities_1.QuestionEntity.get(this.appObjects);
+        if (!this.questionEntity) {
+            this.warn("ToggleQuestionChallengeAnswerIsCorrectUC has been added to an app object that does not have QuestionEntity");
+            return;
+        }
+    }
+    validate() {
+        if (!this.baseAppState)
+            return;
+        if (!this.questionEntity)
+            return;
+        if (!this.baseAppState.slideText) {
+            return this.SLIDE_TEXT_CANNOT_BE_FALSY;
+        }
+        if (this.questionEntity.getAllAnswers().length < 2) {
+            return this.IF_QUESTION_AT_LEAST_TWO_ANSWERS;
+        }
+        let emptyAnswerTest = false;
+        let hasCorrect = false;
+        let hasLongFeedback = false;
+        let hasLongText = false;
+        this.questionEntity.getAllAnswers().forEach((ans) => {
+            if (ans.text === "") {
+                emptyAnswerTest = true;
+            }
+            if (ans.text.length > 40) {
+                hasLongText = true;
+            }
+            if (ans.feedbackText.length > 200) {
+                hasLongFeedback = true;
+            }
+            if (ans.isCorrect) {
+                hasCorrect = true;
+            }
+        });
+        if (!hasCorrect) {
+            return this.QUESTION_CHALLENGE_NO_CORRECT_ANSWER;
+        }
+        if (emptyAnswerTest) {
+            return this.ANSWER_STRING_CANNOT_BE_0_CHARACTERS;
+        }
+        if (hasLongFeedback) {
+            return this.FEEDBACK_STRING_CANNOT_BE_LONGER_THAN_200_CHARACTERS;
+        }
+        if (hasLongText) {
+            return this.ANSWER_STRING_CANNOT_BE_LONGER_THAN_40_CHARACTERS;
+        }
+        return;
+    }
+}
+exports.ValidateQuestionChallengeStateImp = ValidateQuestionChallengeStateImp;

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

@@ -5,3 +5,4 @@ export * from "./SetAnswerFeedbackUC";
 export * from "./SetAnswerTextUC";
 export * from "./SubmitQuestionAnswerUC";
 export * from "./ToggleQuestionAnswerIsCorrect";
+export * from "./ValidateQuestionChallengeStateUC";

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

@@ -17,3 +17,4 @@ __exportStar(require("./SetAnswerFeedbackUC"), exports);
 __exportStar(require("./SetAnswerTextUC"), exports);
 __exportStar(require("./SubmitQuestionAnswerUC"), exports);
 __exportStar(require("./ToggleQuestionAnswerIsCorrect"), exports);
+__exportStar(require("./ValidateQuestionChallengeStateUC"), exports);

package/package.json

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