@configura/web-api 2.0.0-alpha.8 → 2.0.0-alpha.9

package/dist/CfgReferencePathHelper.d.ts

@@ -8,7 +8,20 @@ import { DtoCatalogueParamsWithLang, DtoProductParamsWithLang } from "./Catalogu
  * Internally at Configura we try to stick with this format.
  */
 export declare class CfgReferencePathHelper {
+    /**
+     * 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
+     * @param catParams What catalogue to generate URL for.
+     * @returns An URL to a catalogue
+     */
     static getCataloguePath: (browsingRootUrl: string, catParams: DtoCatalogueParamsWithLang) => string;
-    static getProductPath: (browsingRootUrl: string, productParams: DtoProductParamsWithLang) => 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
+     * @param productParams What product to generate URL for.
+     * @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;
 }
 //# sourceMappingURL=CfgReferencePathHelper.d.ts.map

package/dist/CfgReferencePathHelper.js

@@ -9,5 +9,18 @@ import { encodeURIComponents } from "@configura/web-utilities";
  */
 export class CfgReferencePathHelper {
 }
+/**
+ * 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
+ * @param catParams What catalogue to generate URL for.
+ * @returns An URL to a catalogue
+ */
 CfgReferencePathHelper.getCataloguePath = (browsingRootUrl, catParams) => `${browsingRootUrl}/${encodeURIComponents(catParams.cid, catParams.lang, catParams.enterprise, catParams.prdCat, catParams.prdCatVersion, catParams.vendor, catParams.priceList)}`;
-CfgReferencePathHelper.getProductPath = (browsingRootUrl, productParams) => `${CfgReferencePathHelper.getCataloguePath(browsingRootUrl, productParams)}/product/${encodeURIComponent(productParams.partNumber)}`;
+/**
+ * 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
+ * @param productParams What product to generate URL for.
+ * @param separator Optional, defaults to "product", but can be changed to indicate another function.
+ * @returns An URL to a product
+ */
+CfgReferencePathHelper.getProductPath = (browsingRootUrl, productParams, separator = "product") => `${CfgReferencePathHelper.getCataloguePath(browsingRootUrl, productParams)}/${separator}/${encodeURIComponent(productParams.partNumber)}`;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@configura/web-api",
-	"version": "2.0.0-alpha.8",
+	"version": "2.0.0-alpha.9",
 	"license": "Apache-2.0",
 	"type": "module",
 	"main": "dist/index.js",
@@ -23,7 +23,7 @@
 		"access": "public"
 	},
 	"dependencies": {
-		"@configura/web-utilities": "2.0.0-alpha.8"
+		"@configura/web-utilities": "2.0.0-alpha.9"
 	},
-	"gitHead": "7b649675de680b81a1ba8b63e9ebdf1a61f90469"
+	"gitHead": "734f4e65f7d3dc9836c5c0321dbe6c36bbfa2531"
 }