@configura/web-api 2.0.0-alpha.18 → 2.0.0-alpha.19

package/dist/CatalogueAPI.d.ts

@@ -13,7 +13,7 @@ export interface DtoAdditionalProductConfiguration {
 /** AdditionalProductRef */
 export interface DtoAdditionalProductRef {
     refKey: string;
-    catId: DtoCatalogueParams;
+    catId: DtoCatalogueParamsWithCid;
     partNumber: string;
     refDescription?: string;
     anchor?: DtoMeasureParam;
@@ -44,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 - 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 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;
@@ -357,7 +357,7 @@ export interface DtoProductCatalogueInfo {
 export interface DtoProductConf {
     features?: Array<DtoFeatureConf>;
     additionalProducts?: Array<DtoAdditionalProductConf>;
-    prodParams?: DtoProductParamsWithLang;
+    prodParams?: DtoProductParamsWithCidAndLang;
 }
 /** ProductData */
 export interface DtoProductData {
@@ -383,12 +383,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 */

package/dist/CfgProduct.d.ts

@@ -1,5 +1,5 @@
 import { AggregatedLoadingObservable, LengthUnit, Observable, SingleArgCallback } from "@configura/web-utilities";
-import { DtoAdditionalProductConfiguration, DtoAdditionalProductRef, DtoCatalogueParams, DtoMeasureParam, DtoMtrlApplication, DtoPrices, DtoProductConf, 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,7 @@ 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>;
     private constructor();
     readonly root: _CfgProductInternal;
     private _destroyed;
@@ -173,7 +173,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
@@ -200,9 +200,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. */

package/dist/CfgReferencePathHelper.d.ts

@@ -1,4 +1,4 @@
-import { DtoCatalogueParamsWithLang, DtoProductParamsWithLang } from "./CatalogueAPI";
+import { DtoCatalogueParamsWithCidAndLang, DtoProductParamsWithCidAndLang } from "./CatalogueAPI";
 /**
  * These methods aims to provide a default suggested way of building
  * URLs to Products and Catalogues. By using consistent URL:s copy-paste
@@ -14,7 +14,7 @@ export declare class CfgReferencePathHelper {
      * @param catParams What catalogue to generate URL for.
      * @returns An URL to a catalogue
      */
-    static getCataloguePath: (browsingRootUrl: string, catParams: DtoCatalogueParamsWithLang) => string;
+    static getCataloguePath: (browsingRootUrl: string, catParams: DtoCatalogueParamsWithCidAndLang) => string;
     /**
      * Use to generate URLs in our reference format. This is the format Configura uses in our integrations.
      * @param browsingRootUrl The URL where Stage browsing begins
@@ -22,6 +22,6 @@ export declare class CfgReferencePathHelper {
      * @param separator Optional, defaults to "product", but can be changed to indicate another function.
      * @returns An URL to a product
      */
-    static getProductPath: (browsingRootUrl: string, productParams: DtoProductParamsWithLang, separator?: string) => string;
+    static getProductPath: (browsingRootUrl: string, productParams: DtoProductParamsWithCidAndLang, separator?: string) => string;
 }
 //# sourceMappingURL=CfgReferencePathHelper.d.ts.map

package/dist/productConfiguration/filters.d.ts

@@ -1,6 +1,6 @@
 import { Filters, Matches } from "@configura/web-utilities";
-import { DtoCatalogueParamsWithoutCid, DtoLevel, DtoProductRef } from "../CatalogueAPI.js";
-export declare function applyCatalogueFilters<T extends DtoCatalogueParamsWithoutCid>(filters: Filters<DtoCatalogueParamsWithoutCid>, catalogues: T[]): [Matches<DtoCatalogueParamsWithoutCid>, T[]];
+import { DtoCatalogueParams, DtoLevel, DtoProductRef } from "../CatalogueAPI.js";
+export declare function applyCatalogueFilters<T extends DtoCatalogueParams>(filters: Filters<DtoCatalogueParams>, catalogues: T[]): [Matches<DtoCatalogueParams>, T[]];
 export interface ProductRefParams {
     partNr: string;
 }

package/dist/productConfiguration/productParamsGenerator.d.ts

@@ -1,16 +1,16 @@
 import { Filters } from "@configura/web-utilities";
-import { CatalogueAPI, DtoApplicationAreasResponse, DtoCatalogueParams, DtoCatalogueParamsWithLang } from "../CatalogueAPI.js";
+import { CatalogueAPI, DtoApplicationAreasResponse, DtoCatalogueParamsWithCid, DtoCatalogueParamsWithCidAndLang } from "../CatalogueAPI.js";
 import { CfgProduct, CfgProductSettings } from "../CfgProduct.js";
 import { ProductRefParams } from "./filters.js";
 export interface GeneratedProductConfiguration {
     applicationAreasResponse: DtoApplicationAreasResponse;
     catalogueCount: number;
     catalogueIndex: number;
-    catalogueParams: DtoCatalogueParamsWithLang;
+    catalogueParams: DtoCatalogueParamsWithCidAndLang;
     getProductDuration: number;
     product: CfgProduct;
     productCount: number;
     productIndex: number;
 }
-export declare function generateProductConfigurations(api: CatalogueAPI, lang: string, catalogues: DtoCatalogueParams[], filters: Filters<ProductRefParams>, settings?: Partial<CfgProductSettings>): AsyncIterableIterator<GeneratedProductConfiguration | Error>;
+export declare function generateProductConfigurations(api: CatalogueAPI, lang: string, catalogues: DtoCatalogueParamsWithCid[], filters: Filters<ProductRefParams>, settings?: Partial<CfgProductSettings>): AsyncIterableIterator<GeneratedProductConfiguration | Error>;
 //# sourceMappingURL=productParamsGenerator.d.ts.map

package/dist/productLoader.d.ts

@@ -1,7 +1,7 @@
-import { DtoProductParamsWithLang, DtoValidateRequest } from "./CatalogueAPI.js";
+import { DtoProductParamsWithCidAndLang, DtoValidateRequest } from "./CatalogueAPI.js";
 import { CfgProductResponse, CfgValidateResponse } from "./utilitiesCatalogueData.js";
-export declare type GetProduct = (params: DtoProductParamsWithLang) => Promise<CfgProductResponse>;
-export declare type PostValidate = (params: DtoProductParamsWithLang, body: DtoValidateRequest) => Promise<CfgValidateResponse>;
+export declare type GetProduct = (params: DtoProductParamsWithCidAndLang) => Promise<CfgProductResponse>;
+export declare type PostValidate = (params: DtoProductParamsWithCidAndLang, body: DtoValidateRequest) => Promise<CfgValidateResponse>;
 export declare type ProductLoader = {
     getProduct: GetProduct;
     postValidate: PostValidate;

package/dist/tasks/TaskHandler.d.ts

@@ -1,5 +1,5 @@
 import { Observable, SingleArgCallback } from "@configura/web-utilities";
-import { CatalogueAPI, DtoAdditionalProductConfiguration, DtoExportStatus, DtoExportStatusStatus, DtoProductParamsWithLang, DtoRenderStatus, DtoRenderStatusStatus, DtoTargetCameraArgs } from "../CatalogueAPI.js";
+import { CatalogueAPI, DtoAdditionalProductConfiguration, DtoExportStatus, DtoExportStatusStatus, DtoProductParamsWithCidAndLang, DtoRenderStatus, DtoRenderStatusStatus, DtoTargetCameraArgs } from "../CatalogueAPI.js";
 import { CfgProduct } from "../CfgProduct.js";
 import { RenderOrExportFormat } from "./formats.js";
 export declare type TasksChangeNotification = {
@@ -51,7 +51,7 @@ export declare abstract class Task<F extends RenderOrExportFormat> {
     protected constructor(taskHandler: _TaskHandlerInternal, format: F, product: CfgProduct, getPreviewUrl: (() => Promise<string>) | undefined);
     protected abstract postInit(): Promise<DtoRenderStatus | DtoExportStatus>;
     protected abstract pollStatus(): Promise<DtoRenderStatus | DtoExportStatus>;
-    protected _productParams: DtoProductParamsWithLang;
+    protected _productParams: DtoProductParamsWithCidAndLang;
     protected _apiSelection: DtoAdditionalProductConfiguration;
     private _status;
     private _uuid;

package/dist/tests/testData/dummyProductForTest.d.ts

@@ -1,5 +1,5 @@
-import { DtoCatalogueParamsWithLang } from "../../CatalogueAPI.js";
+import { DtoCatalogueParamsWithCidAndLang } from "../../CatalogueAPI.js";
 import { CfgProduct } from "../../CfgProduct.js";
-export declare const dummyCatId: DtoCatalogueParamsWithLang;
+export declare const dummyCatId: DtoCatalogueParamsWithCidAndLang;
 export declare const getDummyCfgProduct: () => Promise<CfgProduct>;
 //# sourceMappingURL=dummyProductForTest.d.ts.map

package/dist/utilitiesCatalogueData.d.ts

@@ -1,12 +1,12 @@
-import { DtoAdditionalProductRef, DtoCatalogueParams, DtoCatalogueParamsWithLang, DtoCatalogueParamsWithoutCid, DtoMeasureParam, DtoModel, DtoOrientation, DtoPartsData, DtoPrices, DtoProductData, DtoProductParams, DtoProductParamsWithLang, DtoProductResponse, DtoSelectedOption, DtoTransform, DtoValidateResponse, DtoVector } from "./CatalogueAPI.js";
+import { DtoAdditionalProductRef, DtoCatalogueParams, DtoCatalogueParamsWithCid, DtoCatalogueParamsWithCidAndLang, DtoMeasureParam, DtoModel, DtoOrientation, DtoPartsData, DtoPrices, DtoProductData, DtoProductParamsWithCid, DtoProductParamsWithCidAndLang, DtoProductResponse, DtoSelectedOption, DtoTransform, DtoValidateResponse, DtoVector } from "./CatalogueAPI.js";
 /**
  * Makes a string from the params which can be used as a key in for example React. Language is not respected.
  */
-export declare const makeCatalogueKey: (cat: DtoCatalogueParams) => string;
+export declare const makeCatalogueKey: (cat: DtoCatalogueParamsWithCid) => string;
 /**
  * Makes a string from the params which can be used as a key in for example React. Language is not respected.
  */
-export declare const makeProductKey: (prod: DtoProductParams) => string;
+export declare const makeProductKey: (prod: DtoProductParamsWithCid) => string;
 /**
  * Makes a string from selected options, can be used as a key for a selection.
  */
@@ -27,17 +27,17 @@ export declare type CfgValidateResponse = Omit<DtoValidateResponse, "productData
 };
 export declare function isModel(arg: unknown): arg is DtoModel;
 /** Replace empty strings with "-" for compatibility with the API. */
-export declare function correctDefaultsOnCatalogueParams<T extends DtoCatalogueParamsWithoutCid>(catId: T): T;
+export declare function correctDefaultsOnCatalogueParams<T extends DtoCatalogueParams>(catId: T): T;
 export declare function recursivelyGetPriceCodeValue(priceCodes: string[], prices: DtoPrices | undefined): number | undefined;
 export declare function comparePricesObjects(prices1: DtoPrices | undefined, prices2: DtoPrices | undefined): boolean;
-export declare const decodeCatalogueParams: <T extends DtoCatalogueParamsWithoutCid>(params: T) => T;
-export declare const decodeProductParams: <T extends DtoProductParams>(params: T) => T;
-export declare function isSameCatalogueParams(left: DtoCatalogueParamsWithoutCid, right: DtoCatalogueParamsWithoutCid): boolean;
+export declare const decodeCatalogueParams: <T extends DtoCatalogueParams>(params: T) => T;
+export declare const decodeProductParams: <T extends DtoProductParamsWithCid>(params: T) => T;
+export declare function isSameCatalogueParams(left: DtoCatalogueParams, right: DtoCatalogueParams): boolean;
 export declare function isSameVector(left: DtoVector, right: DtoVector): boolean;
 export declare function isSameOrientation(left: DtoOrientation, right: DtoOrientation): boolean;
 export declare function isSameAnchor(left: DtoMeasureParam, right: DtoMeasureParam): boolean;
 export declare function isSameTransform(left: DtoTransform, right: DtoTransform): boolean;
 export declare function isSameProductRef(left: DtoAdditionalProductRef, right: DtoAdditionalProductRef): boolean;
-export declare const isSameDtoCatalogueParamsWithLang: (left: DtoCatalogueParamsWithLang, right: DtoCatalogueParamsWithLang) => boolean;
-export declare const isSameDtoProductParamsWithLang: (left: DtoProductParamsWithLang, right: DtoProductParamsWithLang) => boolean;
+export declare const isSameDtoCatalogueParamsWithLang: (left: DtoCatalogueParamsWithCidAndLang, right: DtoCatalogueParamsWithCidAndLang) => boolean;
+export declare const isSameDtoProductParamsWithLang: (left: DtoProductParamsWithCidAndLang, right: DtoProductParamsWithCidAndLang) => boolean;
 //# sourceMappingURL=utilitiesCatalogueData.d.ts.map

package/dist/utilitiesCataloguePermission.d.ts

@@ -1,10 +1,10 @@
-import { DtoCatalogueParams, DtoCataloguePermission } from "./CatalogueAPI.js";
+import { DtoCatalogueParamsWithCid, DtoCataloguePermission } from "./CatalogueAPI.js";
 interface CataloguePermissionByEnterpriseKey {
     [key: string]: DtoCataloguePermission[];
 }
 export declare const groupAndSortCataloguePermissions: (cataloguePermissions: DtoCataloguePermission[]) => CataloguePermissionByEnterpriseKey;
 export declare const isParamSet: (param: string | undefined) => boolean;
-export declare const createCataloguePermissionsFilter: (catParams: Partial<DtoCatalogueParams>) => (perm: DtoCataloguePermission) => boolean;
+export declare const createCataloguePermissionsFilter: (catParams: Partial<DtoCatalogueParamsWithCid>) => (perm: DtoCataloguePermission) => boolean;
 /**
  * Sometimes you will want to use the latest available prdCatVersion. This method will
  * find the highest prdCatVersion version in the cataloguePermissions. If the versions are
@@ -25,7 +25,7 @@ export declare const getPrdCatVersionFromPermissions: (cataloguePermissions: Dto
  * @param auth
  * @param params
  */
-export declare const getPrdCatVersionOrLatestFromPermissions: (params: DtoCatalogueParams, cataloguePermissions: DtoCataloguePermission[]) => string;
+export declare const getPrdCatVersionOrLatestFromPermissions: (params: DtoCatalogueParamsWithCid, cataloguePermissions: DtoCataloguePermission[]) => string;
 /**
  * Sometimes you will want a missing prdCatVersion to represent "Get the current highest version".
  * This method will, if the prdCatVersion is not set, fetch the highest available from the
@@ -34,6 +34,6 @@ export declare const getPrdCatVersionOrLatestFromPermissions: (params: DtoCatalo
  * @param auth
  * @param params
  */
-export declare const fillMissingPrdCatVersionFromPermissions: <T extends DtoCatalogueParams>(params: T, cataloguePermissions: DtoCataloguePermission[]) => T;
+export declare const fillMissingPrdCatVersionFromPermissions: <T extends DtoCatalogueParamsWithCid>(params: T, cataloguePermissions: DtoCataloguePermission[]) => T;
 export {};
 //# sourceMappingURL=utilitiesCataloguePermission.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@configura/web-api",
-	"version": "2.0.0-alpha.18",
+	"version": "2.0.0-alpha.19",
 	"license": "Apache-2.0",
 	"type": "module",
 	"main": "dist/index.js",
@@ -23,7 +23,7 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@configura/web-utilities": "2.0.0-alpha.18"
+		"@configura/web-utilities": "2.0.0-alpha.19"
 	},
-	"gitHead": "6771998ca63444a51edc9eb35f31bf2f767a356a"
+	"gitHead": "cabb223e0e55c63991c09f652d446e98b0546bf8"
 }