@media-quest/builder 0.0.25 → 0.0.26

package/src/primitives/ID.ts

@@ -1,119 +1,138 @@
-// 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");
+// 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 a = createDummyID(idName, "a");
+  const b = createDummyID(idName, "b");
+  const c = createDummyID(idName, "c");
+  const d = createDummyID(idName, "d");
+  const e = createDummyID(idName, "e");
+  const f = createDummyID(idName, "f");
+  const g = createDummyID(idName, "g");
+  const h = createDummyID(idName, "h");
+  const i = createDummyID(idName, "i");
+  const j = createDummyID(idName, "j");
+  const list = [a, b, c, d, e, f, g, h, i, j];
+
+  const dummy = {
+    a,
+    b,
+    c,
+    d,
+    e,
+    f,
+    g,
+    h,
+    i,
+    j,
+    list,
+  };
+
+  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");
+
+export type SumScoreVariableID = ID<"SUM_SCORE_VARIABLE">;
+export const SumScoreVariableID = createTypedIdSingleton("SUM_SCORE_VARIABLE");
+
+export type SumScoreMemberShipID = ID<"SUM_SCORE_MEMBERSHIP">;
+export const SumScoreMemberShipID = createTypedIdSingleton("SUM_SCORE_MEMBERSHIP");

package/src/primitives/page-prefix.ts

@@ -1,59 +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;
-    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) {}
-}
+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,12 +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

@@ -1,26 +1,28 @@
-export { type BuilderOptionDto, BuilderOption } from "./Builder-option";
-export { type BuilderPageDto, type BuilderPageType, BuilderPage } from "./Builder-page";
-export {
-  type BuilderQuestionDto,
-  BuilderQuestion,
-  type BuilderQuestionType,
-} from "./Builder-question";
-export { BuilderSchema, type BuilderSchemaDto } from "./Builder-schema";
-export { BuilderText, type BuilderTextDto } from "./Builder-text";
-export { type BuilderMainImageDto } from "./BuilderMainImageDto";
-export { BuilderMainText, type BuilderMainTextDto } from "./BuilderMainText";
-export { type BuilderMainVideoDto } from "./BuilderMainVideoDto";
-export { type BuilderTagDto, BuilderTag, TagCollection } from "./BuilderTag";
-export { type AudioFile, type ImageFile, type VideoFile } from "./media-files";
-// Public Api of rule-builder
-export * from "./rulebuilder";
-export { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
-export { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
-export * from "./schema-config";
-export * from "./codebook";
-export { VarID } from "./primitives/varID";
-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";
+export { type BuilderOptionDto, BuilderOption } from "./Builder-option";
+export { type BuilderPageDto, type BuilderPageType, BuilderPage } from "./Builder-page";
+export {
+  type BuilderQuestionDto,
+  BuilderQuestion,
+  type BuilderQuestionType,
+} from "./Builder-question";
+export { BuilderSchema, type BuilderSchemaDto } from "./Builder-schema";
+export { BuilderText, type BuilderTextDto } from "./Builder-text";
+export { type BuilderMainImageDto } from "./BuilderMainImageDto";
+export { BuilderMainText, type BuilderMainTextDto } from "./BuilderMainText";
+export { type BuilderMainVideoDto } from "./BuilderMainVideoDto";
+export { type BuilderTagDto, BuilderTag, TagCollection } from "./BuilderTag";
+export { type AudioFile, type ImageFile, type VideoFile } from "./media-files";
+// Public Api of rule-builder
+export * from "./rulebuilder";
+export { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
+export { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
+export * from "./schema-config";
+export * from "./code-book/codebook";
+export { VarID } from "./primitives/varID";
+export * from "./primitives/ID";
+export * from "./code-book/codebook-variable";
+export * from "./builder-compiler";
+export * from "./sum-score/sum-score";
+export { SumScoreVariableDto } from "./sum-score/sum-score-variable";
+export { SumScoreAnswer } from "./sum-score/sum-score-answer";
+export { SumScoreManager } from "./sum-score/sum-score-manager";