@configura/web-api 1.6.0-iotest.2 → 1.6.1-alpha.1

package/dist/productConfiguration/CfgOption.d.ts

@@ -10,16 +10,25 @@ export declare type OptionChangeNotification = {
 };
 export declare enum ProductConfigurationBubbleMode {
     /**
-     * Bubble to the closest CfgProduct, let it revalidate, then that will continue
-     * the bubble after validate.
+     * If this is select it will turns on all ancestors all the way up.
+     */
+    BubbleSelected = "BubbleSelected",
+    /**
+     * Bubble to the closest CfgProduct, let it revalidate, then that will continue the bubble
+     * after validate.
      */
     Validate = "Validate",
     /**
-     * Bubble to the closest CfgProduct, let it revalidate, then that will continue
-     * the bubble after validate. If this is select it will turns on all ancestors all the way up.
+     * Bubble to the closest CfgProduct, let it revalidate, then that will continue the bubble
+     * after validate. If this is select it will turn on all ancestors all the way up.
      * So with this mode it is possible to select an option where its parents are not selected.
      */
     ValidateAndBubbleSelected = "ValidateAndBubbleSelected",
+    /**
+     * Like ValidateAndBubbleSelected, but SyncGroups are applied after ValidateAndBubbleSelected
+     * has been done
+     */
+    ValidateAndBubbleSelectedAndApplySyncGroups = "ValidateAndBubbleSelectedAndApplySyncGroups",
     /**
      * Stop bubbling
      * This mode supports internal functionality and is not expected to be used by integrators.
@@ -44,10 +53,9 @@ export declare enum ProductConfigurationBubbleMode {
     ToRoot = "ToRoot"
 }
 /**
- * This class is meant to only be used through CfgOption. It should
- * never be instantiated on its own. Normally the internal state of this class
- * should never be directly modified. CfgOption is the class that
- * should be used and interacted with.
+ * This class is only meant to be used through CfgOption. It should never be instantiated on its
+ * own. Normally the internal state of this class should never be directly modified. CfgOption is
+ * the class that should be used and interacted with.
  */
 export declare class _CfgOptionInternal {
     readonly rawOption: Option;
@@ -118,6 +126,11 @@ export declare class CfgOption {
     get selected(): boolean;
     /** Are all ancestors up to the CfgProductConfiguration selected? Includes self. */
     get ancestorsSelected(): boolean;
+    /**
+     * Selects this Option.
+     * Only Options belonging to Features that are "select many" can be deselected.
+     * Calling this will cause a validation call to the server.
+     */
     setSelected: (on: boolean) => Promise<boolean>;
     get thumbnail(): string | undefined;
     get upcharge(): number | undefined;

package/dist/productConfiguration/CfgOption.js

@@ -18,16 +18,25 @@ import { getMtrlPreview, syncCfgFeatures } from "./utilitiesProductConfiguration
 export var ProductConfigurationBubbleMode;
 (function (ProductConfigurationBubbleMode) {
     /**
-     * Bubble to the closest CfgProduct, let it revalidate, then that will continue
-     * the bubble after validate.
+     * If this is select it will turns on all ancestors all the way up.
+     */
+    ProductConfigurationBubbleMode["BubbleSelected"] = "BubbleSelected";
+    /**
+     * Bubble to the closest CfgProduct, let it revalidate, then that will continue the bubble
+     * after validate.
      */
     ProductConfigurationBubbleMode["Validate"] = "Validate";
     /**
-     * Bubble to the closest CfgProduct, let it revalidate, then that will continue
-     * the bubble after validate. If this is select it will turns on all ancestors all the way up.
+     * Bubble to the closest CfgProduct, let it revalidate, then that will continue the bubble
+     * after validate. If this is select it will turn on all ancestors all the way up.
      * So with this mode it is possible to select an option where its parents are not selected.
      */
     ProductConfigurationBubbleMode["ValidateAndBubbleSelected"] = "ValidateAndBubbleSelected";
+    /**
+     * Like ValidateAndBubbleSelected, but SyncGroups are applied after ValidateAndBubbleSelected
+     * has been done
+     */
+    ProductConfigurationBubbleMode["ValidateAndBubbleSelectedAndApplySyncGroups"] = "ValidateAndBubbleSelectedAndApplySyncGroups";
     /**
      * Stop bubbling
      * This mode supports internal functionality and is not expected to be used by integrators.
@@ -66,10 +75,9 @@ function doesChildrenShareOptionsCode(features) {
     return false;
 }
 /**
- * This class is meant to only be used through CfgOption. It should
- * never be instantiated on its own. Normally the internal state of this class
- * should never be directly modified. CfgOption is the class that
- * should be used and interacted with.
+ * This class is only meant to be used through CfgOption. It should never be instantiated on its
+ * own. Normally the internal state of this class should never be directly modified. CfgOption is
+ * the class that should be used and interacted with.
  */
 export class _CfgOptionInternal {
     constructor(rawOption, allRawFeatures, siblingHasDuplicateDescription, parent, parentConfiguration, parentProduct, rootProduct) {
@@ -93,7 +101,8 @@ export class _CfgOptionInternal {
             features[i] = freshRef;
             // In CfgOption we let stop bubble slip through. This is because CfgOption is sort of
             // a semi level. Like Feature + Option together constitutes one level.
-            if (bubbleMode === ProductConfigurationBubbleMode.ValidateAndBubbleSelected) {
+            if (bubbleMode === ProductConfigurationBubbleMode.ValidateAndBubbleSelected ||
+                bubbleMode === ProductConfigurationBubbleMode.BubbleSelected) {
                 // selectOption takes care of the bubble
                 yield this.parent.selectOption(this, true, bubbleMode);
             }
@@ -170,9 +179,8 @@ export class _CfgOptionInternal {
             agg.push(...feature._internal._getFeaturesWithCode(code));
             return agg;
         }, []);
-        // Description based key helps when switching between
-        // products with similar feature-options tree and trying
-        // to retain made selection
+        // Description based key helps when switching between products with similar feature-options
+        // tree and trying to retain made selection.
         this.key =
             this.description +
                 (this.description === "" || siblingHasDuplicateDescription ? this.code : "");
@@ -219,9 +227,9 @@ export class _CfgOptionInternal {
                     this._numericValue = val;
                     change = true;
                 }
-                // It could be that even though our value did not change some sibling value did, and this
-                // could make it needed to bubble later. Maybe. A bit uncertain about why I did not put
-                // this in the if-statement above //Linus
+                // It could be that even though our value did not change some sibling value did, and
+                // this could make it needed to bubble later. Maybe. A bit uncertain about why I did
+                // not put this in the if-statement above //Linus
                 if (yield this.parent.pushStretch()) {
                     change = true;
                 }
@@ -233,7 +241,7 @@ export class _CfgOptionInternal {
             }
             else {
                 if (change) {
-                    yield this.parent._childHasChanged(this, ProductConfigurationBubbleMode.Stop);
+                    yield this.parent._childHasChanged(this, ProductConfigurationBubbleMode.OneLevel);
                 }
             }
             return change;
@@ -320,13 +328,13 @@ export class CfgOption {
         this.isBackedBySame = (other) => this._internal === other._internal;
         this.setNumericValue = (val, doSelectOption) => __awaiter(this, void 0, void 0, function* () { return yield this._internal.setNumericValue(val, doSelectOption); });
         this.isAllowedNumericValue = (val) => this._internal.isAllowedNumericValue(val);
-        /*
+        /**
          * Selects this Option.
          * Only Options belonging to Features that are "select many" can be deselected.
          * Calling this will cause a validation call to the server.
          */
         this.setSelected = (on) => __awaiter(this, void 0, void 0, function* () {
-            return yield this._internal.parent.selectOption(this._internal, on, ProductConfigurationBubbleMode.ValidateAndBubbleSelected);
+            return yield this._internal.parent.selectOption(this._internal, on, ProductConfigurationBubbleMode.ValidateAndBubbleSelectedAndApplySyncGroups);
         });
         this.listenForChange = (l) => this._internal.changeObservable.listen(l);
         this.stopListenForChange = (l) => this._internal.changeObservable.stopListen(l);

package/dist/productConfiguration/CfgProductConfiguration.d.ts

@@ -5,7 +5,6 @@ import { CfgFeature, _CfgFeatureInternal } from "./CfgFeature.js";
 import { ProductConfigurationBubbleMode } from "./CfgOption.js";
 export declare type ProductConfigurationChangeNotification = {
     freshRef: CfgProductConfiguration;
-    committed: boolean;
 };
 export declare type LengthValue = {
     length: number;
@@ -53,7 +52,7 @@ export declare class _CfgProductConfigurationInternal {
     /** Only selected features. */
     _getFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
     populateFeatures: (rootFeatureRefs: FeatureRef[]) => void;
-    setStretchReferenceLength: (measureParamCode: string, referenceLength: number | undefined, unit: LengthUnit) => Promise<boolean>;
+    setStretchReferenceLength: (measureParamCode: string, referenceLength: number | undefined, unit: LengthUnit, doNotify?: boolean) => Promise<boolean>;
 }
 export declare class CfgProductConfiguration {
     readonly _internal: _CfgProductConfigurationInternal;

package/dist/productConfiguration/CfgProductConfiguration.js

@@ -27,7 +27,7 @@ export class _CfgProductConfigurationInternal {
         this._rootFeatureRefs = [];
         this._features = [];
         this.changeObservable = new Observable();
-        this._notifyAllOfChange = (bubbleMode, committed) => __awaiter(this, void 0, void 0, function* () {
+        this._notifyAllOfChange = (bubbleMode) => __awaiter(this, void 0, void 0, function* () {
             if (bubbleMode === ProductConfigurationBubbleMode.Stop) {
                 return;
             }
@@ -35,14 +35,13 @@ export class _CfgProductConfigurationInternal {
             const parent = this.parentProduct;
             this.changeObservable.notifyAll({
                 freshRef,
-                committed,
             });
             if (parent === undefined) {
                 return;
             }
             yield parent._configurationHasChanged(freshRef, bubbleMode === ProductConfigurationBubbleMode.OneLevel
                 ? ProductConfigurationBubbleMode.Stop
-                : bubbleMode, committed);
+                : bubbleMode);
         });
         /** Called by child to tell its parent that it has changed. */
         this._childHasChanged = (freshRef, bubbleMode) => __awaiter(this, void 0, void 0, function* () {
@@ -52,7 +51,7 @@ export class _CfgProductConfigurationInternal {
                 throw Error("Child feature not found");
             }
             features[i] = freshRef;
-            yield this._notifyAllOfChange(bubbleMode, true);
+            yield this._notifyAllOfChange(bubbleMode);
         });
         this.getApiSelection = () => this._features.map((f) => {
             return { code: "!~!", next: f._internal.getApiSelection() };
@@ -71,7 +70,7 @@ export class _CfgProductConfigurationInternal {
             if (change) {
                 yield this._notifyAllOfChange(bubbleToRoot
                     ? ProductConfigurationBubbleMode.ToRoot
-                    : ProductConfigurationBubbleMode.OneLevel, true);
+                    : ProductConfigurationBubbleMode.OneLevel);
             }
             return change;
         });
@@ -103,7 +102,7 @@ export class _CfgProductConfigurationInternal {
             if (change) {
                 yield this._notifyAllOfChange(validate
                     ? ProductConfigurationBubbleMode.Validate
-                    : ProductConfigurationBubbleMode.OneLevel, true);
+                    : ProductConfigurationBubbleMode.OneLevel);
             }
             return change;
         });
@@ -116,7 +115,7 @@ export class _CfgProductConfigurationInternal {
             this._rootFeatureRefs = rootFeatureRefs;
             this._features = syncCfgFeatures(rootFeatureRefs, this._features, this.allRawFeatures, this, this, this.parentProduct, this.rootProduct);
         };
-        this.setStretchReferenceLength = (measureParamCode, referenceLength, unit) => __awaiter(this, void 0, void 0, function* () {
+        this.setStretchReferenceLength = (measureParamCode, referenceLength, unit, doNotify = true) => __awaiter(this, void 0, void 0, function* () {
             if (measureParamCode === "") {
                 return false;
             }
@@ -147,7 +146,9 @@ export class _CfgProductConfigurationInternal {
                 }
                 stretchReferenceLength.current = referenceLengthWithUnit;
             }
-            yield this._notifyAllOfChange(ProductConfigurationBubbleMode.ToRoot, false);
+            if (doNotify) {
+                yield this._notifyAllOfChange(ProductConfigurationBubbleMode.ToRoot);
+            }
             return true;
         });
         // Useful debug tool:

package/dist/syncGroups/SyncGroupsApplier.d.ts

@@ -0,0 +1,20 @@
+import { SyncGroup } from "../CatalogueAPI.js";
+import { _CfgOptionInternal } from "../productConfiguration/CfgOption.js";
+import { SyncCode } from "./SyncGroupsHandler.js";
+import { SyncGroupsTransaction } from "./SyncGroupsTransaction.js";
+export declare class SyncGroupsApplier {
+    /**
+     * At load of a new product this is used to move it into a synced state
+     */
+    static init(transaction: SyncGroupsTransaction): Promise<boolean>;
+    /**
+     * At an active select of an option this is the entry point
+     */
+    static selectOption(transaction: SyncGroupsTransaction, option: _CfgOptionInternal, on: boolean): Promise<boolean>;
+    /**
+     * @returns undefined if the @syncGroup is undefined, false if
+     * the @mustSupport is not fulfilled or the syncCode if all is ok
+     */
+    static getSyncCode(syncGroup: SyncGroup | undefined, mustSupport: "push" | "pull"): SyncCode | undefined | false;
+}
+//# sourceMappingURL=SyncGroupsApplier.d.ts.map