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

package/.eslintrc.json

@@ -1,18 +1,5 @@
 {
 	"parser": "@typescript-eslint/parser",
 	"plugins": ["@typescript-eslint"],
-	"extends": [
-		"eslint:recommended",
-		"plugin:@typescript-eslint/recommended",
-		"prettier"
-
-		// TODO: Type-checking rules require a proper tsconfig-file to work,
-		//       pointed at by the parserOption.project setting.
-		//
-		//"plugin:@typescript-eslint/recommended-requiring-type-checking"
-	]
-	//"rules": { "@typescript-eslint/no-floating-promises": "error" }
-	//"parserOptions": {
-	//	"project": "./tsconfig.json"
-	//}
+	"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"]
 }

package/dist/CatalogueAPI.d.ts

@@ -119,6 +119,7 @@ export interface DtoFeature {
     mtrlApplications?: Array<DtoMtrlApplication>;
     multiple?: boolean;
     numericOrder: boolean;
+    omitOnOrder?: boolean;
     optional?: boolean;
     options: Array<DtoOption>;
     hideIfMainProduct?: boolean;
@@ -126,6 +127,7 @@ export interface DtoFeature {
     measureParams?: Array<DtoMeasureParam>;
     syncGroup?: DtoSyncGroup;
     unit?: string;
+    noteRefs?: Array<string>;
 }
 /** FeatureConf */
 export interface DtoFeatureConf {
@@ -232,6 +234,12 @@ export interface DtoMeasureParam {
 export interface DtoMeasurePriority {
     url: string;
 }
+/** MiscFile */
+export interface DtoMiscFile {
+    key: string;
+    url: string;
+    preview?: string;
+}
 /** Model */
 export interface DtoModel {
     cid: number;
@@ -246,6 +254,17 @@ export interface DtoMtrlApplication {
     preview?: string;
     cid?: number;
 }
+/** Note */
+export interface DtoNote {
+    code: string;
+    severity?: DtoNoteSeverity;
+    key?: string;
+    title?: string;
+    body: string;
+}
+/** NoteSeverity - WIP */
+export declare type DtoNoteSeverity = "Information" | "Critical" | "Warning";
+export declare const dtoNoteSeverityNames: DtoNoteSeverity[];
 /** Option */
 export interface DtoOption {
     additionalProductRefs?: Array<DtoAdditionalProductRef>;
@@ -257,6 +276,8 @@ export interface DtoOption {
     codeRanges?: Array<DtoCodeRange>;
     upcharge?: number;
     priceCodes?: Array<string>;
+    noteRefs?: Array<string>;
+    miscFiles?: Array<DtoMiscFile>;
 }
 /** OptionConf */
 export interface DtoOptionConf {
@@ -378,6 +399,7 @@ export interface DtoProductConf {
     features?: Array<DtoFeatureConf>;
     additionalProducts?: Array<DtoAdditionalProductConf>;
     prodParams?: DtoProductParamsWithCidAndLang;
+    syncGroupState?: DtoSyncGroupState;
 }
 /** ProductData */
 export interface DtoProductData {
@@ -402,6 +424,8 @@ export interface DtoProductData {
     width?: string;
     models?: Array<DtoModel>;
     partsData: DtoPartsData;
+    noteRefs?: Array<string>;
+    miscFiles?: Array<DtoMiscFile>;
 }
 /** ProductParamsWithCid */
 export interface DtoProductParamsWithCid extends DtoCatalogueParamsWithCid {
@@ -429,6 +453,7 @@ export interface DtoProductResponse {
     productData: DtoProductData;
     unit: string;
     uuid: string;
+    notes?: Array<DtoNote>;
 }
 /** RefreshSessionTokenResponse */
 export interface DtoRefreshSessionTokenResponse {
@@ -482,6 +507,20 @@ export interface DtoSyncGroup {
 /** SyncGroupMethods */
 export declare type DtoSyncGroupMethods = "pull" | "push" | "twoWay";
 export declare const dtoSyncGroupMethodsNames: DtoSyncGroupMethods[];
+/** SyncGroupState */
+export interface DtoSyncGroupState {
+    selectOne?: Array<DtoSyncToOptionCode>;
+    selectMany?: Array<DtoSyncToOptionCodeToSelected>;
+}
+/** SyncToOptionCode */
+export interface DtoSyncToOptionCode {
+    syncCode: string;
+    optionCode: string;
+}
+/** SyncToOptionCodeToSelected */
+export interface DtoSyncToOptionCodeToSelected extends DtoSyncToOptionCode {
+    selected: boolean;
+}
 /** TargetCameraArgs */
 export interface DtoTargetCameraArgs {
     location?: DtoPoint;
@@ -519,6 +558,8 @@ export interface DtoValidateRequestLegacyV1 {
 /** ValidateResponse */
 export interface DtoValidateResponse extends DtoValidateResponseLegacyV1 {
     features: Array<DtoFeature>;
+    unit: string;
+    notes?: Array<DtoNote>;
 }
 /** ValidateResponseLegacyV1 */
 export interface DtoValidateResponseLegacyV1 {

package/dist/CatalogueAPI.js

@@ -24,6 +24,7 @@ export const dtoExportStatusStatusNames = [
     "finished",
     "failed",
 ];
+export const dtoNoteSeverityNames = ["Information", "Critical", "Warning"];
 export const dtoRenderFormatNames = ["jpg", "png"];
 export const dtoRenderStatusStatusNames = [
     "pending",

package/dist/CfgProduct.d.ts

@@ -1,6 +1,7 @@
 import { AggregatedLoadingObservable, LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
-import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParamsWithCid, DtoMeasureParam, DtoMtrlApplication, DtoPrices, DtoProductConf, DtoProductParamsWithCidAndLang, DtoTransform } from "./CatalogueAPI.js";
+import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParamsWithCid, DtoMeasureParam, DtoMiscFile, DtoMtrlApplication, DtoNote, DtoPrices, DtoProductConf, DtoProductParamsWithCidAndLang, DtoTransform } from "./CatalogueAPI.js";
 import { CfgMeasureDefinition } from "./CfgMeasure.js";
+import { CfgProdConfParts } from "./index.js";
 import { _CfgFeatureInternal } from "./productConfiguration/CfgFeature.js";
 import { ProductConfigurationBubbleMode } from "./productConfiguration/CfgOption.js";
 import { CfgProductConfiguration } from "./productConfiguration/CfgProductConfiguration.js";
@@ -81,7 +82,7 @@ export declare class _CfgProductInternal {
     readonly parent: _CfgProductInternal | undefined;
     private _additionalProductRef;
     private readonly _syncGroupHandler;
-    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>;
+    static make: (productLoaderRaw: ProductLoader, productLoaderForGroupedLoad: ProductLoader | undefined, prodParams: DtoProductParamsWithCidAndLang, settings: CfgProductSettings, optional: boolean, loadingObservable: AggregatedLoadingObservable, parent: _CfgProductInternal | undefined, root: _CfgProductInternal | undefined, additionalProductRef: DtoAdditionalProductRef | undefined, initialProductConfiguration: DtoProductConf | DtoAdditionalProductConfiguration | undefined) => Promise<_CfgProductInternal>;
     _initialClone: _CfgProductInternal | undefined;
     private constructor();
     readonly root: _CfgProductInternal;
@@ -90,6 +91,7 @@ export declare class _CfgProductInternal {
     readonly additionalProducts: CfgProduct[];
     private _selected;
     private _configuration;
+    private _notes;
     readonly changeObservable: Observable<CfgProductChangeNotification>;
     get selected(): boolean;
     readonly isAdditionalProduct: boolean;
@@ -112,6 +114,19 @@ export declare class _CfgProductInternal {
      * change.
      */
     _updateAdditionalProdRef(p: DtoAdditionalProductRef): void;
+    /**
+     * Return a DtoNode using noteRef as a key.
+     * Throws an error if no note is found.
+     */
+    getNote(noteRef: string): DtoNote;
+    /**
+     * noteRefs is a list of keys coming from CfgOption, CfgFeature or CfgProduct.
+     * The keys are used to get a DtoNote[] from notes at CfgProduct.
+     */
+    getNotes(noteRefs: string[]): DtoNote[];
+    private addNotes;
+    get notes(): DtoNote[];
+    get miscFiles(): DtoMiscFile[];
     get hasRootFeaturesChanged(): boolean;
     get description(): string | undefined;
     get rootNodeSources(): RootNodeSource[] | undefined;
@@ -129,7 +144,7 @@ export declare class _CfgProductInternal {
     get unit(): LengthUnit;
     get aggregatedPrice(): CfgPrice;
     get optional(): boolean;
-    setSelected(v: boolean, bubbleMode: CfgProductBubbleMode): Promise<boolean>;
+    setSelected(selected: boolean, bubbleMode: CfgProductBubbleMode, interactive: boolean): Promise<boolean>;
     get configuration(): CfgProductConfiguration;
     get rawProductData(): CfgProductData;
     /**
@@ -154,7 +169,7 @@ 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) => DtoProductConf;
+    getDtoConf: (include: CfgProdConfParts) => 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>;
@@ -180,11 +195,11 @@ export declare class _CfgProductInternal {
      * 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>;
+    _syncAndLoadAdditionalProducts: (productLoaderForGroupedLoad: ProductLoader, initialProductConfiguration: DtoAdditionalProductConfiguration | undefined) => Promise<boolean>;
 }
 export declare class CfgProduct {
     readonly _internal: _CfgProductInternal;
-    static make(productLoader: ProductLoader, prodParams: DtoProductParamsWithCidAndLang, settings?: Partial<CfgProductSettings>): Promise<CfgProduct>;
+    static make(productLoader: ProductLoader, prodParams: DtoProductParamsWithCidAndLang, settings?: Partial<CfgProductSettings>, initialProductConfiguration?: DtoProductConf | DtoAdditionalProductConfiguration): 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
@@ -211,6 +226,8 @@ export declare class CfgProduct {
      * It will be unique amongst child products, but not globally unique.
      */
     get refKey(): string | undefined;
+    get notes(): DtoNote[];
+    get miscFiles(): DtoMiscFile[];
     get prodParams(): DtoProductParamsWithCidAndLang;
     get lang(): string;
     get catId(): DtoCatalogueParamsWithCid;
@@ -226,7 +243,7 @@ export declare class CfgProduct {
     /**
      * Please note that this relates to the visibility in the Configuration tree.
      * It does not affect the visibility of anything in the 3D view at all.
-     * Visibility is affects the Configuration for this Product, but any Additional Products
+     * Visibility affects the Configuration for this Product, but any Additional Products
      * will not be affected.
      */
     get visible(): boolean;
@@ -305,16 +322,13 @@ export declare class CfgProduct {
      * - 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.
+     * - You can request ExtendedData, ProductParams and/or SyncGroupState 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.
+     * @param include   Includes extra data which is not an actual part of the configuration
      */
-    getDtoConf: (includeExtendedData?: boolean, includeProductParams?: boolean) => DtoProductConf;
+    getDtoConf: (include?: CfgProdConfParts) => DtoProductConf;
     /**
      * A newer alternative version of setApiSelection.
      * @param doValidate Makes a server side validation call. These are necessary to ensure that