@shopify/ui-extensions 2024.4.2 → 2024.10.0

package/build/cjs/surfaces/admin/components/AdminPrintAction/AdminPrintAction.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+/**
+ * AdminPrintAction is a component used by Admin Print Action extensions to configure a src document to preview and print.
+ */
+const AdminPrintAction = core.createRemoteComponent('AdminPrintAction');
+
+exports.AdminPrintAction = AdminPrintAction;

package/build/cjs/surfaces/admin/components/DatePicker/DatePicker.js

@@ -4,6 +4,18 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * A date string using the simplified ISO 8601 format (`YYYY-MM-DD`)
+ */
+
+/**
+ * A year/month string using the simplified ISO 8601 format (`YYYY-MM`)
+ */
+
+/**
+ * Month in 1-12 range
+ */
+
 const DatePicker = core.createRemoteComponent('DatePicker');
 
 exports.DatePicker = DatePicker;

package/build/cjs/surfaces/admin/components/InternalCustomerSegmentTemplate/InternalCustomerSegmentTemplate.js

@@ -4,6 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * Reserved namespace and key for the customer standard metafield used in the template's query.
+ * More info - https://shopify.dev/docs/apps/custom-data/metafields/definitions/standard
+ */
+
 /**
  * Customer segment templates are used to give merchants a starting point to create segments.
  */

package/build/cjs/surfaces/admin/components/MoneyField/MoneyField.js

@@ -6,4 +6,10 @@ var core = require('@remote-ui/core');
 
 const MoneyField = core.createRemoteComponent('MoneyField');
 
+/**
+ * Supported monetary currencies from ISO 4217.
+ *
+ * @see https://www.iso.org/iso-4217-currency-codes.html
+ */
+
 exports.MoneyField = MoneyField;

package/build/cjs/surfaces/admin.js

@@ -4,13 +4,13 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var extension = require('./admin/extension.js');
 var AdminAction = require('./admin/components/AdminAction/AdminAction.js');
+var AdminPrintAction = require('./admin/components/AdminPrintAction/AdminPrintAction.js');
 var AdminBlock = require('./admin/components/AdminBlock/AdminBlock.js');
 var Badge = require('./admin/components/Badge/Badge.js');
 var Banner = require('./admin/components/Banner/Banner.js');
 var BlockStack = require('./admin/components/BlockStack/BlockStack.js');
 var Box = require('./admin/components/Box/Box.js');
 var Button = require('./admin/components/Button/Button.js');
-var Card = require('./admin/components/Card/Card.js');
 var Checkbox = require('./admin/components/Checkbox/Checkbox.js');
 var ChoiceList = require('./admin/components/ChoiceList/ChoiceList.js');
 var ColorPicker = require('./admin/components/ColorPicker/ColorPicker.js');
@@ -34,14 +34,11 @@ var Paragraph = require('./admin/components/Paragraph/Paragraph.js');
 var PasswordField = require('./admin/components/PasswordField/PasswordField.js');
 var Pressable = require('./admin/components/Pressable/Pressable.js');
 var ProgressIndicator = require('./admin/components/ProgressIndicator/ProgressIndicator.js');
-var ResourceItem = require('./admin/components/ResourceItem/ResourceItem.js');
-var ResourceList = require('./admin/components/ResourceList/ResourceList.js');
 var Section = require('./admin/components/Section/Section.js');
 var Select = require('./admin/components/Select/Select.js');
 var Text = require('./admin/components/Text/Text.js');
 var TextArea = require('./admin/components/TextArea/TextArea.js');
 var TextField = require('./admin/components/TextField/TextField.js');
-var Thumbnail = require('./admin/components/Thumbnail/Thumbnail.js');
 var URLField = require('./admin/components/URLField/URLField.js');
 var InternalLocationList = require('./admin/components/InternalLocationList/InternalLocationList.js');
 
@@ -50,13 +47,13 @@ var InternalLocationList = require('./admin/components/InternalLocationList/Inte
 exports.extend = extension.extend;
 exports.extension = extension.extension;
 exports.AdminAction = AdminAction.AdminAction;
+exports.AdminPrintAction = AdminPrintAction.AdminPrintAction;
 exports.AdminBlock = AdminBlock.AdminBlock;
 exports.Badge = Badge.Badge;
 exports.Banner = Banner.Banner;
 exports.BlockStack = BlockStack.BlockStack;
 exports.Box = Box.Box;
 exports.Button = Button.Button;
-exports.Card = Card.Card;
 exports.Checkbox = Checkbox.Checkbox;
 exports.ChoiceList = ChoiceList.ChoiceList;
 exports.ColorPicker = ColorPicker.ColorPicker;
@@ -80,13 +77,10 @@ exports.Paragraph = Paragraph.Paragraph;
 exports.PasswordField = PasswordField.PasswordField;
 exports.Pressable = Pressable.Pressable;
 exports.ProgressIndicator = ProgressIndicator.ProgressIndicator;
-exports.ResourceItem = ResourceItem.ResourceItem;
-exports.ResourceList = ResourceList.ResourceList;
 exports.Section = Section.Section;
 exports.Select = Select.Select;
 exports.Text = Text.Text;
 exports.TextArea = TextArea.TextArea;
 exports.TextField = TextField.TextField;
-exports.Thumbnail = Thumbnail.Thumbnail;
 exports.URLField = URLField.URLField;
 exports.InternalLocationList = InternalLocationList.InternalLocationList;

package/build/cjs/surfaces/checkout/components/Chat/Chat.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+/**
+ * Use Chat to embed another HTML page within the page.
+ */
+const Chat = core.createRemoteComponent('Chat');
+
+exports.Chat = Chat;

package/build/cjs/surfaces/checkout/components/DatePicker/DatePicker.js

@@ -4,16 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
-exports.Day = void 0;
-(function (Day) {
-  Day[Day["Sunday"] = 0] = "Sunday";
-  Day[Day["Monday"] = 1] = "Monday";
-  Day[Day["Tuesday"] = 2] = "Tuesday";
-  Day[Day["Wednesday"] = 3] = "Wednesday";
-  Day[Day["Thursday"] = 4] = "Thursday";
-  Day[Day["Friday"] = 5] = "Friday";
-  Day[Day["Saturday"] = 6] = "Saturday";
-})(exports.Day || (exports.Day = {}));
+/* A date string using the simplified ISO 8601 format (`YYYY-MM-DD`) */
+
+/** A year/month string using the simplified ISO 8601 format (`YYYY-MM`) */
+
 /**
  * The DatePicker component is a calendar picker UI that allows users to select a single date or a date range.
  */

package/build/cjs/surfaces/checkout/components/PaymentIcon/PaymentIcon.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var core = require('@remote-ui/core');
 
 // Copied from https://github.com/Shopify/ui-api-design/blob/main/components/PaymentIcon/PaymentIcon.ts
+// NOTE: Add new entries to the PaymentMethod type in alphabetical order
 
 const PaymentIcon = core.createRemoteComponent('PaymentIcon');
 

package/build/cjs/surfaces/{point-of-sale/components/Actiontem/ActionItem.js → checkout/components/Progress/Progress.js}

@@ -4,6 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
-const ActionItem = core.createRemoteComponent('ActionItem');
+const Progress = core.createRemoteComponent('Progress');
 
-exports.ActionItem = ActionItem;
+exports.Progress = Progress;

package/build/cjs/surfaces/checkout/components/QRCode/QRCode.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const QRCode = core.createRemoteComponent('QRCode');
+
+exports.QRCode = QRCode;

package/build/cjs/surfaces/checkout/components/Switch/Switch.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const Switch = core.createRemoteComponent('Switch');
+
+exports.Switch = Switch;

package/build/cjs/surfaces/checkout.js

@@ -10,6 +10,7 @@ var BlockLayout = require('./checkout/components/BlockLayout/BlockLayout.js');
 var BlockSpacer = require('./checkout/components/BlockSpacer/BlockSpacer.js');
 var BlockStack = require('./checkout/components/BlockStack/BlockStack.js');
 var Button = require('./checkout/components/Button/Button.js');
+var Chat = require('./checkout/components/Chat/Chat.js');
 var ConsentCheckbox = require('./checkout/components/ConsentCheckbox/ConsentCheckbox.js');
 var ConsentPhoneField = require('./checkout/components/ConsentPhoneField/ConsentPhoneField.js');
 var Checkbox = require('./checkout/components/Checkbox/Checkbox.js');
@@ -41,6 +42,8 @@ var PaymentIcon = require('./checkout/components/PaymentIcon/PaymentIcon.js');
 var PhoneField = require('./checkout/components/PhoneField/PhoneField.js');
 var Pressable = require('./checkout/components/Pressable/Pressable.js');
 var ProductThumbnail = require('./checkout/components/ProductThumbnail/ProductThumbnail.js');
+var Progress = require('./checkout/components/Progress/Progress.js');
+var QRCode = require('./checkout/components/QRCode/QRCode.js');
 var Popover = require('./checkout/components/Popover/Popover.js');
 var ScrollView = require('./checkout/components/ScrollView/ScrollView.js');
 var Select = require('./checkout/components/Select/Select.js');
@@ -50,6 +53,7 @@ var SkeletonText = require('./checkout/components/SkeletonText/SkeletonText.js')
 var SkeletonTextBlock = require('./checkout/components/SkeletonTextBlock/SkeletonTextBlock.js');
 var Spinner = require('./checkout/components/Spinner/Spinner.js');
 var Stepper = require('./checkout/components/Stepper/Stepper.js');
+var Switch = require('./checkout/components/Switch/Switch.js');
 var Tag = require('./checkout/components/Tag/Tag.js');
 var Text = require('./checkout/components/Text/Text.js');
 var TextBlock = require('./checkout/components/TextBlock/TextBlock.js');
@@ -72,6 +76,7 @@ exports.BlockLayout = BlockLayout.BlockLayout;
 exports.BlockSpacer = BlockSpacer.BlockSpacer;
 exports.BlockStack = BlockStack.BlockStack;
 exports.Button = Button.Button;
+exports.Chat = Chat.Chat;
 exports.ConsentCheckbox = ConsentCheckbox.ConsentCheckbox;
 exports.ConsentPhoneField = ConsentPhoneField.ConsentPhoneField;
 exports.Checkbox = Checkbox.Checkbox;
@@ -103,6 +108,8 @@ exports.PaymentIcon = PaymentIcon.PaymentIcon;
 exports.PhoneField = PhoneField.PhoneField;
 exports.Pressable = Pressable.Pressable;
 exports.ProductThumbnail = ProductThumbnail.ProductThumbnail;
+exports.Progress = Progress.Progress;
+exports.QRCode = QRCode.QRCode;
 exports.Popover = Popover.Popover;
 exports.ScrollView = ScrollView.ScrollView;
 exports.Select = Select.Select;
@@ -112,6 +119,7 @@ exports.SkeletonText = SkeletonText.SkeletonText;
 exports.SkeletonTextBlock = SkeletonTextBlock.SkeletonTextBlock;
 exports.Spinner = Spinner.Spinner;
 exports.Stepper = Stepper.Stepper;
+exports.Switch = Switch.Switch;
 exports.Tag = Tag.Tag;
 exports.Text = Text.Text;
 exports.TextBlock = TextBlock.TextBlock;

package/build/cjs/surfaces/customer-account/components/Avatar/Avatar.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const Avatar = core.createRemoteComponent('Avatar');
+
+exports.Avatar = Avatar;

package/build/cjs/surfaces/customer-account/components/CustomerAccountAction/CustomerAccountAction.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const CustomerAccountAction = core.createRemoteComponent('CustomerAccountAction');
+
+exports.CustomerAccountAction = CustomerAccountAction;

package/build/cjs/surfaces/customer-account/components/DropZone/DropZone.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const DropZone = core.createRemoteComponent('DropZone');
+
+exports.DropZone = DropZone;

package/build/cjs/surfaces/customer-account/components/ImageGroup/ImageGroup.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const ImageGroup = core.createRemoteComponent('ImageGroup');
+
+exports.ImageGroup = ImageGroup;

package/build/cjs/surfaces/{admin/components/Card/Card.js → customer-account/components/Menu/Menu.js}

@@ -4,6 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
-const Card = core.createRemoteComponent('Card');
+const Menu = core.createRemoteComponent('Menu');
 
-exports.Card = Card;
+exports.Menu = Menu;

package/build/cjs/surfaces/customer-account/components/Page/Page.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const Page = core.createRemoteComponent('Page');
+
+exports.Page = Page;

package/build/cjs/surfaces/customer-account/components/PolicyModal/PolicyModal.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+// The interface is duplicated in the `ui-extensions-react` package because it no longer can be imported
+// More on the PR: https://github.com/Shopify/ui-extensions/pull/1399
+
+const PolicyModal = core.createRemoteComponent('PolicyModal');
+
+exports.PolicyModal = PolicyModal;

package/build/cjs/surfaces/customer-account/components/ResourceItem/ResourceItem.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+const ResourceItem = core.createRemoteComponent('ResourceItem');
+
+exports.ResourceItem = ResourceItem;

package/build/cjs/surfaces/customer-account.js

@@ -5,6 +5,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var extension = require('./customer-account/extension.js');
 var style = require('./checkout/style/style.js');
 var Card = require('./customer-account/components/Card/Card.js');
+var CustomerAccountAction = require('./customer-account/components/CustomerAccountAction/CustomerAccountAction.js');
+var DropZone = require('./customer-account/components/DropZone/DropZone.js');
+var Page = require('./customer-account/components/Page/Page.js');
+var Avatar = require('./customer-account/components/Avatar/Avatar.js');
+var Menu = require('./customer-account/components/Menu/Menu.js');
+var PolicyModal = require('./customer-account/components/PolicyModal/PolicyModal.js');
+var ResourceItem = require('./customer-account/components/ResourceItem/ResourceItem.js');
+var ImageGroup = require('./customer-account/components/ImageGroup/ImageGroup.js');
 var Badge = require('./checkout/components/Badge/Badge.js');
 var Banner = require('./checkout/components/Banner/Banner.js');
 var BlockLayout = require('./checkout/components/BlockLayout/BlockLayout.js');
@@ -39,14 +47,18 @@ var PaymentIcon = require('./checkout/components/PaymentIcon/PaymentIcon.js');
 var PhoneField = require('./checkout/components/PhoneField/PhoneField.js');
 var Pressable = require('./checkout/components/Pressable/Pressable.js');
 var ProductThumbnail = require('./checkout/components/ProductThumbnail/ProductThumbnail.js');
+var Progress = require('./checkout/components/Progress/Progress.js');
 var Popover = require('./checkout/components/Popover/Popover.js');
+var QRCode = require('./checkout/components/QRCode/QRCode.js');
 var ScrollView = require('./checkout/components/ScrollView/ScrollView.js');
 var Select = require('./checkout/components/Select/Select.js');
+var Sheet = require('./checkout/components/Sheet/Sheet.js');
 var SkeletonImage = require('./checkout/components/SkeletonImage/SkeletonImage.js');
 var SkeletonText = require('./checkout/components/SkeletonText/SkeletonText.js');
 var SkeletonTextBlock = require('./checkout/components/SkeletonTextBlock/SkeletonTextBlock.js');
 var Spinner = require('./checkout/components/Spinner/Spinner.js');
 var Stepper = require('./checkout/components/Stepper/Stepper.js');
+var Switch = require('./checkout/components/Switch/Switch.js');
 var Tag = require('./checkout/components/Tag/Tag.js');
 var Text = require('./checkout/components/Text/Text.js');
 var TextBlock = require('./checkout/components/TextBlock/TextBlock.js');
@@ -64,6 +76,14 @@ exports.Style = style.Style;
 exports.isConditionalStyle = style.isConditionalStyle;
 exports.isConditionalStyleWithDefault = style.isConditionalStyleWithDefault;
 exports.Card = Card.Card;
+exports.CustomerAccountAction = CustomerAccountAction.CustomerAccountAction;
+exports.DropZone = DropZone.DropZone;
+exports.Page = Page.Page;
+exports.Avatar = Avatar.Avatar;
+exports.Menu = Menu.Menu;
+exports.PolicyModal = PolicyModal.PolicyModal;
+exports.ResourceItem = ResourceItem.ResourceItem;
+exports.ImageGroup = ImageGroup.ImageGroup;
 exports.Badge = Badge.Badge;
 exports.Banner = Banner.Banner;
 exports.BlockLayout = BlockLayout.BlockLayout;
@@ -98,14 +118,18 @@ exports.PaymentIcon = PaymentIcon.PaymentIcon;
 exports.PhoneField = PhoneField.PhoneField;
 exports.Pressable = Pressable.Pressable;
 exports.ProductThumbnail = ProductThumbnail.ProductThumbnail;
+exports.Progress = Progress.Progress;
 exports.Popover = Popover.Popover;
+exports.QRCode = QRCode.QRCode;
 exports.ScrollView = ScrollView.ScrollView;
 exports.Select = Select.Select;
+exports.Sheet = Sheet.Sheet;
 exports.SkeletonImage = SkeletonImage.SkeletonImage;
 exports.SkeletonText = SkeletonText.SkeletonText;
 exports.SkeletonTextBlock = SkeletonTextBlock.SkeletonTextBlock;
 exports.Spinner = Spinner.Spinner;
 exports.Stepper = Stepper.Stepper;
+exports.Switch = Switch.Switch;
 exports.Tag = Tag.Tag;
 exports.Text = Text.Text;
 exports.TextBlock = TextBlock.TextBlock;

package/build/cjs/surfaces/point-of-sale/components/ActionItem/ActionItem.js

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+/**
+ * Renders an `ActionItem` on action targets. Note that the text displayed on this `ActionItem`
+ * is dependent on the description of the extension.
+ * @property `enabled` sets whether or not the `ActionItem` can be tapped.
+ * @property `onPress` the callback that is executed when the user taps the `ActionItem`.
+ */
+
+const ActionItem = core.createRemoteComponent('ActionItem');
+
+exports.ActionItem = ActionItem;

package/build/cjs/surfaces/point-of-sale/components/Badge/Badge.js

@@ -4,6 +4,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * @property text - The text displayed inside the badge.
+ * @property variant - The appearance and function of the badge.
+ * @property status - A circle icon displaying the status of the badge.
+ */
+
 const Badge = core.createRemoteComponent('Badge');
 
 exports.Badge = Badge;

package/build/cjs/surfaces/point-of-sale/components/Banner/Banner.js

@@ -4,6 +4,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * @property title - The title text displayed on the banner.
+ * @property variant - The variant type of the banner.
+ * @property action - The text for the action button.
+ * @property onPress - The callback function executed when the banner is pressed.
+ * @property hideAction - Whether to hide the action button.
+ * @property visible - The visibility state of the banner.
+ */
+
 const Banner = core.createRemoteComponent('Banner');
 
 exports.Banner = Banner;

package/build/cjs/surfaces/point-of-sale/components/Button/Button.js

@@ -4,6 +4,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * @property `title` the text set on the `Button`.
+ * @property `type` the type of `Button` to render. Determines the appearance of the button.
+ * @property `onPress` the callback that is executed when the user taps the button.
+ * @property `isDisabled` sets whether the `Button` can be tapped.
+ * @property `isLoading` sets whether the `Button` is displaying an animated loading state.
+ */
+
 const Button = core.createRemoteComponent('Button');
 
 exports.Button = Button;

package/build/cjs/surfaces/point-of-sale/components/CameraScanner/CameraScanner.js

@@ -4,6 +4,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * @property title - The title of the banner.
+ * @property variant - The appearance of the banner.
+ * @property visible - The visibility state of the banner.
+ */
+
 const CameraScanner = core.createRemoteComponent('CameraScanner');
 
 exports.CameraScanner = CameraScanner;

package/build/cjs/surfaces/point-of-sale/components/DatePicker/DatePicker.js

@@ -4,6 +4,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * Represents the properties for the DatePicker component.
+ * @property selected - The selected time.
+ * @property onChange - A callback for changes.
+ * @property visibleState - Control the visible state, and a callback to set the visible state as false when the dialog closes.
+ * @property inputMode - Whether to display the picker in inline (clock) mode or spinner mode.
+ */
+
 const DatePicker = core.createRemoteComponent('DatePicker');
 
 exports.DatePicker = DatePicker;

package/build/cjs/surfaces/point-of-sale/components/Dialog/Dialog.js

@@ -4,6 +4,18 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * @property title - The text displayed in the title of the dialog.
+ * @property content - The text displayed in the body of the dialog.
+ * @property actionText - The text displayed in the primary action button of the dialog.
+ * @property secondaryActionText - The text displayed in the secondary action section of the dialog.
+ * @property showSecondaryAction - Whether a secondary action displays.
+ * @property type - Determines the dialog’s appearance and function.
+ * @property onAction - A callback that performs when the action is triggered.
+ * @property onSecondaryAction - A callback that is executed when the secondary action is triggered.
+ * @property isVisible - Whether the dialog should be presented.
+ */
+
 const Dialog = core.createRemoteComponent('Dialog');
 
 exports.Dialog = Dialog;

package/build/cjs/surfaces/point-of-sale/components/FormattedTextField/FormattedTextField.js

@@ -4,6 +4,16 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * Dictates what type of values can be used in a `TextField`.
+ */
+
+/**
+ * @property `inputType` the `InputType` of the `TextField`. This will select the appropriate keyboard.
+ * @property `autoCapitalize` dictates when the text should be auto-capitalized.
+ * @property `customValidator` applies a custom validator that can dictate whether or not an entered value is valid.
+ */
+
 const FormattedTextField = core.createRemoteComponent('FormattedTextField');
 
 exports.FormattedTextField = FormattedTextField;

package/build/cjs/surfaces/point-of-sale/components/Navigator/Navigator.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var core = require('@remote-ui/core');
 
 /**
- * @property `initialScreenName` sets the initial Screen by its `name` property.
+ * @property `initialScreenName` sets the initial `Screen` whose `name` matches.
  */
 
 const Navigator = core.createRemoteComponent('Navigator');

package/build/cjs/surfaces/point-of-sale/components/NumberField/NumberField.js

@@ -4,6 +4,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var core = require('@remote-ui/core');
 
+/**
+ * Represents the properties for the NumberField component.
+ * @typedef {Object} NumberFieldProps
+ * @property {'decimal' | 'numeric'} [inputMode] - The mode of input, can be either 'decimal' or 'numeric'.
+ */
+
 const NumberField = core.createRemoteComponent('NumberField');
 
 exports.NumberField = NumberField;

package/build/cjs/surfaces/point-of-sale/components/POSBlock/POSBlock.js

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+/**
+ * Renders a `POSBlock`. Note that the text displayed on this `POSBlock`
+ * is dependent on the description of the extension. A `POSBlock` only
+ * accepts `POSBlockRow` as children.
+ */
+
+const POSBlock = core.createRemoteComponent('POSBlock');
+
+exports.POSBlock = POSBlock;

package/build/cjs/surfaces/point-of-sale/components/POSBlock/POSBlockRow.js

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+/**
+ * Renders a `POSBlockRow` in a `POSBlock`.
+ */
+
+const POSBlockRow = core.createRemoteComponent('POSBlockRow');
+
+exports.POSBlockRow = POSBlockRow;

package/build/cjs/surfaces/point-of-sale/components/PinPad/PinPad.js

@@ -9,6 +9,30 @@ var core = require('@remote-ui/core');
  * @typedef {('accept'|'reject')} PinValidationResult
  */
 
+/**
+ * Represents the allowed lengths of a PIN.
+ * @typedef {(4|5|6|7|8|9|10)} PinLength
+ */
+
+/**
+ * Represents an action type for the PinPad component.
+ * @typedef {Object} PinPadActionType
+ * @property {string} label - The label for the action button.
+ * @property {function(): number[]} onPress - The function to be called when the action button is pressed.
+ */
+
+/**
+ * Represents the properties for the PinPad component.
+ * @typedef {Object} PinPadProps
+ * @property {boolean} [masked] - Whether the entered PIN should be masked.
+ * @property {PinLength} [minPinLength] - The minimum length of the PIN.
+ * @property {PinLength} [maxPinLength] - The maximum length of the PIN.
+ * @property {string} [label] - The content for the prompt on the pin pad.
+ * @property {PinPadActionType} [pinPadAction] - The call to action between the entry view and the keypad, consisting of a label and function that returns the pin.
+ * @property {function(pin: number[]): Promise<PinValidationResult>} onSubmit - The function to be called when the PIN is submitted.
+ * @property {function(pin: number[]): void} [onPinEntry] - The function to be called when a PIN is entered.
+ */
+
 const PinPad = core.createRemoteComponent('PinPad');
 
 exports.PinPad = PinPad;

package/build/cjs/surfaces/point-of-sale/components/Screen/Screen.js

@@ -8,6 +8,24 @@ var core = require('@remote-ui/core');
  * @property `sheet` displays the screen from the bottom on `navigate` when `true`.
  */
 
+/** Represents the secondary action button of a screen in the navigation stack.
+ * @property `text` displays the name of the secondary action in the action bar.
+ * @property `onPress` triggered when the secondary action button is pressed.
+ * @property `isEnabled` sets whether the action can be tapped.
+ */
+
+/** Represents a screen in the navigation stack.
+ * @property `name` used to identify this screen as a destination in the navigation stack.
+ * @property `title` the title of the screen which will be displayed on the UI.
+ * @property `isLoading` displays a loading indicator when `true`. Set this to `true` when performing an asynchronous task, and then to false when the data becomes available to the UI.
+ * @property `presentation` dictates how the `Screen` will be presented when navigated to.
+ * @property `secondaryAction` displays a secondary action button on the screen.
+ * @property `onNavigate` triggered when the screen is navigated to.
+ * @property `onNavigateBack` triggered when the user navigates back from this screen. Runs after screen is unmounted.
+ * @property `overrideNavigateBack` a callback that allows you to override the secondary navigation action. Runs when screen is mounted.
+ * @property `onReceiveParams` a callback that gets triggered when the navigation event completes and the screen receives the parameters.
+ */
+
 const Screen = core.createRemoteComponent('Screen');
 
 exports.Screen = Screen;