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

package/dist/material/CfgMtrlSource.js

@@ -1,40 +1,40 @@
-export class CfgMtrlSource {
-}
-export class CfgMtrlSourceUrl extends CfgMtrlSource {
-    constructor(_url, _urlIsFromProperty) {
-        super();
-        this._url = _url;
-        this._urlIsFromProperty = _urlIsFromProperty;
-    }
-    get url() {
-        return this._url;
-    }
-    get urlIsFromProperty() {
-        return this._urlIsFromProperty;
-    }
-    isSame(other) {
-        if (!(other instanceof CfgMtrlSourceUrl)) {
-            return false;
-        }
-        return this.url === other.url;
-    }
-}
-export class CfgMtrlSourceBuffer extends CfgMtrlSource {
-    constructor(_fileName, _buffer) {
-        super();
-        this._fileName = _fileName;
-        this._buffer = _buffer;
-    }
-    get fileName() {
-        return this._fileName;
-    }
-    get buffer() {
-        return this._buffer;
-    }
-    isSame(other) {
-        if (!(other instanceof CfgMtrlSourceBuffer)) {
-            return false;
-        }
-        return this.fileName === other.fileName;
-    }
-}
+export class CfgMtrlSource {
+}
+export class CfgMtrlSourceUrl extends CfgMtrlSource {
+    constructor(_url, _urlIsFromProperty) {
+        super();
+        this._url = _url;
+        this._urlIsFromProperty = _urlIsFromProperty;
+    }
+    get url() {
+        return this._url;
+    }
+    get urlIsFromProperty() {
+        return this._urlIsFromProperty;
+    }
+    isSame(other) {
+        if (!(other instanceof CfgMtrlSourceUrl)) {
+            return false;
+        }
+        return this.url === other.url;
+    }
+}
+export class CfgMtrlSourceBuffer extends CfgMtrlSource {
+    constructor(_fileName, _buffer) {
+        super();
+        this._fileName = _fileName;
+        this._buffer = _buffer;
+    }
+    get fileName() {
+        return this._fileName;
+    }
+    get buffer() {
+        return this._buffer;
+    }
+    isSame(other) {
+        if (!(other instanceof CfgMtrlSourceBuffer)) {
+            return false;
+        }
+        return this.fileName === other.fileName;
+    }
+}

package/dist/material/CfgMtrlSourceWithMetaData.d.ts

@@ -1,8 +1,8 @@
-import { CfgMtrlApplication } from "./CfgMtrlApplication.js";
-import { CfgMtrlSource } from "./CfgMtrlSource.js";
-export interface CfgMtrlSourceWithMetaData {
-    mtrl: CfgMtrlSource;
-    source: CfgMtrlApplication;
-    overriddenByOption: boolean;
-}
+import { CfgMtrlApplication } from "./CfgMtrlApplication.js";
+import { CfgMtrlSource } from "./CfgMtrlSource.js";
+export interface CfgMtrlSourceWithMetaData {
+    mtrl: CfgMtrlSource;
+    source: CfgMtrlApplication;
+    overriddenByOption: boolean;
+}
 //# sourceMappingURL=CfgMtrlSourceWithMetaData.d.ts.map

package/dist/material/CfgMtrlSourceWithMetaData.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/productConfiguration/CfgFeature.d.ts

@@ -1,81 +1,135 @@
-import { Observable, SingleArgCallback } from "@configura/web-utilities";
-import { Feature, SelectedOption } from "../CatalogueAPI.js";
-import { CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
-import { CfgMtrlApplication } from "../material/CfgMtrlApplication.js";
-import { CfgOption, ProductConfigurationBubbleMode, _CfgOptionInternal } from "./CfgOption.js";
-import { _CfgProductConfigurationInternal } from "./CfgProductConfiguration.js";
-export declare enum SelectionType {
-    Group = 0,
-    SelectOne = 1,
-    SelectMany = 2
-}
-export declare type FeatureChangeNotification = {
-    freshRef: CfgFeature;
-};
-export declare class _CfgFeatureInternal {
-    readonly rawFeature: Feature;
-    private readonly allRawFeatures;
-    readonly key: string;
-    readonly parent: _CfgProductConfigurationInternal | _CfgOptionInternal;
-    readonly parentProduct: _CfgProductInternal;
-    readonly rootProduct: _CfgProductInternal;
-    constructor(rawFeature: Feature, allRawFeatures: Feature[], key: string, // Unique amongst siblings
-    parent: _CfgProductConfigurationInternal | _CfgOptionInternal, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal);
-    readonly selectionType: SelectionType;
-    private _options;
-    private readonly _selectedOptions;
-    private _mtrlApplications;
-    readonly hasUpcharge: boolean;
-    readonly changeObservable: Observable<FeatureChangeNotification>;
-    get code(): string;
-    get groupCode(): string | undefined;
-    get description(): string;
-    get mtrlApplications(): CfgMtrlApplication[];
-    get selectedOptions(): CfgOption[];
-    private get isAllOptionsAffectedByAnySelection();
-    get preview(): string | undefined;
-    get visibleIfAdditionalProduct(): boolean;
-    get visibleIfMainProduct(): boolean;
-    get visible(): boolean;
-    get options(): CfgOption[];
-    private _notifyAllOfChange;
-    _childHasChanged: (childOption: _CfgOptionInternal, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
-    getApiSelection: () => {
-        [index: string]: SelectedOption;
-    } | undefined;
-    setApiSelection: (apiOptionSelectionMap: {
-        [index: string]: SelectedOption;
-    } | undefined) => Promise<boolean>;
-    structureCompare: (other: _CfgFeatureInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
-    tryMatchSelection: (other: _CfgFeatureInternal, descriptionMatch?: boolean) => Promise<boolean>;
-    selectOption: (optionInternal: _CfgOptionInternal, on: boolean, bubbleMode: ProductConfigurationBubbleMode) => Promise<boolean>;
-    isSelected: (option: _CfgOptionInternal) => boolean;
-    keyMatch: (other: _CfgFeatureInternal, descriptionMatch?: boolean) => boolean;
-    _getFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
-    private _freshRefAllOptions;
-    _freshRefDescendants(): void;
-}
-export declare class CfgFeature {
-    readonly _internal: _CfgFeatureInternal;
-    static make: (rawFeature: Feature, allRawFeatures: Feature[], key: string, parent: _CfgProductConfigurationInternal | _CfgOptionInternal, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal) => CfgFeature;
-    static _makeNewRefFrom: (internal: _CfgFeatureInternal) => CfgFeature;
-    private constructor();
-    isBackedBySame: (other: CfgFeature) => boolean;
-    get parentProduct(): CfgProduct;
-    get rootProduct(): CfgProduct;
-    get selectionType(): SelectionType;
-    get key(): string;
-    get code(): string;
-    get groupCode(): string | undefined;
-    get description(): string;
-    get hasUpcharge(): boolean | undefined;
-    get selectedOptions(): CfgOption[];
-    get preview(): string | undefined;
-    get options(): CfgOption[];
-    get visible(): boolean;
-    selectOption: (option: CfgOption, on: boolean) => Promise<boolean>;
-    isSelected: (option: CfgOption) => boolean;
-    listenForChange: (l: SingleArgCallback<FeatureChangeNotification>) => void;
-    stopListenForChange: (l: SingleArgCallback<FeatureChangeNotification>) => void;
-}
+import { Observable, SingleArgCallback } from "@configura/web-utilities";
+import { Feature, SelectedOption } from "../CatalogueAPI.js";
+import { CfgProduct, _CfgProductInternal } from "../CfgProduct.js";
+import { CfgMtrlApplication } from "../material/CfgMtrlApplication.js";
+import { CfgOption, ProductConfigurationBubbleMode, _CfgOptionInternal } from "./CfgOption.js";
+import { _CfgProductConfigurationInternal } from "./CfgProductConfiguration.js";
+export declare enum SelectionType {
+    /**
+     * All options are permanently selected. In our ui-component for this we skip over this level,
+     * and immediately show the children, but you could do this differently, like for instance
+     * showing the group heading.
+     */
+    Group = 0,
+    /**
+     * One and only one can be selected at a time. This normally corresponds to either a dropdown
+     * menu or radio buttons.
+     */
+    SelectOne = 1,
+    /** Zero to all can be selected at a time. This normally corresponds to checkboxes. */
+    SelectMany = 2
+}
+export declare type FeatureChangeNotification = {
+    freshRef: CfgFeature;
+};
+/**
+ * This class is meant to only be used through CfgFeature. It should
+ * never be instantiated on its own. Normally the internal state of this class
+ * should never be directly modified. CfgFeature is the class that
+ * should be used and interacted with.
+ */
+export declare class _CfgFeatureInternal {
+    readonly rawFeature: Feature;
+    private readonly allRawFeatures;
+    readonly key: string;
+    readonly parent: _CfgProductConfigurationInternal | _CfgOptionInternal;
+    readonly parentProduct: _CfgProductInternal;
+    readonly rootProduct: _CfgProductInternal;
+    constructor(rawFeature: Feature, allRawFeatures: Feature[], key: string, // Unique amongst siblings
+    parent: _CfgProductConfigurationInternal | _CfgOptionInternal, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal);
+    readonly selectionType: SelectionType;
+    private _options;
+    private readonly _selectedOptions;
+    private _mtrlApplications;
+    readonly hasUpcharge: boolean;
+    readonly changeObservable: Observable<FeatureChangeNotification>;
+    get code(): string;
+    get groupCode(): string | undefined;
+    get description(): string;
+    get mtrlApplications(): CfgMtrlApplication[];
+    get selectedOptions(): CfgOption[];
+    get ancestorsSelected(): boolean;
+    /**
+     * If one option is selected or deselected this will potentially
+     * affect all other Options on this Feature
+     */
+    private get isAllOptionsAffectedByAnySelection();
+    get preview(): string | undefined;
+    get visibleIfAdditionalProduct(): boolean;
+    get visibleIfMainProduct(): boolean;
+    get visible(): boolean;
+    get options(): CfgOption[];
+    private _notifyAllOfChange;
+    /**
+     * Called by child to tell its parent that it has changed.
+     * @throws Will throw if options have not yet been generated. This should be impossible
+     * as nonexisting children can not call their parent.
+     */
+    _childHasChanged: (childOption: _CfgOptionInternal, bubbleMode: ProductConfigurationBubbleMode) => Promise<void>;
+    getApiSelection: () => {
+        [index: string]: SelectedOption;
+    } | undefined;
+    setApiSelection: (apiOptionSelectionMap: {
+        [index: string]: SelectedOption;
+    } | undefined) => Promise<boolean>;
+    structureCompare: (other: _CfgFeatureInternal, strictOrder?: boolean, descriptionMatch?: boolean) => boolean;
+    tryMatchSelection: (other: _CfgFeatureInternal, descriptionMatch?: boolean) => Promise<boolean>;
+    /**
+     * Normally this is used through methods on CfgFeature and CfgOption. Use this
+     * internal version if you need to control the bubbleMode.
+     * Using a validate bubbleMode will cause validation calls to the server.
+     */
+    selectOption: (optionInternal: _CfgOptionInternal, on: boolean, bubbleMode: ProductConfigurationBubbleMode) => Promise<boolean>;
+    isSelected: (option: _CfgOptionInternal) => boolean;
+    keyMatch: (other: _CfgFeatureInternal, descriptionMatch?: boolean) => boolean;
+    /** Only in selected options */
+    _getFeaturesWithCode: (code: string) => _CfgFeatureInternal[];
+    /**
+     * Make fresh references to all options on this feature.
+     * Also includes currently selected options.
+     * @throws Will throw if options have not yet been generated.
+     */
+    private _freshRefAllOptions;
+    _freshRefDescendants(): void;
+}
+export declare class CfgFeature {
+    readonly _internal: _CfgFeatureInternal;
+    static make: (rawFeature: Feature, allRawFeatures: Feature[], key: string, parent: _CfgProductConfigurationInternal | _CfgOptionInternal, parentProduct: _CfgProductInternal, rootProduct: _CfgProductInternal) => CfgFeature;
+    /**
+     * 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 built around using equals to detect change.
+     */
+    static _makeNewRefFrom: (internal: _CfgFeatureInternal) => CfgFeature;
+    /**
+     * Private constructor and make-method because make new ref requires the constructor to
+     * take an internal and we don't want those who instantiate CfgFeature to have to be aware
+     * of the internal.
+     */
+    private constructor();
+    isBackedBySame: (other: CfgFeature) => boolean;
+    get parentProduct(): CfgProduct;
+    get rootProduct(): CfgProduct;
+    get selectionType(): SelectionType;
+    get key(): string;
+    get code(): string;
+    get groupCode(): string | undefined;
+    get description(): string;
+    get hasUpcharge(): boolean | undefined;
+    get selectedOptions(): CfgOption[];
+    /** Are all ancestors up to the CfgProductConfiguration selected? */
+    get ancestorsSelected(): boolean;
+    get preview(): string | undefined;
+    get options(): CfgOption[];
+    get visible(): boolean;
+    /**
+     * Selects the passed Option.
+     * Only Options belonging to Features that are "select many" can be deselected.
+     * Calling this will cause a validation call to the server.
+     */
+    selectOption: (option: CfgOption, on: boolean) => Promise<boolean>;
+    isSelected: (option: CfgOption) => boolean;
+    listenForChange: (l: SingleArgCallback<FeatureChangeNotification>) => void;
+    stopListenForChange: (l: SingleArgCallback<FeatureChangeNotification>) => void;
+}
 //# sourceMappingURL=CfgFeature.d.ts.map