@shopify/ui-extensions 2025.10.13 → 2025.10.15

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

@@ -1,69 +1,63 @@
 export interface Storage<BaseStorageTypes extends Record<string, any> = Record<string, unknown>> {
     /**
-     * Sets the value of a key in the storage.
+     * Sets the value of a key in the storage. Use this to save individual data items like user preferences, form state, or cached values. The value is serialized using `JSON.stringify`, so it can be any primitive type, object, or array that JSON supports.
      *
-     * @param key - The key to set the value for.
-     * @param value - The value to set for the key.
-     * Can be any primitive type supported by `JSON.stringify`.
+     * @param key - The key to set the value for. Use descriptive keys to organize your stored data.
+     * @param value - The value to set for the key. Can be any primitive type supported by `JSON.stringify`.
      *
-     * Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.
+     * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.
      */
     set<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(key: Keys, value: StorageTypes[Keys]): Promise<void>;
     /**
-     * Sets multiple key-value pairs in the storage at once.
+     * Sets multiple key-value pairs in the storage at once. Use this for efficient batch operations when you need to save multiple related values together, such as form data or configuration settings.
      *
-     * If the operation fails, no changes are made to storage.
+     * @param entries - An object containing key-value pairs to store. Values can be any primitive type supported by `JSON.stringify`.
      *
-     * @param entries - An object containing key-value pairs to store.
-     * Values can be any primitive type supported by `JSON.stringify`.
-     *
-     * Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.
+     * @throws {StorageExceededError} Rejects with a `StorageExceededError` if the extension exceeds its allotted storage limit.
      */
     setMany<StorageTypes extends BaseStorageTypes = BaseStorageTypes>(entries: Partial<StorageTypes>): Promise<void>;
     /**
-     * Gets the value of a key in the storage.
+     * Gets the value of a key in the storage. Use this to retrieve previously saved data when your extension loads or when you need to access stored values. The value is automatically deserialized from JSON to its original type.
      *
      * @param key - The key to get the value for.
-     * @returns The value of the key.
-     *
-     * If no value for the key exists, the resolved value is undefined.
+     * @returns The value of the key, or `undefined` if no value exists for the key.
      */
     get<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(key: Keys): Promise<StorageTypes[Keys] | undefined>;
     /**
-     * Gets the values of multiple keys in the storage at once.
+     * Gets the values of multiple keys in the storage at once. Use this to efficiently retrieve related data in a single operation, reducing overhead when loading multiple stored values. The returned array is in the same order as the provided keys, with `undefined` values for keys that don't exist in storage.
      *
      * @param keys - An array of keys to get the values for.
-     * @returns An object containing key-value pairs for the requested keys.
-     *
-     * The returned array is in the same order as `keys`, with `undefined` values for keys that do not exist.
+     * @returns An array containing values for the requested keys, in the same order as the input keys.
      */
     getMany<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(keys: Keys[]): Promise<(StorageTypes[Keys] | undefined)[]>;
     /**
-     * Clears the storage.
+     * Clears all data from the storage. Use this to reset your extension's storage, such as when implementing a logout flow, clearing cached data, or resetting to defaults. This operation removes all stored key-value pairs.
      */
     clear(): Promise<void>;
     /**
-     * Deletes a key from the storage.
+     * Deletes a specific key from the storage. Use this to remove individual data items that are no longer needed, freeing up storage space and maintaining data hygiene.
      *
      * @param key - The key to delete.
-     * @returns A promise that resolves to `true` if the key was deleted, or `false` if the key did not exist.
+     * @returns A promise that resolves to `true` if the key existed and was deleted, or `false` if the key did not exist.
      */
     delete<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(key: Keys): Promise<boolean>;
     /**
-     * Deletes multiple keys from the storage at once.
+     * Deletes multiple keys from the storage at once. Use this to efficiently remove several related data items in a single operation, such as clearing expired cache entries or removing a group of related settings.
      *
      * @param keys - An array of keys to delete.
-     * @returns A promise that resolves to an object with `keys` keys, and boolean values,
-     * which are `true` if the key was deleted, or `false` if the key did not exist.
+     * @returns A promise that resolves to an object mapping each key to a boolean value: `true` if the key existed and was deleted, or `false` if the key did not exist.
      */
     deleteMany<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(keys: Keys[]): Promise<Record<Keys, boolean>>;
     /**
-     * Gets all the keys and values in the storage.
+     * Gets all the keys and values in the storage. Use this to iterate over all stored data, useful for debugging, data migration, or displaying all stored settings. The returned iterator provides entries as `[key, value]` tuples.
      *
-     * @returns An iterator containing all the keys and values in the storage.
+     * @returns A promise that resolves to an iterator containing all key-value pairs in the storage.
      */
     entries<StorageTypes extends BaseStorageTypes = BaseStorageTypes, Keys extends keyof StorageTypes = keyof StorageTypes>(): Promise<IterableIterator<[Keys, StorageTypes[Keys]]>>;
 }
+/**
+ * Error thrown when storage operations exceed the available storage quota. This can occur during `set()` or `setMany()` operations when the total stored data size exceeds the limit allocated to your extension.
+ */
 export interface StorageExceededError extends Error {
     name: 'StorageExceededError';
 }

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

@@ -1 +1 @@
-{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/standard/storage.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO,CACtB,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEtE;;;;;;;;OAQG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,GACxB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;;;OASG;IACH,OAAO,CAAC,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EAC9D,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;OAOG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;IAE3C;;;;;;;OAOG;IACH,OAAO,CACL,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,IAAI,EAAE,IAAI,EAAE,GACX,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IAE/C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,MAAM,CACJ,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;;;;;OAMG;IACH,UAAU,CACR,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,IAAI,EAAE,IAAI,EAAE,GACX,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAElC;;;;OAIG;IACH,OAAO,CACL,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,KACjD,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,oBAAqB,SAAQ,KAAK;IACjD,IAAI,EAAE,sBAAsB,CAAC;CAC9B"}
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/standard/storage.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,OAAO,CACtB,gBAAgB,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAEtE;;;;;;;OAOG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,EACT,KAAK,EAAE,YAAY,CAAC,IAAI,CAAC,GACxB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,OAAO,CAAC,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EAC9D,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,GAAG,CACD,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC;IAE3C;;;;;OAKG;IACH,OAAO,CACL,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,IAAI,EAAE,IAAI,EAAE,GACX,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IAE/C;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;;OAKG;IACH,MAAM,CACJ,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,GAAG,EAAE,IAAI,GACR,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,CACR,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,EAEpD,IAAI,EAAE,IAAI,EAAE,GACX,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IAElC;;;;OAIG;IACH,OAAO,CACL,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,IAAI,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,KACjD,OAAO,CAAC,gBAAgB,CAAC,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,KAAK;IACjD,IAAI,EAAE,sBAAsB,CAAC;CAC9B"}

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

@@ -1,4 +1,7 @@
 import { StandardComponents } from './StandardComponents';
+/**
+ * The components available for building action extensions. Includes all standard components plus the admin action component required for action extension setup.
+ */
 export type ActionExtensionComponents = StandardComponents | 'AdminAction';
 export default ActionExtensionComponents;
 //# sourceMappingURL=ActionExtensionComponents.d.ts.map

package/build/ts/surfaces/admin/components/ActionExtensionComponents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActionExtensionComponents.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/admin/components/ActionExtensionComponents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAExD,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,GAAG,aAAa,CAAC;AAE3E,eAAe,yBAAyB,CAAC"}
+{"version":3,"file":"ActionExtensionComponents.d.ts","sourceRoot":"","sources":["../../../../../src/surfaces/admin/components/ActionExtensionComponents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAC,MAAM,sBAAsB,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,kBAAkB,GAAG,aAAa,CAAC;AAE3E,eAAe,yBAAyB,CAAC"}

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

@@ -7,37 +7,76 @@
 /// <reference lib="DOM" />
 import type {ComponentChildren, AdminActionProps$1} from './shared.d.ts';
 
+/**
+ * The properties for the admin action component. These properties configure the heading and loading state of the admin action extension interface.
+ *
+ * @publicDocs
+ */
 export interface AdminActionProps
   extends Pick<AdminActionProps$1, 'heading' | 'loading'> {}
 
 declare const tagName = 's-admin-action';
+
+/**
+ * The JSX props for the admin action component. These properties extend `AdminActionProps` with slots for primary and secondary action buttons that merchants can interact with.
+ */
 export interface AdminActionJSXProps
   extends Partial<AdminActionProps>,
     Pick<AdminActionProps$1, 'id'> {
   /**
-   * The primary action to display in the admin action.
+   * The primary action button or link to display in the admin action area. This is the main call-to-action that appears prominently in the interface. Typically uses a button component with `variant="primary"` to complete or advance the workflow.
    */
   primaryAction: ComponentChildren;
   /**
-   * The secondary actions to display in the admin action.
+   * The secondary action buttons or links to display in the admin action area. These are supporting actions like cancel, back, or alternative operations. Typically uses button components with `variant="secondary"` or `variant="tertiary"`.
    */
   secondaryActions: ComponentChildren;
 }
 
+/**
+ * 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 event you want to influence the synthetic click.
+   * 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;
 }
@@ -84,12 +123,25 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The admin action custom element class that renders action controls in the Shopify admin interface. This component creates a standardized action area with a heading and slots for primary and secondary action buttons, used exclusively in admin action extensions.
+ */
 declare class AdminAction
   extends PreactCustomElement
   implements AdminActionProps
 {
+  /**
+   * The heading text to display at the top of the action area. This title describes the action or task the merchant is performing. If not provided, the extension name is used as the heading.
+   */
   heading: string;
+
+  /**
+   * Whether the action extension is currently in a loading state, such as during initial data fetching or when opening the action. When `true`, the action area might display loading indicators and prevent user interaction until loading completes.
+   *
+   * @default false
+   */
   loading: boolean;
+
   constructor();
 }
 declare global {

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

@@ -7,28 +7,67 @@
 /// <reference lib="DOM" />
 import type {AdminBlockProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties for the admin block component. These properties configure the heading and collapsed summary of collapsible content blocks in the admin interface.
+ *
+ * @publicDocs
+ */
 export interface AdminBlockProps
   extends Pick<AdminBlockProps$1, 'heading' | 'collapsedSummary'> {}
 
 declare const tagName = 's-admin-block';
+
+/**
+ * The JSX props for the admin block component. These properties extend `AdminBlockProps` with an optional `id` for element identification in JSX rendering.
+ */
 export interface AdminBlockJSXProps
   extends Partial<AdminBlockProps>,
     Pick<AdminBlockProps$1, 'id'> {}
 
+/**
+ * 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 event you want to influence the synthetic click.
+   * 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;
 }
@@ -75,12 +114,23 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The admin block custom element class that renders a collapsible content block in the Shopify admin interface. This component organizes content into expandable sections with headings and provides a summary when collapsed.
+ */
 declare class AdminBlock
   extends PreactCustomElement
   implements AdminBlockProps
 {
+  /**
+   * The heading text to display at the top of the block. This title describes the content section the merchant is viewing. If not provided, no heading is displayed.
+   */
   heading: string;
+
+  /**
+   * The summary text to display when the block is collapsed. This provides merchants with a preview of the block's contents without expanding it. If not provided, no summary is displayed.
+   */
   collapsedSummary: string;
+
   constructor();
 }
 declare global {

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

@@ -7,28 +7,67 @@
 /// <reference lib="DOM" />
 import type {AdminPrintActionProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties for the admin print action component. These properties configure the source URL for printing content within admin extensions.
+ *
+ * @publicDocs
+ */
 export interface AdminPrintActionProps
   extends Pick<AdminPrintActionProps$1, 'src'> {}
 
 declare const tagName = 's-admin-print-action';
+
+/**
+ * The JSX props for the admin print action component. These properties extend `AdminPrintActionProps` with an optional `id` for element identification in JSX rendering.
+ */
 export interface AdminPrintActionJSXProps
   extends Partial<AdminPrintActionProps>,
     Pick<AdminPrintActionProps$1, 'id'> {}
 
+/**
+ * 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 event you want to influence the synthetic click.
+   * 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;
 }
@@ -75,11 +114,18 @@ declare abstract class PreactCustomElement extends BaseClass {
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * The admin print action custom element class that renders a print interface in the Shopify admin. This component enables merchants to print content from a specified source URL using the browser's print functionality.
+ */
 declare class AdminPrintAction
   extends PreactCustomElement
   implements AdminPrintActionProps
 {
+  /**
+   * The source URL of the content to print. This should point to the document or page that'll be sent to the printer when the merchant initiates the print action.
+   */
   src: string;
+
   constructor();
 }
 declare global {

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

@@ -8,37 +8,90 @@
 /// <reference lib="DOM" />
 import type {AvatarProps$1, ComponentChildren} from './shared.d.ts';
 
+/**
+ * The properties for the avatar component. An avatar displays a user or entity image with fallback initials when the image isn't available. Properties include `src` for the image URL, `initials` for the fallback text, `alt` for accessibility text, and `size` for controlling the avatar dimensions.
+ */
 export interface AvatarProps
   extends Required<Pick<AvatarProps$1, 'initials' | 'src' | 'alt' | 'size'>> {
+  /**
+   * The initials to display when no image is provided or if the image fails to load. This typically includes the first letter of a user's first and last name (for example, `'JD'` for John Doe).
+   */
+  initials: AvatarProps$1['initials'];
+  /**
+   * The URL of the avatar image to display. You can provide an absolute or relative URL pointing to the image file.
+   */
+  src: AvatarProps$1['src'];
+  /**
+   * Alternative text that describes the avatar for screen readers. This text should identify who or what the avatar represents.
+   */
+  alt: AvatarProps$1['alt'];
+  /**
+   * The size of the avatar. Choose from `'small-200'`, `'small'`, `'base'`, `'large'`, or `'large-200'` to control the avatar dimensions.
+   *
+   * @default 'base'
+   */
   size: Extract<
     AvatarProps$1['size'],
     'small-200' | 'small' | 'base' | 'large' | 'large-200'
   >;
 }
 
+/**
+ * A string containing CSS styles for a custom element.
+ */
 export type Styles = string;
+/**
+ * The configuration for rendering a custom element with Preact.
+ */
 export type RenderImpl = Omit<ShadowRootInit, 'mode'> & {
+  /**
+   * The function that renders the shadow root content.
+   */
   ShadowRoot: (element: any) => ComponentChildren;
+  /**
+   * The optional CSS styles to apply to the shadow root.
+   */
   styles?: Styles;
 };
+/**
+ * The properties of an activation event, such as a click or keypress. These properties capture which modifier keys were pressed and which mouse button was used during the event.
+ */
 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 (0 for left, 1 for middle, 2 for right).
+   */
   button: number;
 }
+/**
+ * The options for triggering a synthetic click event.
+ */
 export interface ClickOptions {
   /**
-   * The event you want to influence the synthetic click.
+   * 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.
+ * The 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.
+ * 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;
+/**
+ * An abstract base class for creating custom elements that render with Preact.
+ */
 declare abstract class PreactCustomElement extends BaseClass {
   /** @private */
   static get observedAttributes(): string[];
@@ -60,8 +113,8 @@ declare abstract class PreactCustomElement extends BaseClass {
   /** @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.
+   * Queues 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;
@@ -69,37 +122,75 @@ declare abstract class PreactCustomElement extends BaseClass {
    * 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.
+   * components will attempt to produce the desired behavior on links, such as opening the page in a background tab.
    * @private
    * @param options
    */
   click({sourceEvent}?: ClickOptions): void;
 }
 
+/**
+ * A callback event that's typed to a specific HTML element.
+ */
 export type CallbackEvent<T extends keyof HTMLElementTagNameMap> = Event & {
+  /**
+   * The element that currently has the event listener attached.
+   */
   currentTarget: HTMLElementTagNameMap[T];
 };
+/**
+ * An event listener for callback events, typed to a specific HTML element.
+ */
 export type CallbackEventListener<T extends keyof HTMLElementTagNameMap> =
   | (EventListener & {
       (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>;
 }
 
+/**
+ * An avatar displays a user or entity image with fallback initials when the image isn't available.
+ */
 declare class Avatar extends PreactCustomElement implements AvatarProps {
+  /**
+   * The initials to display when no image is provided or if the image fails to load.
+   */
   accessor initials: AvatarProps['initials'];
+  /**
+   * The URL of the avatar image to display.
+   */
   accessor src: AvatarProps['src'];
+  /**
+   * The size of the avatar.
+   */
   accessor size: AvatarProps['size'];
+  /**
+   * Alternative text that describes the avatar for screen readers.
+   */
   accessor alt: AvatarProps['alt'];
+  /**
+   * A callback that's fired when the avatar image has loaded successfully.
+   */
   accessor onload: CallbackEventListener<typeof tagName> | null;
+  /**
+   * A callback that's fired when the avatar image fails to load.
+   */
   accessor onerror: OnErrorEventHandler;
   constructor();
 }
@@ -117,10 +208,19 @@ declare module 'preact' {
 }
 
 declare const tagName = 's-avatar';
+/**
+ * The properties for the avatar component when it's used in JSX.
+ */
 export interface AvatarJSXProps
   extends Partial<AvatarProps>,
     Pick<AvatarProps$1, 'id'> {
+  /**
+   * A callback that's fired when the avatar image has loaded successfully.
+   */
   onLoad?: () => void;
+  /**
+   * A callback that's fired when the avatar image fails to load.
+   */
   onError?: () => void;
 }