@shopify/ui-extensions 2023.7.3 → 2023.10.1

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

@@ -1,9 +1,9 @@
 import type {RenderExtension} from '../../extension';
 
-import type {AnyComponent, Components} from './shared';
+import type {Components} from './shared';
 import type {
   StandardApi,
-  CustomerSegmentationTemplateApi,
+  CustomerSegmentTemplateApi,
   ActionExtensionApi,
   BlockExtensionApi,
   ProductDetailsConfigurationApi,
@@ -11,8 +11,11 @@ import type {
 } from './api';
 import {AnyComponentBuilder} from '../../shared';
 
-type CustomerSegmentationTemplateComponent = AnyComponentBuilder<
-  Pick<Components, 'CustomerSegmentationTemplate'>
+type CustomerSegmentTemplateComponent = AnyComponentBuilder<
+  Pick<
+    Components,
+    'CustomerSegmentTemplate' | 'InternalCustomerSegmentTemplate'
+  >
 >;
 
 type ProductConfigurationComponents = AnyComponentBuilder<
@@ -34,118 +37,162 @@ type ProductConfigurationComponents = AnyComponentBuilder<
   >
 >;
 
+/**
+ * See the [list of available components](/docs/api/admin-extensions/components).
+ */
+type AllComponents = AnyComponentBuilder<
+  Omit<
+    Components,
+    'CustomerSegmentTemplate' | 'InternalCustomerSegmentTemplate'
+  >
+>;
+
 export interface ExtensionTargets {
   /**
    * @private
    */
-  Playground: RenderExtension<StandardApi<'Playground'>, AnyComponent>;
+  Playground: RenderExtension<StandardApi<'Playground'>, AllComponents>;
 
   /**
-   * @private
+   * Renders a [`CustomerSegmentTemplate`](/docs/api/admin-extensions/components/customersegmenttemplate) in the [customer segment editor](https://help.shopify.com/en/manual/customers/customer-segmentation/customer-segments).
    */
   'admin.customers.segmentation-templates.render': RenderExtension<
-    CustomerSegmentationTemplateApi<'admin.customers.segmentation-templates.render'>,
-    CustomerSegmentationTemplateComponent
+    CustomerSegmentTemplateApi<'admin.customers.segmentation-templates.render'>,
+    CustomerSegmentTemplateComponent
   >;
 
   // Blocks
   /**
    * Renders an Admin Block in the product details page.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.product-details.block.render': RenderExtension<
     BlockExtensionApi<'admin.product-details.block.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Block in the order details page.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.order-details.block.render': RenderExtension<
     BlockExtensionApi<'admin.order-details.block.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Block in the customer details page.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.customer-details.block.render': RenderExtension<
     BlockExtensionApi<'admin.customer-details.block.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   // Actions
   /**
    * Renders an Admin Action in the product details page. Open this extension from the "More Actions" menu.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.product-details.action.render': RenderExtension<
     ActionExtensionApi<'admin.product-details.action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the order details page. Open this extension from the "More Actions" menu.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.order-details.action.render': RenderExtension<
     ActionExtensionApi<'admin.order-details.action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the customer details page. Open this extension from the "More Actions" menu.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.customer-details.action.render': RenderExtension<
     ActionExtensionApi<'admin.customer-details.action.render'>,
-    AnyComponent
+    AllComponents
+  >;
+
+  /**
+   * Renders an Admin Action in the customer segment details page. Open this extension from the "Use segment" button.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
+   */
+  'admin.customer-segment-details.action.render': RenderExtension<
+    ActionExtensionApi<'admin.customer-segment-details.action.render'>,
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the product index page. Open this extension from the "More Actions" menu.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.product-index.action.render': RenderExtension<
     ActionExtensionApi<'admin.product-index.action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the order index page. Open this extension from the "More Actions" menu.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.order-index.action.render': RenderExtension<
     ActionExtensionApi<'admin.order-index.action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the customer index page. Open this extension from the "More Actions" menu.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.customer-index.action.render': RenderExtension<
     ActionExtensionApi<'admin.customer-index.action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   // Bulk Actions
 
   /**
    * Renders an Admin Action in the product index page when multiple resources are selected. Open this extension from the "More Actions"  menu of the resource list. The resource ids are available to this extension at runtime.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.product-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.product-index.selection-action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the order index page when multiple resources are selected. Open this extension from the "More Actions"  menu of the resource list. The resource ids are available to this extension at runtime.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.order-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.order-index.selection-action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**
    * Renders an Admin Action in the customer index page when multiple resources are selected. Open this extension from the "More Actions"  menu of the resource list. The resource ids are available to this extension at runtime.
+   *
+   * See the [list of available components](/docs/api/admin-extensions/components).
    */
   'admin.customer-index.selection-action.render': RenderExtension<
     ActionExtensionApi<'admin.customer-index.selection-action.render'>,
-    AnyComponent
+    AllComponents
   >;
 
   /**

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

@@ -510,7 +510,7 @@ export interface CheckoutApi {
   /**
    * Performs an update on an attribute attached to the cart and checkout. If
    * successful, this mutation results in an update to the value retrieved
-   * through the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-applyattributechange) property.
+   * through the [`attributes`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/attributes#standardapi-propertydetail-attributes) property.
    *
    * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
    */
@@ -520,7 +520,7 @@ export interface CheckoutApi {
    * Performs an update on the merchandise line items. It resolves when the new
    * line items have been negotiated and results in an update to the value
    * retrieved through the
-   * [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-lines)
+   * [`lines`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/cart-lines#standardapi-propertydetail-lines)
    * property.
    *
    * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
@@ -530,7 +530,7 @@ export interface CheckoutApi {
   /**
    * Performs an update on the discount codes.
    * It resolves when the new discount codes have been negotiated and results in an update
-   * to the value retrieved through the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-discountcodes) property.
+   * to the value retrieved through the [`discountCodes`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/discounts#standardapi-propertydetail-discountcodes) property.
    *
    * > Caution:
    * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves discount codes through a network call.
@@ -544,7 +544,7 @@ export interface CheckoutApi {
   /**
    * Performs an update on the gift cards.
    * It resolves when gift card change have been negotiated and results in an update
-   * to the value retrieved through the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-appliedgiftcards) property.
+   * to the value retrieved through the [`appliedGiftCards`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/gift-cards#standardapi-propertydetail-appliedgiftcards) property.
    *
    * > Caution:
    * > See [security considerations](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access) if your extension retrieves gift card codes through a network call.
@@ -556,14 +556,14 @@ export interface CheckoutApi {
   /**
    * Performs an update on a piece of metadata attached to the checkout. If
    * successful, this mutation results in an update to the value retrieved
-   * through the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-metafields) property.
+   * through the [`metafields`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/metafields#standardapi-propertydetail-metafields) property.
    */
   applyMetafieldChange(change: MetafieldChange): Promise<MetafieldChangeResult>;
 
   /**
    * Performs an update on the note attached to the cart and checkout. If
    * successful, this mutation results in an update to the value retrieved
-   * through the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/standardapi#properties-propertydetail-note) property.
+   * through the [`note`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/note#standardapi-propertydetail-note) property.
    *
    * > Note: This method will return an error if the buyer is using an accelerated checkout method, such as Apple Pay, Google Pay, or Meta Pay.
    */

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

@@ -0,0 +1,99 @@
+import {
+  StandardApi,
+  CheckoutApi,
+  CartLineItemApi,
+  OrderStatusApi,
+} from '../api';
+
+/**
+ * These types are used to generate the documentation for the API and decipher which properties are available for which APIs.
+ * If you are adding a new property and you'd like it to be documented in the API section, then you'll need to specify the property in the appropriate interface below.
+ *
+ * Note: These are not exported as part of the package, they are only used for documentation purposes.
+ */
+
+export interface Docs_Standard_AddressApi
+  extends Pick<StandardApi, 'shippingAddress' | 'billingAddress'> {}
+export interface Docs_Checkout_AddressApi
+  extends Pick<CheckoutApi, 'applyShippingAddressChange'> {}
+
+export interface Docs_Standard_AttributesApi
+  extends Pick<StandardApi, 'attributes'> {}
+export interface Docs_Checkout_AttributesApi
+  extends Pick<CheckoutApi, 'applyAttributeChange'> {}
+
+export interface Docs_Standard_BuyerIdentityApi
+  extends Pick<StandardApi, 'buyerIdentity'> {}
+
+export interface Docs_Standard_BuyerJourneyApi
+  extends Pick<StandardApi, 'buyerJourney'> {}
+
+export interface Docs_Standard_CartLinesApi
+  extends Pick<StandardApi, 'lines'> {}
+export interface Docs_Checkout_CartLinesApi
+  extends Pick<CheckoutApi, 'applyCartLinesChange'> {}
+export interface Docs_CartLineItem_CartLinesApi
+  extends Pick<CartLineItemApi, 'target'> {}
+
+export interface Docs_Standard_CostApi extends Pick<StandardApi, 'cost'> {}
+
+export interface Docs_Standard_LocalizationApi
+  extends Pick<StandardApi, 'i18n' | 'localization'> {}
+
+export interface Docs_Standard_MetafieldsApi
+  extends Pick<StandardApi, 'appMetafields' | 'metafields'> {}
+export interface Docs_Checkout_MetafieldsApi
+  extends Pick<CheckoutApi, 'applyMetafieldChange'> {}
+
+export interface Docs_Standard_DeliveryApi
+  extends Pick<StandardApi, 'deliveryGroups'> {}
+
+export interface Docs_Standard_CheckoutTokenApi
+  extends Pick<StandardApi, 'checkoutToken'> {}
+
+export interface Docs_Standard_ExtensionMetaApi
+  extends Pick<StandardApi, 'extension'> {}
+
+export interface Docs_Standard_CheckoutSettingsApi
+  extends Pick<StandardApi, 'checkoutSettings'> {}
+
+export interface Docs_Standard_ShopApi extends Pick<StandardApi, 'shop'> {}
+
+export interface Docs_Standard_NoteApi extends Pick<StandardApi, 'note'> {}
+export interface Docs_Checkout_NoteApi
+  extends Pick<CheckoutApi, 'applyNoteChange'> {}
+
+export interface Docs_OrderStatus_OrderApi
+  extends Pick<OrderStatusApi, 'order'> {}
+
+export interface Docs_Standard_PaymentOptionsApi
+  extends Pick<
+    StandardApi,
+    'availablePaymentOptions' | 'selectedPaymentOptions'
+  > {}
+
+export interface Docs_Standard_GiftCardsApi
+  extends Pick<StandardApi, 'appliedGiftCards'> {}
+
+export interface Docs_Checkout_GiftCardsApi
+  extends Pick<CheckoutApi, 'applyGiftCardChange'> {}
+
+export interface Docs_Standard_DiscountsApi
+  extends Pick<StandardApi, 'discountAllocations' | 'discountCodes'> {}
+
+export interface Docs_Checkout_DiscountsApi
+  extends Pick<CheckoutApi, 'applyDiscountCodeChange'> {}
+
+export interface Docs_Standard_SessionTokenApi
+  extends Pick<StandardApi, 'sessionToken'> {}
+
+export interface Docs_Standard_SettingsApi
+  extends Pick<StandardApi, 'settings'> {}
+
+export interface Docs_Standard_StorageApi
+  extends Pick<StandardApi, 'storage'> {}
+
+export interface Docs_Standard_QueryApi extends Pick<StandardApi, 'query'> {}
+
+export interface Docs_Standard_AnalyticsApi
+  extends Pick<StandardApi, 'analytics'> {}

package/src/surfaces/checkout/api/payment/payment-option-item.ts

@@ -1,3 +1,5 @@
+import {StatefulRemoteSubscribable} from '@remote-ui/async-subscription';
+
 export type PaymentMethodAttributesResult =
   | PaymentMethodAttributesResultSuccess
   | PaymentMethodAttributesResultError;
@@ -52,4 +54,7 @@ export interface PaymentOptionItemApi {
   applyPaymentMethodAttributesChange(
     change: PaymentMethodAttributesChange,
   ): Promise<PaymentMethodAttributesResult>;
+  paymentMethodAttributes?: StatefulRemoteSubscribable<
+    PaymentMethodAttribute[] | undefined
+  >;
 }

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

@@ -40,9 +40,14 @@ export interface RedeemableAddChange {
   type: 'redeemableAddChange';
 
   /**
-   * The redeemable attributes
+   * The redeemable attributes.
    */
   attributes: RedeemableAttribute[];
+
+  /**
+   * The identifier used to represent the redeemable (e.g. the gift card code).
+   */
+  identifier: string;
 }
 
 export interface RedeemableApi {