@postnord/pn-marketweb-components 2.3.12 → 2.3.14

package/types/components/navigation/pn-mainnav/translations.d.ts

@@ -34,4 +34,25 @@ export declare const translations: {
     menuStartButton: string;
     navLabel: string;
   };
+  zh: {
+    menuHomeButton: string;
+    menuGoBackButton: string;
+    mainMenuButton: string;
+    menuStartButton: string;
+    navLabel: string;
+  };
+  it: {
+    menuHomeButton: string;
+    menuGoBackButton: string;
+    mainMenuButton: string;
+    menuStartButton: string;
+    navLabel: string;
+  };
+  nl: {
+    menuHomeButton: string;
+    menuGoBackButton: string;
+    mainMenuButton: string;
+    menuStartButton: string;
+    navLabel: string;
+  };
 };

package/types/components/navigation/pn-sidenav/translations.d.ts

@@ -29,4 +29,19 @@ export declare const translations: {
     close: string;
     navLabel: string;
   };
+  zh: {
+    open: string;
+    close: string;
+    navLabel: string;
+  };
+  it: {
+    open: string;
+    close: string;
+    navLabel: string;
+  };
+  nl: {
+    open: string;
+    close: string;
+    navLabel: string;
+  };
 };

package/types/components.d.ts

@@ -114,8 +114,8 @@ export namespace Components {
         "source": string;
     }
     interface PnFindServiceAndPriceResult {
-        "item": ProductPriceItem;
-        "shownitems": ProductPriceItem[];
+        "item": ProductPriceItem1;
+        "shownitems": ProductPriceItem1[];
     }
     interface PnLanguageSelector {
         "value": string;
@@ -498,9 +498,9 @@ export namespace Components {
     }
     interface PnProductPricelistResult {
         "description"?: string[];
-        "item": ProductPriceItem;
+        "item": ProductPriceItem1;
         "showMeasurement"?: boolean;
-        "shownitems": ProductPriceItem[];
+        "shownitems": ProductPriceItem1[];
     }
     interface PnProductTile {
     }
@@ -725,6 +725,42 @@ export namespace Components {
         "icon": string;
     }
 }
+export interface PnLanguageSelectorCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnLanguageSelectorElement;
+}
+export interface PnLanguageSelectorOptionCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnLanguageSelectorOptionElement;
+}
+export interface PnMainnavCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnMainnavElement;
+}
+export interface PnMarketwebSearchCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnMarketwebSearchElement;
+}
+export interface PnMarketwebSiteheaderCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnMarketwebSiteheaderElement;
+}
+export interface PnMarketwebSiteheaderLoginCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnMarketwebSiteheaderLoginElement;
+}
+export interface PnMultiFormfieldCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnMultiFormfieldElement;
+}
+export interface PnProfileModalCustomernumberCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnProfileModalCustomernumberElement;
+}
+export interface PnProfileModalProfileCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPnProfileModalProfileElement;
+}
 declare global {
     interface HTMLPnAnimatedTileElement extends Components.PnAnimatedTile, HTMLStencilElement {
     }
@@ -1358,11 +1394,11 @@ declare namespace LocalJSX {
         "source"?: string;
     }
     interface PnFindServiceAndPriceResult {
-        "item"?: ProductPriceItem;
-        "shownitems"?: ProductPriceItem[];
+        "item"?: ProductPriceItem1;
+        "shownitems"?: ProductPriceItem1[];
     }
     interface PnLanguageSelector {
-        "onSetLanguage"?: (event: CustomEvent<any>) => void;
+        "onSetLanguage"?: (event: PnLanguageSelectorCustomEvent<any>) => void;
         "value"?: string;
     }
     interface PnLanguageSelectorOption {
@@ -1372,7 +1408,7 @@ declare namespace LocalJSX {
           * What you write in the comment block above each prop is what ends up in the description fields in the prop table in the documentation
          */
         "name"?: string;
-        "onSetCurrentLanguage"?: (event: CustomEvent<any>) => void;
+        "onSetCurrentLanguage"?: (event: PnLanguageSelectorOptionCustomEvent<any>) => void;
         "selected"?: boolean;
         "url"?: string;
     }
@@ -1395,9 +1431,9 @@ declare namespace LocalJSX {
           * Specifies which endpoint we should read information from
          */
         "navigationId"?: string;
-        "onMarketChange"?: (event: CustomEvent<any>) => void;
-        "onMenuLanguageChange"?: (event: CustomEvent<any>) => void;
-        "onMenuOpenChange"?: (event: CustomEvent<any>) => void;
+        "onMarketChange"?: (event: PnMainnavCustomEvent<any>) => void;
+        "onMenuLanguageChange"?: (event: PnMainnavCustomEvent<any>) => void;
+        "onMenuOpenChange"?: (event: PnMainnavCustomEvent<any>) => void;
         /**
           * Specifies which endpoint we should read information from
          */
@@ -1487,11 +1523,11 @@ declare namespace LocalJSX {
         /**
           * This is emitted on search submission both with keyboard and mouse
          */
-        "onSearch"?: (event: CustomEvent<any>) => void;
+        "onSearch"?: (event: PnMarketwebSearchCustomEvent<any>) => void;
         /**
           * custom event that handles both clearing and input to have the option of just binding listeners to one event instead of two.
          */
-        "onUpdate"?: (event: CustomEvent<any>) => void;
+        "onUpdate"?: (event: PnMarketwebSearchCustomEvent<any>) => void;
         "placeholder"?: string;
         "value"?: string;
     }
@@ -1578,8 +1614,8 @@ declare namespace LocalJSX {
           * Specifies which market we want to show (se,dk,fi,no,com)
          */
         "market"?: string;
-        "onChangeLanguage"?: (event: CustomEvent<any>) => void;
-        "onChangeMarket"?: (event: CustomEvent<any>) => void;
+        "onChangeLanguage"?: (event: PnMarketwebSiteheaderCustomEvent<any>) => void;
+        "onChangeMarket"?: (event: PnMarketwebSiteheaderCustomEvent<any>) => void;
         /**
           * Header search placeholder
          */
@@ -1639,7 +1675,7 @@ declare namespace LocalJSX {
         "i18n"?: SiteHeaderI18N;
         "loggedin"?: boolean;
         "loginDialog"?: LoginDialog;
-        "onLoginStateChange"?: (event: CustomEvent<any>) => void;
+        "onLoginStateChange"?: (event: PnMarketwebSiteheaderLoginCustomEvent<any>) => void;
         /**
           * If this is selected we will show the new profile selection dropdown instead of the login version
          */
@@ -1709,7 +1745,7 @@ declare namespace LocalJSX {
     interface PnMultiFormfield {
         "formFieldClassName"?: string;
         "formFieldOuterParentClassName"?: string;
-        "onChanged"?: (event: CustomEvent<any>) => void;
+        "onChanged"?: (event: PnMultiFormfieldCustomEvent<any>) => void;
         "value"?: FormValue[];
     }
     interface PnParcelTracker {
@@ -1759,9 +1795,9 @@ declare namespace LocalJSX {
     }
     interface PnProductPricelistResult {
         "description"?: string[];
-        "item"?: ProductPriceItem;
+        "item"?: ProductPriceItem1;
         "showMeasurement"?: boolean;
-        "shownitems"?: ProductPriceItem[];
+        "shownitems"?: ProductPriceItem1[];
     }
     interface PnProductTile {
     }
@@ -1785,15 +1821,15 @@ declare namespace LocalJSX {
     }
     interface PnProfileModalCustomernumber {
         "customernumber"?: string;
-        "onUrlSelected"?: (event: CustomEvent<any>) => void;
+        "onUrlSelected"?: (event: PnProfileModalCustomernumberCustomEvent<any>) => void;
         "selected"?: boolean;
         "url"?: string;
     }
     interface PnProfileModalProfile {
         "description"?: string;
         "heading"?: string;
-        "onShowCustomerNumbersEvent"?: (event: CustomEvent<any>) => void;
-        "onUrlSelected"?: (event: CustomEvent<any>) => void;
+        "onShowCustomerNumbersEvent"?: (event: PnProfileModalProfileCustomEvent<any>) => void;
+        "onUrlSelected"?: (event: PnProfileModalProfileCustomEvent<any>) => void;
         "pleaseSelectText"?: string;
         "selected"?: boolean;
         "showCustomerNumbers"?: boolean;

package/types/stencil-public-runtime.d.ts

@@ -133,7 +133,7 @@ export interface ListenOptions {
      */
     passive?: boolean;
 }
-export declare type ListenTargetOptions = 'body' | 'document' | 'window';
+export type ListenTargetOptions = 'body' | 'document' | 'window';
 export interface StateDecorator {
     (): PropertyDecorator;
 }
@@ -214,14 +214,16 @@ export declare const State: StateDecorator;
  * https://stenciljs.com/docs/reactive-data#watch-decorator
  */
 export declare const Watch: WatchDecorator;
-export declare type ResolutionHandler = (elm: HTMLElement) => string | undefined | null;
-export declare type ErrorHandler = (err: any, element?: HTMLElement) => void;
+export type ResolutionHandler = (elm: HTMLElement) => string | undefined | null;
+export type ErrorHandler = (err: any, element?: HTMLElement) => void;
 /**
  * `setMode()` is used for libraries which provide multiple "modes" for styles.
  */
 export declare const setMode: (handler: ResolutionHandler) => void;
 /**
- * getMode
+ * `getMode()` is used for libraries which provide multiple "modes" for styles.
+ * @param ref a reference to the node to get styles for
+ * @returns the current mode or undefined, if not found
  */
 export declare function getMode<T = string | undefined>(ref: any): T;
 export declare function setPlatformHelpers(helpers: {
@@ -234,6 +236,9 @@ export declare function setPlatformHelpers(helpers: {
 /**
  * Get the base path to where the assets can be found. Use `setAssetPath(path)`
  * if the path needs to be customized.
+ * @param path the path to use in calculating the asset path. this value will be
+ * used in conjunction with the base asset path
+ * @returns the base path
  */
 export declare function getAssetPath(path: string): string;
 /**
@@ -246,22 +251,38 @@ export declare function getAssetPath(path: string): string;
  * `setAssetPath(document.currentScript.src)`, or using a bundler's replace plugin to
  * dynamically set the path at build time, such as `setAssetPath(process.env.ASSET_PATH)`.
  * But do note that this configuration depends on how your script is bundled, or lack of
- * bunding, and where your assets can be loaded from. Additionally custom bundling
+ * bundling, and where your assets can be loaded from. Additionally custom bundling
  * will have to ensure the static assets are copied to its build directory.
+ * @param path the asset path to set
+ * @returns the set path
  */
 export declare function setAssetPath(path: string): string;
 /**
- * getElement
+ * Used to specify a nonce value that corresponds with an application's
+ * [Content Security Policy (CSP)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).
+ * When set, the nonce will be added to all dynamically created script and style tags at runtime.
+ * Alternatively, the nonce value can be set on a `meta` tag in the DOM head
+ * (<meta name="csp-nonce" content="{ nonce value here }" />) and will result in the same behavior.
+ * @param nonce The value to be used for the nonce attribute.
+ */
+export declare function setNonce(nonce: string): void;
+/**
+ * Retrieve a Stencil element for a given reference
+ * @param ref the ref to get the Stencil element for
+ * @returns a reference to the element
  */
 export declare function getElement(ref: any): HTMLStencilElement;
 /**
  * Schedules a new render of the given instance or element even if no state changed.
  *
- * Notice `forceUpdate()` is not syncronous and might perform the DOM render in the next frame.
+ * Notice `forceUpdate()` is not synchronous and might perform the DOM render in the next frame.
+ *
+ * @param ref the node/element to force the re-render of
  */
 export declare function forceUpdate(ref: any): void;
 /**
  * getRenderingRef
+ * @returns the rendering ref
  */
 export declare function getRenderingRef(): any;
 export interface HTMLStencilElement extends HTMLElement {
@@ -272,6 +293,8 @@ export interface HTMLStencilElement extends HTMLElement {
  * in the best moment to perform DOM mutation without causing layout thrashing.
  *
  * For further information: https://developers.google.com/web/fundamentals/performance/rendering/avoid-large-complex-layouts-and-layout-thrashing
+ *
+ * @param task the DOM-write to schedule
  */
 export declare function writeTask(task: RafCallback): void;
 /**
@@ -279,6 +302,8 @@ export declare function writeTask(task: RafCallback): void;
  * in the best moment to perform DOM reads without causing layout thrashing.
  *
  * For further information: https://developers.google.com/web/fundamentals/performance/rendering/avoid-large-complex-layouts-and-layout-thrashing
+ *
+ * @param task the DOM-read to schedule
  */
 export declare function readTask(task: RafCallback): void;
 /**
@@ -417,13 +442,57 @@ interface HostAttributes {
     ref?: (el: HTMLElement | null) => void;
     [prop: string]: any;
 }
+/**
+ * Utilities for working with functional Stencil components. An object
+ * conforming to this interface is passed by the Stencil runtime as the third
+ * argument to a functional component, allowing component authors to work with
+ * features like children.
+ *
+ * The children of a functional component will be passed as the second
+ * argument, so a functional component which uses these utils to transform its
+ * children might look like the following:
+ *
+ * ```ts
+ * export const AddClass: FunctionalComponent = (_, children, utils) => (
+ *  utils.map(children, child => ({
+ *    ...child,
+ *    vattrs: {
+ *      ...child.vattrs,
+ *      class: `${child.vattrs.class} add-class`
+ *    }
+ *  }))
+ * );
+ * ```
+ *
+ * For more see the Stencil documentation, here:
+ * https://stenciljs.com/docs/functional-components
+ */
 export interface FunctionalUtilities {
+    /**
+     * Utility for reading the children of a functional component at runtime.
+     * Since the Stencil runtime uses a different interface for children it is
+     * not recommendeded to read the children directly, and is preferable to use
+     * this utility to, for instance, perform a side effect for each child.
+     */
     forEach: (children: VNode[], cb: (vnode: ChildNode, index: number, array: ChildNode[]) => void) => void;
+    /**
+     * Utility for transforming the children of a functional component. Given an
+     * array of children and a callback this will return a list of the results of
+     * passing each child to the supplied callback.
+     */
     map: (children: VNode[], cb: (vnode: ChildNode, index: number, array: ChildNode[]) => ChildNode) => VNode[];
 }
 export interface FunctionalComponent<T = {}> {
     (props: T, children: VNode[], utils: FunctionalUtilities): VNode | VNode[];
 }
+/**
+ * A Child VDOM node
+ *
+ * This has most of the same properties as {@link VNode} but friendlier names
+ * (i.e. `vtag` instead of `$tag$`, `vchildren` instead of `$children$`) in
+ * order to provide a friendlier public interface for users of the
+ * {@link FunctionalUtilities}).
+ */
 export interface ChildNode {
     vtag?: string | number | Function;
     vkey?: string | number;
@@ -470,6 +539,9 @@ export declare function h(sel: any, children: Array<VNode | undefined | null>):
 export declare function h(sel: any, data: VNodeData | null, text: string): VNode;
 export declare function h(sel: any, data: VNodeData | null, children: Array<VNode | undefined | null>): VNode;
 export declare function h(sel: any, data: VNodeData | null, children: VNode): VNode;
+/**
+ * A virtual DOM node
+ */
 export interface VNode {
     $flags$: number;
     $tag$: string | number | Function;