@media-quest/builder 0.0.6 → 0.0.8

package/dist/public-api.d.mts

@@ -1,4 +1,4 @@
-import { DStyle, Condition, PageQueRules, SchemaDto } from '@media-quest/engine';
+import { DStyle, PageID, Condition, PageQueRules, SchemaID, SchemaDto } from '@media-quest/engine';
 
 /**
  * Builder objects are complex objects that are embedded inside
@@ -13,24 +13,12 @@ declare namespace BuilderObjectId {
     type QuestionID = string & {
         __QUESTION__ID__: true;
     };
-    type VideoFileID = string & {
-        __VIDEO__ID__: true;
-    };
-    type AudioFileID = string & {
-        __AUDIO__ID__: true;
-    };
-    type ImageID = string & {
-        __IMAGE__ID__: true;
-    };
     type TextID = string & {
         __TEXT__ID__: true;
     };
     type MainTextID = string & {
         __MAIN__TEXT__ID__: true;
     };
-    type PageID = string & {
-        __PAGE__ID__: true;
-    };
     type TagId = string & {
         __TAG__ID__: true;
     };
@@ -39,7 +27,6 @@ declare namespace BuilderObjectId {
     const textId: () => TextID;
     const questionOptionId: () => QuestionOptionID;
     const questionId: () => QuestionID;
-    const pageId: () => PageID;
 }
 declare abstract class BuilderObject<T extends BuilderObjectType, Dto extends {}> {
     abstract readonly objectType: T;
@@ -180,6 +167,31 @@ declare class BuilderMainText extends BuilderObject<"builder-main-text", Builder
     set audioFile(audioFile: AudioFile | false);
 }
 
+type SchemaPrefixValue = string & {
+    __SCHEMA_PREFIX__: true;
+};
+type PagePrefixValue = string & {
+    __PAGE_PREFIX__: true;
+};
+type VarID = `${SchemaPrefixValue}_${PagePrefixValue}`;
+declare const VarID: {
+    create: (schemaPrefix: SchemaPrefixValue, pagePrefix: PagePrefixValue) => VarID;
+};
+declare class SchemaPrefix {
+    private _value;
+    static readonly MIN_LENGTH = 1;
+    private static randomLen;
+    static readonly MAX_LENGTH = 16;
+    static fromValue: (value: SchemaPrefixValue) => SchemaPrefix;
+    static fromValueOrThrow: (value: string) => SchemaPrefix;
+    static fromString: (value: string) => SchemaPrefix | false;
+    static castOrCreateRandom: (value: string) => SchemaPrefix;
+    static isValid: (prefix: string | 999) => prefix is SchemaPrefixValue;
+    get value(): SchemaPrefixValue;
+    set value(value: string);
+    private constructor();
+}
+
 declare const BuilderVariableType: {
     readonly numericWithOptions: true;
     readonly numeric: true;
@@ -198,28 +210,28 @@ declare class BuilderVariableOption {
     constructor(label: string, value: number);
 }
 declare class QuestionVariable {
-    readonly varId: string;
+    readonly varId: VarID;
     readonly label: string;
     readonly options: ReadonlyArray<BuilderVariableOption>;
     readonly pageNumber: number;
     readonly kind: "question-variable";
     readonly dataType: BuilderVariableType;
-    constructor(varId: string, label: string, options: ReadonlyArray<BuilderVariableOption>, pageNumber: number);
+    constructor(varId: VarID, label: string, options: ReadonlyArray<BuilderVariableOption>, pageNumber: number);
 }
 declare class CustomVariable {
-    readonly varId: string;
+    readonly varId: VarID;
     readonly label: string;
     readonly options: ReadonlyArray<BuilderVariableOption>;
     readonly kind: "configuration-variable";
     readonly dataType: BuilderVariableType;
-    constructor(varId: string, label: string, options: ReadonlyArray<BuilderVariableOption>);
+    constructor(varId: VarID, label: string, options: ReadonlyArray<BuilderVariableOption>);
 }
 type BuilderVariable = QuestionVariable | CustomVariable;
 
 type BuilderPageType = "info-page" | "question" | "multi-select" | "form";
 interface BuilderPageDto {
-    readonly id: BuilderObjectId.PageID;
-    prefix: string;
+    readonly id: PageID;
+    readonly prefix: PagePrefixValue;
     _type: BuilderPageType;
     mainText: BuilderMainTextDto;
     nextButton: BuilderOptionDto;
@@ -231,7 +243,7 @@ interface BuilderPageDto {
 }
 declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     readonly objectType: "builder-page";
-    readonly id: BuilderObjectId.PageID;
+    readonly id: PageID;
     private _pageType;
     private _prefix;
     private _questions;
@@ -241,7 +253,7 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
     defaultQuestion: BuilderQuestion;
     mainText: BuilderMainText;
     nextButton: BuilderOption;
-    static create(type: BuilderPageType, _prefix: string): BuilderPage;
+    static create(type: BuilderPageType, _prefix: PagePrefixValue): BuilderPage;
     static fromJson(dto: BuilderPageDto): BuilderPage;
     private constructor();
     insertQuestion(question: BuilderQuestion, atIndex: number): boolean;
@@ -257,11 +269,11 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
     addTag(tag: string): void;
     deleteTag(tag: string): void;
     set pageType(value: BuilderPageType);
-    getQuestionVariables(modulePrefix: string, pageNumber: number): ReadonlyArray<QuestionVariable>;
+    getQuestionVariables(modulePrefix: SchemaPrefix, pageNumber: number): ReadonlyArray<QuestionVariable>;
     get tags(): ReadonlyArray<string>;
     get pageType(): BuilderPageType;
-    get prefix(): string;
-    set prefix(value: string);
+    get prefix(): PagePrefixValue;
+    set prefix(value: PagePrefixValue);
     toJson(): BuilderPageDto;
     clone(): BuilderPageDto;
     get backgroundColor(): string;
@@ -270,19 +282,19 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
 }
 
 interface ExcludeByPageAction {
-    readonly kind: 'exclude-by-pageId';
-    readonly pageId: string;
+    readonly kind: "exclude-by-pageId";
+    readonly pageId: PageID;
     readonly mainText: string;
     readonly pageNumber: number;
 }
 interface JumpToPageAction {
-    readonly kind: 'jump-to-page';
-    readonly pageId: string;
+    readonly kind: "jump-to-page";
+    readonly pageId: PageID;
     readonly mainText: string;
     readonly pageNumber: number;
 }
 interface ExcludeByTagAction {
-    readonly kind: 'exclude-by-tag';
+    readonly kind: "exclude-by-tag";
     readonly tag: string;
     readonly description: string;
     readonly pageCount: number;
@@ -445,7 +457,7 @@ declare class BuilderCondition extends BuilderObject<"builder-condition", Builde
         isValid: false;
         message: string;
     };
-    toEngineCondition(modulePrefix: string): Condition.Simple | false;
+    toEngineCondition(): Condition.Simple | false;
     private findVariableInUniverse;
     set operator(operator: BuilderOperator | "");
     get operator(): BuilderOperator | "";
@@ -486,7 +498,7 @@ declare class BuilderConditionGroup extends BuilderObject<"builder-condition-gro
     removeCondition(condition: BuilderCondition): boolean;
     clone(): BuilderConditionGroupDto;
     toJson(): BuilderConditionGroupDto;
-    toEngineConditionComplex(modulePrefix: string): Condition.Complex | false;
+    toEngineConditionComplex(): Condition.Complex | false;
     get type(): ConditionGroupType;
     set type(conditionGroupType: ConditionGroupType);
 }
@@ -564,7 +576,7 @@ declare class BuilderRule extends BuilderObject<"builder-rule", BuilderRuleDto>
     addConditionGroup(): BuilderConditionGroup;
     clone(): BuilderRuleDto;
     toJson(): BuilderRuleDto;
-    toEngineRule(modulePrefix: string): PageQueRules;
+    toEngineRule(): PageQueRules;
 }
 
 declare class PageActionManager {
@@ -588,8 +600,8 @@ declare class TagActionManager {
 }
 
 interface BuilderSchemaDto {
-    readonly id: string;
-    readonly prefix: string;
+    readonly id: SchemaID;
+    readonly prefix: SchemaPrefixValue;
     readonly mainImage: ImageFile | false;
     readonly backgroundColor: string;
     readonly name: string;
@@ -605,9 +617,9 @@ interface SchemaBuildOutput {
     schemaConfig: Record<string, string>;
 }
 declare class BuilderSchema {
-    readonly id: string;
+    readonly id: SchemaID;
     name: string;
-    prefix: string;
+    private readonly _prefix;
     baseHeight: number;
     baseWidth: number;
     backgroundColor: string;
@@ -615,9 +627,10 @@ declare class BuilderSchema {
     mainImage: ImageFile | false;
     private _rules;
     get rules(): ReadonlyArray<BuilderRule>;
+    get prefix(): SchemaPrefixValue;
     private readonly _tagCollection;
     get tags(): ReadonlyArray<BuilderTag>;
-    static create(id: string, name: string, prefix: string): BuilderSchema;
+    static create(id: SchemaID, name: string, prefix: SchemaPrefixValue): BuilderSchema;
     static fromJson(dto: BuilderSchemaDto): BuilderSchema;
     toJson(): BuilderSchemaDto;
     private constructor();
@@ -632,7 +645,6 @@ declare class BuilderSchema {
     getRuleInput(): RuleInput;
     deleteTags(tags: ReadonlyArray<BuilderTag>): void;
     addTag(builderTag: BuilderTag): void;
-    private getQuestionVariables;
     compile(): SchemaBuildOutput;
 }
 

package/dist/public-api.d.ts

@@ -1,4 +1,4 @@
-import { DStyle, Condition, PageQueRules, SchemaDto } from '@media-quest/engine';
+import { DStyle, PageID, Condition, PageQueRules, SchemaID, SchemaDto } from '@media-quest/engine';
 
 /**
  * Builder objects are complex objects that are embedded inside
@@ -13,24 +13,12 @@ declare namespace BuilderObjectId {
     type QuestionID = string & {
         __QUESTION__ID__: true;
     };
-    type VideoFileID = string & {
-        __VIDEO__ID__: true;
-    };
-    type AudioFileID = string & {
-        __AUDIO__ID__: true;
-    };
-    type ImageID = string & {
-        __IMAGE__ID__: true;
-    };
     type TextID = string & {
         __TEXT__ID__: true;
     };
     type MainTextID = string & {
         __MAIN__TEXT__ID__: true;
     };
-    type PageID = string & {
-        __PAGE__ID__: true;
-    };
     type TagId = string & {
         __TAG__ID__: true;
     };
@@ -39,7 +27,6 @@ declare namespace BuilderObjectId {
     const textId: () => TextID;
     const questionOptionId: () => QuestionOptionID;
     const questionId: () => QuestionID;
-    const pageId: () => PageID;
 }
 declare abstract class BuilderObject<T extends BuilderObjectType, Dto extends {}> {
     abstract readonly objectType: T;
@@ -180,6 +167,31 @@ declare class BuilderMainText extends BuilderObject<"builder-main-text", Builder
     set audioFile(audioFile: AudioFile | false);
 }
 
+type SchemaPrefixValue = string & {
+    __SCHEMA_PREFIX__: true;
+};
+type PagePrefixValue = string & {
+    __PAGE_PREFIX__: true;
+};
+type VarID = `${SchemaPrefixValue}_${PagePrefixValue}`;
+declare const VarID: {
+    create: (schemaPrefix: SchemaPrefixValue, pagePrefix: PagePrefixValue) => VarID;
+};
+declare class SchemaPrefix {
+    private _value;
+    static readonly MIN_LENGTH = 1;
+    private static randomLen;
+    static readonly MAX_LENGTH = 16;
+    static fromValue: (value: SchemaPrefixValue) => SchemaPrefix;
+    static fromValueOrThrow: (value: string) => SchemaPrefix;
+    static fromString: (value: string) => SchemaPrefix | false;
+    static castOrCreateRandom: (value: string) => SchemaPrefix;
+    static isValid: (prefix: string | 999) => prefix is SchemaPrefixValue;
+    get value(): SchemaPrefixValue;
+    set value(value: string);
+    private constructor();
+}
+
 declare const BuilderVariableType: {
     readonly numericWithOptions: true;
     readonly numeric: true;
@@ -198,28 +210,28 @@ declare class BuilderVariableOption {
     constructor(label: string, value: number);
 }
 declare class QuestionVariable {
-    readonly varId: string;
+    readonly varId: VarID;
     readonly label: string;
     readonly options: ReadonlyArray<BuilderVariableOption>;
     readonly pageNumber: number;
     readonly kind: "question-variable";
     readonly dataType: BuilderVariableType;
-    constructor(varId: string, label: string, options: ReadonlyArray<BuilderVariableOption>, pageNumber: number);
+    constructor(varId: VarID, label: string, options: ReadonlyArray<BuilderVariableOption>, pageNumber: number);
 }
 declare class CustomVariable {
-    readonly varId: string;
+    readonly varId: VarID;
     readonly label: string;
     readonly options: ReadonlyArray<BuilderVariableOption>;
     readonly kind: "configuration-variable";
     readonly dataType: BuilderVariableType;
-    constructor(varId: string, label: string, options: ReadonlyArray<BuilderVariableOption>);
+    constructor(varId: VarID, label: string, options: ReadonlyArray<BuilderVariableOption>);
 }
 type BuilderVariable = QuestionVariable | CustomVariable;
 
 type BuilderPageType = "info-page" | "question" | "multi-select" | "form";
 interface BuilderPageDto {
-    readonly id: BuilderObjectId.PageID;
-    prefix: string;
+    readonly id: PageID;
+    readonly prefix: PagePrefixValue;
     _type: BuilderPageType;
     mainText: BuilderMainTextDto;
     nextButton: BuilderOptionDto;
@@ -231,7 +243,7 @@ interface BuilderPageDto {
 }
 declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto> {
     readonly objectType: "builder-page";
-    readonly id: BuilderObjectId.PageID;
+    readonly id: PageID;
     private _pageType;
     private _prefix;
     private _questions;
@@ -241,7 +253,7 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
     defaultQuestion: BuilderQuestion;
     mainText: BuilderMainText;
     nextButton: BuilderOption;
-    static create(type: BuilderPageType, _prefix: string): BuilderPage;
+    static create(type: BuilderPageType, _prefix: PagePrefixValue): BuilderPage;
     static fromJson(dto: BuilderPageDto): BuilderPage;
     private constructor();
     insertQuestion(question: BuilderQuestion, atIndex: number): boolean;
@@ -257,11 +269,11 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
     addTag(tag: string): void;
     deleteTag(tag: string): void;
     set pageType(value: BuilderPageType);
-    getQuestionVariables(modulePrefix: string, pageNumber: number): ReadonlyArray<QuestionVariable>;
+    getQuestionVariables(modulePrefix: SchemaPrefix, pageNumber: number): ReadonlyArray<QuestionVariable>;
     get tags(): ReadonlyArray<string>;
     get pageType(): BuilderPageType;
-    get prefix(): string;
-    set prefix(value: string);
+    get prefix(): PagePrefixValue;
+    set prefix(value: PagePrefixValue);
     toJson(): BuilderPageDto;
     clone(): BuilderPageDto;
     get backgroundColor(): string;
@@ -270,19 +282,19 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
 }
 
 interface ExcludeByPageAction {
-    readonly kind: 'exclude-by-pageId';
-    readonly pageId: string;
+    readonly kind: "exclude-by-pageId";
+    readonly pageId: PageID;
     readonly mainText: string;
     readonly pageNumber: number;
 }
 interface JumpToPageAction {
-    readonly kind: 'jump-to-page';
-    readonly pageId: string;
+    readonly kind: "jump-to-page";
+    readonly pageId: PageID;
     readonly mainText: string;
     readonly pageNumber: number;
 }
 interface ExcludeByTagAction {
-    readonly kind: 'exclude-by-tag';
+    readonly kind: "exclude-by-tag";
     readonly tag: string;
     readonly description: string;
     readonly pageCount: number;
@@ -445,7 +457,7 @@ declare class BuilderCondition extends BuilderObject<"builder-condition", Builde
         isValid: false;
         message: string;
     };
-    toEngineCondition(modulePrefix: string): Condition.Simple | false;
+    toEngineCondition(): Condition.Simple | false;
     private findVariableInUniverse;
     set operator(operator: BuilderOperator | "");
     get operator(): BuilderOperator | "";
@@ -486,7 +498,7 @@ declare class BuilderConditionGroup extends BuilderObject<"builder-condition-gro
     removeCondition(condition: BuilderCondition): boolean;
     clone(): BuilderConditionGroupDto;
     toJson(): BuilderConditionGroupDto;
-    toEngineConditionComplex(modulePrefix: string): Condition.Complex | false;
+    toEngineConditionComplex(): Condition.Complex | false;
     get type(): ConditionGroupType;
     set type(conditionGroupType: ConditionGroupType);
 }
@@ -564,7 +576,7 @@ declare class BuilderRule extends BuilderObject<"builder-rule", BuilderRuleDto>
     addConditionGroup(): BuilderConditionGroup;
     clone(): BuilderRuleDto;
     toJson(): BuilderRuleDto;
-    toEngineRule(modulePrefix: string): PageQueRules;
+    toEngineRule(): PageQueRules;
 }
 
 declare class PageActionManager {
@@ -588,8 +600,8 @@ declare class TagActionManager {
 }
 
 interface BuilderSchemaDto {
-    readonly id: string;
-    readonly prefix: string;
+    readonly id: SchemaID;
+    readonly prefix: SchemaPrefixValue;
     readonly mainImage: ImageFile | false;
     readonly backgroundColor: string;
     readonly name: string;
@@ -605,9 +617,9 @@ interface SchemaBuildOutput {
     schemaConfig: Record<string, string>;
 }
 declare class BuilderSchema {
-    readonly id: string;
+    readonly id: SchemaID;
     name: string;
-    prefix: string;
+    private readonly _prefix;
     baseHeight: number;
     baseWidth: number;
     backgroundColor: string;
@@ -615,9 +627,10 @@ declare class BuilderSchema {
     mainImage: ImageFile | false;
     private _rules;
     get rules(): ReadonlyArray<BuilderRule>;
+    get prefix(): SchemaPrefixValue;
     private readonly _tagCollection;
     get tags(): ReadonlyArray<BuilderTag>;
-    static create(id: string, name: string, prefix: string): BuilderSchema;
+    static create(id: SchemaID, name: string, prefix: SchemaPrefixValue): BuilderSchema;
     static fromJson(dto: BuilderSchemaDto): BuilderSchema;
     toJson(): BuilderSchemaDto;
     private constructor();
@@ -632,7 +645,6 @@ declare class BuilderSchema {
     getRuleInput(): RuleInput;
     deleteTags(tags: ReadonlyArray<BuilderTag>): void;
     addTag(builderTag: BuilderTag): void;
-    private getQuestionVariables;
     compile(): SchemaBuildOutput;
 }