@mobielnl/elements 0.13.13 → 0.13.14

package/dist/index.d.ts

@@ -1577,7 +1577,18 @@ export declare type ProductResultsProps = {
     initialProfile?: Partial<Profile>;
     /** Callback function to handle profile changes */
     onProfileChange?: (profile: Partial<Profile>) => void;
-    /** Callback function to add search params for the click-out URL */
+    /** Callback function to add search params for the click-out URL
+     *
+     * @note Add additional unsupported fields as a stringified JSON object to the `partner_metadata` search param.
+     * @example
+     * addClickoutSearchParams={searchParams => {
+     *   searchParams.set('partner_metadata', JSON.stringify({
+     *     click_id: '123',
+     *     affiliate_id: '456',
+     *   }))
+     *   return searchParams
+     * }}
+     */
     addClickoutSearchParams?: (searchParams: URLSearchParams) => URLSearchParams;
     /** Callback function called when an error occurs */
     onError?: (error: Error) => void;
@@ -1644,17 +1655,11 @@ export declare type ProductResultsProps = {
 
 /** Product version lifecycle status */
 declare enum ProductVersionStatusEnum {
-    /** Product version is available and active. */
     Available = "AVAILABLE",
-    /** Not used by the product service. */
     AvailableIfStock = "AVAILABLE_IF_STOCK",
-    /** Product version is being prepared and is not yet active. */
     Preparing = "PREPARING",
-    /** Product version is announced (pre-release) and active. */
     Prerelease = "PRERELEASE",
-    /** Product version is terminated (end of life) and inactive. */
     Terminated = "TERMINATED",
-    /** Product version is retired and inactive. */
     Unavailable = "UNAVAILABLE"
 }
 
@@ -2063,7 +2068,18 @@ export declare type PropositionSelectorProps = RequiredProps & {
     onPropositionKeyChange?: (propositionKey: string) => void;
     /** Callback function to handle profile changes */
     onProfileChange?: (profile: Partial<Profile>) => void;
-    /** Callback function to add search params for the click-out URL */
+    /** Callback function to add search params for the click-out URL
+     *
+     * @note Add additional unsupported fields as a stringified JSON object to the `partner_metadata` search param.
+     * @example
+     * addClickoutSearchParams={searchParams => {
+     *   searchParams.set('partner_metadata', JSON.stringify({
+     *     click_id: '123',
+     *     affiliate_id: '456',
+     *   }))
+     *   return searchParams
+     * }}
+     */
     addClickoutSearchParams?: (searchParams: URLSearchParams) => URLSearchParams;
     /** Callback function called when an error occurs */
     onError?: (error: Error) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mobielnl/elements",
-  "version": "0.13.13",
+  "version": "0.13.14",
   "description": "Mobiel.nl Elements - React component library for partner websites",
   "private": false,
   "type": "module",