@shopify/ui-extensions 2026.1.2 → 2026.1.3

package/build/ts/surfaces/admin/components/EmailField.d.ts

@@ -1,4 +1,4 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -9,59 +9,203 @@
 import type {
   TextFieldProps,
   EmailFieldProps$1,
-  PreactCustomElement,
-  RenderImpl,
+  ComponentChildren,
 } from './shared.d.ts';
 
+/**
+ * An event with a strongly-typed currentTarget property for a specific HTML element.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event listener is attached to.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * A callback function that receives a strongly-typed event for a specific HTML element.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
     })
   | null;
+/**
+ * The React-style event callback props for form field components.
+ */
 export interface FieldReactProps<T extends keyof HTMLElementTagNameMap> {
+  /**
+   * A callback that's invoked when the user makes any changes in the field. Learn more about the [input event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
+   */
   onInput?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the user has finished editing the field, such as when they blur the field. Learn more about the [change event](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/change_event).
+   */
   onChange?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the field receives focus. Learn more about the [focus event](https://developer.mozilla.org/en-US/docs/Web/API/Element/focus_event).
+   */
   onFocus?: ((event: CallbackEvent<T>) => void) | null;
+  /**
+   * A callback that's invoked when the field loses focus. Learn more about the [blur event](https://developer.mozilla.org/en-US/docs/Web/API/Element/blur_event).
+   */
   onBlur?: ((event: CallbackEvent<T>) => void) | null;
 }
-/** Used when an element does not have children. */
+/**
+ * The base properties for Preact elements that don't have children, providing essential attributes like keys and refs for component management.
+ */
 export interface PreactBaseElementProps<TClass extends HTMLElement> {
-  /** Assigns a unique key to this element. */
+  /**
+   * A unique identifier for this element within its parent. Preact uses keys to optimize rendering performance when lists change by tracking which items have been added, removed, or reordered.
+   */
   key?: preact.Key;
-  /** Assigns a ref (generally from `useRef()`) to this element. */
+  /**
+   * A reference to the underlying DOM element, typically created using `useRef()`. This allows you to access and manipulate the DOM element directly in your component logic.
+   */
   ref?: preact.Ref<TClass>;
-  /** Assigns this element to a parent's slot. */
+  /**
+   * Assigns this element to a named slot in a parent component that uses shadow DOM or slot-based composition patterns.
+   */
   slot?: Lowercase<string>;
 }
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * A string containing CSS styles for the component's shadow DOM.
+ */
+export type Styles = string;
+/**
+ * The configuration for rendering a Preact component in a shadow root.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's Preact elements into the shadow root.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the shadow root.
+   */
+  styles?: Styles;
+};
+/**
+ * The properties from an event that indicate how the user activated an element.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was held down when the event occurred.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on macOS) was held down when the event occurred.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the Control key was held down when the event occurred.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed when the event occurred. A value of 0 indicates the primary button (usually left), 1 indicates the middle button, and 2 indicates the secondary button (usually right).
+   */
+  button: number;
+}
+/**
+ * The options for influencing a programmatic click event.
+ */
+export interface ClickOptions {
+  /**
+   * The original user event (such as a click or keyboard event) that triggered this programmatic click. When provided, the component preserves important event properties like modifier keys (Ctrl, Shift, Alt, Meta) and mouse button states, enabling behaviors such as opening links in a new tab when middle-clicked or Ctrl+clicked.
+   */
+  sourceEvent?: ActivationEventEsque;
+}
+/**
+ * Base class for creating custom elements with Preact.
+ * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
+ * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
+ */
+declare const BaseClass: typeof globalThis.HTMLElement;
+declare abstract class PreactCustomElement extends BaseClass {
+  /** @private */
+  static get observedAttributes(): string[];
+  constructor({
+    styles,
+    ShadowRoot: renderFunction,
+    delegatesFocus,
+    ...options
+  }: RenderImpl);
+
+  /** @private */
+  setAttribute(name: string, value: string): void;
+  /** @private */
+  attributeChangedCallback(name: string): void;
+  /** @private */
+  connectedCallback(): void;
+  /** @private */
+  disconnectedCallback(): void;
+  /** @private */
+  adoptedCallback(): void;
+  /**
+   * Queue a run of the render function.
+   * You shouldn't need to call this manually - it should be handled by changes to @property values.
+   * @private
+   */
+  queueRender(): void;
+  /**
+   * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
+   *
+   * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
+   * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
+   * @private
+   * @param options
+   */
+  click({sourceEvent}?: ClickOptions): void;
 }
 
 declare const internals: unique symbol;
+/**
+ * The base properties for an input element that participates in form submission.
+ */
 export type PreactInputProps = Required<
   Pick<TextFieldProps, 'disabled' | 'id' | 'name' | 'value'>
 >;
+/** @private */
 declare class PreactInputElement
-  extends PolarisCustomElement
+  extends PreactCustomElement
   implements PreactInputProps
 {
   static formAssociated: boolean;
   /** @private */
   [internals]: ElementInternals;
+  /**
+   * A callback that's invoked when the user has finished editing the field, such as when they blur the field.
+   */
   accessor onchange: CallbackEventListener<'input'>;
+  /**
+   * A callback that's invoked when the user makes any changes in the field.
+   */
   accessor oninput: CallbackEventListener<'input'>;
+  /**
+   * Whether the field is disabled, disallowing any interaction.
+   *
+   * @default false
+   */
   accessor disabled: PreactInputProps['disabled'];
+  /**
+   * An identifier for the field.
+   */
   accessor id: PreactInputProps['id'];
+  /**
+   * An identifier for the field that's unique within the nearest containing form.
+   */
   accessor name: PreactInputProps['name'];
+  /**
+   * The current value for the field.
+   */
   get value(): PreactInputProps['value'];
   set value(value: PreactInputProps['value']);
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The base properties for form field elements that support labels, validation, and autocomplete.
+ */
 export type PreactFieldProps<Autocomplete extends string = string> =
   PreactInputProps &
     Required<
@@ -81,10 +225,10 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        * A hint as to the intended content of the field.
        *
        * When set to `on` (the default), this property indicates that the field should support
-       * autofill, but you do not have any more semantic information on the intended
+       * autofill, but you don't have any more semantic information on the intended
        * contents.
        *
-       * When set to `off`, you are indicating that this field contains sensitive
+       * When set to `off`, you're indicating that this field contains sensitive
        * information, or contents that are never saved, like one-time codes.
        *
        * Alternatively, you can provide value which describes the
@@ -99,20 +243,58 @@ export type PreactFieldProps<Autocomplete extends string = string> =
        */
       autocomplete: Autocomplete;
     };
+/** @private */
 declare class PreactFieldElement<Autocomplete extends string = string>
   extends PreactInputElement
   implements PreactFieldProps<Autocomplete>
 {
+  /**
+   * A callback that's invoked when the field loses focus.
+   */
   accessor onblur: CallbackEventListener<'input'>;
+  /**
+   * A callback that's invoked when the field receives focus.
+   */
   accessor onfocus: CallbackEventListener<'input'>;
+  /**
+   * A hint as to the intended content of the field for autocomplete purposes.
+   */
   accessor autocomplete: PreactFieldProps<Autocomplete>['autocomplete'];
+  /**
+   * The initial value for the field when it's first rendered.
+   */
   accessor defaultValue: PreactFieldProps['defaultValue'];
+  /**
+   * Additional descriptive text to display below the field that provides supplementary information.
+   */
   accessor details: PreactFieldProps['details'];
+  /**
+   * An error message to display below the field, indicating validation failure or other issues.
+   */
   accessor error: PreactFieldProps['error'];
+  /**
+   * The text label to display for the field, describing what the user should enter.
+   */
   accessor label: PreactFieldProps['label'];
+  /**
+   * Controls the visibility of the label for accessibility purposes.
+   */
   accessor labelAccessibilityVisibility: PreactFieldProps['labelAccessibilityVisibility'];
+  /**
+   * The placeholder text that's displayed inside the field when it's empty, providing a hint about expected input.
+   */
   accessor placeholder: PreactFieldProps['placeholder'];
+  /**
+   * Whether the field is read-only, preventing edits while still allowing focus and selection.
+   *
+   * @default false
+   */
   accessor readOnly: PreactFieldProps['readOnly'];
+  /**
+   * Whether the field must be filled out before form submission.
+   *
+   * @default false
+   */
   accessor required: PreactFieldProps['required'];
   /**
    * Global keyboard event handlers for things like key bindings typically
@@ -141,18 +323,40 @@ declare class PreactFieldElement<Autocomplete extends string = string>
   constructor(renderImpl: RenderImpl);
 }
 
+/**
+ * The properties for the email field component. These properties configure a specialized text input field for entering email addresses with built-in validation and appropriate keyboard support.
+ */
 export type EmailFieldProps = PreactFieldProps<
   Required<EmailFieldProps$1>['autocomplete']
 > &
   Required<Pick<EmailFieldProps$1, 'maxLength' | 'minLength'>>;
 
+/**
+ * The email field custom element class that renders an email input field in the Shopify admin interface. This component allows merchants to enter email addresses with automatic validation and optimized mobile keyboard layouts.
+ */
 declare class EmailField
   extends PreactFieldElement<EmailFieldProps['autocomplete']>
   implements EmailFieldProps
 {
+  /**
+   * A hint as to the intended content of the field for autocomplete purposes.
+   *
+   * @default 'email'
+   */
   accessor autocomplete: EmailFieldProps['autocomplete'];
+  /**
+   * The maximum number of characters the user can enter in the field.
+   */
   accessor maxLength: EmailFieldProps['maxLength'];
+  /**
+   * The minimum number of characters required in the field for validation.
+   */
   accessor minLength: EmailFieldProps['minLength'];
+  /**
+   * The current email address value in the field. When setting this property programmatically, it updates the field's display value. When reading it, you get the user's current input. The field validates this value as an email address format when the user finishes editing.
+   */
+  get value(): string;
+  set value(value: string);
   constructor();
 }
 declare global {
@@ -169,6 +373,9 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-email-field';
+/**
+ * The JSX props for the email field component. These properties extend `EmailFieldProps` with JSX-specific event callbacks for React-style event handling.
+ */
 export interface EmailFieldJSXProps
   extends Partial<Omit<EmailFieldProps, 'accessory'>>,
     Pick<EmailFieldProps$1, 'id'>,

package/build/ts/surfaces/admin/components/Form/Form.ext.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Form.ext.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Form/Form.ext.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAGrE,QAAA,MAAM,IAAI,EAAE,6BAwBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Form.ext.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/Form/Form.ext.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAGrE,QAAA,MAAM,IAAI,EAAE,6BAgHX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/components/Form.d.ts

@@ -1,4 +1,4 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -8,22 +8,39 @@
 import type {
   ExtendableEvent,
   FormProps$1,
-  PreactCustomElement,
-  RenderImpl,
+  ComponentChildren,
 } from './shared.d.ts';
 
+/**
+ * A callback event with a strongly-typed `currentTarget` property that corresponds to a specific HTML element. This provides better type safety when handling events from custom elements.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that the event listener is attached to, strongly typed based on the element's tag name.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+
+/**
+ * An event listener function type for callback events with a strongly-typed `currentTarget`. This ensures the event handler receives the correct element type.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (event: CallbackEvent<T>): void;
     })
   | null;
+
+/**
+ * A callback event that includes the `waitUntil` method for extending asynchronous operations. This allows you to delay form submission until promises resolve, enabling async validation or data processing before the form completes its action.
+ */
 export interface CallbackExtendableEvent<
   TTagName extends keyof HTMLElementTagNameMap,
 > extends CallbackEvent<TTagName>,
     Pick<ExtendableEvent, 'waitUntil'> {}
+
+/**
+ * An event listener function type for extendable callback events. This combines strong typing with the ability to extend the event lifecycle using `waitUntil`.
+ */
 export type CallbackExtendableEventListener<
   TTagName extends keyof HTMLElementTagNameMap,
 > =
@@ -32,32 +49,130 @@ export type CallbackExtendableEventListener<
     })
   | null;
 
+/**
+ * The properties for the form component. These properties configure the form's identifier for targeting and referencing within the admin extension.
+ */
 export interface FormProps extends Pick<FormProps$1, 'id'> {}
 
 declare const tagName = 's-form';
+
+/**
+ * The JSX props for the form component. These properties extend `FormProps` with event callbacks for form submission and reset actions in JSX rendering.
+ */
 export interface FormJSXProps extends Partial<FormProps> {
   /**
-   * A callback that is run when the form is submitted.
+   * A callback that's invoked when the form is submitted. Use the event's `waitUntil` method to perform async operations like validation or data processing before the submission completes.
    */
   onSubmit?: ((event: CallbackExtendableEvent<typeof tagName>) => void) | null;
   /**
-   * A callback that is run when the form is reset.
+   * A callback that's invoked when the form is reset, restoring all form fields to their initial values.
    */
   onReset?: ((event: CallbackEvent<typeof tagName>) => void) | null;
 }
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * The CSS styles as a string, used for styling web components within their shadow DOM.
+ */
+export type Styles = string;
+/**
+ * The implementation configuration for rendering a Preact component into a shadow root. Defines the render function that returns JSX elements and optional CSS styles to apply to the component's shadow DOM.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The render function that returns Preact/JSX elements to display in the component's shadow root.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The optional CSS styles to inject into the component's shadow DOM.
+   */
+  styles?: Styles;
+};
+/**
+ * The properties of an activation event (such as a click or keyboard press) that describe which modifier keys and mouse buttons were involved. This is used to determine intended behavior like opening links in new tabs when Command/Control is pressed.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the activation event.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the activation event.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the activation event.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed during the activation event. `0` for primary button (left click), `1` for auxiliary button (middle click), `2` for secondary button (right click).
+   */
+  button: number;
+}
+/**
+ * The options for controlling how a synthetic click behaves. Allows passing modifier key states and button information from an original event to influence link behavior such as opening in new tabs or background tabs.
+ */
+export interface ClickOptions {
+  /**
+   * The activation event (such as a click or keyboard event) whose modifier key state and button information should influence the synthetic click behavior. For example, passing an event with `metaKey: true` will cause links to open in a new tab.
+   */
+  sourceEvent?: ActivationEventEsque;
+}
+/**
+ * Base class for creating custom elements with Preact.
+ * While this class could be used in both Node and the browser, the constructor will only be used in the browser.
+ * So we give it a type of HTMLElement to avoid typing issues later where it's used, which will only happen in the browser.
+ */
+declare const BaseClass: typeof globalThis.HTMLElement;
+declare abstract class PreactCustomElement extends BaseClass {
+  /** @private */
+  static get observedAttributes(): string[];
+  constructor({
+    styles,
+    ShadowRoot: renderFunction,
+    delegatesFocus,
+    ...options
+  }: RenderImpl);
+
+  /** @private */
+  setAttribute(name: string, value: string): void;
+  /** @private */
+  attributeChangedCallback(name: string): void;
+  /** @private */
+  connectedCallback(): void;
+  /** @private */
+  disconnectedCallback(): void;
+  /** @private */
+  adoptedCallback(): void;
+  /**
+   * Queue a run of the render function.
+   * You shouldn't need to call this manually - it should be handled by changes to @property values.
+   * @private
+   */
+  queueRender(): void;
+  /**
+   * Like the standard `element.click()`, but you can influence the behavior with a `sourceEvent`.
+   *
+   * For example, if the `sourceEvent` was a middle click, or has particular keys held down,
+   * components will attempt to produce the desired behavior on links, such as opening the page in the background tab.
+   * @private
+   * @param options
+   */
+  click({sourceEvent}?: ClickOptions): void;
 }
 
-declare class Form extends PolarisCustomElement implements FormProps {
+/**
+ * The form custom element class that renders a form container in the Shopify admin interface. This component manages form submission, validation, and reset behavior for collecting merchant input.
+ */
+declare class Form extends PreactCustomElement implements FormProps {
   constructor();
+
   /**
-   * A callback that is run when the form is submitted.
+   * A callback that's invoked when the form is submitted. Use the event's `waitUntil` method to perform async operations like validation, data processing, or API calls before the submission completes.
    */
   accessor onsubmit: CallbackExtendableEventListener<typeof tagName> | null;
+
   /**
-   * A callback that is run when the form is reset.
+   * A callback that's invoked when the form is reset, restoring all form fields to their initial values.
    */
   accessor onreset: CallbackEventListener<typeof tagName> | null;
 }

package/build/ts/surfaces/admin/components/FormExtensionComponents.d.ts

@@ -1,6 +1,6 @@
 import { StandardComponents } from './StandardComponents';
 /**
- * The components available for building form-based extensions. Includes all standard components plus the `Form` component for creating structured data collection interfaces with submission handling and validation.
+ * The components available for building form-based extensions. Includes all standard components plus the form component for creating structured data collection interfaces with submission handling and validation.
  */
 export type FormExtensionComponents = StandardComponents | 'Form';
 export default FormExtensionComponents;

package/build/ts/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FunctionSettings.ext.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAGrE,QAAA,MAAM,IAAI,EAAE,6BAyBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"FunctionSettings.ext.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/components/FunctionSettings/FunctionSettings.ext.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAGrE,QAAA,MAAM,IAAI,EAAE,6BA2GX,CAAC;AAEF,eAAe,IAAI,CAAC"}