@media-quest/builder 0.0.24 → 0.0.25

package/src/Builder-question.ts

@@ -1,101 +1,102 @@
-import type { BuilderOptionDto } from "./Builder-option";
-import { BuilderOption } from "./Builder-option";
-import { BuilderObject, BuilderObjectId } from "./BuilderObject";
-
-export type BuilderQuestionType =
-    | "select-one"
-    | "select-many"
-    | "text"
-    | "color"
-    | "radio"
-    | "email"
-    | "time"
-    | "checkbox"
-    | "textarea"
-    | "date"
-    | "numeric-range"
-    | "duration";
-
-export interface BuilderQuestionDto {
-    readonly id: BuilderObjectId.QuestionID;
-    _type: BuilderQuestionType;
-    text: string;
-    options: ReadonlyArray<BuilderOptionDto>;
-    prefix: string;
-}
-
-export class BuilderQuestion extends BuilderObject<"builder-question", BuilderQuestionDto> {
-    readonly objectType = "builder-question";
-    id: BuilderObjectId.QuestionID;
-    type: BuilderQuestionType;
-    questionText = "";
-    options: BuilderOption[] = [];
-    prefix = "";
-
-    static create = (type: BuilderQuestionType) => {
-        const id = BuilderObjectId.questionId();
-
-        return new BuilderQuestion({
-            id,
-            _type: type,
-            text: "",
-            options: [],
-            prefix: "",
-        });
-    };
-
-    public static fromJson(dto: BuilderQuestionDto): BuilderQuestion {
-        const question = new BuilderQuestion(dto);
-        return question;
-    }
-
-    private constructor(dto: BuilderQuestionDto) {
-        super(dto);
-        this.id = dto.id as BuilderObjectId.QuestionID;
-        this.type = dto._type;
-        this.questionText = dto.text;
-        this.prefix = dto.prefix;
-        this.options = dto.options.map((o) => BuilderOption.fromJson(o));
-    }
-
-    addOption(label: string, value: number, atIndex = -1) {
-        const option = BuilderOption.create(value, label);
-        if (atIndex >= 0 && atIndex < this.options.length) {
-            this.options.splice(atIndex, 0, option);
-        } else {
-            this.options.push(option);
-        }
-        return option;
-    }
-
-    deleteOption(option: BuilderOption): boolean {
-        const filtered = this.options.filter((o) => o.id !== option.id);
-        const didDelete = filtered.length === this.options.length - 1;
-        this.options = filtered;
-        return didDelete;
-    }
-
-    toJson() {
-        const optionsJson = this.options.map((o) => o.toJson());
-        const dto: BuilderQuestionDto = {
-            id: this.id,
-            prefix: this.prefix,
-            _type: this.type,
-            text: this.questionText,
-            options: optionsJson,
-        };
-        return dto;
-    }
-
-    clone(): BuilderQuestionDto {
-        const cloneId = BuilderObjectId.questionId();
-        const dto = this.toJson();
-        const optionsClone = this.options.map((o) => o.clone());
-        const clonedDto: BuilderQuestionDto = {
-            ...dto,
-            id: cloneId,
-            options: optionsClone,
-        };
-        return clonedDto;
-    }
-}
+import type { BuilderOptionDto } from "./Builder-option";
+import { BuilderOption } from "./Builder-option";
+import { BuilderObject } from "./BuilderObject";
+import { QuestionID } from "./primitives/ID";
+
+export type BuilderQuestionType =
+  | "select-one"
+  | "select-many"
+  | "text"
+  | "color"
+  | "radio"
+  | "email"
+  | "time"
+  | "checkbox"
+  | "textarea"
+  | "date"
+  | "numeric-range"
+  | "duration";
+
+export interface BuilderQuestionDto {
+  readonly id: QuestionID;
+  _type: BuilderQuestionType;
+  text: string;
+  options: ReadonlyArray<BuilderOptionDto>;
+  prefix: string;
+}
+
+export class BuilderQuestion extends BuilderObject<"builder-question", BuilderQuestionDto> {
+  readonly objectType = "builder-question";
+  id: QuestionID;
+  type: BuilderQuestionType;
+  questionText = "";
+  options: BuilderOption[] = [];
+  prefix = "";
+
+  static create = (type: BuilderQuestionType) => {
+    const id = QuestionID.create();
+
+    return new BuilderQuestion({
+      id,
+      _type: type,
+      text: "",
+      options: [],
+      prefix: "",
+    });
+  };
+
+  public static fromJson(dto: BuilderQuestionDto): BuilderQuestion {
+    const question = new BuilderQuestion(dto);
+    return question;
+  }
+
+  private constructor(dto: BuilderQuestionDto) {
+    super(dto);
+    this.id = QuestionID.validateOrCreate(dto.id);
+    this.type = dto._type;
+    this.questionText = dto.text;
+    this.prefix = dto.prefix;
+    this.options = dto.options.map((o) => BuilderOption.fromJson(o));
+  }
+
+  addOption(label: string, value: number, atIndex = -1) {
+    const option = BuilderOption.create(value, label);
+    if (atIndex >= 0 && atIndex < this.options.length) {
+      this.options.splice(atIndex, 0, option);
+    } else {
+      this.options.push(option);
+    }
+    return option;
+  }
+
+  deleteOption(option: BuilderOption): boolean {
+    const filtered = this.options.filter((o) => o.id !== option.id);
+    const didDelete = filtered.length === this.options.length - 1;
+    this.options = filtered;
+    return didDelete;
+  }
+
+  toJson() {
+    const optionsJson = this.options.map((o) => o.toJson());
+    const dto: BuilderQuestionDto = {
+      id: this.id,
+      prefix: this.prefix,
+      _type: this.type,
+      text: this.questionText,
+      options: optionsJson,
+    };
+    return dto;
+  }
+
+  clone(): BuilderQuestionDto {
+    const cloneId = QuestionID.create();
+    const dto = this.toJson();
+    const optionsClone = this.options.map((o) => o.clone());
+    const clonedDto: BuilderQuestionDto = {
+      ...dto,
+      id: cloneId,
+      options: optionsClone,
+    };
+    return clonedDto;
+  }
+}

package/src/Builder-schema.spec.ts

@@ -3,11 +3,11 @@ import { BuilderSchema } from "./Builder-schema";
 import { BuilderPage } from "./Builder-page";
 import type { BuilderTagDto } from "./BuilderTag";
 import { BuilderTag } from "./BuilderTag";
-import type { BuilderObjectId } from "./BuilderObject";
-import { PageID, SchemaID } from "@media-quest/engine";
 import { PagePrefix } from "./primitives/page-prefix";
 import { SchemaPrefix } from "./primitives/schema-prefix";
-import { SumScoreVariable } from "./variable/sum-score";
+
+import { SumScoreVariableDto } from "./variable/sum-score-variable";
+import { OptionID, PageID, QuestionID, SchemaID } from "./primitives/ID";
 
 const tag1: BuilderTagDto = BuilderTag.create("tag1", "This tag is defined in schemaDto1").toJson();
 
@@ -34,7 +34,7 @@ const schemaDto1: BuilderSchemaDto = {
   ],
   pages: [
     {
-      id: PageID.ensure("a".repeat(24)),
+      id: PageID.validateOrCreate("a".repeat(24)),
       _type: "info-page",
       prefix: PagePrefix.fromStringOrThrow("p1"),
       mainText: {
@@ -45,28 +45,28 @@ const schemaDto1: BuilderSchemaDto = {
       },
 
       nextButton: {
-        id: "next-button-text-id" as BuilderObjectId.QuestionOptionID,
+        id: "next-button-text-id" as OptionID,
         label: "Neste",
         value: -1,
       },
       defaultQuestion: {
-        id: "q1" as BuilderObjectId.QuestionID,
+        id: QuestionID.create(),
         prefix: "one-prefix",
         _type: "select-one",
         text: "q1-text",
         options: [
           {
-            id: "opt-nei" as BuilderObjectId.QuestionOptionID,
+            id: "opt-nei" as OptionID,
             value: 0,
             label: "Nei",
           },
           {
-            id: "opt-ja" as BuilderObjectId.QuestionOptionID,
+            id: "opt-ja" as OptionID,
             value: 1,
             label: "Ja",
           },
           {
-            id: "opt-vet-ikke" as BuilderObjectId.QuestionOptionID,
+            id: "opt-vet-ikke" as OptionID,
             value: 9,
             label: "Vet ikke",
           },
@@ -82,7 +82,7 @@ const schemaDto1: BuilderSchemaDto = {
       autoplaySequence: [],
     },
     {
-      id: PageID.ensure("b".repeat(24)),
+      id: PageID.validateOrCreate("b".repeat(24)),
       _type: "multi-select",
       prefix: PagePrefix.fromStringOrThrow("page2-prefix"),
       tags: [tag3.tag],
@@ -93,12 +93,12 @@ const schemaDto1: BuilderSchemaDto = {
         audioFile: false,
       },
       nextButton: {
-        id: "next-button-id-page2" as BuilderObjectId.QuestionOptionID,
+        id: "next-button-id-page2" as OptionID,
         label: "Neste",
         value: -1,
       },
       defaultQuestion: {
-        id: "default-q" as BuilderObjectId.QuestionID,
+        id: QuestionID.validateOrCreate("default-question-id"),
         prefix: "one-prefix",
         _type: "select-one",
         text: "q1",
@@ -106,23 +106,23 @@ const schemaDto1: BuilderSchemaDto = {
       },
       questions: [
         {
-          id: "q1" as BuilderObjectId.QuestionID,
+          id: QuestionID.create(),
           prefix: "one-prefix",
           _type: "select-one",
           text: "q1-text",
           options: [
             {
-              id: "opt-nei" as BuilderObjectId.QuestionOptionID,
+              id: "opt-nei" as OptionID,
               value: 0,
               label: "Nei",
             },
             {
-              id: "opt-ja" as BuilderObjectId.QuestionOptionID,
+              id: "opt-ja" as OptionID,
               value: 1,
               label: "Ja",
             },
             {
-              id: "opt-vet-ikke" as BuilderObjectId.QuestionOptionID,
+              id: "opt-vet-ikke" as OptionID,
               value: 9,
               label: "Vet ikke",
             },
@@ -326,7 +326,7 @@ describe("Builder schema", () => {
     p2.defaultQuestion.addOption("Nei", 0);
 
     const ruleInput = builderSchema.getRuleInput();
-    const ss1: SumScoreVariable = {
+    const ss1: SumScoreVariableDto = {
       label: "ss1",
       varId: "ss1_var_id",
       initialValue: 0,

package/src/Builder-schema.ts

@@ -13,14 +13,16 @@ import type { BuilderTagDto } from "./BuilderTag";
 import { BuilderTag, TagCollection } from "./BuilderTag";
 import { DefaultThemeCompiler } from "./theme/default-theme-compiler";
 import { ImageFile } from "./media-files";
-import { DUtil, SchemaID } from "@media-quest/engine";
+import { DUtil } from "@media-quest/engine";
 import { PagePrefix } from "./primitives/page-prefix";
 import { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
 import { CodeBook } from "./codebook";
-import { PredefinedVariable } from "./variable/mq-variable";
+import { PredefinedVariable } from "./variable/b-variable";
 import { SchemaConfig } from "./schema-config";
 import { CompilerOption, CompilerOutput } from "./builder-compiler";
-import { SumScoreVariable } from "./variable/sum-score";
+
+import { SumScoreVariableDto } from "./variable/sum-score-variable";
+import { SchemaID } from "./primitives/ID";
 
 const U = DUtil;
 
@@ -34,13 +36,13 @@ export interface BuilderSchemaDto {
   readonly baseHeight: number;
   readonly baseWidth: number;
   readonly predefinedVariables?: Array<PredefinedVariable>;
-  readonly sumScoreVariables?: Array<SumScoreVariable>;
+  readonly sumScoreVariables?: ReadonlyArray<SumScoreVariableDto>;
   readonly rules: ReadonlyArray<BuilderRuleDto>;
   readonly tags: ReadonlyArray<BuilderTagDto>;
 }
 
 class SumScoreVariableCollection {
-  private _all: Array<SumScoreVariable> = [];
+  private _all: Array<SumScoreVariableDto> = [];
 }
 
 export class BuilderSchema {
@@ -52,11 +54,11 @@ export class BuilderSchema {
   mainImage: ImageFile | false = false;
   predefinedVariables: PredefinedVariable[] = [];
   private _rules: BuilderRule[] = [];
-  private _sumVariables: SumScoreVariable[] = [];
+  private _sumVariables: SumScoreVariableDto[] = [];
   get rules(): ReadonlyArray<BuilderRule> {
     return [...this._rules];
   }
-  get sumScoreVariables(): ReadonlyArray<SumScoreVariable> {
+  get sumScoreVariables(): ReadonlyArray<SumScoreVariableDto> {
     return [...this._sumVariables];
   }
 
@@ -77,6 +79,7 @@ export class BuilderSchema {
     const schemaPrefix = SchemaPrefix.castOrCreateRandom(dto.prefix);
     const schema = new BuilderSchema(dto.id, dto.name, schemaPrefix);
     const pages = dto.pages.map(BuilderPage.fromJson);
+
     schema._tagCollection.init(dto.tags);
     schema.backgroundColor = dto.backgroundColor;
     schema.baseHeight = dto.baseHeight;
@@ -87,6 +90,8 @@ export class BuilderSchema {
     schema.mainImage = dto.mainImage ?? false;
     const rulesDto = dto.rules ?? [];
     const ruleInput = schema.getRuleInput();
+
+    schema._sumVariables = Array.isArray(dto.sumScoreVariables) ? [...dto.sumScoreVariables] : [];
     schema._rules = rulesDto.map((r) => BuilderRule.fromDto(r, ruleInput));
     return schema;
   }
@@ -106,6 +111,7 @@ export class BuilderSchema {
       rules,
       tags,
       predefinedVariables: this.predefinedVariables,
+      sumScoreVariables: [...this.sumScoreVariables],
       mainImage: this.mainImage,
       prefix: this.prefix.value,
     };
@@ -130,7 +136,7 @@ export class BuilderSchema {
     return newPage;
   }
 
-  addSumScoreVariable(variable: SumScoreVariable) {
+  addSumScoreVariable(variable: SumScoreVariableDto) {
     // TODO VALIDATE.
     this._sumVariables.push({ ...variable });
   }

package/src/Builder-text.spec.ts

@@ -1,24 +1,24 @@
-import type { BuilderTextDto } from "./Builder-text";
-import { BuilderText } from "./Builder-text";
-import type { BuilderObjectId } from "./BuilderObject";
-
-const textDto: BuilderTextDto = {
-    id: "dto1" as BuilderObjectId.TextID,
-    name: "dto1-name",
-    text: "text one",
-    translationRequired: true,
-};
-
-let text1 = BuilderText.create("text one created");
-
-beforeEach(() => {
-    text1 = BuilderText.create("text one created");
-});
-
-describe("Builder Text", () => {
-    test("Can serialize", () => {
-        const instance1 = BuilderText.fromJson(textDto);
-        const json = instance1.toJson();
-        expect(textDto).toStrictEqual(json);
-    });
-});
+import type { BuilderTextDto } from "./Builder-text";
+import { BuilderText } from "./Builder-text";
+import { TextID } from "./primitives/ID";
+
+const textDto: BuilderTextDto = {
+  id: "dto1" as TextID,
+  name: "dto1-name",
+  text: "text one",
+  translationRequired: true,
+};
+
+let text1 = BuilderText.create("text one created");
+
+beforeEach(() => {
+  text1 = BuilderText.create("text one created");
+});
+
+describe("Builder Text", () => {
+  test("Can serialize", () => {
+    const instance1 = BuilderText.fromJson(textDto);
+    const json = instance1.toJson();
+    expect(textDto).toStrictEqual(json);
+  });
+});

package/src/Builder-text.ts

@@ -1,57 +1,57 @@
-import { BuilderObjectId, BuilderObject } from './BuilderObject';
-
-export interface BuilderTextDto {
-  readonly id: BuilderObjectId.TextID;
-  text: string;
-  name: string;
-  translationRequired: boolean;
-}
-
-export class BuilderText extends BuilderObject<'builder-text', BuilderTextDto> {
-  readonly objectType = 'builder-text';
-  id: BuilderObjectId.TextID;
-  text = '';
-  name = '';
-  translateRequired = false;
-  // audio: {id: B}
-  private constructor(dto: BuilderTextDto) {
-    super(dto);
-    this.id = dto.id;
-    this.translateRequired = dto.translationRequired;
-    this.name = dto.name;
-    this.text = dto.text;
-  }
-
-  public static create(name: string) {
-    const id = BuilderObjectId.textId();
-    const dto: BuilderTextDto = {
-      id,
-      name,
-      text: '',
-      translationRequired: false
-    };
-    const instance = new BuilderText(dto);
-    return instance;
-  }
-  public static fromJson(dto: BuilderTextDto) {
-    const instance = new BuilderText(dto);
-    return instance;
-  }
-
-  clone(): BuilderTextDto {
-    const newId = BuilderObjectId.textId();
-    const dto = this.toJson();
-    const withNewId: BuilderTextDto = { ...dto, id: newId };
-    return withNewId;
-  }
-
-  toJson(): BuilderTextDto {
-    const dto: BuilderTextDto = {
-      id: this.id,
-      name: this.name,
-      text: this.text,
-      translationRequired: this.translateRequired
-    };
-    return dto;
-  }
-}
+import { BuilderObject } from "./BuilderObject";
+import { TextID } from "./primitives/ID";
+
+export interface BuilderTextDto {
+  readonly id: TextID;
+  text: string;
+  name: string;
+  translationRequired: boolean;
+}
+
+export class BuilderText extends BuilderObject<"builder-text", BuilderTextDto> {
+  readonly objectType = "builder-text";
+  id: TextID;
+  text = "";
+  name = "";
+  translateRequired = false;
+  // audio: {id: B}
+  private constructor(dto: BuilderTextDto) {
+    super(dto);
+    this.id = dto.id;
+    this.translateRequired = dto.translationRequired;
+    this.name = dto.name;
+    this.text = dto.text;
+  }
+
+  public static create(name: string) {
+    const id = TextID.create();
+    const dto: BuilderTextDto = {
+      id,
+      name,
+      text: "",
+      translationRequired: false,
+    };
+    const instance = new BuilderText(dto);
+    return instance;
+  }
+  public static fromJson(dto: BuilderTextDto) {
+    const instance = new BuilderText(dto);
+    return instance;
+  }
+
+  clone(): BuilderTextDto {
+    const dto = this.toJson();
+    const withNewId: BuilderTextDto = { ...dto, id: TextID.create() };
+    return withNewId;
+  }
+
+  toJson(): BuilderTextDto {
+    const dto: BuilderTextDto = {
+      id: this.id,
+      name: this.name,
+      text: this.text,
+      translationRequired: this.translateRequired,
+    };
+    return dto;
+  }
+}

package/src/BuilderObject.ts

@@ -1,61 +1,29 @@
-import { DUtil } from "@media-quest/engine";
-
-const U = DUtil;
-/**
- * Builder objects are complex objects that are embedded inside
- * a Builder-schema, and needs to be serialized to json. Often these objects
- * are used in collections, and that is why most of them need an id.
- */
-type BuilderObjectType =
-  | "builder-page"
-  | "builder-question-option"
-  | "builder-question"
-  | "builder-main-text"
-  | "builder-text"
-  | "builder-rule"
-  | "builder-tag"
-  | "builder-condition"
-  | "builder-variable"
-  | "builder-condition-group";
-
-export namespace BuilderObjectId {
-  export type QuestionOptionID = string & { __OPTION__ID__: true };
-  export type QuestionID = string & { __QUESTION__ID__: true };
-  export type TextID = string & { __TEXT__ID__: true };
-  export type MainTextID = string & { __MAIN__TEXT__ID__: true };
-  export type TagId = string & { __TAG__ID__: true };
-  export const createTagId = (): TagId => {
-    return createId("builder-tag") as TagId;
-  };
-
-  export const mainTextId = (): MainTextID => {
-    return createId("builder-main-text") as MainTextID;
-  };
-  export const textId = (): TextID => {
-    return createId("builder-text") as TextID;
-  };
-
-  export const questionOptionId = (): QuestionOptionID => {
-    return createId("builder-question-option") as QuestionOptionID;
-  };
-  export const questionId = (): QuestionID => {
-    return createId("builder-question") as QuestionID;
-  };
-
-  const createId = (type: BuilderObjectType): string => {
-    const id = U.randomString(24);
-    return type + "-" + id;
-  };
-}
-
-export abstract class BuilderObject<T extends BuilderObjectType, Dto extends {}> {
-  // abstract readonly id: string;
-  abstract readonly objectType: T;
-  abstract toJson(): Dto;
-  abstract clone(): Dto;
-  protected readonly originalDto: Dto;
-  protected constructor(dto: Dto) {
-    this.originalDto = dto;
-    // this.objectId = dto.objectId;
-  }
-}
+/**
+ * Builder objects are complex objects that are embedded inside
+ * a Builder-schema, and needs to be serialized to json. Often these objects
+ * are used in collections, and that is why most of them need an id.
+ */
+type BuilderObjectType =
+  | "builder-page"
+  | "builder-question-option"
+  | "builder-question"
+  | "builder-main-text"
+  | "builder-text"
+  | "builder-rule"
+  | "builder-tag"
+  | "builder-sum-score-variable"
+  | "builder-condition"
+  | "builder-variable"
+  | "builder-condition-group";
+
+export abstract class BuilderObject<T extends BuilderObjectType, Dto extends {}> {
+  // abstract readonly id: string;
+  abstract readonly objectType: T;
+  abstract toJson(): Dto;
+  abstract clone(): Dto;
+  protected readonly originalDto: Dto;
+  protected constructor(dto: Dto) {
+    this.originalDto = dto;
+    // this.objectId = dto.objectId;
+  }
+}