@media-quest/builder 0.0.22 → 0.0.24

package/src/BuilderMainText.ts

@@ -1,81 +1,81 @@
-import { BuilderObject } from "./BuilderObject";
-import { AudioFile } from "./media-files";
-
-export interface BuilderMainTextDto {
-    text: string;
-    audioFile: AudioFile | false;
-    autoplay: boolean;
-    autoplayDelay: number;
-}
-
-export class BuilderMainText extends BuilderObject<"builder-main-text", BuilderMainTextDto> {
-    readonly objectType: "builder-main-text" = "builder-main-text";
-    autoplay = false;
-    private _audioFile: AudioFile | false = false;
-    autoplayDelay = 0;
-
-    text = "";
-
-    private constructor(dto: BuilderMainTextDto) {
-        super(dto);
-        this._audioFile = dto.audioFile ?? false;
-        this.autoplay = dto.autoplay ?? false;
-        this.autoplayDelay = dto.autoplayDelay ?? 0;
-        this.text = dto.text ?? "";
-    }
-
-    get autoplayDelayInSeconds() {
-        const delay = this.autoplayDelay;
-        const s = delay / 1000;
-        const formatted = s.toFixed(1);
-        return formatted;
-    }
-
-    get durationTag() {
-        if (!this.audioFile) return "";
-        // console.log(this.audioFile.duration);
-        const dur = this.audioFile.duration.toFixed(1);
-        return "dur " + dur + " s";
-    }
-
-    static fromJson(dto: BuilderMainTextDto): BuilderMainText {
-        const mainText = new BuilderMainText(dto);
-        return mainText;
-    }
-
-    static create = () => {
-        const dto: BuilderMainTextDto = {
-            autoplay: false,
-            autoplayDelay: 0,
-            audioFile: false,
-            text: "",
-        };
-        return new BuilderMainText(dto);
-    };
-
-    clone(): BuilderMainTextDto {
-        const dto = this.toJson();
-        const clone = JSON.parse(JSON.stringify(dto));
-        return clone;
-    }
-
-    toJson(): BuilderMainTextDto {
-        const dto: BuilderMainTextDto = {
-            text: this.text,
-            audioFile: this.audioFile,
-            autoplay: this.autoplay,
-            autoplayDelay: this.autoplayDelay,
-        };
-        return dto;
-    }
-    get audioFile(): AudioFile | false {
-        return this._audioFile;
-    }
-    set audioFile(audioFile: AudioFile | false) {
-        if (audioFile === false) {
-            this.autoplayDelay = 0;
-            this.autoplay = false;
-        }
-        this._audioFile = audioFile;
-    }
-}
+import { BuilderObject } from "./BuilderObject";
+import { AudioFile } from "./media-files";
+
+export interface BuilderMainTextDto {
+    text: string;
+    audioFile: AudioFile | false;
+    autoplay: boolean;
+    autoplayDelay: number;
+}
+
+export class BuilderMainText extends BuilderObject<"builder-main-text", BuilderMainTextDto> {
+    readonly objectType: "builder-main-text" = "builder-main-text";
+    autoplay = false;
+    private _audioFile: AudioFile | false = false;
+    autoplayDelay = 0;
+
+    text = "";
+
+    private constructor(dto: BuilderMainTextDto) {
+        super(dto);
+        this._audioFile = dto.audioFile ?? false;
+        this.autoplay = dto.autoplay ?? false;
+        this.autoplayDelay = dto.autoplayDelay ?? 0;
+        this.text = dto.text ?? "";
+    }
+
+    get autoplayDelayInSeconds() {
+        const delay = this.autoplayDelay;
+        const s = delay / 1000;
+        const formatted = s.toFixed(1);
+        return formatted;
+    }
+
+    get durationTag() {
+        if (!this.audioFile) return "";
+        // console.log(this.audioFile.duration);
+        const dur = this.audioFile.duration.toFixed(1);
+        return "dur " + dur + " s";
+    }
+
+    static fromJson(dto: BuilderMainTextDto): BuilderMainText {
+        const mainText = new BuilderMainText(dto);
+        return mainText;
+    }
+
+    static create = () => {
+        const dto: BuilderMainTextDto = {
+            autoplay: false,
+            autoplayDelay: 0,
+            audioFile: false,
+            text: "",
+        };
+        return new BuilderMainText(dto);
+    };
+
+    clone(): BuilderMainTextDto {
+        const dto = this.toJson();
+        const clone = JSON.parse(JSON.stringify(dto));
+        return clone;
+    }
+
+    toJson(): BuilderMainTextDto {
+        const dto: BuilderMainTextDto = {
+            text: this.text,
+            audioFile: this.audioFile,
+            autoplay: this.autoplay,
+            autoplayDelay: this.autoplayDelay,
+        };
+        return dto;
+    }
+    get audioFile(): AudioFile | false {
+        return this._audioFile;
+    }
+    set audioFile(audioFile: AudioFile | false) {
+        if (audioFile === false) {
+            this.autoplayDelay = 0;
+            this.autoplay = false;
+        }
+        this._audioFile = audioFile;
+    }
+}

package/src/BuilderMainVideoDto.ts

@@ -1,10 +1,10 @@
-import { VideoFile } from "./media-files";
-
-export interface BuilderMainVideoDto {
-  readonly kind: "main-video";
-  readonly file: VideoFile;
-  mode: "autoplay" | "required" | "optional" | "gif-mode";
-  preDelay: number;
-  volume: number;
-  controls: boolean;
-}
+import { VideoFile } from "./media-files";
+
+export interface BuilderMainVideoDto {
+  readonly kind: "main-video";
+  readonly file: VideoFile;
+  mode: "autoplay" | "required" | "optional" | "gif-mode";
+  preDelay: number;
+  volume: number;
+  controls: boolean;
+}

package/src/BuilderObject.ts

@@ -1,61 +1,61 @@
-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;
-  }
-}
+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;
+  }
+}

package/src/BuilderTag.ts

@@ -1,97 +1,97 @@
-import { BuilderObjectId, BuilderObject } from './BuilderObject';
-
-export interface BuilderTagDto {
-  readonly id: BuilderObjectId.TagId;
-  readonly tag: string;
-  readonly description: string;
-}
-
-export class BuilderTag extends BuilderObject<'builder-tag', BuilderTagDto> {
-  readonly objectType: 'builder-tag' = 'builder-tag';
-  readonly id: BuilderObjectId.TagId;
-  tagText = '';
-  tagDescription = '';
-  public static readonly MAX_LENGTH = 20;
-  public static readonly MIN_LENGTH = 1;
-
-  public static readonly create = (tag: string, description: string = '') => {
-    const id = BuilderObjectId.createTagId();
-    const dto: BuilderTagDto = {
-      id,
-      tag,
-      description
-    };
-    return new BuilderTag(dto);
-  };
-  public static readonly fromDto = (dto: BuilderTagDto) => {
-    return new BuilderTag(dto);
-  };
-  protected constructor(dto: BuilderTagDto) {
-    const id = dto.id ?? BuilderObjectId.createTagId();
-    const withId = { ...dto, id };
-    super(withId);
-    this.id = id;
-    this.tagText = dto.tag ?? '';
-    this.tagDescription = dto.description ?? '';
-  }
-  clone(): BuilderTagDto {
-    return this.toJson();
-  }
-
-  toJson(): BuilderTagDto {
-    return { tag: this.tagText, description: this.tagDescription, id: this.id };
-  }
-}
-
-export class TagCollection implements Iterable<BuilderTag> {
-  private readonly _tags = new Set<BuilderTag>();
-  public static readonly create = () => {
-    return new TagCollection([]);
-  };
-
-  [Symbol.iterator]() {
-    const list = [...this._tags];
-    return list[Symbol.iterator]();
-  }
-  private constructor(initialTags: ReadonlyArray<BuilderTag>) {
-    initialTags.forEach(tag => {
-      this._tags.add(tag);
-    });
-  }
-
-  init(tags: ReadonlyArray<BuilderTagDto>) {
-    const dtoList: ReadonlyArray<BuilderTagDto> = Array.isArray(tags)
-      ? tags
-      : [];
-    const all = dtoList.map(BuilderTag.fromDto);
-    all.forEach(tag => {
-      this._tags.add(tag);
-    });
-  }
-
-  add(tag: BuilderTag) {
-    this._tags.add(tag);
-  }
-
-  /**
-   * Delete this tag from collection;
-   * @param tag
-   */
-  delete(tag: BuilderTag) {
-    this._tags.delete(tag);
-  }
-
-  toJson(): ReadonlyArray<BuilderTagDto> {
-    const list = [...this._tags];
-    const dtoList = list.map(t => t.toJson());
-    return dtoList;
-  }
-
-  deleteAll(tags: Iterable<BuilderTag>) {
-    const l = tags[Symbol.iterator]();
-    const asList = [...tags];
-    asList.forEach(t => {
-      this.delete(t);
-    });
-  }
-}
+import { BuilderObjectId, BuilderObject } from './BuilderObject';
+
+export interface BuilderTagDto {
+  readonly id: BuilderObjectId.TagId;
+  readonly tag: string;
+  readonly description: string;
+}
+
+export class BuilderTag extends BuilderObject<'builder-tag', BuilderTagDto> {
+  readonly objectType: 'builder-tag' = 'builder-tag';
+  readonly id: BuilderObjectId.TagId;
+  tagText = '';
+  tagDescription = '';
+  public static readonly MAX_LENGTH = 20;
+  public static readonly MIN_LENGTH = 1;
+
+  public static readonly create = (tag: string, description: string = '') => {
+    const id = BuilderObjectId.createTagId();
+    const dto: BuilderTagDto = {
+      id,
+      tag,
+      description
+    };
+    return new BuilderTag(dto);
+  };
+  public static readonly fromDto = (dto: BuilderTagDto) => {
+    return new BuilderTag(dto);
+  };
+  protected constructor(dto: BuilderTagDto) {
+    const id = dto.id ?? BuilderObjectId.createTagId();
+    const withId = { ...dto, id };
+    super(withId);
+    this.id = id;
+    this.tagText = dto.tag ?? '';
+    this.tagDescription = dto.description ?? '';
+  }
+  clone(): BuilderTagDto {
+    return this.toJson();
+  }
+
+  toJson(): BuilderTagDto {
+    return { tag: this.tagText, description: this.tagDescription, id: this.id };
+  }
+}
+
+export class TagCollection implements Iterable<BuilderTag> {
+  private readonly _tags = new Set<BuilderTag>();
+  public static readonly create = () => {
+    return new TagCollection([]);
+  };
+
+  [Symbol.iterator]() {
+    const list = [...this._tags];
+    return list[Symbol.iterator]();
+  }
+  private constructor(initialTags: ReadonlyArray<BuilderTag>) {
+    initialTags.forEach(tag => {
+      this._tags.add(tag);
+    });
+  }
+
+  init(tags: ReadonlyArray<BuilderTagDto>) {
+    const dtoList: ReadonlyArray<BuilderTagDto> = Array.isArray(tags)
+      ? tags
+      : [];
+    const all = dtoList.map(BuilderTag.fromDto);
+    all.forEach(tag => {
+      this._tags.add(tag);
+    });
+  }
+
+  add(tag: BuilderTag) {
+    this._tags.add(tag);
+  }
+
+  /**
+   * Delete this tag from collection;
+   * @param tag
+   */
+  delete(tag: BuilderTag) {
+    this._tags.delete(tag);
+  }
+
+  toJson(): ReadonlyArray<BuilderTagDto> {
+    const list = [...this._tags];
+    const dtoList = list.map(t => t.toJson());
+    return dtoList;
+  }
+
+  deleteAll(tags: Iterable<BuilderTag>) {
+    const l = tags[Symbol.iterator]();
+    const asList = [...tags];
+    asList.forEach(t => {
+      this.delete(t);
+    });
+  }
+}

package/src/builder-compiler.ts

@@ -0,0 +1,14 @@
+import { SchemaDto } from "@media-quest/engine";
+import { Codebook } from "./codebook";
+import { SchemaConfig } from "./schema-config";
+
+export interface CompilerOutput {
+  schema: SchemaDto;
+  codebook: Codebook;
+  schemaConfig: SchemaConfig;
+}
+
+export interface CompilerOption {
+  blockAutoplayQuestion: boolean;
+  blockAutoplayVideo: boolean;
+}

package/src/codebook.ts

@@ -1,72 +1,72 @@
-import { BuilderPageDto } from "./Builder-page";
-import { BuilderSchemaDto } from "./Builder-schema";
-import { PageVariable, PredefinedVariable } from "./mq-variable";
-
-export interface Codebook {
-  readonly predefinedVariables: ReadonlyArray<PredefinedVariable>;
-  readonly pageVariables: ReadonlyArray<PageVariable>;
-}
-
-const fromPage = (
-  page: BuilderPageDto,
-  pagePosition: number,
-  modulePrefix: string,
-): PageVariable[] => {
-  const variables: PageVariable[] = [];
-
-  if (page._type !== "question") {
-    // TODO Implement form field variables
-    return [];
-  }
-
-  const options: PageVariable["options"] = page.defaultQuestion.options.map((o) => {
-    return { value: o.value, label: o.label };
-  });
-
-  const variable: PageVariable = {
-    kind: "numeric-variable",
-    label: page.mainText.text,
-    options,
-    modulePrefix,
-    origin: "question",
-    pageId: page.id,
-    pagePosition,
-    pagePrefix: page.prefix,
-    varId: modulePrefix + "_" + page.prefix,
-  };
-
-  variables.push(variable);
-
-  return variables;
-};
-
-/**
- * Converts a list of pages into a list of question-variables
- * @param pages
- * @param modulePrefix
- */
-const getPageVariablesFromPages = (
-  pages: BuilderPageDto[],
-  modulePrefix: string,
-): PageVariable[] => {
-  const variables: PageVariable[] = [];
-  pages.forEach((page, index) => {
-    const pageVariables = fromPage(page, index, modulePrefix);
-    variables.push(...pageVariables);
-  });
-  return variables;
-};
-
-const fromSchema = (schema: BuilderSchemaDto): Codebook => {
-  const modulePrefix = schema.prefix;
-  const pageVariables = getPageVariablesFromPages(schema.pages, modulePrefix);
-  const vs = schema.predefinedVariables;
-  const predefinedVariables: PredefinedVariable[] = vs ? [...vs] : [];
-  return { pageVariables, predefinedVariables };
-};
-
-export const _CodeBook = {
-  fromSchema,
-} as const;
-
-export const CodeBook = Object.freeze(_CodeBook);
+import { BuilderPageDto } from "./Builder-page";
+import { BuilderSchemaDto } from "./Builder-schema";
+import { PageVariable, PredefinedVariable } from "./variable/mq-variable";
+
+export interface Codebook {
+  readonly predefinedVariables: ReadonlyArray<PredefinedVariable>;
+  readonly pageVariables: ReadonlyArray<PageVariable>;
+}
+
+const fromPage = (
+  page: BuilderPageDto,
+  pagePosition: number,
+  modulePrefix: string,
+): PageVariable[] => {
+  const variables: PageVariable[] = [];
+
+  if (page._type !== "question") {
+    // TODO Implement form field variables
+    return [];
+  }
+
+  const options: PageVariable["options"] = page.defaultQuestion.options.map((o) => {
+    return { value: o.value, label: o.label };
+  });
+
+  const variable: PageVariable = {
+    kind: "numeric-variable",
+    label: page.mainText.text,
+    options,
+    modulePrefix,
+    origin: "question",
+    pageId: page.id,
+    pagePosition,
+    pagePrefix: page.prefix,
+    varId: modulePrefix + "_" + page.prefix,
+  };
+
+  variables.push(variable);
+
+  return variables;
+};
+
+/**
+ * Converts a list of pages into a list of question-variables
+ * @param pages
+ * @param modulePrefix
+ */
+const getPageVariablesFromPages = (
+  pages: BuilderPageDto[],
+  modulePrefix: string,
+): PageVariable[] => {
+  const variables: PageVariable[] = [];
+  pages.forEach((page, index) => {
+    const pageVariables = fromPage(page, index, modulePrefix);
+    variables.push(...pageVariables);
+  });
+  return variables;
+};
+
+const fromSchema = (schema: BuilderSchemaDto): Codebook => {
+  const modulePrefix = schema.prefix;
+  const pageVariables = getPageVariablesFromPages(schema.pages, modulePrefix);
+  const vs = schema.predefinedVariables;
+  const predefinedVariables: PredefinedVariable[] = vs ? [...vs] : [];
+  return { pageVariables, predefinedVariables };
+};
+
+export const _CodeBook = {
+  fromSchema,
+} as const;
+
+export const CodeBook = Object.freeze(_CodeBook);