@media-quest/builder 0.0.24 → 0.0.25

package/src/BuilderTag.ts

@@ -1,97 +1,96 @@
-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 { BuilderObject } from "./BuilderObject";
+import { TagID } from "./primitives/ID";
+
+export interface BuilderTagDto {
+  readonly id: TagID;
+  readonly tag: string;
+  readonly description: string;
+}
+
+export class BuilderTag extends BuilderObject<"builder-tag", BuilderTagDto> {
+  readonly objectType: "builder-tag" = "builder-tag";
+  readonly id: 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 = TagID.create();
+    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 = TagID.validateOrCreate(dto.id);
+    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/codebook.ts

@@ -1,72 +1,72 @@
-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);
+import { BuilderPageDto } from "./Builder-page";
+import { BuilderSchemaDto } from "./Builder-schema";
+import { PageVariable, PredefinedVariable } from "./variable/b-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);

package/src/primitives/ID.spec.ts

@@ -0,0 +1,39 @@
+import { PageID, SchemaID } from "./ID";
+
+describe("ID Functions work", () => {
+  //Generate test for schema prefix
+  test("SCHEMA_ID isFunction works", () => {
+    const id = SchemaID.create();
+    expect(SchemaID.is(id)).toBe(true);
+    expect(SchemaID.is("")).toBe(false);
+    expect(SchemaID.is("a")).toBe(false);
+    expect(SchemaID.is("a".repeat(10))).toBe(true);
+    expect(SchemaID.is("a".repeat(9))).toBe(false);
+  });
+  test("SCHEMA_ID ensure works", () => {
+    const id = SchemaID.create();
+    expect(SchemaID.validateOrCreate(id)).toBe(id);
+    expect(SchemaID.validateOrCreate("")).not.toBe("");
+    expect(SchemaID.validateOrCreate("")).not.toBe("a");
+    expect(SchemaID.validateOrCreate("a".repeat(10))).toBe("a".repeat(10));
+    expect(SchemaID.validateOrCreate("a".repeat(9))).not.toBe("a".repeat(9));
+    expect(SchemaID.validateOrCreate("ABcdefghigKLML")).toBe("ABcdefghigKLML");
+  });
+  test("PageID isFunction works", () => {
+    const id = PageID.create();
+    expect(PageID.is(id)).toBe(true);
+    expect(PageID.is("")).toBe(false);
+    expect(PageID.is("a")).toBe(false);
+    expect(PageID.is("a".repeat(10))).toBe(true);
+    expect(PageID.is("a".repeat(9))).toBe(false);
+  });
+  test("PageID ensure works", () => {
+    const id = PageID.create();
+    expect(PageID.validateOrCreate(id)).toBe(id);
+    expect(PageID.validateOrCreate("")).not.toBe("");
+    expect(PageID.validateOrCreate("")).not.toBe("a");
+    expect(PageID.validateOrCreate("a".repeat(10))).toBe("a".repeat(10));
+    expect(PageID.validateOrCreate("a".repeat(9))).not.toBe("a".repeat(9));
+    expect(PageID.validateOrCreate("ABcdefghigKLML")).toBe("ABcdefghigKLML");
+  });
+});

package/src/primitives/ID.ts

@@ -0,0 +1,119 @@
+// The default length of an ID
+const ID_LENGTH = 32;
+
+// The minimum length of an ID
+const MIN_LENGTH = 10;
+
+export type ID<B extends string> = string & { __ID__: B };
+
+const isID = <const B extends string>(idName: B, id?: string): id is ID<B> => {
+  if (typeof id !== "string") return false;
+  return id.length >= MIN_LENGTH;
+};
+
+const createIDByName = <const B extends string>(idName: B): ID<B> => {
+  const letters = "abcdefghijklmnopqrstuvyz";
+  const all = letters + letters.toUpperCase();
+  let result = "";
+
+  for (let i = 0; i < ID_LENGTH; i++) {
+    const char = all.charAt(Math.floor(Math.random() * all.length));
+    result += char;
+  }
+
+  return result as ID<B>;
+};
+const createDummyID = <const B extends string>(idName: B, letter: string): ID<B> => {
+  return letter.repeat(ID_LENGTH) as ID<B>;
+};
+interface Id<T extends string> {
+  name: T;
+  is: (id: string) => id is ID<T>;
+  validateOrCreate: (id: string) => ID<T>;
+  validateOrThrow: (id: string) => ID<T>;
+  create: () => ID<T>;
+  dummy: {
+    a: ID<T>;
+    b: ID<T>;
+    c: ID<T>;
+    d: ID<T>;
+    e: ID<T>;
+    f: ID<T>;
+    g: ID<T>;
+    h: ID<T>;
+    i: ID<T>;
+    j: ID<T>;
+  };
+}
+
+/**
+ * Creates a object with helper functions for a specific ID type
+ * @param idName
+ */
+export const createTypedIdSingleton = <const B extends string>(idName: B): Id<B> => {
+  /**
+   * Creates a new ID of the correct type
+   */
+  const create = (): ID<B> => createIDByName(idName);
+
+  /**
+   * Checks if the id is of the correct type
+   * @param id
+   */
+  const is = (id: string): id is ID<B> => isID(idName, id);
+
+  /**
+   * Checks if the id is of the correct type, if not it throws an error
+   * @param id
+   */
+  const validateOrThrow = (id: string): ID<B> => {
+    if (!is(id)) {
+      throw new Error(`Invalid id: ${id}`);
+    }
+    return id;
+  };
+
+  /**
+   * The lowercase name of the id (SCHEMA, PAGE, etc)
+   */
+  const name: B = idName;
+
+  /**
+   * Ensures that the id is of the correct type, if not it creates a new one
+   * @param id
+   */
+  const validateOrCreate = (id: string): ID<B> => {
+    return is(id) ? id : create();
+  };
+
+  const dummy = {
+    a: createDummyID(idName, "a"),
+    b: createDummyID(idName, "b"),
+    c: createDummyID(idName, "c"),
+    d: createDummyID(idName, "d"),
+    e: createDummyID(idName, "e"),
+    f: createDummyID(idName, "f"),
+    g: createDummyID(idName, "g"),
+    h: createDummyID(idName, "h"),
+    i: createDummyID(idName, "i"),
+    j: createDummyID(idName, "j"),
+  };
+
+  return Object.freeze({ create, is, validateOrCreate, validateOrThrow, name, dummy });
+};
+
+export type SchemaID = ID<"SCHEMA">;
+export const SchemaID = createTypedIdSingleton("SCHEMA");
+
+export type PageID = ID<"PAGE">;
+export const PageID = createTypedIdSingleton("PAGE");
+
+export type TagID = ID<"TAG">;
+export const TagID = createTypedIdSingleton("TAG");
+export type OptionID = ID<"OPTION">;
+export const OptionID = createTypedIdSingleton("OPTION");
+
+export type TextID = ID<"TEXT">;
+export const TextID = createTypedIdSingleton("TEXT");
+export type QuestionID = ID<"QUESTION">;
+export const QuestionID = createTypedIdSingleton("QUESTION");

package/src/primitives/page-prefix.ts

@@ -1,58 +1,59 @@
-import { SchemaPrefix } from "./schema-prefix";
-
-export type PagePrefixValue = string & { __PAGE_PREFIX__: true };
-export const createRandomPrefix = <const P extends string>(length: number): P => {
-  const letters = "abcdefghijklmnopqrstuvyz";
-  const all = letters + letters.toUpperCase();
-  let result = "";
-  for (let i = 0; i < length; i++) {
-    const char = all.charAt(Math.floor(Math.random() * all.length));
-    result += char;
-  }
-  return result as P;
-};
-
-export class PagePrefix {
-  public static readonly MIN_LENGTH = 1;
-  private static randomLen = 5;
-  public static readonly MAX_LENGTH = 16;
-
-  public static create = (): PagePrefix => {
-    const v = createRandomPrefix<PagePrefixValue>(PagePrefix.randomLen);
-    return new PagePrefix(v);
-  };
-  public static fromString = (value: string): PagePrefix | false => {
-    if (!PagePrefix.isValid(value)) return false;
-    return new PagePrefix(value);
-  };
-
-  public static fromStringOrThrow = (value: string): PagePrefixValue => {
-    if (!PagePrefix.isValid(value)) throw new Error("Invalid prefix");
-    return value;
-  };
-  public static castOrCreateRandom = (value: string): PagePrefix => {
-    const v = PagePrefix.isValid(value) ? value : createRandomPrefix<PagePrefixValue>(PagePrefix.randomLen);
-    return new PagePrefix(v);
-  };
-
-  public static isValid = (prefix: string | 999): prefix is PagePrefixValue => {
-    if (typeof prefix !== "string") return false;
-    if (prefix.length < SchemaPrefix.MIN_LENGTH) return false;
-    if (prefix.length > SchemaPrefix.MAX_LENGTH) return false;
-    return true;
-  };
-
-  get value(): PagePrefixValue {
-    return this._value;
-  }
-
-  set value(value: string) {
-    if (!PagePrefix.isValid(value)) {
-      console.log("INVALID PREFIX", value);
-    } else {
-      this._value = value;
-    }
-  }
-
-  private constructor(private _value: PagePrefixValue) {}
-}
+import { SchemaPrefix } from "./schema-prefix";
+
+export type PagePrefixValue = string & { __PAGE_PREFIX__: true };
+export const createRandomPrefix = <const P extends string>(length: number): P => {
+  const letters = "abcdefghijklmnopqrstuvyz";
+  const all = letters + letters.toUpperCase();
+  let result = "";
+  for (let i = 0; i < length; i++) {
+    const char = all.charAt(Math.floor(Math.random() * all.length));
+    result += char;
+  }
+  return result as P;
+};
+
+export class PagePrefix {
+  public static readonly MIN_LENGTH = 1;
+  private static randomLen = 5;
+  public static readonly MAX_LENGTH = 16;
+
+  public static create = (): PagePrefix => {
+    const v = createRandomPrefix<PagePrefixValue>(PagePrefix.randomLen);
+    return new PagePrefix(v);
+  };
+  public static fromString = (value: string): PagePrefix | false => {
+    if (!PagePrefix.isValid(value)) return false;
+    return new PagePrefix(value);
+  };
+
+  public static fromStringOrThrow = (value: string): PagePrefixValue => {
+    if (!PagePrefix.isValid(value)) throw new Error("Invalid prefix");
+    return value;
+  };
+  public static castOrCreateRandom = (value: string): PagePrefix => {
+    const v = PagePrefix.isValid(value)
+      ? value
+      : createRandomPrefix<PagePrefixValue>(PagePrefix.randomLen);
+    return new PagePrefix(v);
+  };
+
+  public static isValid = (prefix: string | 999): prefix is PagePrefixValue => {
+    if (typeof prefix !== "string") return false;
+    if (prefix.length < SchemaPrefix.MIN_LENGTH) return false;
+    return prefix.length <= SchemaPrefix.MAX_LENGTH;
+  };
+
+  get value(): PagePrefixValue {
+    return this._value;
+  }
+
+  set value(value: string) {
+    if (!PagePrefix.isValid(value)) {
+      console.log("INVALID PREFIX", value);
+    } else {
+      this._value = value;
+    }
+  }
+
+  private constructor(private _value: PagePrefixValue) {}
+}

package/src/primitives/varID.ts

@@ -1,11 +1,12 @@
-import { PagePrefixValue } from "./page-prefix";
-
-import { SchemaPrefixValue } from "./schema-prefix";
-
-export type VarID = `${SchemaPrefixValue}_${PagePrefixValue}`;
-export const VarID = {
-  create: (schemaPrefix: SchemaPrefixValue, pagePrefix: PagePrefixValue): VarID => {
-    const varId = schemaPrefix + "_" + pagePrefix;
-    return varId as VarID;
-  },
-};
+import { PagePrefixValue } from "./page-prefix";
+
+import { SchemaPrefixValue } from "./schema-prefix";
+
+export type VarID = `${SchemaPrefixValue}_${PagePrefixValue}`;
+
+export const VarID = {
+  create: (schemaPrefix: SchemaPrefixValue, pagePrefix: PagePrefixValue): VarID => {
+    const varId = schemaPrefix + "_" + pagePrefix;
+    return varId as VarID;
+  },
+};

package/src/public-api.ts

@@ -19,6 +19,8 @@ export { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
 export * from "./schema-config";
 export * from "./codebook";
 export { VarID } from "./primitives/varID";
-export * from "./variable/mq-variable";
+export * from "./primitives/ID";
+export * from "./variable/b-variable";
 export * from "./builder-compiler";
 export * from "./variable/sum-score";
+export { SumScoreVariableDto } from "./variable/sum-score-variable";