@configura/web-api 2.0.0-alpha.2 → 2.0.0-alpha.20

package/dist/syncGroups/SyncGroupsTransaction.js

@@ -13,6 +13,12 @@ import { SelectionType, } from "../productConfiguration/CfgFeature.js";
 import { ProductConfigurationBubbleMode, } from "../productConfiguration/CfgOption.js";
 import { SyncGroupsApplyMode } from "./SyncGroupsApplyMode.js";
 import { SyncGroupsPathHelper } from "./SyncGroupsPathHelper.js";
+var AffectedLevel;
+(function (AffectedLevel) {
+    AffectedLevel[AffectedLevel["None"] = 0] = "None";
+    AffectedLevel[AffectedLevel["Initialized"] = 1] = "Initialized";
+    AffectedLevel[AffectedLevel["Set"] = 2] = "Set";
+})(AffectedLevel || (AffectedLevel = {}));
 /**
  * The Transaction is a transient object used to track all the changes made to the supplied
  * SyncGroupState as a result of a (normally) single initial event, like when opening a product
@@ -39,7 +45,7 @@ import { SyncGroupsPathHelper } from "./SyncGroupsPathHelper.js";
 export class SyncGroupsTransaction {
     constructor(syncState, updateMode, productLoader, original, target, initial) {
         this._closed = false;
-        this.affectedSelectOneFeatures = new Set();
+        this.affectedSelectOneFeatures = new Map();
         this.affectedSelectManyOptions = new Set();
         this.affectedSelectOneSyncGroups = new Set();
         this.affectedSelectManySyncGroupsAndOptions = new Map();
@@ -104,7 +110,7 @@ export class SyncGroupsTransaction {
                 change = true;
                 switch (feature.selectionType) {
                     case SelectionType.SelectOne:
-                        this.affectedSelectOneFeatures.add(feature);
+                        this.affectedSelectOneFeatures.set(feature, AffectedLevel.Set);
                         break;
                     case SelectionType.SelectMany:
                         this.affectedSelectManyOptions.add(option);
@@ -266,14 +272,19 @@ export class SyncGroupsTransaction {
         return __awaiter(this, void 0, void 0, function* () {
             const feature = featureWithInitial.target;
             const featureDidJustComeIntoScope = featureWithInitial.initial === undefined;
-            if (this.affectedSelectOneFeatures.has(feature)) {
-                // This feature has already changed selection once for this transaction. We expect
-                // this to happen very rarely, as the algorithm should settle the selection tree
-                // further and further out. Nevertheless, this safeguard is needed to avoid infinite
-                // looping if for example the server would return the same data over and over.
+            const hasBeenAffectedLevel = this.affectedSelectOneFeatures.get(feature);
+            const syncGroupHasBeenUpdated = this.affectedSelectOneSyncGroups.has(syncCode);
+            if (hasBeenAffectedLevel === AffectedLevel.Set ||
+                (!syncGroupHasBeenUpdated && hasBeenAffectedLevel === AffectedLevel.Initialized)) {
+                // A feature can change value for two reasons:
+                // 1. The feature did just come into scope and loads from the sync group to set its "defaults"
+                // 2. The sync group has updated with a new value
+                // The rule is that in one sync group transaction the feature value is allowed to be updated
+                // once or twice. Once for initialization and once for new sync group value. But they have to
+                // happen in the right order.
                 return "recurseDown";
             }
-            if (!featureDidJustComeIntoScope && !this.affectedSelectOneSyncGroups.has(syncCode)) {
+            if (!featureDidJustComeIntoScope && !syncGroupHasBeenUpdated) {
                 return "recurseDown";
             }
             const currentSyncGroupValue = this.syncState.getForSelectOne(syncCode);
@@ -295,7 +306,7 @@ export class SyncGroupsTransaction {
             // Do not recurse further as we will change the state and so what is selected now won't be
             // selected then.
             yield feature.selectOption(optionToSelect._internal, true, ProductConfigurationBubbleMode.ToRoot);
-            this.affectedSelectOneFeatures.add(feature);
+            this.affectedSelectOneFeatures.set(feature, syncGroupHasBeenUpdated ? AffectedLevel.Set : AffectedLevel.Initialized);
             productsToValidate.add(feature.parentProduct);
             return "stop";
         });
@@ -435,7 +446,7 @@ export class SyncGroupsTransaction {
             return change;
         });
     }
-    applySelectOneFeature(feature, activeSelectionForce, featureDidJustComeIntoScope) {
+    applySelectOneFeature(feature, userInitiated, featureDidJustComeIntoScope) {
         const selectionType = feature.selectionType;
         if (selectionType !== SelectionType.SelectOne) {
             throw new Error("can only be used for selectOne");
@@ -453,7 +464,7 @@ export class SyncGroupsTransaction {
             // Options with no default are never written
             return false;
         }
-        if (activeSelectionForce) {
+        if (userInitiated) {
             // To make re-apply happen, even if it actually does not update the sync group
             this.affectedSelectOneSyncGroups.add(syncCode);
         }
@@ -464,7 +475,7 @@ export class SyncGroupsTransaction {
         // can not be set to the current sync group value, then it will set in the opposite
         // direction. Like if the sync group was empty. To avoid bouncing back and forth we will
         // need to enforce that a sync group can only be updated once per transaction
-        if (!(activeSelectionForce ||
+        if (!(userInitiated ||
             currentSyncGroupOptionCode === undefined ||
             (featureDidJustComeIntoScope &&
                 feature.options.every((o) => currentSyncGroupOptionCode !== o.code)))) {
@@ -486,7 +497,7 @@ export class SyncGroupsTransaction {
         }
         return change;
     }
-    applySelectManyOption(option, activeSelectionForce) {
+    applySelectManyOption(option, userInitiated) {
         const feature = option.parent;
         if (feature.selectionType !== SelectionType.SelectMany) {
             throw new Error("can only be used for selectMany");
@@ -500,14 +511,14 @@ export class SyncGroupsTransaction {
         }
         const optionSelected = option.selected;
         const currentSyncGroupValue = this.syncState.getForSelectMany(syncCode, option.code);
-        if (activeSelectionForce) {
+        if (userInitiated) {
             // To make re-apply happen, even if it actually does not update the sync group
             this.addSyncGroupAffectedForSelectMany(syncCode, option);
         }
-        // We only initialize if the option is selected or we force.
-        // activeSelectionForce = active selection by the user.
-        if (!(currentSyncGroupValue === undefined && optionSelected) &&
-            !(activeSelectionForce && currentSyncGroupValue !== optionSelected)) {
+        // We only initialize if the option has not been initiated or if it is userInitiated.
+        // userInitiated = active selection by the user.
+        if (currentSyncGroupValue !== undefined &&
+            !(userInitiated && currentSyncGroupValue !== optionSelected)) {
             return false;
         }
         this.addSyncGroupAffectedForSelectMany(syncCode, option);
@@ -529,7 +540,9 @@ export class SyncGroupsTransaction {
 }
 function getAdditionalProducts(product) {
     const initial = product.initial;
-    return product.target.additionalProducts.map((childTarget) => {
+    return product.target.additionalProducts
+        .filter((p) => p.selected)
+        .map((childTarget) => {
         const refKey = childTarget.refKey;
         const childInitial = initial === null || initial === void 0 ? void 0 : initial.additionalProducts.find((p) => refKey === p.refKey);
         return {
@@ -558,8 +571,8 @@ function getOptions(feature) {
 }
 function pairFeatures(targets, initials) {
     return targets.map((childTarget) => {
-        const key = childTarget.key;
-        const childInitial = initials === null || initials === void 0 ? void 0 : initials.find((f) => key === f.key);
+        const code = childTarget.code;
+        const childInitial = initials === null || initials === void 0 ? void 0 : initials.find((f) => code === f.code);
         return {
             target: childTarget._internal,
             initial: childInitial === null || childInitial === void 0 ? void 0 : childInitial._internal,

package/dist/tasks/TaskHandler.d.ts

@@ -1,5 +1,5 @@
 import { Observable, SingleArgCallback } from "@configura/web-utilities";
-import { CatalogueAPI, DtoAdditionalProductConfiguration, DtoExportStatus, DtoExportStatusStatus, DtoProductParamsWithLang, DtoRenderStatus, DtoRenderStatusStatus, DtoTargetCameraArgs } from "../CatalogueAPI.js";
+import { CatalogueAPI, DtoAdditionalProductConfiguration, DtoExportStatus, DtoExportStatusStatus, DtoProductParamsWithCidAndLang, DtoRenderStatus, DtoRenderStatusStatus, DtoTargetCameraArgs } from "../CatalogueAPI.js";
 import { CfgProduct } from "../CfgProduct.js";
 import { RenderOrExportFormat } from "./formats.js";
 export declare type TasksChangeNotification = {
@@ -51,7 +51,7 @@ export declare abstract class Task<F extends RenderOrExportFormat> {
     protected constructor(taskHandler: _TaskHandlerInternal, format: F, product: CfgProduct, getPreviewUrl: (() => Promise<string>) | undefined);
     protected abstract postInit(): Promise<DtoRenderStatus | DtoExportStatus>;
     protected abstract pollStatus(): Promise<DtoRenderStatus | DtoExportStatus>;
-    protected _productParams: DtoProductParamsWithLang;
+    protected _productParams: DtoProductParamsWithCidAndLang;
     protected _apiSelection: DtoAdditionalProductConfiguration;
     private _status;
     private _uuid;

package/dist/tasks/TaskHandler.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { augmentErrorMessage, Observable } from "@configura/web-utilities";
 import { dtoExportFormatNames, dtoRenderFormatNames, } from "../CatalogueAPI.js";
+import { convertDtoProductConfToV1 } from "../ConfigurationConverter.js";
 import { isExportFormat, isRenderFormat } from "./formats.js";
 export class _TaskHandlerInternal {
     constructor(api) {
@@ -175,7 +176,7 @@ export class Task {
             this.taskHandler.removeTask(this);
         };
         this._productParams = product.prodParams;
-        this._apiSelection = product.getApiSelection();
+        this._apiSelection = convertDtoProductConfToV1(product.getDtoConf());
         if (getPreviewUrl !== undefined) {
             void getPreviewUrl().then((dataUrl) => {
                 this._previewUrl = dataUrl;

package/dist/tests/testData/dummyProductForTest.d.ts

@@ -1,5 +1,5 @@
-import { DtoCatalogueParamsWithLang } from "../../CatalogueAPI.js";
+import { DtoCatalogueParamsWithCidAndLang } from "../../CatalogueAPI.js";
 import { CfgProduct } from "../../CfgProduct.js";
-export declare const dummyCatId: DtoCatalogueParamsWithLang;
+export declare const dummyCatId: DtoCatalogueParamsWithCidAndLang;
 export declare const getDummyCfgProduct: () => Promise<CfgProduct>;
 //# sourceMappingURL=dummyProductForTest.d.ts.map

package/dist/tests/testData/testDataAdditionalProductInAdditionalProductInProductForTest.js

@@ -254,6 +254,7 @@ export const cfgProductTest = (testFunc, prepFunc) => __awaiter(void 0, void 0,
                 uuid: "",
                 validated: true,
                 productData,
+                features: []
             };
             collect.pushNotification(`Validate ${params.enterprise} ${params.prdCat} ${params.prdCatVersion} ${params.priceList} ${params.vendor} ${params.partNumber}`);
             return validateResponse;

package/dist/tests/testData/testDataCachedGetProduct.js

@@ -173,6 +173,7 @@ export const cachedProductLoaderTest = () => __awaiter(void 0, void 0, void 0, f
                 uuid: "",
                 validated: true,
                 productData,
+                features: []
             };
             return validateResponse;
         }),

package/dist/tests/testData/testDataCachedPostValidate.js

@@ -173,6 +173,7 @@ export const cachedProductLoaderTest = () => __awaiter(void 0, void 0, void 0, f
                 uuid: "",
                 validated: true,
                 productData,
+                features: [],
             };
             validateCounter.count++;
             return validateResponse;

package/dist/tests/testData/testDataProductAggregatedPrice.js

@@ -176,6 +176,7 @@ export const cfgProductPriceTest = (testFunc, featureOption) => __awaiter(void 0
                 uuid: "",
                 validated: true,
                 productData,
+                features: [],
             };
             return validateResponse;
         }),

package/dist/tests/testData/testDataUpcharge.js

@@ -99,6 +99,7 @@ export const getUpchargeProduct = (testFunc) => __awaiter(void 0, void 0, void 0
                 uuid: "",
                 validated: true,
                 productData,
+                features: [],
             };
             return validateResponse;
         }),

package/dist/utilitiesCatalogueData.d.ts

@@ -1,12 +1,12 @@
-import { DtoAdditionalProductRef, DtoCatalogueParams, DtoCatalogueParamsWithLang, DtoCatalogueParamsWithoutCid, DtoMeasureParam, DtoModel, DtoOrientation, DtoPartsData, DtoPrices, DtoProductData, DtoProductParams, DtoProductParamsWithLang, DtoProductResponse, DtoSelectedOption, DtoTransform, DtoValidateResponse, DtoVector } from "./CatalogueAPI.js";
+import { DtoAdditionalProductRef, DtoCatalogueParams, DtoCatalogueParamsWithCid, DtoCatalogueParamsWithCidAndLang, DtoMeasureParam, DtoModel, DtoOrientation, DtoPartsData, DtoPrices, DtoProductData, DtoProductParamsWithCid, DtoProductParamsWithCidAndLang, DtoProductResponse, DtoSelectedOption, DtoTransform, DtoValidateResponse, DtoVector } from "./CatalogueAPI.js";
 /**
  * Makes a string from the params which can be used as a key in for example React. Language is not respected.
  */
-export declare const makeCatalogueKey: (cat: DtoCatalogueParams) => string;
+export declare const makeCatalogueKey: (cat: DtoCatalogueParamsWithCid) => string;
 /**
  * Makes a string from the params which can be used as a key in for example React. Language is not respected.
  */
-export declare const makeProductKey: (prod: DtoProductParams) => string;
+export declare const makeProductKey: (prod: DtoProductParamsWithCid) => string;
 /**
  * Makes a string from selected options, can be used as a key for a selection.
  */
@@ -18,6 +18,11 @@ export declare type CfgProductData = Omit<Omit<DtoProductData, "models">, "parts
         selOptions: DtoSelectedOption[];
     };
 };
+/**
+ * Deep compare. Uses the JSON.stringify method for comparison
+ * @returns true if equal. Key and array order is respected.
+ */
+export declare function compareCfgProductData(pd1: CfgProductData, pd2: CfgProductData): boolean;
 export declare type CfgProductResponse = Omit<DtoProductResponse, "productData"> & {
     productData: CfgProductData;
 };
@@ -27,17 +32,17 @@ export declare type CfgValidateResponse = Omit<DtoValidateResponse, "productData
 };
 export declare function isModel(arg: unknown): arg is DtoModel;
 /** Replace empty strings with "-" for compatibility with the API. */
-export declare function correctDefaultsOnCatalogueParams<T extends DtoCatalogueParamsWithoutCid>(catId: T): T;
+export declare function correctDefaultsOnCatalogueParams<T extends DtoCatalogueParams>(catId: T): T;
 export declare function recursivelyGetPriceCodeValue(priceCodes: string[], prices: DtoPrices | undefined): number | undefined;
 export declare function comparePricesObjects(prices1: DtoPrices | undefined, prices2: DtoPrices | undefined): boolean;
-export declare const decodeCatalogueParams: <T extends DtoCatalogueParamsWithoutCid>(params: T) => T;
-export declare const decodeProductParams: <T extends DtoProductParams>(params: T) => T;
-export declare function isSameCatalogueParams(left: DtoCatalogueParamsWithoutCid, right: DtoCatalogueParamsWithoutCid): boolean;
+export declare const decodeCatalogueParams: <T extends DtoCatalogueParams>(params: T) => T;
+export declare const decodeProductParams: <T extends DtoProductParamsWithCid>(params: T) => T;
+export declare function isSameCatalogueParams(left: DtoCatalogueParams, right: DtoCatalogueParams): boolean;
 export declare function isSameVector(left: DtoVector, right: DtoVector): boolean;
 export declare function isSameOrientation(left: DtoOrientation, right: DtoOrientation): boolean;
 export declare function isSameAnchor(left: DtoMeasureParam, right: DtoMeasureParam): boolean;
 export declare function isSameTransform(left: DtoTransform, right: DtoTransform): boolean;
 export declare function isSameProductRef(left: DtoAdditionalProductRef, right: DtoAdditionalProductRef): boolean;
-export declare const isSameDtoCatalogueParamsWithLang: (left: DtoCatalogueParamsWithLang, right: DtoCatalogueParamsWithLang) => boolean;
-export declare const isSameDtoProductParamsWithLang: (left: DtoProductParamsWithLang, right: DtoProductParamsWithLang) => boolean;
+export declare const isSameDtoCatalogueParamsWithLang: (left: DtoCatalogueParamsWithCidAndLang, right: DtoCatalogueParamsWithCidAndLang) => boolean;
+export declare const isSameDtoProductParamsWithLang: (left: DtoProductParamsWithCidAndLang, right: DtoProductParamsWithCidAndLang) => boolean;
 //# sourceMappingURL=utilitiesCatalogueData.d.ts.map

package/dist/utilitiesCatalogueData.js

@@ -25,6 +25,13 @@ export const makeSelOptionsKey = (options) => options.reduce((p, option) => {
     p += "_}";
     return p;
 }, "");
+/**
+ * Deep compare. Uses the JSON.stringify method for comparison
+ * @returns true if equal. Key and array order is respected.
+ */
+export function compareCfgProductData(pd1, pd2) {
+    return JSON.stringify(pd1) === JSON.stringify(pd2);
+}
 export function isModel(arg) {
     return typeof arg === "object" && arg !== null && "cid" in arg && "uri" in arg;
 }

package/dist/utilitiesCataloguePermission.d.ts

@@ -1,10 +1,10 @@
-import { DtoCatalogueParams, DtoCataloguePermission } from "./CatalogueAPI.js";
+import { DtoCatalogueParamsWithCid, DtoCataloguePermission } from "./CatalogueAPI.js";
 interface CataloguePermissionByEnterpriseKey {
     [key: string]: DtoCataloguePermission[];
 }
 export declare const groupAndSortCataloguePermissions: (cataloguePermissions: DtoCataloguePermission[]) => CataloguePermissionByEnterpriseKey;
 export declare const isParamSet: (param: string | undefined) => boolean;
-export declare const createCataloguePermissionsFilter: (catParams: Partial<DtoCatalogueParams>) => (perm: DtoCataloguePermission) => boolean;
+export declare const createCataloguePermissionsFilter: (catParams: Partial<DtoCatalogueParamsWithCid>) => (perm: DtoCataloguePermission) => boolean;
 /**
  * Sometimes you will want to use the latest available prdCatVersion. This method will
  * find the highest prdCatVersion version in the cataloguePermissions. If the versions are
@@ -25,7 +25,7 @@ export declare const getPrdCatVersionFromPermissions: (cataloguePermissions: Dto
  * @param auth
  * @param params
  */
-export declare const getPrdCatVersionOrLatestFromPermissions: (params: DtoCatalogueParams, cataloguePermissions: DtoCataloguePermission[]) => string;
+export declare const getPrdCatVersionOrLatestFromPermissions: (params: DtoCatalogueParamsWithCid, cataloguePermissions: DtoCataloguePermission[]) => string;
 /**
  * Sometimes you will want a missing prdCatVersion to represent "Get the current highest version".
  * This method will, if the prdCatVersion is not set, fetch the highest available from the
@@ -34,6 +34,6 @@ export declare const getPrdCatVersionOrLatestFromPermissions: (params: DtoCatalo
  * @param auth
  * @param params
  */
-export declare const fillMissingPrdCatVersionFromPermissions: <T extends DtoCatalogueParams>(params: T, cataloguePermissions: DtoCataloguePermission[]) => T;
+export declare const fillMissingPrdCatVersionFromPermissions: <T extends DtoCatalogueParamsWithCid>(params: T, cataloguePermissions: DtoCataloguePermission[]) => T;
 export {};
 //# sourceMappingURL=utilitiesCataloguePermission.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@configura/web-api",
-	"version": "2.0.0-alpha.2",
+	"version": "2.0.0-alpha.20",
 	"license": "Apache-2.0",
 	"type": "module",
 	"main": "dist/index.js",
@@ -23,7 +23,7 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@configura/web-utilities": "2.0.0-alpha.2"
+		"@configura/web-utilities": "2.0.0-alpha.20"
 	},
-	"gitHead": "70b1f8c6426c11420f00b031912e1023d3b591bf"
+	"gitHead": "74b8fd6c45f392b9133843b409f7662dbf93c47e"
 }