@shopify/ui-extensions 2026.4.0-rc.2 → 2026.4.0

package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts

@@ -1,54 +1,60 @@
 import type { SubscribableSignalLike } from '../../shared';
 import type { DeliveryGroup, DeliveryGroupType, DeliveryOptionReference, Money } from '../standard/standard';
+/** @publicDocs */
 export interface ShippingOptionListApi {
     /**
-     * The delivery group list the extension is attached to. The target will be undefined when there are no groups for a given type.
+     * The delivery group list that this extension is attached to. Use this to access all delivery groups and their options. The value is `undefined` when there aren't any delivery groups for the given type.
      */
     target: SubscribableSignalLike<DeliveryGroupList | undefined>;
     /**
-     * The list of selection groups available to the buyers. The property will be undefined when no such groups are available.
+     * The list of delivery selection groups available to the buyer, which let buyers choose between grouped delivery options. The value is `undefined` when no selection groups are available.
      */
     deliverySelectionGroups: SubscribableSignalLike<DeliverySelectionGroup[] | undefined>;
 }
 /**
- * The delivery group list the extension is associated to.
+ * A collection of delivery groups that share the same group type.
+ * @publicDocs
  */
 export interface DeliveryGroupList {
     /**
-     * The group type of the delivery group list.
+     * The type of delivery groups in this list. This is the same `DeliveryGroupType` used on `DeliveryGroup.groupType`.
+     *
+     * - `'oneTimePurchase'`: Items bought as a single, non-recurring purchase.
+     * - `'subscription'`: Items bought through a [selling plan](https://shopify.dev/docs/apps/build/purchase-options/subscriptions) that results in recurring deliveries.
      */
     groupType: DeliveryGroupType;
     /**
-     * The delivery groups that compose this list.
+     * The delivery groups in this list. Each group contains cart lines and available delivery options for those items.
      */
     deliveryGroups: DeliveryGroup[];
 }
 /**
- * A selection group for delivery options.
+ * A named group of delivery options that the buyer can select as a unit.
+ * @publicDocs
  */
 export interface DeliverySelectionGroup {
     /**
-     * The handle of the selection group.
+     * A unique identifier for this selection group.
      */
     handle: string;
     /**
-     * If the selection group is selected.
+     * Whether the buyer has selected this delivery selection group. When `true`, the associated delivery options are active. When `false`, the buyer has selected a different group.
      */
     selected: boolean;
     /**
-     * The localized title of the selection group.
+     * The localized display title of this selection group, suitable for rendering in the checkout UI.
      */
     title: string;
     /**
-     * The associated delivery option handles with the selection group. The handles will match the delivery group's delivery option handles.
+     * The delivery options that belong to this selection group. Each reference's `handle` matches a delivery option handle in the associated delivery group.
      */
     associatedDeliveryOptions: DeliveryOptionReference[];
     /**
-     * The sum of each delivery option's cost.
+     * The combined cost of all delivery options in this group before discounts.
      */
     cost: Money;
     /**
-     * The sum of each delivery option's cost after discounts.
+     * The combined cost of all delivery options in this group after discounts have been applied. This is what the buyer actually pays.
      */
     costAfterDiscounts: Money;
 }

package/build/ts/surfaces/checkout/api/shipping/shipping-option-list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"shipping-option-list.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/shipping/shipping-option-list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EACjB,uBAAuB,EACvB,KAAK,EACN,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC9D;;OAEG;IACH,uBAAuB,EAAE,sBAAsB,CAC7C,sBAAsB,EAAE,GAAG,SAAS,CACrC,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,yBAAyB,EAAE,uBAAuB,EAAE,CAAC;IACrD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC;CAC3B"}
+{"version":3,"file":"shipping-option-list.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/shipping/shipping-option-list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,sBAAsB,EAAC,MAAM,cAAc,CAAC;AACzD,OAAO,KAAK,EACV,aAAa,EACb,iBAAiB,EACjB,uBAAuB,EACvB,KAAK,EACN,MAAM,sBAAsB,CAAC;AAE9B,kBAAkB;AAClB,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAAC;IAC9D;;OAEG;IACH,uBAAuB,EAAE,sBAAsB,CAC7C,sBAAsB,EAAE,GAAG,SAAS,CACrC,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,SAAS,EAAE,iBAAiB,CAAC;IAC7B;;OAEG;IACH,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,yBAAyB,EAAE,uBAAuB,EAAE,CAAC;IACrD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC;IACZ;;OAEG;IACH,kBAAkB,EAAE,KAAK,CAAC;CAC3B"}