@media-quest/builder 0.0.27 → 0.0.29

package/dist/public-api.d.ts

@@ -525,34 +525,6 @@ declare class TagActionManager {
     getEngineActions(): ReadonlyArray<ExcludeByTagAction>;
 }
 
-interface SumScoreVariableDto {
-    id: SumScoreVariableID;
-    name: string;
-    description: string;
-    useAvg: boolean;
-}
-declare class SumScoreVariable extends BuilderObject<"builder-sum-score-variable", SumScoreVariableDto> {
-    readonly objectType = "builder-sum-score-variable";
-    readonly id: SumScoreVariableID;
-    private _useAvg;
-    private _name;
-    private _description;
-    private _error;
-    static readonly create: (data: {
-        name: string;
-        description: string;
-        useAvg: boolean;
-    }) => SumScoreVariable;
-    get hasErrors(): boolean;
-    static fromDto: (dto: SumScoreVariableDto) => SumScoreVariable;
-    private constructor();
-    toJson(): SumScoreVariableDto;
-    clone(): SumScoreVariableDto;
-    get name(): string;
-    get description(): string;
-    get useAvg(): boolean;
-}
-
 type BuilderPageType = "info-page" | "question";
 interface BuilderPageDto {
     readonly id: PageID;
@@ -598,13 +570,10 @@ declare class BuilderPage extends BuilderObject<"builder-page", BuilderPageDto>
     get pageType(): BuilderPageType;
     get prefix(): PagePrefixValue;
     set prefix(value: PagePrefixValue);
-    sumScoreVariableSet(sumScoreVariable: SumScoreVariable, weight: number): boolean;
-    sumScoreVariableUpdateData(variables: ReadonlyArray<SumScoreVariable>): void;
     toJson(): BuilderPageDto;
     clone(): BuilderPageDto;
     get backgroundColor(): string;
     set backgroundColor(color: string);
-    sumScoreVariableDelete(sumScoreVariableID: SumScoreVariableID): void;
 }
 
 interface BuilderTagDto {
@@ -626,6 +595,36 @@ declare class BuilderTag extends BuilderObject<"builder-tag", BuilderTagDto> {
     toJson(): BuilderTagDto;
 }
 
+interface SumScoreVariableDto {
+    id: SumScoreVariableID;
+    name: string;
+    description: string;
+    useAvg: boolean;
+}
+declare class SumScoreVariable extends BuilderObject<"builder-sum-score-variable", SumScoreVariableDto> {
+    readonly objectType = "builder-sum-score-variable";
+    readonly id: SumScoreVariableID;
+    private _useAvg;
+    private _name;
+    private _description;
+    private _error;
+    private _usedIn;
+    get usedIn(): BuilderPage[];
+    static readonly create: (data: {
+        name: string;
+        description: string;
+        useAvg: boolean;
+    }) => SumScoreVariable;
+    get hasErrors(): boolean;
+    static fromDto: (dto: SumScoreVariableDto) => SumScoreVariable;
+    private constructor();
+    toJson(): SumScoreVariableDto;
+    clone(): SumScoreVariableDto;
+    get name(): string;
+    get description(): string;
+    get useAvg(): boolean;
+}
+
 /**
  * Interface representing a code book question sum-score.
  *
@@ -733,7 +732,9 @@ declare class BuilderSchema {
         useAvg: boolean;
     }): SumScoreVariable;
     sumScoreVariableAddToPage(sumScoreVariable: SumScoreVariable, page: BuilderPage, weight: number): boolean;
+    private updateSumScoreRelations;
     sumScoreVariableUpdate(id: SumScoreVariableID, data: Partial<SumScoreVariableDto>): boolean;
+    sumScoreVariableDeleteFromPage(pageId: PageID, sumScoreVariableId: SumScoreVariableID): void;
     insertPage(page: BuilderPage, atIndex: number): boolean;
     private insertPageAtIndex;
     addRule(): BuilderRule;
@@ -775,6 +776,9 @@ interface SumScoreAnswer {
 }
 
 interface SumScore {
+    readonly sumScoreVariableId: SumScoreVariableID;
+    readonly name: string;
+    readonly description: string;
     sumScore: number;
     avg: number;
     useAvg: boolean;
@@ -816,4 +820,4 @@ declare class TagCollection implements Iterable<BuilderTag> {
     deleteAll(tags: Iterable<BuilderTag>): void;
 }
 
-export { type AudioFile, BuilderCondition, type BuilderConditionDto, BuilderConditionGroup, type BuilderConditionGroupDto, type BuilderMainImageDto, BuilderMainText, type BuilderMainTextDto, type BuilderMainVideoDto, BuilderOperator, BuilderOption, type BuilderOptionDto, BuilderPage, type BuilderPageDto, type BuilderPageType, BuilderQuestion, type BuilderQuestionDto, type BuilderQuestionType, BuilderRule, type BuilderRuleDto, BuilderSchema, type BuilderSchemaDto, BuilderTag, type BuilderTagDto, BuilderText, type BuilderTextDto, CodeBook, type CodeBookQuestionVariable, type Codebook, type CodebookPredefinedVariable, type CompilerOption, type CompilerOutput, ConditionGroupType, type ExcludeByPageAction, ExcludeByPageIdSelectItem, type ExcludeByTagAction, ExcludeByTagSelectItem, type ID, type ImageFile, JumpToActionManager, type JumpToPageAction, JumpToPageSelectItem, MultiSelectItem, OperatorSelectItem, OptionID, PageActionManager, PageID, PagePrefix, type PagePrefixValue, QuestionID, RuleCustomVariable, RuleInput, RuleOptionSelectItem, RuleQuestionVariable, type RuleVariable, RuleVariableOption, RuleVariableSelectItem, SchemaConfig, SchemaID, SchemaPrefix, type SchemaPrefixValue, SingleSelectItem, SumScore, type SumScoreAnswer, type SumScoreVariableDto, SumScoreVariableID, TagActionManager, TagCollection, TagID, TextID, VarID, type VideoFile, _CodeBook, createTypedIdSingleton };
+export { type AudioFile, BuilderCondition, type BuilderConditionDto, BuilderConditionGroup, type BuilderConditionGroupDto, type BuilderMainImageDto, BuilderMainText, type BuilderMainTextDto, type BuilderMainVideoDto, BuilderOperator, BuilderOption, type BuilderOptionDto, BuilderPage, type BuilderPageDto, type BuilderPageType, BuilderQuestion, type BuilderQuestionDto, type BuilderQuestionType, BuilderRule, type BuilderRuleDto, BuilderSchema, type BuilderSchemaDto, BuilderTag, type BuilderTagDto, BuilderText, type BuilderTextDto, CodeBook, type CodeBookQuestionVariable, type Codebook, type CodebookPredefinedVariable, type CompilerOption, type CompilerOutput, ConditionGroupType, type ExcludeByPageAction, ExcludeByPageIdSelectItem, type ExcludeByTagAction, ExcludeByTagSelectItem, type ID, type ImageFile, JumpToActionManager, type JumpToPageAction, JumpToPageSelectItem, MultiSelectItem, OperatorSelectItem, OptionID, PageActionManager, PageID, PagePrefix, type PagePrefixValue, QuestionID, RuleCustomVariable, RuleInput, RuleOptionSelectItem, RuleQuestionVariable, type RuleVariable, RuleVariableOption, RuleVariableSelectItem, SchemaConfig, SchemaID, SchemaPrefix, type SchemaPrefixValue, SingleSelectItem, SumScore, type SumScoreAnswer, SumScoreVariable, type SumScoreVariableDto, SumScoreVariableID, TagActionManager, TagCollection, TagID, TextID, VarID, type VideoFile, _CodeBook, createTypedIdSingleton };

package/dist/public-api.js

@@ -54,6 +54,7 @@ __export(public_api_exports, {
   SchemaPrefix: () => SchemaPrefix,
   SingleSelectItem: () => SingleSelectItem,
   SumScore: () => SumScore,
+  SumScoreVariable: () => SumScoreVariable,
   SumScoreVariableID: () => SumScoreVariableID,
   TagActionManager: () => TagActionManager,
   TagCollection: () => TagCollection,
@@ -1309,6 +1310,7 @@ var BuilderPage = class _BuilderPage extends BuilderObject {
   set prefix(value) {
     this._prefix.value = value;
   }
+  /** @internal */
   sumScoreVariableSet(sumScoreVariable, weight) {
     const { id, name, description } = sumScoreVariable;
     this._includedInSumScores.set(sumScoreVariable.id, {
@@ -1319,7 +1321,8 @@ var BuilderPage = class _BuilderPage extends BuilderObject {
     });
     return true;
   }
-  sumScoreVariableUpdateData(variables) {
+  /** @internal */
+  updateRelationShips(variables) {
     variables.forEach((v) => {
       const sumScoreEntry = this._includedInSumScores.get(v.id);
       if (sumScoreEntry) {
@@ -1372,6 +1375,15 @@ var BuilderPage = class _BuilderPage extends BuilderObject {
       this._backgroundColor = color;
     }
   }
+  /**
+   * @internal
+   */
+  _isIncludedInSumScore(sumScoreId) {
+    return this._includedInSumScores.has(sumScoreId);
+  }
+  /**
+   * @internal
+   */
   sumScoreVariableDelete(sumScoreVariableID) {
     this._includedInSumScores.delete(sumScoreVariableID);
   }
@@ -1958,7 +1970,11 @@ var SumScoreVariable = class _SumScoreVariable extends BuilderObject {
   _name = "";
   _description = "";
   _error = "";
+  _usedIn = [];
   // private _basedOn = new Map<pageId: Page>()
+  get usedIn() {
+    return [...this._usedIn];
+  }
   // private _basedOn: Array<{ varId: string }> = [];
   static create = (data) => {
     const id = SumScoreVariableID.create();
@@ -2010,6 +2026,10 @@ var SumScoreVariable = class _SumScoreVariable extends BuilderObject {
   _setError(error) {
     this._error = error;
   }
+  /** @internal - used by sum-score-variable-collection */
+  _setUsedInPages(pages) {
+    this._usedIn = [...pages];
+  }
   get name() {
     return this._name;
   }
@@ -2269,9 +2289,14 @@ var BuilderPageCollection = class _BuilderPageCollection {
     maybePage.sumScoreVariableSet(sumScoreVariable, weight);
     return true;
   }
-  updateAllData(context) {
+  updateRelationShips(context) {
+    const { sumScoreVariables } = context;
     this._all.forEach((p) => {
-      p.sumScoreVariableUpdateData(context.sumScoreVariables);
+      p.updateRelationShips(context.sumScoreVariables);
+    });
+    sumScoreVariables.forEach((v) => {
+      const usedInPages = this._all.filter((p) => p._isIncludedInSumScore(v.id));
+      v._setUsedInPages(usedInPages);
     });
   }
   sumScoreVariableDelete(sumScoreVariableID) {
@@ -2279,6 +2304,13 @@ var BuilderPageCollection = class _BuilderPageCollection {
       p.sumScoreVariableDelete(sumScoreVariableID);
     });
   }
+  sumScoreVariableDeleteFromPage(pageId, sumScoreVariableId) {
+    const maybePage = this.getPageById(pageId);
+    if (!maybePage)
+      return false;
+    maybePage.sumScoreVariableDelete(sumScoreVariableId);
+    return true;
+  }
 };
 
 // src/Builder-schema.ts
@@ -2336,6 +2368,7 @@ var BuilderSchema = class _BuilderSchema {
     const rulesDto = dto.rules ?? [];
     const ruleInput = schema.getRuleInput();
     schema._rules = rulesDto.map((r) => BuilderRule.fromDto(r, ruleInput));
+    schema.updateSumScoreRelations();
     return schema;
   }
   toJson() {
@@ -2367,13 +2400,23 @@ var BuilderSchema = class _BuilderSchema {
     return variable;
   }
   sumScoreVariableAddToPage(sumScoreVariable, page, weight) {
-    return this._pageCollection.addSumScoreVariable(sumScoreVariable, page.id, weight);
+    const added = this._pageCollection.addSumScoreVariable(sumScoreVariable, page.id, weight);
+    this.updateSumScoreRelations();
+    return added;
+  }
+  updateSumScoreRelations() {
+    const sumScoreVariables = this._sumScoreCollection.asArray();
+    this._pageCollection.updateRelationShips({ sumScoreVariables });
   }
   sumScoreVariableUpdate(id, data) {
     const didUpdate = this._sumScoreCollection._updateOne(id, data);
-    this._pageCollection.updateAllData({ sumScoreVariables: this._sumScoreCollection.asArray() });
+    this.updateSumScoreRelations();
     return didUpdate;
   }
+  sumScoreVariableDeleteFromPage(pageId, sumScoreVariableId) {
+    this._pageCollection.sumScoreVariableDeleteFromPage(pageId, sumScoreVariableId);
+    this.updateSumScoreRelations();
+  }
   insertPage(page, atIndex) {
     return this.insertPageAtIndex(page, atIndex);
   }
@@ -2485,7 +2528,7 @@ var BuilderSchema = class _BuilderSchema {
   sumScoreVariableDelete(id) {
     const didDelete = this._sumScoreCollection._deleteVariable(id);
     const sumScoreVariables = [...this._sumScoreCollection];
-    this._pageCollection.updateAllData({ sumScoreVariables });
+    this._pageCollection.updateRelationShips({ sumScoreVariables });
     this._pageCollection.sumScoreVariableDelete(id);
     return didDelete;
   }
@@ -2620,6 +2663,9 @@ var calculate = (sumScoreVariable, basedOnVariables, answers) => {
   });
   const avg = sumScore / includedAnswerCount;
   const result = {
+    sumScoreVariableId: sumScoreVariable.id,
+    name: sumScoreVariable.name,
+    description: sumScoreVariable.description,
     avg,
     useAvg,
     includedAnswerCount,
@@ -2684,6 +2730,7 @@ var SumScore = {
   SchemaPrefix,
   SingleSelectItem,
   SumScore,
+  SumScoreVariable,
   SumScoreVariableID,
   TagActionManager,
   TagCollection,