MWPW-152411 raw md doc for web components & events

libs/deps/mas/doc.md

@@ -0,0 +1,129 @@
+# a[is="checkout-link"]
+
+HTML Checkout Link Anchor element, extends anchor
+special member _onceSettled_ promise that either resolves or fail with web commerce information.
+
+
+# span[is="inline-price"]
+
+HTML Price Web Component, extends span.
+special member _onceSettled_ promise that either resolves or fail with web commerce information.
+
+
+# wcms-commerce
+
+Custom web component to provide active instance of commerce service
+to consumers, appended to the head section of current document.
+
+
+# merch-card-collection
+
+## Events
+
+| Event                            | Type                           |
+|----------------------------------|--------------------------------|
+| `merch-card-collection:showmore` | `CustomEvent<any>`             |
+| `merch-card-collection:sort`     | `CustomEvent<{ value: any; }>` |
+
+
+# merch-card
+
+## Events
+
+| Event                  | Type                                 |
+|------------------------|--------------------------------------|
+| `merch-card:ready`     | `CustomEvent<any>`                   |
+| `merch-storage:change` | `CustomEvent<{ offerSelect: any; }>` |
+
+
+# merch-datasource
+
+Custom element representing a MerchDataSource.
+
+
+# merch-icon
+
+
+# merch-mnemonic-list
+
+
+# merch-offer-select
+
+## Events
+
+| Event                      | Type                |
+|----------------------------|---------------------|
+| `merch-offer-select:ready` | `CustomEvent<any>`  |
+| `merch-offer:selected`     | `CustomEvent<this>` |
+
+
+# merch-offer
+
+## Events
+
+| Event               | Type               |
+|---------------------|--------------------|
+| `merch-offer:ready` | `CustomEvent<any>` |
+
+
+# merch-quantity-select
+
+## Events
+
+| Event                            | Type                               |
+|----------------------------------|------------------------------------|
+| `merch-quantity-selector:change` | `CustomEvent<{ option: number; }>` |
+
+
+# merch-search
+
+## Events
+
+| Event                 | Type                                            |
+|-----------------------|-------------------------------------------------|
+| `merch-search:change` | `CustomEvent<{ type: string; value: string; }>` |
+
+
+# merch-secure-transaction
+
+
+# merch-stock
+
+## Events
+
+| Event                | Type                                            |
+|----------------------|-------------------------------------------------|
+| `merch-stock:change` | `CustomEvent<{ checked: any; planType: any; }>` |
+
+
+# merch-subscription-panel
+
+
+# merch-twp-d2p
+
+
+# merch-whats-included
+
+## Events
+
+| Event                    | Type               |
+|--------------------------|--------------------|
+| `hide-see-more-elements` | `CustomEvent<any>` |
+
+
+# plans-modal
+
+
+# merch-sidenav-checkbox-group
+
+
+# merch-sidenav-list
+
+## Events
+
+| Event                  | Type                                             |
+|------------------------|--------------------------------------------------|
+| `merch-sidenav:select` | `CustomEvent<{ type: string; value: any; elt: any; }>` |
+
+
+# merch-sidenav

libs/features/mas/commerce/src/checkout-link.js

@@ -10,6 +10,12 @@ import { selectOffers, useService } from './utilities.js';
 export const CLASS_NAME_DOWNLOAD = 'download';
 export const CLASS_NAME_UPGRADE = 'upgrade';
 
+/**
+ * HTML Checkout Link Anchor element, extends anchor
+ * special member _onceSettled_ promise that either resolves or fail with web commerce information.
+ * 
+ * @element a[is="checkout-link"]
+ */
 export class HTMLCheckoutAnchorElement extends HTMLAnchorElement {
     static is = 'checkout-link';
     static tag = 'a';

libs/features/mas/commerce/src/inline-price.js

@@ -84,7 +84,12 @@ const DISPLAY_TAX_MAP = {
     TEAM_EDU: [GeoMap.sea, GeoMap.kr], // school and uni
 };
 
-/** @type {Commerce.Price.PlaceholderConstructor} */
+/** 
+ * HTML Price Web Component, extends span.
+ * special member _onceSettled_ promise that either resolves or fail with web commerce information.
+ * 
+ * @element span[is="inline-price"]
+ **/
 export class HTMLPriceSpanElement extends HTMLSpanElement {
     static is = 'inline-price';
     static tag = 'span';