Merge pull request #3028 from Shopify/add-announcement-close-and-close-callback-interface

Add announcement api to announcement targets

Author: brianshen1990

.changeset/neat-insects-run.md

@@ -0,0 +1,5 @@
+---
+'@shopify/ui-extensions': patch
+---
+
+Add announcement api to announcement targets

packages/ui-extensions/src/surfaces/checkout/api/announcement/announcement.ts

@@ -0,0 +1,7 @@
+export interface Announcement {
+  announcement: {
+    close(): void;
+    addEventListener(type: 'close', cb: () => void): void;
+    removeEventListener(type: 'close', cb: () => void): void;
+  };
+}

packages/ui-extensions/src/surfaces/checkout/targets.ts

@@ -24,6 +24,7 @@ import type {
   AllowedComponents,
   AnyComponentExcept,
 } from './shared';
+import {Announcement} from './api/announcement/announcement';
 
 /**
  * A UI extension will register for one or more extension targets using `shopify.extend()`.
@@ -652,7 +653,8 @@ export interface RenderExtensionTargets {
    */
   'purchase.thank-you.announcement.render': RenderExtension<
     OrderConfirmationApi &
-      StandardApi<'purchase.thank-you.announcement.render'>,
+      StandardApi<'purchase.thank-you.announcement.render'> &
+      Announcement,
     AnyComponent
   >;
 }

packages/ui-extensions/src/surfaces/customer-account/api/announcement/announcement.ts

@@ -0,0 +1,7 @@
+export interface Announcement {
+  announcement: {
+    close(): void;
+    addEventListener(type: 'close', cb: () => void): void;
+    removeEventListener(type: 'close', cb: () => void): void;
+  };
+}

packages/ui-extensions/src/surfaces/customer-account/targets.ts

@@ -11,6 +11,7 @@ import {
   FulfillmentApi,
   ReturnApi,
 } from './api/standard-api/standard-api';
+import {Announcement} from './api/announcement/announcement';
 
 type Components = typeof import('./components');
 
@@ -95,7 +96,8 @@ export interface OrderStatusExtensionTargets {
    */
   'customer-account.order-status.announcement.render': RenderExtension<
     OrderStatusApi<'customer-account.order-status.announcement.render'> &
-      StandardApi<'customer-account.order-status.announcement.render'>,
+      StandardApi<'customer-account.order-status.announcement.render'> &
+      Announcement,
     AnyComponent
   >;
   'customer-account.order.page.render': RenderExtension<
@@ -126,15 +128,16 @@ export interface CustomerAccountExtensionTargets {
     AllComponents
   >;
   'customer-account.order-index.announcement.render': RenderExtension<
-    StandardApi<'customer-account.order-index.announcement.render'>,
+    StandardApi<'customer-account.order-index.announcement.render'> &
+      Announcement,
     AllComponents
   >;
   'customer-account.profile.block.render': RenderExtension<
     StandardApi<'customer-account.profile.block.render'>,
     AllComponents
   >;
   'customer-account.profile.announcement.render': RenderExtension<
-    StandardApi<'customer-account.profile.announcement.render'>,
+    StandardApi<'customer-account.profile.announcement.render'> & Announcement,
     AllComponents
   >;
   'customer-account.profile.addresses.render-after': RenderExtension<