@shopify/ui-extensions 2025.10.0-rc.44 → 2025.10.0-rc.46

package/build/ts/docs/shared/components/ColorField.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ColorField.d.ts","sourceRoot":"","sources":["../../../../../src/docs/shared/components/ColorField.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,cAAc,CAAC;AAEtE,QAAA,MAAM,IAAI,EAAE,mCAMX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"ColorField.d.ts","sourceRoot":"","sources":["../../../../../src/docs/shared/components/ColorField.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,cAAc,CAAC;AAEtE,QAAA,MAAM,IAAI,EAAE,mCAOX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/intents/intents.d.ts

@@ -0,0 +1,132 @@
+/**
+ * User dismissed or closed the workflow without completing it.
+ */
+export interface ClosedIntentResponse {
+    code?: 'closed';
+}
+/**
+ * Successful intent completion.
+ */
+export interface SuccessIntentResponse {
+    code?: 'ok';
+    data?: {
+        [key: string]: unknown;
+    };
+}
+/**
+ * Failed intent completion.
+ */
+export interface ErrorIntentResponse {
+    code?: 'error';
+    message?: string;
+    issues?: {
+        /**
+         * The path to the field with the issue.
+         */
+        path?: string[];
+        /**
+         * The error message for the issue.
+         */
+        message?: string;
+        /**
+         * A code identifier for the issue.
+         */
+        code?: string;
+    }[];
+}
+/**
+ * Result of an intent activity.
+ * Discriminated union representing all possible completion outcomes.
+ */
+export type IntentResponse = SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse;
+/**
+ * Activity handle for tracking intent workflow progress.
+ */
+export interface IntentActivity {
+    /**
+     * A Promise that resolves when the intent workflow completes, returning the response.
+     */
+    complete?: Promise<IntentResponse>;
+}
+/**
+ * The action to perform on a resource.
+ */
+export type IntentAction = 'create' | 'edit';
+/**
+ * Supported resource types that can be targeted by intents.
+ */
+export type IntentType = 'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant';
+/**
+ * Options for invoking intents when using the query string format.
+ */
+export interface IntentQueryOptions {
+    /**
+     * The resource identifier for edit actions (e.g., 'gid://shopify/Product/123').
+     */
+    value?: string;
+    /**
+     * Additional data required for certain intent types.
+     * For example:
+     * - Discount creation requires { type: 'amount-off-product' | 'amount-off-order' | 'buy-x-get-y' | 'free-shipping' }
+     * - ProductVariant creation requires { productId: 'gid://shopify/Product/123' }
+     * - Metaobject creation requires { type: 'shopify--color-pattern' }
+     */
+    data?: {
+        [key: string]: unknown;
+    };
+}
+/**
+ * Structured description of an intent to invoke.
+ */
+export interface IntentQuery extends IntentQueryOptions {
+    /**
+     * The operation to perform on the target resource.
+     */
+    action: IntentAction;
+    /**
+     * The resource type (e.g., 'shopify/Product').
+     */
+    type: IntentType;
+}
+/**
+ * The invoke API for triggering intent workflows.
+ *
+ * @param intent - Either a string query or structured object describing the intent
+ * @param options - Optional parameters when using string query format
+ * @returns A Promise resolving to an activity handle for tracking the workflow
+ *
+ * @example
+ * ```javascript
+ * // Create a new product
+ * const activity = await intents.invoke('create:shopify/Product');
+ * const response = await activity.complete;
+ *
+ * // Edit an existing product
+ * const activity = await intents.invoke('edit:shopify/Product,gid://shopify/Product/123');
+ * const response = await activity.complete;
+ *
+ * // Create a discount with required type
+ * const activity = await intents.invoke('create:shopify/Discount', {
+ *   data: { type: 'amount-off-product' }
+ * });
+ * const response = await activity.complete;
+ * ```
+ */
+export interface IntentInvokeApi {
+    (query: IntentQuery): Promise<IntentActivity>;
+    (intentURL: string, options?: IntentQueryOptions): Promise<IntentActivity>;
+}
+/**
+ * Intent information provided to the receiver of an intent.
+ */
+export interface Intents {
+    /**
+     * The URL that was used to launch the intent.
+     */
+    launchUrl?: string | URL;
+    /**
+     * Invoke an intent workflow to create or edit Shopify resources.
+     */
+    invoke?: IntentInvokeApi;
+}
+//# sourceMappingURL=intents.d.ts.map

package/build/ts/surfaces/admin/api/intents/intents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,6BAA6B,GAC7B,oBAAoB,GACpB,8BAA8B,GAC9B,cAAc,GACd,iBAAiB,GACjB,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B"}

package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=intents.doc.d.ts.map

package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intents.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA2hBX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/standard/standard.d.ts

@@ -2,12 +2,8 @@ import type { I18n } from '../../../../api';
 import { ApiVersion } from '../../../../shared';
 import type { Storage } from './storage';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
-export interface Intents {
-    /**
-     * The URL that was used to launch the intent.
-     */
-    launchUrl?: string | URL;
-}
+import type { Intents } from '../intents/intents';
+export type { Intents } from '../intents/intents';
 /**
  * GraphQL error returned by the Shopify Admin API.
  */
@@ -64,5 +60,4 @@ export interface StandardApi<ExtensionTarget extends AnyExtensionTarget> {
         errors?: GraphQLError[];
     }>;
 }
-export {};
 //# sourceMappingURL=standard.d.ts.map

package/build/ts/surfaces/admin/api/standard/standard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/standard/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,UAAU,IAAI;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,eAAe,SAAS,kBAAkB;IACrE;;OAEG;IACH,SAAS,EAAE;QACT,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,GAAG,OAAO,EAAE,SAAS,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,EAC1D,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;KAAC,KACrE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAA;KAAC,CAAC,CAAC;CACtD"}
+{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/standard/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAEhD,YAAY,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,UAAU,IAAI;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,eAAe,SAAS,kBAAkB;IACrE;;OAEG;IACH,SAAS,EAAE;QACT,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,GAAG,OAAO,EAAE,SAAS,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,EAC1D,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;KAAC,KACrE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAA;KAAC,CAAC,CAAC;CACtD"}

package/build/ts/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChoiceList.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAwCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"ChoiceList.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/ChoiceList/ChoiceList.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsEX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/ChoiceList.d.ts

@@ -39,8 +39,10 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
 declare const tagName = 's-choice-list';
 export interface ChoiceListJSXProps
   extends Pick<ChoiceListProps, 'values' | 'multiple'> {
-  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the user changes a choice. Fires simultaneously with onChange. */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the user changes a choice. Fires simultaneously with onInput. */
+  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
   children?: ComponentChildren;
 }
 declare global {

package/build/ts/surfaces/point-of-sale/components/DateField/DateField.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateField/DateField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"DateField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateField/DateField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/DateField.d.ts

@@ -8,12 +8,7 @@
 /* eslint-disable import-x/namespace */
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  DateFieldProps,
-  Key,
-  Ref,
-  ComponentChild,
-} from './components-shared.d.ts';
+import type {DateFieldProps, Key, Ref} from './components-shared.d.ts';
 
 export type ComponentChildren = any;
 /**
@@ -47,11 +42,14 @@ export interface DateFieldJSXProps
     DateFieldProps,
     'label' | 'details' | 'value' | 'disabled' | 'error'
   > {
+  /** Function called when the user makes any changes in the field. */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called after editing completes (typically on blur). */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  accessory?: ComponentChild;
+  /** Function called when the element loses focus. */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element receives focus. */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 declare global {
   interface HTMLElementTagNameMap {

package/build/ts/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DatePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"DatePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DatePicker/DatePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgEX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/DatePicker.d.ts

@@ -39,10 +39,14 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
 declare const tagName = 's-date-picker';
 export interface DatePickerJSXProps
   extends Pick<DatePickerProps, 'id' | 'value'> {
+  /** Function called when the user selects a date from the picker. */
+  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the user selects a date from the picker that is different to the current value. */
+  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the date picker is dismissed. */
   onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the date picker is revealed. */
   onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
 }
 declare global {
   interface HTMLElementTagNameMap {

package/build/ts/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateSpinner.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"DateSpinner.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/DateSpinner/DateSpinner.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgEX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/DateSpinner.d.ts

@@ -39,10 +39,18 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
 declare const tagName = 's-date-spinner';
 export interface DateSpinnerJSXProps
   extends Pick<DateSpinnerProps, 'id' | 'value'> {
+  /**
+   * Function called when the user makes a selection.
+   */
+  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /**
+   * Function called when the value changes. Only called when a different value is selected.
+   */
+  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the date picker is dismissed. */
   onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the date picker is revealed. */
   onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
 }
 declare global {
   interface HTMLElementTagNameMap {

package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=Divider.doc.d.ts.map

package/build/ts/surfaces/point-of-sale/components/Divider/Divider.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Divider.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/Divider/Divider.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6BX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/EmailField/EmailField.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EmailField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/EmailField/EmailField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"EmailField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/EmailField/EmailField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuEX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/EmailField.d.ts

@@ -54,10 +54,17 @@ export interface EmailFieldJSXProps
     | 'maxLength'
     | 'details'
   > {
+  /** Function called when the user makes any changes in the field. */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called after editing completes (typically on blur). */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element loses focus. */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element receives focus. */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * Additional content to be displayed in the field. Commonly used to display clickable text.
+   */
   accessory?: ComponentChild;
 }
 declare global {

package/build/ts/surfaces/point-of-sale/components/NumberField/NumberField.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NumberField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/NumberField/NumberField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"NumberField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/NumberField/NumberField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAwEX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/NumberField.d.ts

@@ -42,7 +42,7 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
 }
 
 declare const tagName = 's-number-field';
-export interface PickedJSXProps
+export interface NumberFieldJSXProps
   extends Pick<
     NumberFieldProps,
     | 'label'
@@ -56,20 +56,12 @@ export interface PickedJSXProps
     | 'min'
     | 'controls'
   > {
-  inputMode?: Extract<NumberFieldProps['inputMode'], 'decimal' | 'numeric'>;
-  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  accessory?: ComponentChild;
-}
-export interface NumberFieldJSXProps extends PickedJSXProps {
   /**
    * Content to use as the field label.
    *
    * Label is not supported when using Stepper controls
    */
-  label?: PickedJSXProps['label'];
+  label?: NumberFieldProps['label'];
   /**
    * Additional text to provide context or guidance for the field.
    * This text is displayed along with the field and its label
@@ -79,7 +71,7 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
    *
    * Details are not supported when using Stepper controls
    */
-  details?: PickedJSXProps['details'];
+  details?: NumberFieldProps['details'];
   /**
    * Whether the field needs a value. This requirement adds semantic value
    * to the field, but it will not cause an error to appear automatically.
@@ -90,14 +82,14 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
    *
    * Required is not supported when using Stepper controls
    */
-  required?: PickedJSXProps['required'];
+  required?: NumberFieldProps['required'];
   /**
    * Indicate an error to the user. The field will be given a specific stylistic treatment
    * to communicate problems that have to be resolved immediately.
    *
    * Error is not supported when using Stepper controls
    */
-  error?: PickedJSXProps['error'];
+  error?: NumberFieldProps['error'];
   /**
    * Sets the virtual keyboard.
    *
@@ -106,20 +98,19 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
    * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode
    * @default 'decimal'
    */
-  inputMode?: PickedJSXProps['inputMode'];
+  inputMode?: NumberFieldProps['inputMode'];
   /**
    * A short hint that describes the expected value of the field.
    *
    * Placeholder text is not supported when using Stepper controls due to constrained space for the number field, especially on phones.
    */
-  placeholder?: PickedJSXProps['placeholder'];
+  placeholder?: NumberFieldProps['placeholder'];
   /**
-   * Additional content to be displayed in the field.
-   * Commonly used to display an icon that activates a tooltip providing more information.
+   *  Additional content to be displayed in the field. Commonly used to display clickable text.
    *
-   * Accessory is not supported when using Stepper controls
+   * > Note: Accessory is not supported when using Stepper controls
    */
-  accessory?: PickedJSXProps['accessory'];
+  accessory?: ComponentChild;
   /**
    * Sets the type of controls displayed for the field.
    *
@@ -130,7 +121,15 @@ export interface NumberFieldJSXProps extends PickedJSXProps {
    * - `none`: no controls are displayed and users must input the value manually.
    * - `auto`: the presence of the controls depends on the surface and context.
    */
-  controls?: PickedJSXProps['controls'];
+  controls?: NumberFieldProps['controls'];
+  /** Function called when the user makes any changes in the field. */
+  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called after editing completes (typically on blur). */
+  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element loses focus. */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element receives focus. */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 declare global {
   interface HTMLElementTagNameMap {

package/build/ts/surfaces/point-of-sale/components/SearchField/SearchField.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SearchField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/SearchField/SearchField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"SearchField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/SearchField/SearchField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/SearchField.d.ts

@@ -39,10 +39,14 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
 declare const tagName = 's-search-field';
 export interface SearchFieldJSXProps
   extends Pick<SearchFieldProps, 'disabled' | 'placeholder' | 'value'> {
-  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the user changes the value in the field. */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the field loses focus after the user changes the value in the field. */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the field loses focus. */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the field is focused. */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 declare global {
   interface HTMLElementTagNameMap {

package/build/ts/surfaces/point-of-sale/components/TextArea/TextArea.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"TextArea.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextArea/TextArea.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAmFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/TextArea.d.ts

@@ -55,10 +55,17 @@ export interface TextAreaJSXProps
     | 'maxLength'
     | 'rows'
   > {
+  /** Function called when the user makes any changes in the field. */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called after editing completes (typically on blur). */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element loses focus. */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element receives focus. */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * Additional content to be displayed in the field. Commonly used to display clickable text.
+   */
   accessory?: ComponentChild;
 }
 declare global {

package/build/ts/surfaces/point-of-sale/components/TextField/TextField.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"TextField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TextField/TextField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/TextField.d.ts

@@ -54,10 +54,25 @@ export interface TextFieldJSXProps
     | 'required'
     | 'maxLength'
   > {
+  /**
+   * Function called when the user makes any changes in the field.
+   */
   onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
-  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * Function called after editing completes (typically on blur).
+   */
   onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * Function called when the element loses focus.
+   */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * Function called when the element receives focus.
+   */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /**
+   * Additional content to be displayed in the field. Commonly used to display clickable text.
+   */
   accessory?: ComponentChild;
 }
 declare global {

package/build/ts/surfaces/point-of-sale/components/TimeField/TimeField.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TimeField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimeField/TimeField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"TimeField.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimeField/TimeField.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAoDX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/TimeField.d.ts

@@ -42,10 +42,14 @@ export interface TimeFieldJSXProps
     TimeFieldProps,
     'id' | 'label' | 'disabled' | 'value' | 'error' | 'details'
   > {
-  onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the user makes any changes in the field. */
+  onInput?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called after editing completes (typically on blur). */
+  onChange?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element loses focus. */
+  onBlur?: ((event: CallbackEvent<typeof tagName>) => void) | null;
+  /** Function called when the element receives focus. */
+  onFocus?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 declare global {
   interface HTMLElementTagNameMap {

package/build/ts/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TimePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAiCX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"TimePicker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/point-of-sale/components/TimePicker/TimePicker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA+DX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/point-of-sale/components/TimePicker.d.ts

@@ -39,10 +39,14 @@ export interface CallbackEvent<T extends keyof HTMLElementTagNameMap> {
 declare const tagName = 's-time-picker';
 export interface TimePickerJSXProps
   extends Pick<TimePickerProps, 'id' | 'value'> {
+  /** Function called when the user selects a time from the picker. */
+  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the user selects a time from the picker that is different to the current value. */
+  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the time picker is dismissed. */
   onBlur?: (event: CallbackEvent<typeof tagName>) => void | null;
+  /** Function called when the time picker is revealed. */
   onFocus?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onChange?: (event: CallbackEvent<typeof tagName>) => void | null;
-  onInput?: (event: CallbackEvent<typeof tagName>) => void | null;
 }
 declare global {
   interface HTMLElementTagNameMap {