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

package/dist/productConfiguration/CfgOption.d.ts

@@ -1,65 +1,113 @@
-import { Observable, SingleArgCallback } from "@configura/web-utilities";
-import { Feature, Option, SelectedOption } from "../CatalogueAPI.js";
-import { CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
-import { CfgMtrlApplication } from "../material/CfgMtrlApplication.js";
-import { CfgFeature, _CfgFeatureInternal } from "./CfgFeature.js";
-export declare type OptionChangeNotification = {
-    freshRef: CfgOption;
-};
-export declare enum ProductConfigurationBubbleMode {
-    Validate = "Validate",
-    ValidateAndBubbleSelected = "ValidateAndBubbleSelected",
-    Stop = "Stop",
-    OneLevel = "OneLevel",
-    ToParentProduct = "ToParentProduct",
-    ToRoot = "ToRoot"
-}
-export declare class _CfgOptionInternal {
-    readonly rawOption: Option;
-    readonly parent: _CfgFeatureInternal;
-    private readonly allRawFeatures;
-    readonly parentProduct: _CfgProductInternal;
-    readonly rootProduct: _CfgProductInternal;
-    constructor(rawOption: Option, parent: _CfgFeatureInternal, allRawFeatures: Feature[], siblingHasDuplicateDescription: boolean, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal);
-    private _features;
-    private _mtrlApplications;
-    readonly key: string;
-    readonly changeObservable: Observable<OptionChangeNotification>;
-    get code(): string;
-    get description(): string;
-    get mtrlApplications(): CfgMtrlApplication[];
-    get thumbnail(): string | undefined;
-    get upcharge(): number | undefined;
-    get priceChangeAtSelectChange(): number | undefined;
-    get features(): CfgFeature[];
-    _childHasChanged: (freshRef: CfgFeature, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
-    getApiSelection: () => SelectedOption;
-    setApiSelection: (apiOptionSelection: SelectedOption | undefined) => Promise<boolean>;
-    structureCompare: (other: _CfgOptionInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
-    tryMatchSelection: (other: CfgOption, descriptionMatch?: boolean) => Promise<boolean>;
-    keyMatch: (other: _CfgOptionInternal, descriptionMatch?: boolean) => boolean;
-    _getFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
-    _freshRefDescendants(): void;
-}
-export declare class CfgOption {
-    readonly _internal: _CfgOptionInternal;
-    static make: (rawOption: Option, parent: _CfgFeatureInternal, allRawFeatures: Feature[], siblingHasDuplicateDescription: boolean, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal) => CfgOption;
-    static _makeNewRefFrom: (internal: _CfgOptionInternal) => CfgOption;
-    private constructor();
-    isBackedBySame: (other: CfgOption) => boolean;
-    get parentProduct(): CfgProduct;
-    get rootProduct(): CfgProduct;
-    get rawOption(): Option;
-    get key(): string;
-    get code(): string;
-    get description(): string;
-    get selected(): boolean;
-    setSelected: (on: boolean) => Promise<boolean>;
-    get thumbnail(): string | undefined;
-    get upcharge(): number | undefined;
-    get priceChangeAtSelectChange(): number | undefined;
-    get features(): CfgFeature[];
-    listenForChange: (l: SingleArgCallback<OptionChangeNotification>) => void;
-    stopListenForChange: (l: SingleArgCallback<OptionChangeNotification>) => void;
-}
+import { Observable, SingleArgCallback } from "@configura/web-utilities";
+import { Feature, Option, SelectedOption } from "../CatalogueAPI.js";
+import { CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
+import { CfgMtrlApplication } from "../material/CfgMtrlApplication.js";
+import { CfgFeature, _CfgFeatureInternal } from "./CfgFeature.js";
+export declare type OptionChangeNotification = {
+    freshRef: CfgOption;
+};
+export declare enum ProductConfigurationBubbleMode {
+    /**
+     * Bubble to the closest CfgProduct, let it revalidate, then that will continue
+     * the bubble after validate. Turns on all ancestors all the way up.
+     */
+    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.
+     * So with this mode it is possible to select an option where its parents are not selected.
+     */
+    ValidateAndBubbleSelected = "ValidateAndBubbleSelected",
+    /**
+     * Stop bubbling
+     * This mode supports internal functionality and is not expected to be used by integrators.
+     */
+    Stop = "Stop",
+    /**
+     * Bubble to the next level up the tree. In features-options the next level is considered
+     * the next feature, so option levels are skipped over. The node we call from notifies its
+     * parent, and the parent switches out the reference to the node. Then bubbling stops.
+     * This mode supports internal functionality and is not expected to be used by integrators.
+     */
+    OneLevel = "OneLevel",
+    /**
+     * Bubble to the closest CfgProduct without doing any validation
+     * This mode supports internal functionality and is not expected to be used by integrators.
+     */
+    ToParentProduct = "ToParentProduct",
+    /**
+     * Bubble to the root CfgProduct
+     * This mode supports internal functionality and is not expected to be used by integrators.
+     */
+    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.
+ */
+export declare class _CfgOptionInternal {
+    readonly rawOption: Option;
+    readonly parent: _CfgFeatureInternal;
+    private readonly allRawFeatures;
+    readonly parentProduct: _CfgProductInternal;
+    readonly rootProduct: _CfgProductInternal;
+    constructor(rawOption: Option, parent: _CfgFeatureInternal, allRawFeatures: Feature[], siblingHasDuplicateDescription: boolean, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal);
+    private _features;
+    private _mtrlApplications;
+    readonly key: string;
+    readonly changeObservable: Observable<OptionChangeNotification>;
+    get code(): string;
+    get description(): string;
+    get selected(): boolean;
+    get ancestorsSelected(): boolean;
+    get mtrlApplications(): CfgMtrlApplication[];
+    get thumbnail(): string | undefined;
+    get upcharge(): number | undefined;
+    get priceChangeAtSelectChange(): number | undefined;
+    get features(): CfgFeature[];
+    /** Called by child to tell its parent that it has changed. */
+    _childHasChanged: (freshRef: CfgFeature, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
+    getApiSelection: () => SelectedOption;
+    setApiSelection: (apiOptionSelection: SelectedOption | undefined) => Promise<boolean>;
+    structureCompare: (other: _CfgOptionInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
+    tryMatchSelection: (other: CfgOption, descriptionMatch?: boolean) => Promise<boolean>;
+    keyMatch: (other: _CfgOptionInternal, descriptionMatch?: boolean) => boolean;
+    _getFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
+    _freshRefDescendants(): void;
+}
+export declare class CfgOption {
+    readonly _internal: _CfgOptionInternal;
+    static make: (rawOption: Option, parent: _CfgFeatureInternal, allRawFeatures: Feature[], siblingHasDuplicateDescription: boolean, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal) => CfgOption;
+    /**
+     * 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: (internal: _CfgOptionInternal) => CfgOption;
+    /**
+     * Private constructor and make-method because make new ref requires the constructor to
+     * take an internal and we don't want those who instantiate CfgOption to have to be aware
+     * of the internal.
+     */
+    private constructor();
+    isBackedBySame: (other: CfgOption) => boolean;
+    get parentProduct(): CfgProduct;
+    get rootProduct(): CfgProduct;
+    get rawOption(): Option;
+    get key(): string;
+    get code(): string;
+    get description(): string;
+    get selected(): boolean;
+    /** Are all ancestors up to the CfgProductConfiguration selected? Includes self. */
+    get ancestorsSelected(): boolean;
+    setSelected: (on: boolean) => Promise<boolean>;
+    get thumbnail(): string | undefined;
+    get upcharge(): number | undefined;
+    get priceChangeAtSelectChange(): number | undefined;
+    get features(): CfgFeature[];
+    listenForChange: (l: SingleArgCallback<OptionChangeNotification>) => void;
+    stopListenForChange: (l: SingleArgCallback<OptionChangeNotification>) => void;
+}
 //# sourceMappingURL=CfgOption.d.ts.map