@shopify/ui-extensions 2025.10.0 → 2025.10.2

package/README.md

@@ -1,42 +1,24 @@
 # `@shopify/ui-extensions`
 
-This package contains the public type definitions and utilities needed to create a Shopify UI extension. This is a generalized package that is intended to be the long-term home of the surface-specific UI extension packages, like [`@shopify/checkout-ui-extensions`](https://github.com/Shopify/ui-extensions/tree/main/packages/checkout-ui-extensions) and [`@shopify/admin-ui-extensions`](https://github.com/Shopify/ui-extensions/tree/main/packages/admin-ui-extensions).
+This package contains the public type definitions and utilities needed to create Shopify UI extensions.
 
-> **Is your extension currently using `@shopify/checkout-ui-extensions`?** You can learn what you need to do to upgrade to this API versioned package in the [migration guide](../../documentation/upgrade/checkout-ui-extension-api-versioning.md).
+This package supports the development of UI extension for [Admin](https://shopify.dev/docs/api/admin-extensions), [Customer account](https://shopify.dev/docs/api/customer-account-ui-extensions), [POS](https://shopify.dev/docs/api/pos-ui-extensions), and [Checkout](https://shopify.dev/docs/api/checkout-ui-extensions) surfaces.
 
-Currently, this package only contains the extension APIs for the [`checkout`](./src/surfaces/checkout) and [`admin`](./src/surfaces/admin) surfaces, but other Shopify surfaces will be added here soon.
+All extensions, regardless of where they appear in Shopify, make use of the same [underlying technology](https://github.com/Shopify/remote-dom), and most of the same “core” components (e.g., `s-block`, `s-button`, `s-text-field`, etc) and capabilities (e.g., direct API access, session tokens). Separating APIs by surface makes it easier for a developer to see what is available to them in each context, and gives us a flexible system for introducing components and APIs available in only some areas of Shopify.
 
-All extensions, regardless of where they appear in Shopify, make use of the same [underlying technology](../../documentation/how-extensions-work.md), and most of the same “core” components (e.g., `BlockStack`, `Button`, `TextField`, etc) and capabilities (e.g., direct API access, session tokens). Separating APIs by surface makes it easier for a developer to see what is available to them in each context, and gives us a flexible system for introducing components and APIs available in only some areas of Shopify.
-
-A checkout extension using “vanilla” JavaScript would be written as follows:
+A checkout extension using Preact would be written as follows:
 
 ```ts
-import {extension, TextField} from '@shopify/ui-extensions/checkout';
-
-export default extension(
-  'purchase.checkout.block.render',
-  (root, {i18n, metafields, applyMetafieldChange}) => {
-    const metafield = metafields.current.find(
-      (metafield) =>
-        metafield.namespace === 'custom' && metafield.key === 'gift_note',
-    );
-
-    const textfield = root.createComponent(TextField, {
-      label: i18n.translate('gift_note.label'),
-      value: metafield?.value ?? '',
-      onChange(value) {
-        textfield.updateProps({value});
-
-        applyMetafieldChange({
-          namespace: 'custom',
-          key: 'gift_note',
-          value,
-          valueType: 'string',
-        });
-      },
-    });
-
-    root.appendChild(textfield);
-  },
-);
+import '@shopify/ui-extensions/preact';
+import {render} from 'preact';
+
+export default function extension() {
+  render(<Extension />, document.body);
+}
+
+function Extension() {
+  return (
+    <s-text>Line item title: {shopify.target.value.merchandise.title}</s-text>
+  );
+}
 ```

package/build/ts/surfaces/admin/components/Avatar/Avatar.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Avatar.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Avatar/Avatar.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA8BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Avatar.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Avatar/Avatar.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAuLX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Badge/Badge.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Badge.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Badge/Badge.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA6BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Badge.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Badge/Badge.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA2FX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Chip/Chip.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Chip.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Chip/Chip.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA4BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Chip.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Chip/Chip.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAuGX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Heading/Heading.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Heading.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Heading/Heading.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAsDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Heading.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Heading/Heading.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAoHX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Icon/Icon.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Icon.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Icon/Icon.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAwBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Icon.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Icon/Icon.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA0IX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Image/Image.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Image.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Image/Image.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA6CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Image.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Image/Image.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAkJX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Paragraph/Paragraph.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Paragraph.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Paragraph/Paragraph.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAgDX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Paragraph.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Paragraph/Paragraph.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCAqJX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Text/Text.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Text.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Text/Text.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA+CX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Text.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Text/Text.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA8KX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Thumbnail/Thumbnail.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Thumbnail.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Thumbnail/Thumbnail.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA+BX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Thumbnail.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Thumbnail/Thumbnail.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAGpE,QAAA,MAAM,IAAI,EAAE,kCA6FX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/docs-types.d.ts

@@ -1,15 +1,31 @@
 import type { CSSProperties } from 'react';
-import { ReferenceEntityTemplateSchema, CodeTabType } from '@shopify/generate-docs';
+import { ReferenceEntityTemplateSchema, CodeTabType, ExampleType, ExampleSectionSchema, ExampleGroupType } from '@shopify/generate-docs';
 type AllowedCSSProperties = Pick<CSSProperties, 'minHeight' | 'minBlockSize'>;
-export interface AdminReferenceEntityTemplateSchema extends Omit<ReferenceEntityTemplateSchema, 'defaultExample'> {
-    defaultExample?: Omit<NonNullable<ReferenceEntityTemplateSchema['defaultExample']>, 'codeblock'> & {
-        codeblock?: {
-            title: string;
-            tabs: (CodeTabType & {
-                layout?: string;
-                customStyles?: AllowedCSSProperties;
-            })[];
-        };
+type AdminCodeTabType = CodeTabType & {
+    layout?: string;
+    customStyles?: AllowedCSSProperties;
+};
+interface CodeLinkType {
+    name: string;
+    url: string;
+    icon: string;
+}
+interface AdminCodeblockType {
+    title: string;
+    tabs: AdminCodeTabType[];
+    links?: CodeLinkType[];
+}
+type AdminExampleType = Omit<ExampleType, 'codeblock'> & {
+    codeblock: AdminCodeblockType | AdminCodeblockType[];
+};
+type AdminExampleGroupType = Omit<ExampleGroupType, 'examples'> & {
+    examples: AdminExampleType[];
+};
+export interface AdminReferenceEntityTemplateSchema extends Omit<ReferenceEntityTemplateSchema, 'defaultExample' | 'examples'> {
+    defaultExample?: AdminExampleType;
+    examples?: Omit<ExampleSectionSchema, 'exampleGroups' | 'examples'> & {
+        exampleGroups?: AdminExampleGroupType[] | null;
+        examples?: AdminExampleType[] | null;
     };
 }
 export {};

package/build/ts/surfaces/admin/docs-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"docs-types.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/admin/docs-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EACL,6BAA6B,EAC7B,WAAW,EACZ,MAAM,wBAAwB,CAAC;AAGhC,KAAK,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC;AAE9E,MAAM,WAAW,kCACf,SAAQ,IAAI,CAAC,6BAA6B,EAAE,gBAAgB,CAAC;IAC7D,cAAc,CAAC,EAAE,IAAI,CACnB,WAAW,CAAC,6BAA6B,CAAC,gBAAgB,CAAC,CAAC,EAC5D,WAAW,CACZ,GAAG;QACF,SAAS,CAAC,EAAE;YACV,KAAK,EAAE,MAAM,CAAC;YACd,IAAI,EAAE,CAAC,WAAW,GAAG;gBACnB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,YAAY,CAAC,EAAE,oBAAoB,CAAC;aACrC,CAAC,EAAE,CAAC;SACN,CAAC;KACH,CAAC;CACH"}
+{"version":3,"file":"docs-types.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/admin/docs-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EACL,6BAA6B,EAC7B,WAAW,EACX,WAAW,EACX,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,wBAAwB,CAAC;AAGhC,KAAK,oBAAoB,GAAG,IAAI,CAAC,aAAa,EAAE,WAAW,GAAG,cAAc,CAAC,CAAC;AAE9E,KAAK,gBAAgB,GAAG,WAAW,GAAG;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,kBAAkB;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,gBAAgB,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,KAAK,gBAAgB,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG;IACvD,SAAS,EAAE,kBAAkB,GAAG,kBAAkB,EAAE,CAAC;CACtD,CAAC;AAEF,KAAK,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,GAAG;IAChE,QAAQ,EAAE,gBAAgB,EAAE,CAAC;CAC9B,CAAC;AAEF,MAAM,WAAW,kCACf,SAAQ,IAAI,CAAC,6BAA6B,EAAE,gBAAgB,GAAG,UAAU,CAAC;IAC1E,cAAc,CAAC,EAAE,gBAAgB,CAAC;IAClC,QAAQ,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,eAAe,GAAG,UAAU,CAAC,GAAG;QACpE,aAAa,CAAC,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC;QAC/C,QAAQ,CAAC,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC;KACtC,CAAC;CACH"}

package/build/ts/surfaces/customer-account/api/standard-api/standard-api.d.ts

@@ -84,7 +84,7 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
      *
      * - Use noun + past tense verb format. For example, \`Changes saved\`.
      *
-     * For errors, or information that needs to persist on the page, use a [banner](/docs/api/checkout-ui-extensions/unstable/components/feedback/banner) component.
+     * For errors, or information that needs to persist on the page, use a [banner](/docs/api/checkout-ui-extensions/polaris-web-components/feedback/banner) component.
      */
     toast: ToastApi;
     /**

package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts

@@ -19,15 +19,6 @@ export interface NavigationHistoryEntry {
      */
     getState(): unknown;
 }
-/**
- * The NavigationCurrentEntryChangeEvent interface of the Navigation API is the event object for the currententrychange event, which fires when the Navigation.currentEntry has changed.
- */
-export interface NavigationCurrentEntryChangeEvent {
-    /**
-     * Returns the NavigationHistoryEntry that was navigated from.
-     */
-    from: NavigationHistoryEntry;
-}
 export interface Navigation {
     /**
      * The navigate() method navigates to a specific URL, updating any provided state in the history entries list.
@@ -41,7 +32,5 @@ export interface Navigation {
      * The back() method of the Navigation interface navigates to the previous entry in the history list.
      */
     back(): void;
-    addEventListener(type: 'currententrychange', cb: (event: NavigationCurrentEntryChangeEvent) => void): void;
-    removeEventListener(type: 'currententrychange', cb: (event: NavigationCurrentEntryChangeEvent) => void): void;
 }
 //# sourceMappingURL=navigation-api.d.ts.map

package/build/ts/surfaces/point-of-sale/api/navigation-api/navigation-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"navigation-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,4KAA4K;IAC5K,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,sBAAsB,CAAC;CAC9B;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E;;OAEG;IACH,YAAY,EAAE,sBAAsB,CAAC;IACrC;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IACb,gBAAgB,CACd,IAAI,EAAE,oBAAoB,EAC1B,EAAE,EAAE,CAAC,KAAK,EAAE,iCAAiC,KAAK,IAAI,GACrD,IAAI,CAAC;IACR,mBAAmB,CACjB,IAAI,EAAE,oBAAoB,EAC1B,EAAE,EAAE,CAAC,KAAK,EAAE,iCAAiC,KAAK,IAAI,GACrD,IAAI,CAAC;CACT"}
+{"version":3,"file":"navigation-api.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/api/navigation-api/navigation-api.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,4KAA4K;IAC5K,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E;;OAEG;IACH,YAAY,EAAE,sBAAsB,CAAC;IACrC;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;CACd"}

package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts

@@ -1,15 +1,22 @@
 import { PinPadOptions, PinValidationResult } from '../types/pin-pad';
 export interface PinPadApiContent {
-    /** Shows a pin pad to the user in a modal dialog.
+    /** Shows a PIN pad to the user in a modal dialog.
+     *
+     * `onSubmit` is called when the PIN is submitted for validation by the user. The callback
+     * should validate the PIN and accept or reject it.
+     *
+     * If the PIN is accepted, the modal will be dismissed and the `onDismissed` callback
+     * (provided via `options`) will be called. It is recommended that any post-validation
+     * navigation is performed in this callback rather than in `onSubmit`.
+     *
+     * If the PIN is rejected, the optional `errorMessage` will be displayed to the user and the modal
+     * will not be dismissed.
      *
-     * @param onSubmit the function to be called when the PIN is submitted.
-     * The callback should be used to validate the PIN and return `accept` or `reject`.
-     * @param options the options for the pin pad
      */
     showPinPad(onSubmit: (pin: number[]) => Promise<PinValidationResult> | PinValidationResult, options?: PinPadOptions): void;
 }
 /**
- * Access the Pin Pad API for pin pad functionality in a modal.
+ * Access the PIN Pad API for PIN pad functionality in a modal.
  */
 export interface PinPadApi {
     pinPad: PinPadApiContent;

package/build/ts/surfaces/point-of-sale/api/pin-pad-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pin-pad-api.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/api/pin-pad-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAC,MAAM,kBAAkB,CAAC;AAEpE,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,UAAU,CACR,QAAQ,EAAE,CACR,GAAG,EAAE,MAAM,EAAE,KACV,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,EACvD,OAAO,CAAC,EAAE,aAAa,GACtB,IAAI,CAAC;CACT;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}
+{"version":3,"file":"pin-pad-api.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/api/pin-pad-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,mBAAmB,EAAC,MAAM,kBAAkB,CAAC;AAEpE,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;OAYG;IACH,UAAU,CACR,QAAQ,EAAE,CACR,GAAG,EAAE,MAAM,EAAE,KACV,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,EACvD,OAAO,CAAC,EAAE,aAAa,GACtB,IAAI,CAAC;CACT;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,gBAAgB,CAAC;CAC1B"}

package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts

@@ -25,27 +25,34 @@ export interface PinPadActionType {
 }
 export interface PinPadOptions {
     /**
-     * The function to be called when a pin is entered
+     * The function to be called whenever the entered PIN is updated
      */
     onPinEntry?: (pin: number[]) => void;
     /**
-     * The function to be called when the pin pad modal is dismissed
+     * The function to be called when the PIN pad modal is dismissed
      */
     onDismissed?: (result: PinPadResult) => void;
     /**
-     * The content for the prompt on the pin pad
+     * The content for the prompt on the PIN pad. This will be overridden by any
+     * `errorMessage` provided when rejecting a PIN from the `onSubmit` callback.
      */
     label?: string;
     /**
      * Whether the entered PIN should be masked
+     *
+     * @default true
      */
     masked?: boolean;
     /**
      * The minimum length of the PIN
+     *
+     * @default 4
      */
     minPinLength?: PinLength;
     /**
      * The maximum length of the PIN
+     *
+     * @default 6
      */
     maxPinLength?: PinLength;
     /**
@@ -57,7 +64,9 @@ export interface PinPadOptions {
      */
     title?: string;
     /**
-     * Whether the pin should be automatically submitted when the user has entered the maximum PIN length
+     * Whether the PIN should be automatically submitted when the user has entered the maximum PIN length
+     *
+     * @default false
      */
     autoSubmit?: boolean;
 }

package/build/ts/surfaces/point-of-sale/types/pin-pad.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pin-pad.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/pin-pad.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAC,GAClB;IAAC,MAAM,EAAE,QAAQ,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE9C,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;AAEnD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;IAC7C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"pin-pad.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/point-of-sale/types/pin-pad.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAC,MAAM,EAAE,QAAQ,CAAA;CAAC,GAClB;IAAC,MAAM,EAAE,QAAQ,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAE9C,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;AAEnD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;IAC7C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;OAEG;IACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}