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

package/dist/CatalogueAPI.d.ts

@@ -1,3 +1,8 @@
+/** AdditionalProductConf */
+export interface DtoAdditionalProductConf extends DtoProductConf {
+    refKey: string;
+    selected: boolean;
+}
 /** AdditionalProductConfiguration */
 export interface DtoAdditionalProductConfiguration {
     refKey?: string;
@@ -22,7 +27,7 @@ export interface DtoApplicationArea {
     material?: string;
     preview?: string;
 }
-/** DtoApplicationAreasResponse */
+/** ApplicationAreasResponse */
 export interface DtoApplicationAreasResponse {
     applicationAreas: Array<DtoApplicationArea>;
     uuid: string;
@@ -39,22 +44,22 @@ export interface DtoCatalogueAPISession {
     features?: Array<string>;
     permissions?: Array<DtoCataloguePermission>;
 }
-/** CatalogueParams */
-export interface DtoCatalogueParams extends DtoCatalogueParamsWithoutCid {
-    cid: number;
-}
-/** CatalogueParamsWithLang */
-export interface DtoCatalogueParamsWithLang extends DtoCatalogueParams {
-    lang: string;
-}
-/** CatalogueParamsWithoutCid */
-export interface DtoCatalogueParamsWithoutCid {
+/** CatalogueParams - To identify one catalogue the Portfolio ID CID is needed in addition to the parameters in this object. However as of now CID is not used in API calls and therefore this version without CID is needed. */
+export interface DtoCatalogueParams {
     enterprise: string;
     prdCat: string;
     prdCatVersion: string;
     vendor: string;
     priceList: string;
 }
+/** CatalogueParamsWithCid */
+export interface DtoCatalogueParamsWithCid extends DtoCatalogueParams {
+    cid: number;
+}
+/** CatalogueParamsWithCidAndLang */
+export interface DtoCatalogueParamsWithCidAndLang extends DtoCatalogueParamsWithCid {
+    lang: string;
+}
 /** CataloguePermission */
 export interface DtoCataloguePermission {
     cid: number;
@@ -74,31 +79,6 @@ export interface DtoCodeRange {
     maxValue: number;
     increment?: number;
 }
-/** ConfAddProd */
-export interface DtoConfAddProd extends DtoConfProd {
-    refKey: string;
-    selected: boolean;
-}
-/** ConfFeature */
-export interface DtoConfFeature {
-    code: string;
-    groupCode?: string;
-    unit?: string;
-    options?: Array<DtoConfOption>;
-}
-/** ConfOption */
-export interface DtoConfOption {
-    code: string;
-    selected: boolean;
-    numericValue?: DtoValueWithUnit;
-    features?: Array<DtoConfFeature>;
-}
-/** ConfProd */
-export interface DtoConfProd {
-    features?: Array<DtoConfFeature>;
-    additionalProducts?: Array<DtoConfAddProd>;
-    prodParams?: DtoProductParamsWithLang;
-}
 /** ErrorResponse */
 export interface DtoErrorResponse {
     error: string;
@@ -147,6 +127,13 @@ export interface DtoFeature {
     syncGroup?: DtoSyncGroup;
     unit?: string;
 }
+/** FeatureConf */
+export interface DtoFeatureConf {
+    code: string;
+    groupCode?: string;
+    unit?: string;
+    options?: Array<DtoOptionConf>;
+}
 /** FeatureRef */
 export interface DtoFeatureRef {
     code: string;
@@ -176,7 +163,17 @@ export interface DtoGetPriceListsParams {
     vendor: string;
     priceList: string;
 }
-/** DtoProductParamsWithLang represents the URL parameters of getProduct */
+/** GetProductLegacyV2Params represents the URL parameters of getProductLegacyV2 */
+export interface DtoGetProductLegacyV2Params {
+    lang: string;
+    enterprise: string;
+    prdCat: string;
+    prdCatVersion: string;
+    vendor: string;
+    priceList: string;
+    partNumber: string;
+}
+/** GetProductParams represents the URL parameters of getProduct */
 export interface DtoGetProductParams {
     lang: string;
     enterprise: string;
@@ -261,6 +258,13 @@ export interface DtoOption {
     upcharge?: number;
     priceCodes?: Array<string>;
 }
+/** OptionConf */
+export interface DtoOptionConf {
+    code: string;
+    selected: boolean;
+    numericValue?: DtoValueWithUnit;
+    features?: Array<DtoFeatureConf>;
+}
 /** Orientation */
 export interface DtoOrientation {
     yaw: number;
@@ -320,6 +324,16 @@ export interface DtoPostRenderParams {
     priceList: string;
     partNumber: string;
 }
+/** PostValidateLegacyV1Params represents the URL parameters of postValidateLegacyV1 */
+export interface DtoPostValidateLegacyV1Params {
+    lang: string;
+    enterprise: string;
+    prdCat: string;
+    prdCatVersion: string;
+    vendor: string;
+    priceList: string;
+    partNumber: string;
+}
 /** PostValidateParams represents the URL parameters of postValidate */
 export interface DtoPostValidateParams {
     lang: string;
@@ -359,6 +373,12 @@ export interface DtoProductCatalogueInfo {
     exchangeRate: number;
     lastModified: string;
 }
+/** ProductConf - This is intended to eventually supersede AdditionalProductConfiguration as the format for sending/receiving how a Product is configured. */
+export interface DtoProductConf {
+    features?: Array<DtoFeatureConf>;
+    additionalProducts?: Array<DtoAdditionalProductConf>;
+    prodParams?: DtoProductParamsWithCidAndLang;
+}
 /** ProductData */
 export interface DtoProductData {
     area?: string;
@@ -383,12 +403,12 @@ export interface DtoProductData {
     models?: Array<DtoModel>;
     partsData: DtoPartsData;
 }
-/** ProductParams */
-export interface DtoProductParams extends DtoCatalogueParams {
+/** ProductParamsWithCid */
+export interface DtoProductParamsWithCid extends DtoCatalogueParamsWithCid {
     partNumber: string;
 }
-/** ProductParamsWithLang */
-export interface DtoProductParamsWithLang extends DtoProductParams {
+/** ProductParamsWithCidAndLang */
+export interface DtoProductParamsWithCidAndLang extends DtoProductParamsWithCid {
     lang: string;
 }
 /** ProductRef */
@@ -489,11 +509,19 @@ export interface DtoTransform {
     rot: DtoOrientation;
 }
 /** ValidateRequest */
-export interface DtoValidateRequest {
+export interface DtoValidateRequest extends DtoValidateRequestLegacyV1 {
+    knownFeatureCodes: Array<string>;
+}
+/** ValidateRequestLegacyV1 */
+export interface DtoValidateRequestLegacyV1 {
     selOptions: Array<DtoSelectedOption>;
 }
 /** ValidateResponse */
-export interface DtoValidateResponse {
+export interface DtoValidateResponse extends DtoValidateResponseLegacyV1 {
+    features: Array<DtoFeature>;
+}
+/** ValidateResponseLegacyV1 */
+export interface DtoValidateResponseLegacyV1 {
     productData: DtoProductData;
     uuid: string;
     validated: boolean;
@@ -536,8 +564,10 @@ export declare class CatalogueAPI {
     getApplicationAreas(params: DtoGetApplicationAreasParams): Promise<DtoApplicationAreasResponse>;
     postExport(params: DtoPostExportParams, body: DtoExportRequest): Promise<DtoExportResponse>;
     getPriceLists(params: DtoGetPriceListsParams): Promise<DtoPriceListsResponse>;
+    getProductLegacyV2(params: DtoGetProductLegacyV2Params): Promise<DtoProductResponse>;
     getProduct(params: DtoGetProductParams): Promise<DtoProductResponse>;
     postRender(params: DtoPostRenderParams, body: DtoRenderRequest): Promise<DtoRenderResponse>;
+    postValidateLegacyV1(params: DtoPostValidateLegacyV1Params, body: DtoValidateRequestLegacyV1): Promise<DtoValidateResponseLegacyV1>;
     postValidate(params: DtoPostValidateParams, body: DtoValidateRequest): Promise<DtoValidateResponse>;
     getTocTree(params: DtoGetTocTreeParams): Promise<DtoTOCResponse>;
     getTocFlat(params: DtoGetTocFlatParams): Promise<DtoTOCResponse>;

package/dist/CatalogueAPI.js

@@ -147,7 +147,7 @@ export class CatalogueAPI {
             return this.fetch(this.auth.endpoint + url, options);
         });
     }
-    getProduct(params) {
+    getProductLegacyV2(params) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.auth === undefined) {
                 throw new Error("missing auth");
@@ -163,6 +163,22 @@ export class CatalogueAPI {
             return this.fetch(this.auth.endpoint + url, options);
         });
     }
+    getProduct(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product-v3/${encodeURIComponent(params.partNumber)}`;
+            const options = {
+                method: "GET",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+            };
+            if (this._alternativeReferer) {
+                options.headers["Alternative-Referer"] = this._alternativeReferer;
+            }
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
     postRender(params, body) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.auth === undefined) {
@@ -180,7 +196,7 @@ export class CatalogueAPI {
             return this.fetch(this.auth.endpoint + url, options);
         });
     }
-    postValidate(params, body) {
+    postValidateLegacyV1(params, body) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.auth === undefined) {
                 throw new Error("missing auth");
@@ -197,6 +213,23 @@ export class CatalogueAPI {
             return this.fetch(this.auth.endpoint + url, options);
         });
     }
+    postValidate(params, body) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.auth === undefined) {
+                throw new Error("missing auth");
+            }
+            const url = `/v1/catalogue/${encodeURIComponent(params.lang)}/${encodeURIComponent(params.enterprise)}/${encodeURIComponent(params.prdCat)}/${encodeURIComponent(params.prdCatVersion)}/${encodeURIComponent(params.vendor)}/${encodeURIComponent(params.priceList)}/product/${encodeURIComponent(params.partNumber)}/validate-v2`;
+            const options = {
+                method: "POST",
+                headers: { "X-API-Key": this.auth.secretToken || "" },
+                body: JSON.stringify(body),
+            };
+            if (this._alternativeReferer) {
+                options.headers["Alternative-Referer"] = this._alternativeReferer;
+            }
+            return this.fetch(this.auth.endpoint + url, options);
+        });
+    }
     getTocTree(params) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.auth === undefined) {
@@ -283,8 +316,10 @@ export const DTO_OPERATION_ID_TO_DEBIT_GROUP = {
     getApplicationAreas: "base",
     postExport: "export",
     getPriceLists: "base",
+    getProductLegacyV2: "base",
     getProduct: "base",
     postRender: "render",
+    postValidateLegacyV1: "base",
     postValidate: "base",
     getTocTree: "base",
     getTocFlat: "base",

package/dist/CfgProduct.d.ts

@@ -1,5 +1,5 @@
 import { AggregatedLoadingObservable, LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
-import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParams, DtoConfProd, DtoMeasureParam, DtoMtrlApplication, DtoPrices, DtoProductParamsWithLang, DtoTransform } from "./CatalogueAPI.js";
+import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParamsWithCid, DtoMeasureParam, DtoMtrlApplication, DtoPrices, DtoProductConf, DtoProductParamsWithCidAndLang, DtoTransform } from "./CatalogueAPI.js";
 import { CfgMeasureDefinition } from "./CfgMeasure.js";
 import { _CfgFeatureInternal } from "./productConfiguration/CfgFeature.js";
 import { ProductConfigurationBubbleMode } from "./productConfiguration/CfgOption.js";
@@ -72,7 +72,7 @@ export declare type CfgPrice = {
  */
 export declare class _CfgProductInternal {
     readonly _productLoaderRaw: ProductLoader;
-    readonly prodParams: DtoProductParamsWithLang;
+    readonly prodParams: DtoProductParamsWithCidAndLang;
     readonly settings: CfgProductSettings;
     readonly uuid: string;
     private readonly _rawUnit;
@@ -81,7 +81,8 @@ export declare class _CfgProductInternal {
     readonly parent: _CfgProductInternal | undefined;
     private _additionalProductRef;
     private readonly _syncGroupHandler;
-    static make: (productLoaderRaw: ProductLoader, productLoaderForGroupedLoad: ProductLoader | undefined, prodParams: DtoProductParamsWithLang, settings: CfgProductSettings, optional: boolean, loadingObservable: AggregatedLoadingObservable, parent: _CfgProductInternal | undefined, root: _CfgProductInternal | undefined, additionalProductRef: DtoAdditionalProductRef | undefined) => Promise<_CfgProductInternal>;
+    static make: (productLoaderRaw: ProductLoader, productLoaderForGroupedLoad: ProductLoader | undefined, prodParams: DtoProductParamsWithCidAndLang, settings: CfgProductSettings, optional: boolean, loadingObservable: AggregatedLoadingObservable, parent: _CfgProductInternal | undefined, root: _CfgProductInternal | undefined, additionalProductRef: DtoAdditionalProductRef | undefined) => Promise<_CfgProductInternal>;
+    _initialClone: _CfgProductInternal | undefined;
     private constructor();
     readonly root: _CfgProductInternal;
     private _destroyed;
@@ -92,9 +93,26 @@ export declare class _CfgProductInternal {
     readonly changeObservable: Observable<CfgProductChangeNotification>;
     get selected(): boolean;
     readonly isAdditionalProduct: boolean;
+    /**
+     * Please note that cloning an additional product will make the clone believe is is
+     * an additional product, even if it has no parent and root.
+     * Providing the parent and root of what you clone as arguments is unwise as it will
+     * make changes you do on the clone be propagated up to the original non-clone root product.
+     */
     clone(parent?: _CfgProductInternal, root?: _CfgProductInternal): Promise<_CfgProductInternal>;
+    /** Mark this and its descendants as destroyed and remove all listeners */
     destroy: () => void;
+    /**
+     * Reset will reset the product to its initial state
+     */
+    reset: () => Promise<void>;
+    /**
+     * Internal use. Used when this product is an additional product, and
+     * changing a parent product has made the settings for this product
+     * change.
+     */
     _updateAdditionalProdRef(p: DtoAdditionalProductRef): void;
+    get hasRootFeaturesChanged(): boolean;
     get description(): string | undefined;
     get rootNodeSources(): RootNodeSource[] | undefined;
     get mtrlApplications(): DtoMtrlApplication[] | undefined;
@@ -136,8 +154,8 @@ export declare class _CfgProductInternal {
     _additionalProductHasChanged: (freshRef: CfgProduct, bubbleMode: CfgProductBubbleMode, committed: boolean) => Promise<void>;
     /** Called by the configuration to tell its parent that it has changed. */
     _configurationHasChanged: (freshRef: CfgProductConfiguration, bubbleMode: ProductConfigurationBubbleMode, committed: boolean) => Promise<void>;
-    getDtoConf: (includeExtendedData: boolean, includeProductParams: boolean) => DtoConfProd;
-    setDtoConf: (s: DtoConfProd, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
+    getDtoConf: (includeExtendedData: boolean, includeProductParams: boolean) => DtoProductConf;
+    setDtoConf: (s: DtoProductConf, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
     setApiSelection: (s: DtoAdditionalProductConfiguration, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
     copyFrom: (source: _CfgProductInternal, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
     private _setApiSelectionWithOtherProduct;
@@ -166,7 +184,7 @@ export declare class _CfgProductInternal {
 }
 export declare class CfgProduct {
     readonly _internal: _CfgProductInternal;
-    static make(productLoader: ProductLoader, prodParams: DtoProductParamsWithLang, settings?: Partial<CfgProductSettings>): Promise<CfgProduct>;
+    static make(productLoader: ProductLoader, prodParams: DtoProductParamsWithCidAndLang, settings?: Partial<CfgProductSettings>): Promise<CfgProduct>;
     /**
      * Makes an object wrapping the passed object. This is not a clone method, it is a method to
      * make a new outer reference. Like a shallow copy. We use this to help frameworks that are
@@ -193,9 +211,9 @@ export declare class CfgProduct {
      * It will be unique amongst child products, but not globally unique.
      */
     get refKey(): string | undefined;
-    get prodParams(): DtoProductParamsWithLang;
+    get prodParams(): DtoProductParamsWithCidAndLang;
     get lang(): string;
-    get catId(): DtoCatalogueParams;
+    get catId(): DtoCatalogueParamsWithCid;
     get partNumber(): string;
     get isAdditionalProduct(): boolean;
     /** Only used when this product is an additional product. Root products are never optional. */
@@ -218,6 +236,18 @@ export declare class CfgProduct {
      *  assumed to always be legal.
      */
     setSelected: (v: boolean) => Promise<boolean>;
+    /**
+     * Functional selection is a Catalogues feature where selecting Options on Features result in that you
+     * "jump" to another Product as a result of the Validate call. You normally do not notice that a functional
+     * selection has occurred except for the styleNr changing. Functional selection can change which Features
+     * from the original product call are used as root Features. This can in turn affect if serialized
+     * configuration can be applied or not.
+     *
+     * The SDK can currently only apply serialized configuration if the list of root Features has not changed.
+     * For this reason, when functional selection has happened, extracting data for external systems might work
+     * well, but reapplying back into Stage will probably fail.
+     */
+    get hasRootFeaturesChanged(): boolean;
     get rawProductData(): CfgProductData;
     get uuid(): string;
     get unit(): LengthUnit;
@@ -254,11 +284,43 @@ export declare class CfgProduct {
      * Gets what selections has been made on the product, recursively including product
      * configuration, optional products and additional products. Used when a full view of all
      * selections on a product is needed, such as when doing Render or Export.
+     * @deprecated getDtoConf provides a newer format.
+     * @see getDtoConf
      */
     getApiSelection: () => DtoAdditionalProductConfiguration;
-    getDtoConf: (includeExtendedData?: boolean, includeProductParams?: boolean) => DtoConfProd;
-    setDtoConf: (s: DtoConfProd, doValidate?: boolean) => Promise<boolean>;
-    setApiSelection: (s: DtoAdditionalProductConfiguration, doValidate?: boolean) => Promise<boolean>;
+    /**
+     * Applies the configuration (selections) in the passed object onto the product recursively
+     * including product configuration, optional products and additional products.
+     * @param doValidate Makes a server side validation call. These are necessary to ensure that
+     *                   the right models are loaded.
+     * @deprecated setDtoConf uses a newer format.
+     */
+    setApiSelection: (configuration: DtoAdditionalProductConfiguration, doValidate?: boolean) => Promise<boolean>;
+    /**
+     * A newer alternative version of getApiSelection. This returns the configuration (selections)
+     * on the product, recursively including product configuration, optional products and additional
+     * products.
+     * This version has the following advantages over getApiSelection:
+     * - The format is clearer, designed to be readable
+     * - Makes less assumptions about the structure in the Product being unchanging over time. In
+     *   particular, the Feature codes are included in the data, so that changes to what Features
+     *   are used in a Product is less likely to lead to unexpected results.
+     * - You can request ExtendedData and/or ProductParams to be included in the result. This extra
+     *   data is ignored when passed back into the API, but it can be very useful for external
+     *   applications.
+     * The other version (getApiSelection) has the advantage of using a format directly compatible with the API:s.
+     * @param includeExtendedData  Includes extra data which is not an actual part of the configuration,
+     *                             i.e. units and groupCodes
+     * @param includeProductParams Includes what Product this was generated for, and the same for any
+     *                             Additional Products.
+     */
+    getDtoConf: (includeExtendedData?: boolean, includeProductParams?: boolean) => DtoProductConf;
+    /**
+     * A newer alternative version of setApiSelection.
+     * @param doValidate Makes a server side validation call. These are necessary to ensure that
+     *                   the right models are loaded.
+     */
+    setDtoConf: (configuration: DtoProductConf, doValidate?: boolean) => Promise<boolean>;
     listenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
     stopListenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
     stopAllListenForChange: () => void;