@configura/web-api 1.4.0-alpha.0 → 1.4.0-alpha.4

package/dist/CfgProduct.d.ts

@@ -1,218 +1,218 @@
-import { AggregatedLoadingObservable, LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
-import { AdditionalProductConfiguration, CatalogueParams, MeasureParam, MtrlApplication, Prices, Transform } from "./CatalogueAPI.js";
-import { CfgMeasureDefinition } from "./CfgMeasure.js";
-import { _CfgFeatureInternal } from "./productConfiguration/CfgFeature.js";
-import { ProductConfigurationBubbleMode } from "./productConfiguration/CfgOption.js";
-import { CfgProductConfiguration } from "./productConfiguration/CfgProductConfiguration.js";
-import { ProductLoader } from "./productLoader.js";
-import { CfgProductData, RootNodeSource } from "./utilitiesCatalogueData.js";
-export declare type CfgProductChangeNotification = {
-    freshRef: CfgProduct;
-};
-export declare type CfgProductSettings = {
-    /**
-     * In a correctly setup catalogue a select-one Feature (i.e. neither optional nor multiple)
-     * must have exactly one Option set at a time. However, this is not enforced in Catalogue
-     * Creator and it is not uncommon with catalogues which fails to meet this requirement.
-     * Activating this will make setApi throw an Error if more or less than one is selected.
-     */
-    strictSelectOneSelectionCount: boolean;
-    /**
-     * Activating this will make setAPI throw an error if the number of actually selected options
-     * on Features (excluding Group) are not exactly equal to the number of options passed in.
-     * Note: This check is not always reliable for Options with multiple Features each, which we
-     * believe is a rare use case.
-     */
-    strictSetApiSelectionMatch: boolean;
-};
-/**
- * This enum is used internally in the SDK and is not expected by be used directly by integrators.
- */
-export declare enum CfgProductBubbleMode {
-    /** Stop bubbling. */
-    Stop = "Stop",
-    /**
-     * Bubble to the parent CfgProduct up the tree.
-     * This makes the CfgProduct we we call from notify that it has changed, and the CfgProduct
-     * above switch out the reference to this.
-     */
-    OneLevel = "OneLevel",
-    /** Bubble to the root CfgProduct. */
-    ToRoot = "ToRoot",
-    /** Bubble to the root CfgProduct and turn on all optional CfgProducts on the way up. */
-    ToRootAndBubbleSelected = "ToRootAndBubbleSelected"
-}
-export declare type CfgPrice = {
-    basePrice: number;
-    listPrice: number;
-    currency: string;
-    fractionDigits: number;
-};
-/**
- * This class is meant to only be used through CfgProduct. It should never be instantiated on its
- * own. Normally the internal state of this class should never be directly modified. CfgProduct is
- * the class that should be used and interacted with.
- */
-export declare class _CfgProductInternal {
-    readonly _productLoaderRaw: ProductLoader;
-    readonly lang: string;
-    readonly catId: CatalogueParams;
-    readonly partNumber: string;
-    readonly settings: CfgProductSettings;
-    readonly uuid: string;
-    private readonly _rawUnit;
-    private _rawProductData;
-    readonly loadingObservable: AggregatedLoadingObservable;
-    readonly refKey: string | undefined;
-    readonly refDescription: string | undefined;
-    readonly parent: _CfgProductInternal | undefined;
-    readonly transform: Transform | undefined;
-    anchor: MeasureParam | undefined;
-    static make: (productLoaderRaw: ProductLoader, productLoaderForGroupedLoad: ProductLoader | undefined, lang: string, catId: CatalogueParams, partNumber: string, settings: CfgProductSettings, optional: boolean, loadingObservable: AggregatedLoadingObservable, refKey: string | undefined, refDescription: string | undefined, parent: _CfgProductInternal | undefined, root: _CfgProductInternal | undefined, transform: Transform | undefined, anchor: MeasureParam | undefined) => Promise<_CfgProductInternal>;
-    private constructor();
-    readonly root: _CfgProductInternal;
-    private _destroyed;
-    readonly key: string;
-    readonly additionalProducts: CfgProduct[];
-    private _selected;
-    private _configuration;
-    readonly changeObservable: Observable<CfgProductChangeNotification>;
-    get selected(): boolean;
-    readonly isAdditionalProduct: boolean;
-    clone(parent?: _CfgProductInternal, root?: _CfgProductInternal): Promise<_CfgProductInternal>;
-    destroy: () => void;
-    get description(): string | undefined;
-    get rootNodeSources(): RootNodeSource[] | undefined;
-    get mtrlApplications(): MtrlApplication[] | undefined;
-    get currency(): string;
-    get fractionDigits(): number;
-    get prices(): Prices | undefined;
-    private _measureDefinitions;
-    get measureDefinitions(): CfgMeasureDefinition[];
-    private _unit;
-    /** @throws an error if the actual unit sent by the server was not a LengthUnit */
-    get unit(): LengthUnit;
-    get aggregatedPrice(): CfgPrice;
-    get optional(): boolean;
-    setSelected(v: boolean, bubbleMode: CfgProductBubbleMode): Promise<boolean>;
-    get configuration(): CfgProductConfiguration;
-    get rawProductData(): CfgProductData;
-    _notifyAllOfChange: (bubbleMode: CfgProductBubbleMode) => Promise<void>;
-    /** Called when a child (additional product or the configuration) has changed. */
-    private _childHasChanged;
-    /** Called by child to tell its parent that it has changed. */
-    _additionalProductHasChanged: (freshRef: CfgProduct, bubbleMode: CfgProductBubbleMode) => Promise<void>;
-    /** Called by the configuration to tell its parent that it has changed. */
-    _configurationHasChanged: (freshRef: CfgProductConfiguration, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
-    getApiSelection: () => AdditionalProductConfiguration;
-    setApiSelection: (s: AdditionalProductConfiguration, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
-    structureCompare: (other: _CfgProductInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
-    tryMatchSelection: (other: _CfgProductInternal, descriptionMatch?: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
-    /** Only features in selected options and selected additional products. */
-    _getDescendantFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
-    private _revalidateInProgressToken;
-    /**
-     * Do a validate call for this product. It does not validate additional products, only this
-     * product in isolation. The validation result is applied on the configuration. Then additional
-     * products are synced (unloaded, loaded etc.) Finally the changes bubble up the tree.
-     */
-    _revalidate: (bubbleMode: CfgProductBubbleMode, productLoaderForGroupedLoad: ProductLoader) => Promise<boolean>;
-    /**
-     * Based on this configuration find what additional products should be shown and not, unload
-     * (i.e. destroy) those that should no longer be shown, load the new ones.
-     */
-    _syncAndLoadAdditionalProducts: (productLoaderForGroupedLoad: ProductLoader) => Promise<boolean>;
-}
-export declare class CfgProduct {
-    readonly _internal: _CfgProductInternal;
-    static make(productLoader: ProductLoader, lang: string, catId: CatalogueParams, partNumber: string, 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
-     * build around using equals to detect change.
-     */
-    static _makeNewRefFrom(source: _CfgProductInternal): CfgProduct;
-    private constructor();
-    isBackedBySame: (other: CfgProduct) => boolean;
-    /**
-     * Recursively marks this and descendants as destroyed so that late events are ignored
-     * correctly. If you destroy one shallow copy of this you destroy all.
-     */
-    destroy: () => void;
-    /** Makes a clone of this. It is disconnected from the original. */
-    clone: () => Promise<CfgProduct>;
-    /**
-     * A client side only key that should uniquely identify this product amongst other additional
-     * products.
-     */
-    get key(): string;
-    /**
-     * Only used when this product is in additional product.
-     * As a product can have multiple instances of the same additional product this key exists.
-     * It will be unique amongst child products, but not globally unique.
-     */
-    get refKey(): string | undefined;
-    get lang(): string;
-    get catId(): CatalogueParams;
-    get partNumber(): string;
-    get isAdditionalProduct(): boolean;
-    /** Only used when this product is an additional product. Root products are never optional. */
-    get optional(): boolean;
-    /**
-     * Only applicable when this product is optional. If this product is not optional this is
-     * always true.
-     */
-    get selected(): boolean;
-    /**
-     * Only applicable when this product is optional.
-     * Setting this does not cause a validation call as toggling an optional additional product is
-     *  assumed to always be legal.
-     */
-    setSelected: (v: boolean) => Promise<boolean>;
-    get rawProductData(): CfgProductData;
-    get uuid(): string;
-    get unit(): LengthUnit;
-    get sku(): string;
-    get styleNr(): string;
-    /** An URL. */
-    get preview(): string | undefined;
-    get description(): string | undefined;
-    get additionalProducts(): CfgProduct[];
-    get configuration(): CfgProductConfiguration;
-    get transform(): Transform | undefined;
-    get currency(): string;
-    /**
-     * If positive the number of fraction digits.
-     * If negative rounding (essentially the number of zeros to the right)
-     */
-    get fractionDigits(): number;
-    get aggregatedPrice(): CfgPrice;
-    /**
-     * Experimental. Additional products lacks descriptions or keys that are suitably for structure
-     * compare, so we use strict-order when trying to match the additional products. This makes
-     * this method work nicely for different products having pretty much the same child products.
-     */
-    structureCompare: (other: CfgProduct, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
-    /**
-     * Experimental. Additional products lacks descriptions or keys that are suitably for try
-     *  match, so we use strict-order when trying to match the additional products. This makes
-     *  this method work nicely for different products having pretty much the same child products.
-     *  This method does not propagate its selections.
-     *  This method will cause validation calls if something change.
-     */
-    tryMatchSelection: (other: CfgProduct, descriptionMatch?: boolean) => Promise<boolean>;
-    /**
-     * 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.
-     */
-    getApiSelection: () => AdditionalProductConfiguration;
-    setApiSelection: (s: AdditionalProductConfiguration, doValidate?: boolean) => Promise<boolean>;
-    listenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
-    stopListenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
-    stopAllListenForChange: () => void;
-    listenForLoading: (l: SingleArgCallback<boolean>) => void;
-    stopListenForLoading: (l: SingleArgCallback<boolean>) => void;
-    stopAllListenForLoading: () => void;
-}
+import { AggregatedLoadingObservable, LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
+import { AdditionalProductConfiguration, CatalogueParams, MeasureParam, MtrlApplication, Prices, Transform } from "./CatalogueAPI.js";
+import { CfgMeasureDefinition } from "./CfgMeasure.js";
+import { _CfgFeatureInternal } from "./productConfiguration/CfgFeature.js";
+import { ProductConfigurationBubbleMode } from "./productConfiguration/CfgOption.js";
+import { CfgProductConfiguration } from "./productConfiguration/CfgProductConfiguration.js";
+import { ProductLoader } from "./productLoader.js";
+import { CfgProductData, RootNodeSource } from "./utilitiesCatalogueData.js";
+export declare type CfgProductChangeNotification = {
+    freshRef: CfgProduct;
+};
+export declare type CfgProductSettings = {
+    /**
+     * In a correctly setup catalogue a select-one Feature (i.e. neither optional nor multiple)
+     * must have exactly one Option set at a time. However, this is not enforced in Catalogue
+     * Creator and it is not uncommon with catalogues which fails to meet this requirement.
+     * Activating this will make setApi throw an Error if more or less than one is selected.
+     */
+    strictSelectOneSelectionCount: boolean;
+    /**
+     * Activating this will make setAPI throw an error if the number of actually selected options
+     * on Features (excluding Group) are not exactly equal to the number of options passed in.
+     * Note: This check is not always reliable for Options with multiple Features each, which we
+     * believe is a rare use case.
+     */
+    strictSetApiSelectionMatch: boolean;
+};
+/**
+ * This enum is used internally in the SDK and is not expected by be used directly by integrators.
+ */
+export declare enum CfgProductBubbleMode {
+    /** Stop bubbling. */
+    Stop = "Stop",
+    /**
+     * Bubble to the parent CfgProduct up the tree.
+     * This makes the CfgProduct we we call from notify that it has changed, and the CfgProduct
+     * above switch out the reference to this.
+     */
+    OneLevel = "OneLevel",
+    /** Bubble to the root CfgProduct. */
+    ToRoot = "ToRoot",
+    /** Bubble to the root CfgProduct and turn on all optional CfgProducts on the way up. */
+    ToRootAndBubbleSelected = "ToRootAndBubbleSelected"
+}
+export declare type CfgPrice = {
+    basePrice: number;
+    listPrice: number;
+    currency: string;
+    fractionDigits: number;
+};
+/**
+ * This class is meant to only be used through CfgProduct. It should never be instantiated on its
+ * own. Normally the internal state of this class should never be directly modified. CfgProduct is
+ * the class that should be used and interacted with.
+ */
+export declare class _CfgProductInternal {
+    readonly _productLoaderRaw: ProductLoader;
+    readonly lang: string;
+    readonly catId: CatalogueParams;
+    readonly partNumber: string;
+    readonly settings: CfgProductSettings;
+    readonly uuid: string;
+    private readonly _rawUnit;
+    private _rawProductData;
+    readonly loadingObservable: AggregatedLoadingObservable;
+    readonly refKey: string | undefined;
+    readonly refDescription: string | undefined;
+    readonly parent: _CfgProductInternal | undefined;
+    readonly transform: Transform | undefined;
+    anchor: MeasureParam | undefined;
+    static make: (productLoaderRaw: ProductLoader, productLoaderForGroupedLoad: ProductLoader | undefined, lang: string, catId: CatalogueParams, partNumber: string, settings: CfgProductSettings, optional: boolean, loadingObservable: AggregatedLoadingObservable, refKey: string | undefined, refDescription: string | undefined, parent: _CfgProductInternal | undefined, root: _CfgProductInternal | undefined, transform: Transform | undefined, anchor: MeasureParam | undefined) => Promise<_CfgProductInternal>;
+    private constructor();
+    readonly root: _CfgProductInternal;
+    private _destroyed;
+    readonly key: string;
+    readonly additionalProducts: CfgProduct[];
+    private _selected;
+    private _configuration;
+    readonly changeObservable: Observable<CfgProductChangeNotification>;
+    get selected(): boolean;
+    readonly isAdditionalProduct: boolean;
+    clone(parent?: _CfgProductInternal, root?: _CfgProductInternal): Promise<_CfgProductInternal>;
+    destroy: () => void;
+    get description(): string | undefined;
+    get rootNodeSources(): RootNodeSource[] | undefined;
+    get mtrlApplications(): MtrlApplication[] | undefined;
+    get currency(): string;
+    get fractionDigits(): number;
+    get prices(): Prices | undefined;
+    private _measureDefinitions;
+    get measureDefinitions(): CfgMeasureDefinition[];
+    private _unit;
+    /** @throws an error if the actual unit sent by the server was not a LengthUnit */
+    get unit(): LengthUnit;
+    get aggregatedPrice(): CfgPrice;
+    get optional(): boolean;
+    setSelected(v: boolean, bubbleMode: CfgProductBubbleMode): Promise<boolean>;
+    get configuration(): CfgProductConfiguration;
+    get rawProductData(): CfgProductData;
+    _notifyAllOfChange: (bubbleMode: CfgProductBubbleMode) => Promise<void>;
+    /** Called when a child (additional product or the configuration) has changed. */
+    private _childHasChanged;
+    /** Called by child to tell its parent that it has changed. */
+    _additionalProductHasChanged: (freshRef: CfgProduct, bubbleMode: CfgProductBubbleMode) => Promise<void>;
+    /** Called by the configuration to tell its parent that it has changed. */
+    _configurationHasChanged: (freshRef: CfgProductConfiguration, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
+    getApiSelection: () => AdditionalProductConfiguration;
+    setApiSelection: (s: AdditionalProductConfiguration, doValidate: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
+    structureCompare: (other: _CfgProductInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
+    tryMatchSelection: (other: _CfgProductInternal, descriptionMatch?: boolean, productLoaderForGroupedLoad?: ProductLoader | undefined) => Promise<boolean>;
+    /** Only features in selected options and selected additional products. */
+    _getDescendantFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
+    private _revalidateInProgressToken;
+    /**
+     * Do a validate call for this product. It does not validate additional products, only this
+     * product in isolation. The validation result is applied on the configuration. Then additional
+     * products are synced (unloaded, loaded etc.) Finally the changes bubble up the tree.
+     */
+    _revalidate: (bubbleMode: CfgProductBubbleMode, productLoader: ProductLoader) => Promise<boolean>;
+    /**
+     * Based on this configuration find what additional products should be shown and not, unload
+     * (i.e. destroy) those that should no longer be shown, load the new ones.
+     */
+    _syncAndLoadAdditionalProducts: (productLoaderForGroupedLoad: ProductLoader) => Promise<boolean>;
+}
+export declare class CfgProduct {
+    readonly _internal: _CfgProductInternal;
+    static make(productLoader: ProductLoader, lang: string, catId: CatalogueParams, partNumber: string, 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
+     * build around using equals to detect change.
+     */
+    static _makeNewRefFrom(source: _CfgProductInternal): CfgProduct;
+    private constructor();
+    isBackedBySame: (other: CfgProduct) => boolean;
+    /**
+     * Recursively marks this and descendants as destroyed so that late events are ignored
+     * correctly. If you destroy one shallow copy of this you destroy all.
+     */
+    destroy: () => void;
+    /** Makes a clone of this. It is disconnected from the original. */
+    clone: () => Promise<CfgProduct>;
+    /**
+     * A client side only key that should uniquely identify this product amongst other additional
+     * products.
+     */
+    get key(): string;
+    /**
+     * Only used when this product is in additional product.
+     * As a product can have multiple instances of the same additional product this key exists.
+     * It will be unique amongst child products, but not globally unique.
+     */
+    get refKey(): string | undefined;
+    get lang(): string;
+    get catId(): CatalogueParams;
+    get partNumber(): string;
+    get isAdditionalProduct(): boolean;
+    /** Only used when this product is an additional product. Root products are never optional. */
+    get optional(): boolean;
+    /**
+     * Only applicable when this product is optional. If this product is not optional this is
+     * always true.
+     */
+    get selected(): boolean;
+    /**
+     * Only applicable when this product is optional.
+     * Setting this does not cause a validation call as toggling an optional additional product is
+     *  assumed to always be legal.
+     */
+    setSelected: (v: boolean) => Promise<boolean>;
+    get rawProductData(): CfgProductData;
+    get uuid(): string;
+    get unit(): LengthUnit;
+    get sku(): string;
+    get styleNr(): string;
+    /** An URL. */
+    get preview(): string | undefined;
+    get description(): string | undefined;
+    get additionalProducts(): CfgProduct[];
+    get configuration(): CfgProductConfiguration;
+    get transform(): Transform | undefined;
+    get currency(): string;
+    /**
+     * If positive the number of fraction digits.
+     * If negative rounding (essentially the number of zeros to the right)
+     */
+    get fractionDigits(): number;
+    get aggregatedPrice(): CfgPrice;
+    /**
+     * Experimental. Additional products lacks descriptions or keys that are suitably for structure
+     * compare, so we use strict-order when trying to match the additional products. This makes
+     * this method work nicely for different products having pretty much the same child products.
+     */
+    structureCompare: (other: CfgProduct, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
+    /**
+     * Experimental. Additional products lacks descriptions or keys that are suitably for try
+     *  match, so we use strict-order when trying to match the additional products. This makes
+     *  this method work nicely for different products having pretty much the same child products.
+     *  This method does not propagate its selections.
+     *  This method will cause validation calls if something change.
+     */
+    tryMatchSelection: (other: CfgProduct, descriptionMatch?: boolean) => Promise<boolean>;
+    /**
+     * 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.
+     */
+    getApiSelection: () => AdditionalProductConfiguration;
+    setApiSelection: (s: AdditionalProductConfiguration, doValidate?: boolean) => Promise<boolean>;
+    listenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
+    stopListenForChange: (l: SingleArgCallback<CfgProductChangeNotification>) => void;
+    stopAllListenForChange: () => void;
+    listenForLoading: (l: SingleArgCallback<boolean>) => void;
+    stopListenForLoading: (l: SingleArgCallback<boolean>) => void;
+    stopAllListenForLoading: () => void;
+}
 //# sourceMappingURL=CfgProduct.d.ts.map