@shopify/ui-extensions 2026.1.2 → 2026.1.3

package/src/surfaces/admin/docs-types.ts

@@ -29,6 +29,7 @@ interface AdminCodeblockType {
 
 type AdminExampleType = Omit<ExampleType, 'codeblock'> & {
   codeblock: AdminCodeblockType | AdminCodeblockType[];
+  description?: string;
 };
 
 type AdminExampleGroupType = Omit<ExampleGroupType, 'examples'> & {
@@ -36,10 +37,18 @@ type AdminExampleGroupType = Omit<ExampleGroupType, 'examples'> & {
 };
 
 export interface AdminReferenceEntityTemplateSchema
-  extends Omit<ReferenceEntityTemplateSchema, 'defaultExample' | 'examples'> {
+  extends Omit<
+    ReferenceEntityTemplateSchema,
+    'defaultExample' | 'examples' | 'related'
+  > {
+  related?: ReferenceEntityTemplateSchema['related'];
   defaultExample?: AdminExampleType;
   examples?: Omit<ExampleSectionSchema, 'exampleGroups' | 'examples'> & {
     exampleGroups?: AdminExampleGroupType[] | null;
     examples?: AdminExampleType[] | null;
   };
+  usedComponents?: string[];
+  recommendedApis?: string[];
+  recommendedTemplates?: string[];
+  recommendedCompositions?: string[];
 }

package/src/surfaces/admin/extension-targets.ts

@@ -133,7 +133,7 @@ export interface ExtensionTargets {
   >;
 
   /**
-   * A block target that displays inline content within the product details page. Use this to show product-specific tools or reorderable content sections.
+   * A block target that provides custom reordering functionality on the product details page. Use this to help merchants rearrange product data.
    */
   'admin.product-details.reorder.render': RenderExtension<
     BlockExtensionApi<'admin.product-details.reorder.render'>,
@@ -296,7 +296,7 @@ export interface ExtensionTargets {
   // Bulk Actions
 
   /**
-   * An action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing.
+   * A selection action target that appears in the **More actions** menu on the product index page when multiple products are selected. Use this to create workflows for bulk product operations, batch updates, or mass data processing.
    */
   'admin.product-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.product-index.selection-action.render'>,
@@ -304,7 +304,7 @@ export interface ExtensionTargets {
   >;
 
   /**
-   * An action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing.
+   * A selection action target that appears in the **More actions** menu on the order index page when multiple orders are selected. Use this to create workflows for bulk order operations, batch fulfillment, or mass order processing.
    */
   'admin.order-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.order-index.selection-action.render'>,
@@ -312,7 +312,7 @@ export interface ExtensionTargets {
   >;
 
   /**
-   * An action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates.
+   * A selection action target that appears in the **More actions** menu on the customer index page when multiple customers are selected. Use this to create workflows for bulk customer operations, mass email campaigns, or batch data updates.
    */
   'admin.customer-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.customer-index.selection-action.render'>,
@@ -320,7 +320,7 @@ export interface ExtensionTargets {
   >;
 
   /**
-   * An action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing.
+   * A selection action target that appears in the **More actions** menu on the draft order index page when multiple draft orders are selected. Use this to create workflows for bulk draft order operations, batch conversions, or mass order processing.
    */
   'admin.draft-order-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.draft-order-index.selection-action.render'>,
@@ -650,6 +650,6 @@ export interface ExtensionTargets {
 }
 
 /**
- * A string literal union of all valid extension target identifiers. Use this type to specify where your Admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components.
+ * A string literal union of all valid extension target identifiers. Use this type to specify where your admin UI extension should render, such as `admin.product-details.block.render` for a block on product details pages or `admin.order-details.action.render` for an action on order details pages. The target determines the extension's location, available APIs, and UI components.
  */
 export type ExtensionTarget = keyof ExtensionTargets;

package/src/surfaces/checkout/api/docs.ts

@@ -100,5 +100,3 @@ export interface Docs_Standard_AnalyticsApi
 
 export interface Docs_Standard_CustomerPrivacyApi
   extends Pick<StandardApi, 'customerPrivacy' | 'applyTrackingConsentChange'> {}
-
-export interface Docs_Standard_Ui extends Pick<StandardApi, 'ui'> {}

package/src/surfaces/checkout/api/standard/standard.ts

@@ -723,11 +723,6 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
    */
   storage: Storage;
 
-  /**
-   * Methods to interact with the extension’s UI.
-   */
-  ui: Ui;
-
   /**
    * The renderer version being used for the extension.
    *
@@ -756,22 +751,6 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
   localizedFields?: SubscribableSignalLike<LocalizedField[]>;
 }
 
-export interface Ui {
-  /**
-   * Allows the extension to close an overlay programmatically.
-   *
-   * Supported overlay components are [Modal](/docs/api/checkout-ui-extensions/latest/components/overlays/modal), [Sheet](/docs/api/checkout-ui-extensions/latest/components/overlays/sheet) and [Popover](/docs/api/checkout-ui-extensions/latest/components/overlays/popover).
-   */
-  overlay: Overlay;
-}
-
-interface Overlay {
-  /**
-   * Closes the overlay with the given ID.
-   */
-  close(overlayId: string): void;
-}
-
 export interface SessionToken {
   /**
    * Requests a session token that hasn't expired. You should call this method every

package/src/surfaces/checkout/shared.ts

@@ -95,24 +95,21 @@ export type AnyCheckoutComponentExcept<Except extends AnyCheckoutComponent> =
   Exclude<AnyCheckoutComponent, Except>;
 
 /**
- * Represents a read-only value managed on the main thread that an extension can subscribe to.
- *
- * Example: Checkout uses this to manage the state of an object and
- * communicate state changes to extensions running in a sandboxed web worker.
- *
- * This interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709).
- *
- * Some fields are deprecated but still supported for backwards compatibility.
- * In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.
- *
+ * Represents a reactive signal interface that provides both immediate value access and subscription-based updates. Enables real-time synchronization with changing data through the observer pattern. This interface extends `ReadonlySignalLike` with deprecated fields that are still supported for backwards compatibility.
  */
 export interface SubscribableSignalLike<T> extends ReadonlySignalLike<T> {
   /**
+   * The current value of the signal. This property provides synchronous access to the
+   * latest value without subscribing to changes.
+   *
    * @deprecated Use `.value` instead.
    */
   readonly current: T;
   /**
-   * @deprecated No longer needed. Use Preact Signal management instead.
+   * Cleans up the subscription and releases any resources held by this signal. After calling
+   * `destroy()`, the signal stops receiving updates from the main thread.
+   *
+   * @deprecated No longer needed. Use [Preact Signals](https://preactjs.com/guide/v10/signals) to manage reactive state instead.
    */
   destroy(): Promise<void>;
 }