@media-quest/builder 0.0.9 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@media-quest/builder",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Builder library for Media-quest schemas",
   "main": "dist/public-api.js",
   "module": "dist/public-api.mjs",
@@ -13,6 +13,6 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@media-quest/engine": "0.0.9"
+    "@media-quest/engine": "0.0.11"
   }
 }

package/src/Builder-page.spec.ts

@@ -4,7 +4,8 @@ import type { BuilderQuestionDto } from "./Builder-question";
 import { BuilderQuestion } from "./Builder-question";
 import type { BuilderObjectId } from "./BuilderObject";
 import { DUtil, PageID } from "@media-quest/engine";
-import { PagePrefix, SchemaPrefix } from "./prefix";
+import { PagePrefix } from "./primitives/page-prefix";
+import { SchemaPrefix } from "./primitives/schema-prefix";
 
 const U = DUtil;
 const deleteIdsFromPage = (page: BuilderPageDto) => {

package/src/Builder-page.ts

@@ -9,7 +9,9 @@ import type { BuilderMainTextDto } from "./BuilderMainText";
 import { BuilderMainText } from "./BuilderMainText";
 import { BuilderVariableOption, QuestionVariable } from "./rulebuilder/RuleVariable";
 import { DUtil, PageID } from "@media-quest/engine";
-import { PagePrefix, PagePrefixValue, VarID, SchemaPrefix, SchemaPrefixValue } from "./prefix";
+import { PagePrefix, PagePrefixValue } from "./primitives/page-prefix";
+import { VarID } from "./primitives/varID";
+import { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
 
 const U = DUtil;
 export type BuilderPageType = "info-page" | "question" | "multi-select" | "form";

package/src/Builder-schema.spec.ts

@@ -5,7 +5,8 @@ import type { BuilderTagDto } from "./BuilderTag";
 import { BuilderTag } from "./BuilderTag";
 import type { BuilderObjectId } from "./BuilderObject";
 import { PageID, SchemaID } from "@media-quest/engine";
-import { PagePrefix, SchemaPrefix } from "./prefix";
+import { PagePrefix } from "./primitives/page-prefix";
+import { SchemaPrefix } from "./primitives/schema-prefix";
 
 const tag1: BuilderTagDto = BuilderTag.create("tag1", "This tag is defined in schemaDto1").toJson();
 
@@ -166,7 +167,7 @@ describe("Builder schema", () => {
   test("Can create Schema from dto", () => {
     const s = BuilderSchema.fromJson(schemaDto1);
     expect(s.id).toBe(schemaDto1.id);
-    expect(s.prefix).toBe(schemaDto1.prefix);
+    expect(s.prefix.value).toBe(schemaDto1.prefix);
     expect(s.baseHeight).toBe(schemaDto1.baseHeight);
     expect(s.baseWidth).toBe(schemaDto1.baseWidth);
     expect(s.backgroundColor).toBe(schemaDto1.backgroundColor);

package/src/Builder-schema.ts

@@ -11,18 +11,10 @@ import { BuilderRule } from "./rulebuilder";
 import { DefaultThemeCompiler } from "./theme/default-theme-compiler";
 import { ImageFile } from "./media-files";
 import { SchemaDto, DUtil, PageID, SchemaID } from "@media-quest/engine";
-import { PagePrefix, SchemaPrefix, SchemaPrefixValue } from "./prefix";
+import { PagePrefix } from "./primitives/page-prefix";
+import { SchemaPrefix, SchemaPrefixValue } from "./primitives/schema-prefix";
 const U = DUtil;
 
-class PrimitiveWrapper<T> {
-  constructor(private readonly _value: T) {}
-
-  get value(): T {
-    return this._value;
-  }
-}
-
-// type SchemaHash = string & { __MD5__HASH: true };
 export interface BuilderSchemaDto {
   readonly id: SchemaID;
   readonly prefix: SchemaPrefixValue;
@@ -43,7 +35,7 @@ export interface SchemaBuildOutput {
 }
 
 export class BuilderSchema {
-  private readonly _prefix: SchemaPrefix;
+  readonly prefix: SchemaPrefix;
   baseHeight = 1300;
   baseWidth = 1024;
   backgroundColor = "#000000";
@@ -54,9 +46,9 @@ export class BuilderSchema {
     return [...this._rules];
   }
 
-  get prefix(): SchemaPrefixValue {
-    return this._prefix.value;
-  }
+  // get prefix(): SchemaPrefixValue {
+  //   return this._prefix.value;
+  // }
 
   private readonly _tagCollection: TagCollection = TagCollection.create();
   get tags(): ReadonlyArray<BuilderTag> {
@@ -99,16 +91,16 @@ export class BuilderSchema {
       rules,
       tags,
       mainImage: this.mainImage,
-      prefix: this.prefix,
+      prefix: this.prefix.value,
     };
     return dto;
   }
   private constructor(
     public readonly id: SchemaID,
     public name: string,
-    _prefix: SchemaPrefix,
+    prefix: SchemaPrefix,
   ) {
-    this._prefix = _prefix;
+    this.prefix = prefix;
   }
 
   addPage(type: BuilderPageType, atIndex = -1): BuilderPage {
@@ -208,20 +200,22 @@ export class BuilderSchema {
       return excludeByTagDto;
     });
     const jumpActions: JumpToPageAction[] = [];
-    const prefix = this.prefix;
     this.pages.forEach((page, index) => {
-      const pageVariables = page.getQuestionVariables(this._prefix, index);
+      const pageVariables = page.getQuestionVariables(this.prefix, index);
       qVars.push(...pageVariables);
       const mainText = page.mainText.text;
+      const pagePrefix = page.prefix;
       const jumpAction: JumpToPageAction = {
         kind: "jump-to-page",
         pageId: page.id,
+        pagePrefix,
         pageNumber: index,
         mainText: page.mainText.text,
       };
       const excludePageAction: ExcludeByPageAction = {
         kind: "exclude-by-pageId",
         pageId: page.id,
+        pagePrefix,
         pageNumber: index,
         mainText,
       };

package/src/primitives/page-prefix.ts

@@ -0,0 +1,58 @@
+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) {}
+}

package/src/primitives/schema-prefix.ts

@@ -0,0 +1,52 @@
+import { createRandomPrefix } from "./page-prefix";
+
+export type SchemaPrefixValue = string & { __SCHEMA_PREFIX__: true };
+
+export class SchemaPrefix {
+  public static readonly MIN_LENGTH = 1;
+  private static randomLen = 5;
+  public static readonly MAX_LENGTH = 16;
+
+  public static fromValue = (value: SchemaPrefixValue): SchemaPrefix => {
+    return new SchemaPrefix(value);
+  };
+
+  public static fromValueOrThrow = (value: string): SchemaPrefix => {
+    if (!SchemaPrefix.isValid(value)) throw new Error("Invalid prefix");
+    return new SchemaPrefix(value);
+  };
+  public static fromString = (value: string): SchemaPrefix | false => {
+    if (!SchemaPrefix.isValid(value)) return false;
+    return new SchemaPrefix(value);
+  };
+  public static castOrCreateRandom = (value: string): SchemaPrefix => {
+    const v = SchemaPrefix.isValid(value) ? value : createRandomPrefix<SchemaPrefixValue>(SchemaPrefix.randomLen);
+    return new SchemaPrefix(v);
+  };
+
+  public static isValid = (prefix: string | 999): prefix is SchemaPrefixValue => {
+    if (typeof prefix !== "string") return false;
+    if (prefix.length < SchemaPrefix.MIN_LENGTH) return false;
+    if (prefix.length > SchemaPrefix.MAX_LENGTH) return false;
+    return true;
+  };
+
+  toJSON() {}
+
+  get value(): SchemaPrefixValue {
+    return this._value;
+  }
+
+  get isValid() {
+    return SchemaPrefix.isValid(this._value);
+  }
+
+  set value(value: string) {
+    const casted = value as unknown;
+    if (typeof casted === "string") {
+      this._value = casted as SchemaPrefixValue;
+    }
+  }
+
+  private constructor(private _value: SchemaPrefixValue) {}
+}

package/src/primitives/varID.ts

@@ -0,0 +1,11 @@
+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

@@ -8,6 +8,9 @@ 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";
-export * from "./prefix";
 // Public Api of rule-builder
 export * from "./rulebuilder";
+export { PagePrefix } from "./primitives/page-prefix";
+export { createRandomPrefix } from "./primitives/page-prefix";
+export { PagePrefixValue } from "./primitives/page-prefix";
+export { VarID } from "./primitives/varID";

package/src/rulebuilder/Builder-rule.spec.ts

@@ -4,7 +4,9 @@ import { RuleInput } from "./RuleInput";
 import type { BuilderConditionGroupDto } from "./condition/Builder-condition-group";
 import { BuilderConditionDto } from "./condition/Builder-condition";
 import { Condition, PageID } from "@media-quest/engine";
-import { PagePrefix, VarID, SchemaPrefix } from "../prefix";
+import { PagePrefix } from "../primitives/page-prefix";
+import { VarID } from "../primitives/varID";
+import { SchemaPrefix } from "../primitives/schema-prefix";
 
 const { createPagesAndVars_A_H } = U;
 

package/src/rulebuilder/Builder-rule.ts

@@ -9,14 +9,14 @@ import { BuilderObject } from "../BuilderObject";
 import { TagActionManager } from "./tag-action-manager";
 import { PageActionManager } from "./page-action-manager";
 import { JumpToActionManager } from "./jump-to-action-manager";
-import { Condition, PageQueCommand, PageQueRules } from "@media-quest/engine";
+import { Condition, PageID, PageQueCommand, PageQueRules } from "@media-quest/engine";
 
 export interface BuilderRuleDto {
   readonly type: ConditionGroupType;
   readonly name: string;
   readonly conditions: ReadonlyArray<BuilderConditionDto | BuilderConditionGroupDto>;
   readonly excludeTags: ReadonlyArray<string>;
-  readonly excludePages: ReadonlyArray<string>;
+  readonly excludePages: ReadonlyArray<PageID>;
   readonly jumpToPage: string | false;
 }
 export class BuilderRule extends BuilderObject<"builder-rule", BuilderRuleDto> {

package/src/rulebuilder/RuleAction.ts

@@ -1,8 +1,11 @@
 import { PageID } from "@media-quest/engine";
 
+import { PagePrefixValue } from "../primitives/page-prefix";
+
 export interface ExcludeByPageAction {
   readonly kind: "exclude-by-pageId";
   readonly pageId: PageID;
+  readonly pagePrefix: PagePrefixValue;
   readonly mainText: string;
   readonly pageNumber: number;
 }
@@ -10,6 +13,7 @@ export interface ExcludeByPageAction {
 export interface JumpToPageAction {
   readonly kind: "jump-to-page";
   readonly pageId: PageID;
+  readonly pagePrefix: PagePrefixValue;
   readonly mainText: string;
   readonly pageNumber: number;
 }
@@ -20,3 +24,83 @@ export interface ExcludeByTagAction {
   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/rulebuilder/RuleBuilder-test-utils.ts

@@ -7,9 +7,15 @@ import type { BuilderOperator } from "./condition/Builder-operator";
 import type { ExcludeByPageAction, ExcludeByTagAction, JumpToPageAction } from "./RuleAction";
 import { ExcludeByPageIdSelectItem, ExcludeByTagSelectItem } from "./multi-select-item";
 import { PageID } from "@media-quest/engine";
-import { PagePrefix, VarID, SchemaPrefix } from "../prefix";
+import { PagePrefix, PagePrefixValue } from "../primitives/page-prefix";
+import { VarID } from "../primitives/varID";
+import { SchemaPrefix } from "../primitives/schema-prefix";
 
-const id = () => PageID.create();
+const idPxx = () => {
+  const id = PageID.create();
+  const prefix = PagePrefix.fromStringOrThrow("pxx");
+  return { id, prefix: prefix };
+};
 export namespace RuleBuilderTestUtils {
   export const createOptions = () => [
     BuilderOption.create(0, "Nei"),
@@ -29,18 +35,22 @@ export namespace RuleBuilderTestUtils {
   };
 
   export const excludeByPageIdAction = (pageId: PageID, pageNumber: number) => {
+    const pagePrefix = PagePrefix.castOrCreateRandom("").value;
     const action: ExcludeByPageAction = {
       kind: "exclude-by-pageId",
       mainText: "",
       pageId,
+      pagePrefix,
       pageNumber,
     };
     return action;
   };
   export const jumpToPageAction = (pageId: PageID, pageNumber: number) => {
+    const pagePrefix = PagePrefix.castOrCreateRandom("").value;
     const action: JumpToPageAction = {
       kind: "jump-to-page",
       mainText: "TEXT: " + pageId,
+      pagePrefix,
       pageId,
       pageNumber,
     };
@@ -150,7 +160,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -160,7 +171,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -170,7 +182,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -180,7 +193,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -190,7 +204,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -199,7 +214,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -209,7 +225,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -219,7 +236,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -229,7 +247,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },
@@ -239,7 +258,8 @@ export namespace RuleBuilderTestUtils {
     ExcludeByPageIdSelectItem.create(
       {
         kind: "exclude-by-pageId",
-        pageId: id(),
+        pageId: idPxx().id,
+        pagePrefix: idPxx().prefix,
         pageNumber: 5,
         mainText: "Har du noen gang vært deprimeri?? ",
       },

package/src/rulebuilder/RuleVariable.ts

@@ -1,4 +1,6 @@
-import { PagePrefix, VarID, SchemaPrefix } from "../prefix";
+import { PagePrefix } from "../primitives/page-prefix";
+import { VarID } from "../primitives/varID";
+import { SchemaPrefix } from "../primitives/schema-prefix";
 
 const BuilderVariableType = {
   numericWithOptions: true,

package/src/rulebuilder/SingleSelectItem.ts

@@ -122,11 +122,11 @@ export class JumpToPageSelectItem extends SingleSelectItem<JumpToPageAction> {
   }
 
   protected getSearchString(): string {
-    return this.data.pageId + this.data.mainText;
+    return this.data.pagePrefix + this.data.mainText;
   }
 
   protected getSelectLabel(): string {
-    return this.data.pageId + " (" + this.data.pageNumber + ")";
+    return this.data.pagePrefix + " (" + this.data.pageNumber + ")";
   }
 
   protected getTooltip(): string {

package/src/rulebuilder/condition/Builder-condition.spec.ts

@@ -2,7 +2,8 @@ import { BuilderCondition, type BuilderConditionDto } from "./Builder-condition"
 import { RuleBuilderTestUtils } from "../RuleBuilder-test-utils";
 import type { BuilderVariable, BuilderVariableOption } from "../RuleVariable";
 import { QuestionVariable } from "../RuleVariable";
-import { SchemaPrefix } from "../../prefix";
+
+import { SchemaPrefix } from "../../primitives/schema-prefix";
 
 let condition = BuilderCondition.create([]);