@shopify/ui-extensions 2026.1.2 → 2026.1.3

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

@@ -1,42 +1,142 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  TableHeaderRowProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+import type {ComponentChildren, TableHeaderRowProps$1} from './shared.d.ts';
 
+/**
+ * The properties you can set on a table header row component.
+ */
 export interface TableHeaderRowProps extends TableHeaderRowProps$1 {}
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * A string that contains CSS styles to apply to the component.
+ */
+export type Styles = string;
+/**
+ * The implementation details for rendering a Preact custom element with a shadow root.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow root content.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the component.
+   */
+  styles?: Styles;
+};
+/**
+ * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the event.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the event.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right).
+   */
+  button: number;
+}
+/**
+ * The options for customizing how a synthetic click is performed.
+ */
+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);
 
-/** Used when an element does not have children. */
+  /** @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;
+}
+
+/**
+ * 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>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
   children?: preact.ComponentChildren;
 }
 
+/**
+ * A component that wraps the header row of a table, which contains the table header components that define the column structure.
+ */
 declare class TableHeaderRow
-  extends PolarisCustomElement
+  extends PreactCustomElement
   implements TableHeaderRowProps
 {
+  /**
+   * Creates a new TableHeaderRow instance.
+   */
   constructor();
   /** @private */
   connectedCallback(): void;
@@ -57,12 +157,18 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the table header row component.
+ */
 declare const tagName = 's-table-header-row';
+/**
+ * The JSX properties you can set on a table header row component.
+ */
 export interface TableHeaderRowJSXProps
   extends Partial<TableHeaderRowProps>,
     Pick<TableHeaderRowProps$1, 'id' | 'children'> {
   /**
-   * Contents of the table heading row; children should be `TableHeading` components.
+   * The content to display inside the table header row, which should include table header components.
    */
   children?: ComponentChildren;
 }

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

@@ -1,41 +1,144 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  TableRowProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+import type {ComponentChildren, TableRowProps$1} from './shared.d.ts';
 
+/**
+ * The properties you can set on a table row component.
+ */
 export interface TableRowProps
   extends Pick<TableRowProps$1, 'children' | 'clickDelegate'> {}
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
+/**
+ * A string that contains CSS styles to apply to the component.
+ */
+export type Styles = string;
+/**
+ * The implementation details for rendering a Preact custom element with a shadow root.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow root content.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The CSS styles to apply to the component.
+   */
+  styles?: Styles;
+};
+/**
+ * An object that resembles an activation event, containing information about which modifier keys were pressed and which mouse button was used.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the Shift key was pressed during the event.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the Meta key (Command on Mac, Windows key on Windows) was pressed during the event.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the Control key was pressed during the event.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed. A value of `0` means the primary button (usually left), `1` means the middle button, and `2` means the secondary button (usually right).
+   */
+  button: number;
 }
+/**
+ * The options for customizing how a synthetic click is performed.
+ */
+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);
 
-/** Used when an element does not have children. */
+  /** @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;
+}
+
+/**
+ * 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>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
   children?: preact.ComponentChildren;
 }
 
-declare class TableRow extends PolarisCustomElement implements TableRowProps {
+/**
+ * A component that represents a single row in a table, which contains the data cells.
+ */
+declare class TableRow extends PreactCustomElement implements TableRowProps {
+  /**
+   * Creates a new TableRow instance.
+   */
   constructor();
+  /**
+   * A CSS selector for a child element that should handle clicks on the entire row. When you set this property, clicking anywhere on the row will trigger a click on the element that matches the selector.
+   */
   accessor clickDelegate: string;
 }
 declare global {
@@ -52,12 +155,18 @@ declare module 'preact' {
   }
 }
 
+/**
+ * The custom element tag name for the table row component.
+ */
 declare const tagName = 's-table-row';
+/**
+ * The JSX properties you can set on a table row component.
+ */
 export interface TableRowJSXProps
   extends Partial<TableRowProps>,
     Pick<TableRowProps$1, 'id' | 'children'> {
   /**
-   * The content of a TableRow, which should be `TableCell` components.
+   * The content to display inside the row, which should include table cell components.
    */
   children?: ComponentChildren;
 }

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,kCAuOX,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,kCAkKX,CAAC;AAEF,eAAe,IAAI,CAAC"}

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

@@ -1,4 +1,4 @@
-/** VERSION: 1.38.0 **/
+/** VERSION: 1.25.0 **/
 /* eslint-disable import/extensions */
 
 /* eslint-disable @typescript-eslint/no-namespace */
@@ -6,13 +6,11 @@
 
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference, spaced-comment
 /// <reference lib="DOM" />
-import type {
-  ComponentChildren,
-  TextProps$1,
-  PreactCustomElement,
-  RenderImpl,
-} from './shared.d.ts';
+import type {ComponentChildren, TextProps$1} from './shared.d.ts';
 
+/**
+ * The properties for the text component. These properties define inline or small blocks of text content with various visual styles and semantic meanings.
+ */
 export interface TextProps
   extends Required<
     Pick<
@@ -26,65 +24,218 @@ export interface TextProps
       | 'interestFor'
     >
   > {
+  /**
+   * The color of the text. Available options:
+   * - `'base'` - The default text color.
+   * - `'subdued'` - A lighter text color for secondary information.
+   */
   color: Extract<TextProps$1['color'], 'base' | 'subdued'>;
+  /**
+   * The semantic type and styling treatment for the text content.
+   *
+   * Other presentation properties on Text override the default styling.
+   *
+   * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.
+   * - `generic`: Standard text with no special semantic meaning or styling.
+   * - `address`: Marks the text as contact information, such as a physical or email address.
+   * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.
+   *
+   * @default 'generic'
+   */
   type: Extract<
     TextProps$1['type'],
-    'address' | 'redundant' | 'strong' | 'generic'
+    'strong' | 'generic' | 'address' | 'redundant'
   >;
+  /**
+   * The semantic tone that's applied to the text, which changes its color to convey meaning.
+   *
+   * - `info`: Informational content or helpful tips (blue).
+   * - `success`: Positive outcomes or successful states (green).
+   * - `warning`: Important warnings about potential issues (orange).
+   * - `critical`: Urgent problems or destructive actions (red).
+   * - `auto`: Automatically determined based on context.
+   * - `neutral`: General information without specific intent (gray).
+   * - `caution`: Advisory notices that need attention (yellow).
+   *
+   * @default 'auto'
+   */
   tone: Extract<
     TextProps$1['tone'],
-    'auto' | 'neutral' | 'info' | 'success' | 'warning' | 'caution' | 'critical'
+    'info' | 'success' | 'warning' | 'critical' | 'auto' | 'neutral' | 'caution'
   >;
+  /**
+   * The numeric font variant for the text. Available options:
+   * - `'auto'` - The font variant is automatically determined.
+   * - `'normal'` - Standard numeric rendering.
+   * - `'tabular-nums'` - Monospaced numbers for better alignment in tables.
+   */
   fontVariantNumeric: Extract<
     TextProps$1['fontVariantNumeric'],
     'auto' | 'normal' | 'tabular-nums'
   >;
 }
 
-/** Used when an element does not have children. */
+/**
+ * A string containing CSS styles.
+ */
+export type Styles = string;
+/**
+ * The configuration for rendering a custom element with a shadow DOM.
+ */
+export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the component's shadow DOM content.
+   */
+  ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * Optional CSS styles to apply to the shadow DOM.
+   */
+  styles?: Styles;
+};
+/**
+ * An object that represents the state of modifier keys and mouse button
+ * during an activation event like a click.
+ */
+export interface ActivationEventEsque {
+  /**
+   * Whether the shift key was pressed during the event.
+   */
+  shiftKey: boolean;
+  /**
+   * Whether the meta (Command on Mac, Windows key on PC) key was pressed.
+   */
+  metaKey: boolean;
+  /**
+   * Whether the control key was pressed during the event.
+   */
+  ctrlKey: boolean;
+  /**
+   * The mouse button that was pressed (0 for left, 1 for middle, 2 for right).
+   */
+  button: number;
+}
+/**
+ * Options for customizing click behavior on an element.
+ */
+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;
+}
+
+/**
+ * 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>;
 }
-/** Used when an element has children. */
+/**
+ * The base properties for Preact elements that have children, extending the base element properties to include child content.
+ */
 export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
   extends PreactBaseElementProps<TClass> {
   children?: preact.ComponentChildren;
 }
 
-declare class PolarisCustomElement extends PreactCustomElement {
-  constructor(renderImpl: Omit<RenderImpl, 'globalShadowCSS'>);
-}
-
-declare abstract class TextBase
-  extends PolarisCustomElement
-  implements
-    Pick<
-      TextProps,
-      | 'fontVariantNumeric'
-      | 'color'
-      | 'type'
-      | 'dir'
-      | 'accessibilityVisibility'
-      | 'interestFor'
-    >
-{
+/**
+ * A custom element for displaying inline or small blocks of text with various visual styles and semantic meanings. Use Text to render short pieces of content with appropriate styling, emphasis, and color treatment.
+ */
+declare class Text extends PreactCustomElement implements TextProps {
+  /**
+   * The numeric font variant for the text.
+   */
   accessor fontVariantNumeric: TextProps['fontVariantNumeric'];
+  /**
+   * The color of the text.
+   */
   accessor color: TextProps['color'];
+  /**
+   * The semantic tone that's applied to the text, which changes its color to convey meaning.
+   *
+   * - `info`: Informational content or helpful tips (blue).
+   * - `success`: Positive outcomes or successful states (green).
+   * - `warning`: Important warnings about potential issues (orange).
+   * - `critical`: Urgent problems or destructive actions (red).
+   * - `auto`: Automatically determined based on context.
+   * - `neutral`: General information without specific intent (gray).
+   * - `caution`: Advisory notices that need attention (yellow).
+   */
+  accessor tone: TextProps['tone'];
+  /**
+   * The semantic type and styling treatment for the text content.
+   *
+   * - `strong`: Emphasizes the text with strong importance, typically displayed in bold.
+   * - `generic`: Standard text with no special semantic meaning or styling.
+   * - `address`: Marks the text as contact information, such as a physical or email address.
+   * - `redundant`: Indicates the text is redundant or duplicated information for screen reader context.
+   */
   accessor type: TextProps['type'];
+  /**
+   * The text direction (left-to-right or right-to-left).
+   */
   accessor dir: TextProps['dir'];
+  /**
+   * The visibility of the element to assistive technologies.
+   */
   accessor accessibilityVisibility: TextProps['accessibilityVisibility'];
+  /**
+   * The ID of an element this text provides contextual information for.
+   */
   accessor interestFor: string;
-  abstract tone: string;
-  constructor(renderImpl: RenderImpl);
-}
-
-declare class Text extends TextBase implements TextProps {
-  accessor tone: TextProps['tone'];
   constructor();
 }
 declare global {
@@ -101,11 +252,14 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-text';
+/**
+ * The JSX properties for the text component. These properties define how text is rendered in Preact or JSX.
+ */
 export interface TextJSXProps
   extends Partial<TextProps>,
     Pick<TextProps$1, 'id' | 'children'> {
   /**
-   * The content of the Text.
+   * The content of the text.
    */
   children?: ComponentChildren;
 }

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

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