@configura/web-api 1.5.0-alpha.0 → 1.6.1-alpha.0

package/dist/productConfiguration/CfgFeature.js

@@ -11,6 +11,7 @@ import { compareArrays, convertLength, count, Observable, someMatch, toLengthUni
 import { CfgProduct } from "../CfgProduct.js";
 import { CfgMtrlApplication } from "../material/CfgMtrlApplication.js";
 import { CfgMtrlApplicationSource } from "../material/CfgMtrlApplicationSource.js";
+import { wrapWithCache } from "../productLoader.js";
 import { CfgOption, ProductConfigurationBubbleMode } from "./CfgOption.js";
 import { _CfgProductConfigurationInternal } from "./CfgProductConfiguration.js";
 import { getMtrlPreview } from "./utilitiesProductConfiguration.js";
@@ -306,6 +307,15 @@ export class _CfgFeatureInternal {
          * Using a validate bubbleMode will cause validation calls to the server.
          */
         this.selectOption = (optionInternal, on, bubbleMode) => __awaiter(this, void 0, void 0, function* () {
+            if (bubbleMode ===
+                ProductConfigurationBubbleMode.ValidateAndBubbleSelectedAndApplySyncGroups) {
+                const product = this.rootProduct;
+                const syncGroupHandler = product.syncGroupHandler;
+                if (syncGroupHandler === undefined) {
+                    throw new Error(`No sync group handler when bubble mode ${ProductConfigurationBubbleMode.ValidateAndBubbleSelectedAndApplySyncGroups}`);
+                }
+                return yield syncGroupHandler.selectOption(product, optionInternal.path, on, wrapWithCache(product._productLoaderRaw));
+            }
             if (!on) {
                 if (this.selectionType === SelectionType.Group) {
                     throw new Error(`Multiple features are always selected and are not user selectable. Feature key: "${this.key}".`);
@@ -357,11 +367,18 @@ export class _CfgFeatureInternal {
             if (isAllOptionsAffectedByAnySelection) {
                 this._freshRefAllOptions();
             }
-            // If this was a deselect action we shall not bubble selected, that is, we shall not
-            // select the ancestors if this action was deselect.
-            yield this._notifyAllOfChange(!on && bubbleMode === ProductConfigurationBubbleMode.ValidateAndBubbleSelected
-                ? ProductConfigurationBubbleMode.Validate
-                : bubbleMode);
+            let nextLevelBubbleMode = bubbleMode;
+            if (!on) {
+                // If this was a deselect action we shall not bubble selected, that is, we shall not
+                // select the ancestors if this action was deselect.
+                if (bubbleMode === ProductConfigurationBubbleMode.ValidateAndBubbleSelected) {
+                    nextLevelBubbleMode = ProductConfigurationBubbleMode.Validate;
+                }
+                else if (bubbleMode === ProductConfigurationBubbleMode.BubbleSelected) {
+                    nextLevelBubbleMode = ProductConfigurationBubbleMode.ToRoot;
+                }
+            }
+            yield this._notifyAllOfChange(nextLevelBubbleMode);
             return isActualChange;
         });
         this.isSelected = (option) => this.selectionType === SelectionType.Group ||
@@ -412,6 +429,9 @@ export class _CfgFeatureInternal {
         }
         return value;
     }
+    get syncGroup() {
+        return this.rawFeature.syncGroup;
+    }
     get description() {
         return this.rawFeature.description;
     }
@@ -450,12 +470,24 @@ export class _CfgFeatureInternal {
     get preview() {
         return getMtrlPreview(this._mtrlApplications);
     }
+    /**
+     * Please note that this relates to the visibility in the Configuration tree.
+     * It does not affect the visibility of anything in the 3D view at all.
+     */
     get visibleIfAdditionalProduct() {
         return this.rawFeature.hideIfAdditionalProduct !== true;
     }
+    /**
+     * Please note that this relates to the visibility in the Configuration tree.
+     * It does not affect the visibility of anything in the 3D view at all.
+     */
     get visibleIfMainProduct() {
         return this.rawFeature.hideIfMainProduct !== true;
     }
+    /**
+     * Please note that this relates to the visibility in the Configuration tree.
+     * It does not affect the visibility of anything in the 3D view at all.
+     */
     get visible() {
         return this.parentProduct.isAdditionalProduct
             ? this.visibleIfAdditionalProduct
@@ -470,6 +502,23 @@ export class _CfgFeatureInternal {
         }
         return this._options;
     }
+    get path() {
+        return [...this.parent.path, this.code];
+    }
+    getFromPath(path) {
+        path = path.slice();
+        const s = path.shift();
+        switch (s) {
+            case undefined:
+                return this;
+            default:
+                const option = this.options.find((o) => o.code === s);
+                if (option === undefined) {
+                    throw new Error(`Option not found ${s}, ${path.join(", ")}`);
+                }
+                return option._internal.getFromPath(path);
+        }
+    }
     /**
      * Make fresh references to all options on this feature.
      * Also includes currently selected options.
@@ -519,7 +568,7 @@ export class CfgFeature {
          * Calling this will cause a validation call to the server.
          */
         this.selectOption = (option, on) => __awaiter(this, void 0, void 0, function* () {
-            return yield this._internal.selectOption(option._internal, on, ProductConfigurationBubbleMode.ValidateAndBubbleSelected);
+            return yield this._internal.selectOption(option._internal, on, ProductConfigurationBubbleMode.ValidateAndBubbleSelectedAndApplySyncGroups);
         });
         this.isSelected = (option) => this._internal.isSelected(option._internal);
         this.listenForChange = (l) => this._internal.changeObservable.listen(l);
@@ -588,6 +637,8 @@ export class CfgFeature {
         return this._internal.options;
     }
     /**
+     * Please note that this relates to the visibility in the Configuration tree.
+     * It does not affect the visibility of anything in the 3D view at all.
      * Visibility is not inherited. If this is hidden the children
      * of this Feature might still be visible, depending on their settings.
      */

package/dist/productConfiguration/CfgOption.d.ts

@@ -1,6 +1,6 @@
 import { LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
 import { Feature, Option, SelectedOption } from "../CatalogueAPI.js";
-import { CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
+import { CfgPath, CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
 import { CfgMtrlApplication } from "../material/CfgMtrlApplication.js";
 import { NumericValuesSelection } from "../utilitiesNumericValues.js";
 import { CfgFeature, _CfgFeatureInternal } from "./CfgFeature.js";
@@ -9,6 +9,10 @@ export declare type OptionChangeNotification = {
     freshRef: CfgOption;
 };
 export declare enum ProductConfigurationBubbleMode {
+    /**
+     * 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.
@@ -20,6 +24,11 @@ export declare enum ProductConfigurationBubbleMode {
      * 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.
@@ -81,6 +90,8 @@ export declare class _CfgOptionInternal {
     _childHasChanged: (freshRef: CfgFeature, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
     getApiSelection: () => SelectedOption;
     setApiSelection: (apiOptionSelection: SelectedOption | undefined) => Promise<boolean>;
+    get path(): CfgPath;
+    getFromPath(path: CfgPath): _CfgFeatureInternal | _CfgOptionInternal;
     structureCompare: (other: _CfgOptionInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
     tryMatchSelection: (other: CfgOption, descriptionMatch?: boolean) => Promise<boolean>;
     keyMatch: (other: _CfgOptionInternal, descriptionMatch?: boolean) => boolean;

package/dist/productConfiguration/CfgOption.js

@@ -17,6 +17,10 @@ import { CfgFeature, SelectionType } from "./CfgFeature.js";
 import { getMtrlPreview, syncCfgFeatures } from "./utilitiesProductConfiguration.js";
 export var ProductConfigurationBubbleMode;
 (function (ProductConfigurationBubbleMode) {
+    /**
+     * 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.
@@ -28,6 +32,11 @@ export var ProductConfigurationBubbleMode;
      * 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.
@@ -93,7 +102,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);
             }
@@ -300,6 +310,23 @@ export class _CfgOptionInternal {
         }
         return this._features;
     }
+    get path() {
+        return [...this.parent.path, this.code];
+    }
+    getFromPath(path) {
+        path = path.slice();
+        const s = path.shift();
+        switch (s) {
+            case undefined:
+                return this;
+            default:
+                const feature = this.features.find((o) => o.code === s);
+                if (feature === undefined) {
+                    throw new Error(`Feature not found ${s}, ${path.join(", ")}`);
+                }
+                return feature._internal.getFromPath(path);
+        }
+    }
     _freshRefDescendants() {
         const features = this._features || [];
         for (let i = 0; i < features.length; i++) {
@@ -326,7 +353,7 @@ export class CfgOption {
          * 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

@@ -1,8 +1,8 @@
 import { LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
 import { Feature, FeatureRef, SelectedOption } from "../CatalogueAPI.js";
-import { CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
+import { CfgPath, CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
 import { CfgFeature, _CfgFeatureInternal } from "./CfgFeature.js";
-import { ProductConfigurationBubbleMode } from "./CfgOption.js";
+import { ProductConfigurationBubbleMode, _CfgOptionInternal } from "./CfgOption.js";
 export declare type ProductConfigurationChangeNotification = {
     freshRef: CfgProductConfiguration;
 };
@@ -43,6 +43,8 @@ export declare class _CfgProductConfigurationInternal {
      * outside we want notifications to bubble all the way to the root.
      */
     setApiSelection: (selectedOptions: SelectedOption[], bubbleToRoot: boolean) => Promise<boolean>;
+    get path(): CfgPath;
+    getFromPath(path: CfgPath): _CfgProductConfigurationInternal | _CfgFeatureInternal | _CfgOptionInternal;
     structureCompare: (other: _CfgProductConfigurationInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
     /**
      * When used internally the notifications are taken care off by the caller, but if set from

package/dist/productConfiguration/CfgProductConfiguration.js

@@ -215,6 +215,23 @@ export class _CfgProductConfigurationInternal {
             features[i] = CfgFeature._makeNewRefFrom(featureInternal);
         }
     }
+    get path() {
+        return [...this.parentProduct.path, "c"];
+    }
+    getFromPath(path) {
+        path = path.slice();
+        const s = path.shift();
+        switch (s) {
+            case undefined:
+                return this;
+            default:
+                const feature = this.features.find((f) => f.code === s);
+                if (feature === undefined) {
+                    throw new Error(`Feature not found ${s}, ${path.join(", ")}`);
+                }
+                return feature._internal.getFromPath(path);
+        }
+    }
 }
 export class CfgProductConfiguration {
     /**

package/dist/productLoader.d.ts

@@ -1,4 +1,4 @@
-import { GetProductParams, PostValidateParams, ValidateRequest } from "./CatalogueAPI";
+import { GetProductParams, PostValidateParams, ValidateRequest } from "./CatalogueAPI.js";
 import { CfgProductResponse, CfgValidateResponse } from "./utilitiesCatalogueData.js";
 export declare type GetProduct = (params: GetProductParams) => Promise<CfgProductResponse>;
 export declare type PostValidate = (params: PostValidateParams, body: ValidateRequest) => Promise<CfgValidateResponse>;

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