@media-quest/builder 0.0.39 → 0.0.41

package/src/primitives/ID.ts

@@ -1,135 +1,135 @@
-// 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");
+// 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");

package/src/public-api.ts

@@ -1,30 +1,29 @@
-export { type BuilderOptionDto, BuilderOption } from "./Builder-option";
-export { type BuilderPageDto, type BuilderPageType, BuilderPage } from "./page/Builder-page";
-export {
-  type BuilderQuestionDto,
-  BuilderQuestion,
-  type BuilderQuestionType,
-} from "./Builder-question";
-export { BuilderSchema } 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 } from "./tag/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, SumScoreVariable } from "./sum-score/sum-score-variable";
-export { SumScoreAnswer } from "./sum-score/sum-score-answer";
-export { TagCollection } from "./tag/Tag-Collection";
-export * from "./theme/Default-theme";
-export { BuilderSchemaDto } from "./Builder-schema-dto";
+export { type BuilderOptionDto, BuilderOption } from "./Builder-option";
+export { type BuilderPageDto, type BuilderPageType, BuilderPage } from "./page/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 } from "./tag/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, SumScoreVariable } from "./sum-score/sum-score-variable";
+export { SumScoreAnswer } from "./sum-score/sum-score-answer";
+export { TagCollection } from "./tag/Tag-Collection";
+export * from "./theme/Default-theme";

package/src/rulebuilder/RuleAction.ts

@@ -1,105 +1,105 @@
-import { PagePrefixValue } from "../primitives/page-prefix";
-import { PageID } from "../primitives/ID";
-
-export interface ExcludeByPageAction {
-  readonly kind: "exclude-by-pageId";
-  readonly pageId: PageID;
-  readonly pagePrefix: PagePrefixValue;
-  readonly mainText: string;
-  readonly pageNumber: number;
-}
-
-export interface JumpToPageAction {
-  readonly kind: "jump-to-page";
-  readonly pageId: PageID;
-  readonly pagePrefix: PagePrefixValue;
-  readonly mainText: string;
-  readonly pageNumber: number;
-}
-
-export interface ExcludeByTagAction {
-  readonly kind: "exclude-by-tag";
-  readonly tag: string;
-  readonly description: string;
-  readonly pageCount: number;
-}
-
-// interface ISearchable {
-//   getLabel(): string;
-//   getTooltip(): string;
-//   getSearchString(): string;
-// }
-// interface ISelectable {
-//   isSelected: boolean;
-// }
-//
-// export class PageAction implements ISearchable, ISelectable {
-//   public readonly description = "Will exclude this page from the survey.";
-//   private _isSelected: boolean = false;
-//   get isSelected(): boolean {
-//     return this._isSelected;
-//   }
-//   set isSelected(value: boolean) {
-//     const casted = value as unknown;
-//     if (typeof casted === "boolean") {
-//       this._isSelected = casted;
-//     }
-//   }
-//   get pageId(): PageID {
-//     return this.data.pageId;
-//   }
-//   get pagePrefix(): PagePrefixValue {
-//     return this.data.pagePrefix;
-//   }
-//   get mainText(): string {
-//     return this.data.mainText;
-//   }
-//   get pageNumber(): number {
-//     return this.data.pageNumber;
-//   }
-//   constructor(
-//     private readonly data: {
-//       pageId: PageID;
-//       pagePrefix: PagePrefixValue;
-//       mainText: string;
-//       pageNumber: number;
-//       isSelected: boolean;
-//     },
-//   ) {
-//     this.isSelected = this.data.isSelected;
-//   }
-//
-//   getLabel(): string {
-//     return this.data.pagePrefix + " (" + this.data.pageNumber + ")";
-//   }
-//   getTooltip(): string {
-//     return this.data.mainText;
-//   }
-//   getSearchString(): string {
-//     return this.data.pagePrefix + this.data.mainText;
-//   }
-// }
-// export class TagAction implements ISearchable {
-//   constructor(
-//     readonly tag: string,
-//     readonly description: string,
-//     readonly usedInPages: { pageNumber: number; pagePrefix: PagePrefixValue }[],
-//   ) {}
-//   getLabel(): string {
-//     return this.tag + " (" + this.usedInPages.length + ")";
-//   }
-//   getTooltip(): string {
-//     return this.description;
-//   }
-//   getSearchString(): string {
-//     return this.tag;
-//   }
-// }
-
-// class SelectableCollection<T> {
-//   private readonly _items: Array<T>;
-//   private selected: T | false = false;
-//   constructor(items: ReadonlyArray<T>) {
-//     this._items = [...items];
-//   }
-// }
+import { PagePrefixValue } from "../primitives/page-prefix";
+import { PageID } from "../primitives/ID";
+
+export interface ExcludeByPageAction {
+  readonly kind: "exclude-by-pageId";
+  readonly pageId: PageID;
+  readonly pagePrefix: PagePrefixValue;
+  readonly mainText: string;
+  readonly pageNumber: number;
+}
+
+export interface JumpToPageAction {
+  readonly kind: "jump-to-page";
+  readonly pageId: PageID;
+  readonly pagePrefix: PagePrefixValue;
+  readonly mainText: string;
+  readonly pageNumber: number;
+}
+
+export interface ExcludeByTagAction {
+  readonly kind: "exclude-by-tag";
+  readonly tag: string;
+  readonly description: string;
+  readonly pageCount: number;
+}
+
+// interface ISearchable {
+//   getLabel(): string;
+//   getTooltip(): string;
+//   getSearchString(): string;
+// }
+// interface ISelectable {
+//   isSelected: boolean;
+// }
+//
+// export class PageAction implements ISearchable, ISelectable {
+//   public readonly description = "Will exclude this page from the survey.";
+//   private _isSelected: boolean = false;
+//   get isSelected(): boolean {
+//     return this._isSelected;
+//   }
+//   set isSelected(value: boolean) {
+//     const casted = value as unknown;
+//     if (typeof casted === "boolean") {
+//       this._isSelected = casted;
+//     }
+//   }
+//   get pageId(): PageID {
+//     return this.data.pageId;
+//   }
+//   get pagePrefix(): PagePrefixValue {
+//     return this.data.pagePrefix;
+//   }
+//   get mainText(): string {
+//     return this.data.mainText;
+//   }
+//   get pageNumber(): number {
+//     return this.data.pageNumber;
+//   }
+//   constructor(
+//     private readonly data: {
+//       pageId: PageID;
+//       pagePrefix: PagePrefixValue;
+//       mainText: string;
+//       pageNumber: number;
+//       isSelected: boolean;
+//     },
+//   ) {
+//     this.isSelected = this.data.isSelected;
+//   }
+//
+//   getLabel(): string {
+//     return this.data.pagePrefix + " (" + this.data.pageNumber + ")";
+//   }
+//   getTooltip(): string {
+//     return this.data.mainText;
+//   }
+//   getSearchString(): string {
+//     return this.data.pagePrefix + this.data.mainText;
+//   }
+// }
+// export class TagAction implements ISearchable {
+//   constructor(
+//     readonly tag: string,
+//     readonly description: string,
+//     readonly usedInPages: { pageNumber: number; pagePrefix: PagePrefixValue }[],
+//   ) {}
+//   getLabel(): string {
+//     return this.tag + " (" + this.usedInPages.length + ")";
+//   }
+//   getTooltip(): string {
+//     return this.description;
+//   }
+//   getSearchString(): string {
+//     return this.tag;
+//   }
+// }
+
+// class SelectableCollection<T> {
+//   private readonly _items: Array<T>;
+//   private selected: T | false = false;
+//   constructor(items: ReadonlyArray<T>) {
+//     this._items = [...items];
+//   }
+// }

package/src/schema-config.ts

@@ -1,26 +1,25 @@
-import { CodebookPredefinedVariable } from "./code-book/codebook-variable";
-
-import { BuilderSchemaDto } from "./Builder-schema-dto";
-
-/**
- * This interface is ment to define all information that a schema-admin app
- * needs to generate a dynamic form for setting values for predefined variables.
- */
-export interface SchemaConfig {
-  readonly schemaName: string;
-  readonly schemaId: string;
-  readonly schemaPrefix: string;
-  readonly variables: ReadonlyArray<CodebookPredefinedVariable>;
-}
-
-export const SchemaConfig = {
-  fromSchema: (schema: BuilderSchemaDto): SchemaConfig => {
-    const variables = schema.predefinedVariables ?? [];
-    return {
-      schemaId: schema.id,
-      schemaName: schema.name,
-      schemaPrefix: schema.prefix,
-      variables,
-    };
-  },
-} as const;
+import { CodebookPredefinedVariable } from "./code-book/codebook-variable";
+import { BuilderSchemaDto } from "./Builder-schema";
+
+/**
+ * This interface is ment to define all information that a schema-admin app
+ * needs to generate a dynamic form for setting values for predefined variables.
+ */
+export interface SchemaConfig {
+  readonly schemaName: string;
+  readonly schemaId: string;
+  readonly schemaPrefix: string;
+  readonly variables: ReadonlyArray<CodebookPredefinedVariable>;
+}
+
+export const SchemaConfig = {
+  fromSchema: (schema: BuilderSchemaDto): SchemaConfig => {
+    const variables = schema.predefinedVariables ?? [];
+    return {
+      schemaId: schema.id,
+      schemaName: schema.name,
+      schemaPrefix: schema.prefix,
+      variables,
+    };
+  },
+} as const;