@media-quest/builder 0.0.6 → 0.0.8

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@media-quest/builder",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Builder library for Media-quest schemas",
   "main": "dist/public-api.js",
   "module": "dist/public-api.mjs",
   "types": "dist/public-api.d.ts",
   "license": "MIT",
   "scripts": {
-    "check": "tsc --watch --noEmit",
+    "tsc:check:builder": "tsc --watch --noEmit",
     "clean": "rimraf dist",
     "build": "npm run clean && tsup src/public-api.ts --sourcemap inline --format cjs,esm --dts",
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@media-quest/engine": "0.0.6"
+    "@media-quest/engine": "0.0.8"
   }
 }

package/src/Builder-page.spec.ts

@@ -3,7 +3,8 @@ import type { BuilderPageDto } from "./Builder-page";
 import type { BuilderQuestionDto } from "./Builder-question";
 import { BuilderQuestion } from "./Builder-question";
 import type { BuilderObjectId } from "./BuilderObject";
-import { DUtil } from "@media-quest/engine";
+import { DUtil, PageID } from "@media-quest/engine";
+import { PagePrefix, SchemaPrefix } from "./prefix";
 
 const U = DUtil;
 const deleteIdsFromPage = (page: BuilderPageDto) => {
@@ -19,6 +20,7 @@ const deleteIdsFromPage = (page: BuilderPageDto) => {
   return page;
 };
 
+const pxx = PagePrefix.fromStringOrThrow("pxx");
 const questionPageDto: BuilderPageDto = {
   _type: "question",
   autoplaySequence: [],
@@ -58,8 +60,9 @@ const questionPageDto: BuilderPageDto = {
     ],
     _type: "select-one",
   },
-  id: "p1" as BuilderObjectId.PageID,
-  prefix: "",
+  // id: "p1" as BuilderObjectId.PageID,
+  id: PageID.create(),
+  prefix: PagePrefix.fromStringOrThrow("pxx"),
   questions: [],
 };
 
@@ -86,8 +89,8 @@ const multiQuestionPageDto: BuilderPageDto = {
     value: -1,
   },
 
-  id: "p2" as BuilderObjectId.PageID,
-  prefix: "",
+  id: PageID.create(),
+  prefix: PagePrefix.fromStringOrThrow("pxx"),
   questions: [
     {
       id: "q3" as BuilderObjectId.QuestionID,
@@ -140,10 +143,10 @@ const multiQuestionPageDto: BuilderPageDto = {
   ],
 };
 
-let page = BuilderPage.create("info-page", "a");
+let page = BuilderPage.create("info-page", PagePrefix.fromStringOrThrow("a"));
 
 beforeEach(() => {
-  page = BuilderPage.create("info-page", "a");
+  page = BuilderPage.create("info-page", PagePrefix.fromStringOrThrow("a"));
 });
 
 describe("Builder Page", () => {
@@ -190,7 +193,7 @@ describe("Builder Page", () => {
     expect(q3.type).toBe("email");
   });
   test("Can clone a page and everything except id is equal ", () => {
-    const page1 = BuilderPage.create("info-page", "as");
+    const page1 = BuilderPage.create("info-page", PagePrefix.fromStringOrThrow("as"));
     const clone1 = BuilderPage.fromJson(page1.clone());
     const page1Json = deleteIdsFromPage(page1.clone());
     const clone1Json = deleteIdsFromPage(page1.clone());
@@ -209,7 +212,7 @@ describe("Builder Page", () => {
     expect(page3Json).toStrictEqual(clone3Json);
   });
   test("Can clone a page and no id is equal", () => {
-    const page1 = BuilderPage.create("info-page", "as");
+    const page1 = BuilderPage.create("info-page", pxx);
     const clone1 = BuilderPage.fromJson(page1.clone());
     expect(page1.id).not.toBe(clone1.id);
 
@@ -243,7 +246,7 @@ describe("Builder Page", () => {
     testDtoIds(multiQuestionPageDto);
   });
   test("Can insert a new Question at index", () => {
-    const page1 = BuilderPage.create("form", "as");
+    const page1 = BuilderPage.create("form", pxx);
     const q1 = page1.addQuestion("select-one");
     const q2 = page1.addQuestion("select-many");
     expect(page1.questions.length).toBe(3);
@@ -256,7 +259,7 @@ describe("Builder Page", () => {
     expect(page1.questions[1]).toBe(q1Clone);
   });
   test("Can not  insert a duplicate question", () => {
-    const page1 = BuilderPage.create("form", "as");
+    const page1 = BuilderPage.create("form", pxx);
     const q1 = page1.addQuestion("select-one");
     expect(page1.questions.length).toBe(2);
     expect(page1.questions[1]).toBe(q1);
@@ -266,7 +269,7 @@ describe("Builder Page", () => {
   });
 
   test("Can move a question", () => {
-    const page1 = BuilderPage.create("form", "as1");
+    const page1 = BuilderPage.create("form", pxx);
     const q1 = page1.addQuestion("select-many");
     const q2 = page1.addQuestion("select-one");
     const q3 = page1.addQuestion("select-one");
@@ -285,7 +288,8 @@ describe("Builder Page", () => {
   });
 
   test("Can not move a question that is not in questions-array", () => {
-    const page1 = BuilderPage.create("form", "as1");
+    const prefix = PagePrefix.fromStringOrThrow("as1");
+    const page1 = BuilderPage.create("form", prefix);
     const q1 = page1.addQuestion("select-many");
     const q2 = page1.addQuestion("select-one");
     expect(page1.questions.length).toBe(3);
@@ -295,11 +299,13 @@ describe("Builder Page", () => {
     expect(m1).toBe(false);
   });
   test("Can get all rule-variables.", () => {
-    const page = BuilderPage.create("question", "as1");
+    const prefix = PagePrefix.fromStringOrThrow("as1");
+    const page = BuilderPage.create("question", prefix);
     page.mainText.text = "Hva heter du?";
     page.defaultQuestion.addOption("Ja", 1);
     page.defaultQuestion.addOption("Nei", 0);
-    const variables = page.getQuestionVariables("ax", 1);
+    const shemaPrefix = SchemaPrefix.fromValueOrThrow("ax");
+    const variables = page.getQuestionVariables(shemaPrefix, 1);
     const first = variables[0];
     expect(variables.length).toBe(1);
     expect(first.options.length).toBe(2);

package/src/Builder-page.ts

@@ -1,6 +1,6 @@
 import type { BuilderQuestionDto, BuilderQuestionType } from "./Builder-question";
 import { BuilderQuestion } from "./Builder-question";
-import { BuilderObject, BuilderObjectId } from "./BuilderObject";
+import { BuilderObject } from "./BuilderObject";
 import type { BuilderOptionDto } from "./Builder-option";
 import { BuilderOption } from "./Builder-option";
 import type { BuilderMainVideoDto } from "./BuilderMainVideoDto";
@@ -8,14 +8,15 @@ import type { BuilderMainImageDto } from "./BuilderMainImageDto";
 import type { BuilderMainTextDto } from "./BuilderMainText";
 import { BuilderMainText } from "./BuilderMainText";
 import { BuilderVariableOption, QuestionVariable } from "./rulebuilder/RuleVariable";
-import { DUtil } from "@media-quest/engine";
+import { DUtil, PageID } from "@media-quest/engine";
+import { PagePrefix, PagePrefixValue, VarID, SchemaPrefix, SchemaPrefixValue } from "./prefix";
 
 const U = DUtil;
 export type BuilderPageType = "info-page" | "question" | "multi-select" | "form";
 
 export interface BuilderPageDto {
-  readonly id: BuilderObjectId.PageID;
-  prefix: string;
+  readonly id: PageID;
+  readonly prefix: PagePrefixValue;
   _type: BuilderPageType;
   mainText: BuilderMainTextDto;
   nextButton: BuilderOptionDto;
@@ -28,9 +29,9 @@ export interface BuilderPageDto {
 
 export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
   readonly objectType: "builder-page" = "builder-page";
-  readonly id: BuilderObjectId.PageID;
+  readonly id: PageID;
   private _pageType: BuilderPageType;
-  private _prefix = "";
+  private _prefix: PagePrefix;
   private _questions: Array<BuilderQuestion> = [];
   private readonly _tags: Set<string>;
   private _backgroundColor = "#FFFFFF";
@@ -39,8 +40,8 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
   mainText: BuilderMainText;
   nextButton = BuilderOption.create(-1, "Neste");
 
-  public static create(type: BuilderPageType, _prefix: string) {
-    const id = BuilderObjectId.pageId();
+  public static create(type: BuilderPageType, _prefix: PagePrefixValue) {
+    const id = PageID.create();
     const mainTextDto: BuilderMainTextDto = {
       text: "",
       audioFile: false,
@@ -49,6 +50,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     };
     const nextButtonDto = BuilderOption.create(-1, "page-next-button-text").toJson();
     const defaultQuestionDto = BuilderQuestion.create("select-one").toJson();
+
     const dto: BuilderPageDto = {
       _type: type,
       autoplaySequence: [],
@@ -56,7 +58,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       id,
       nextButton: nextButtonDto,
       mainText: mainTextDto,
-      prefix: "",
+      prefix: _prefix,
       questions: [],
       tags: [],
     };
@@ -73,7 +75,8 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     super(dto);
     this.id = dto.id;
     this._pageType = dto._type;
-    this._prefix = dto.prefix;
+    const prefixInstance = PagePrefix.castOrCreateRandom(dto.prefix);
+    this._prefix = prefixInstance;
     this.mainText = BuilderMainText.fromJson(dto.mainText);
     this.nextButton = BuilderOption.fromJson(dto.nextButton);
     this.defaultQuestion = BuilderQuestion.fromJson(dto.defaultQuestion);
@@ -160,19 +163,19 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     this.updateRows();
   }
 
-  getQuestionVariables(modulePrefix: string, pageNumber: number): ReadonlyArray<QuestionVariable> {
+  getQuestionVariables(modulePrefix: SchemaPrefix, pageNumber: number): ReadonlyArray<QuestionVariable> {
     const variables: QuestionVariable[] = [];
 
     if (this._pageType === "question") {
       const pagePrefix = this.prefix;
-      const id = modulePrefix ? modulePrefix + "_" + pagePrefix : pagePrefix;
+      const varId = VarID.create(modulePrefix.value, pagePrefix);
       const label = this.mainText.text;
       const op = this.defaultQuestion.options.map((o) => {
         const label = o.label;
         const value = o.value;
         return new BuilderVariableOption(label, value);
       });
-      const singleVar = new QuestionVariable(id, label, op, pageNumber);
+      const singleVar = new QuestionVariable(varId, label, op, pageNumber);
       variables.push(singleVar);
     }
     return variables;
@@ -186,11 +189,11 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
   }
 
   get prefix() {
-    return this._prefix;
+    return this._prefix.value;
   }
 
-  set prefix(value: string) {
-    this._prefix = value;
+  set prefix(value: PagePrefixValue) {
+    this._prefix.value = value;
   }
 
   toJson(): BuilderPageDto {
@@ -205,7 +208,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
       nextButton,
       id: this.id,
       tags: [...this.tags],
-      prefix: this._prefix,
+      prefix: this._prefix.value,
       defaultQuestion: this.defaultQuestion.toJson(),
       questions,
     };
@@ -221,7 +224,7 @@ export class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     const mainTextClone = JSON.parse(JSON.stringify(this.mainText));
     // const pagesClone = this
     const questionsClone = this.questions.map((q) => q.clone());
-    const newId = BuilderObjectId.pageId();
+    const newId = PageID.create();
     const clone: BuilderPageDto = {
       ...dto,
       id: newId,