feat(products): updating Product Configuration extension points to us…

…e block extension api & components
Shopify · Feb 14, 2025 · 2297f5c · 2297f5c
1 parent 4835263
commit 2297f5c
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 26 deletions.
diff --git a/...-extensions/src/surfaces/admin/api/product-configuration/product-details-configuration.ts b/...-extensions/src/surfaces/admin/api/product-configuration/product-details-configuration.ts
@@ -1,6 +1,8 @@
-import type {StandardApi} from '../standard/standard';
+import type {BlockExtensionApi} from '../block/block';
 import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';
+import type {Data} from '../shared';
 
+/* @deprecated */
 interface Product {
   id: string;
   title: string;
@@ -21,6 +23,7 @@ interface Product {
   productComponents: ProductComponent[];
 }
 
+/* @deprecated */
 export interface ProductComponent {
   id: string;
   title: string;
@@ -37,9 +40,12 @@ export interface ProductComponent {
 
 export interface ProductDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,
-> extends StandardApi<ExtensionTarget> {
-  data: {
-    /* The product currently being viewed in the admin. */
+> extends BlockExtensionApi<ExtensionTarget> {
+  data: Data & {
+    /*
+      @deprecated 
+      The product currently being viewed in the admin.
+    */
     product: Product;
     app: {
       launchUrl: string;

diff --git a/...ons/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts b/...ons/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts
@@ -1,6 +1,7 @@
-import type {StandardApi} from '../standard/standard';
+import type {BlockExtensionApi} from '../block/block';
 import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';
 
+/* @deprecated */
 interface ProductVariant {
   id: string;
   sku: string;
@@ -19,6 +20,7 @@ interface ProductVariant {
   productVariantComponents: ProductVariantComponent[];
 }
 
+/* @deprecated */
 export interface ProductVariantComponent {
   id: string;
   displayName: string;
@@ -38,9 +40,12 @@ export interface ProductVariantComponent {
 
 export interface ProductVariantDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,
-> extends StandardApi<ExtensionTarget> {
-  data: {
-    /* The product variant currently being viewed in the admin. */
+> extends BlockExtensionApi<ExtensionTarget> {
+  data: Data & {
+    /*
+      @deprecated
+      The product variant currently being viewed in the admin.
+    */
     variant: ProductVariant;
     app: {
       launchUrl: string;

diff --git a/packages/ui-extensions/src/surfaces/admin/extension-targets.ts b/packages/ui-extensions/src/surfaces/admin/extension-targets.ts
@@ -28,22 +28,6 @@ type CustomerSegmentTemplateComponent = AnyComponentBuilder<
   >
 >;
 
-type ProductConfigurationComponents = AnyComponentBuilder<
-  Pick<
-    Components,
-    | 'Box'
-    | 'InlineStack'
-    | 'BlockStack'
-    | 'Divider'
-    | 'HeadingGroup'
-    | 'Heading'
-    | 'Text'
-    | 'Link'
-    | 'Image'
-    | 'Icon'
-  >
->;
-
 type OrderRoutingComponents = AnyComponentBuilder<
   Pick<Components, 'InternalLocationList'>
 >;
@@ -510,7 +494,7 @@ export interface ExtensionTargets {
    */
   'admin.product-details.configuration.render': RenderExtension<
     ProductDetailsConfigurationApi<'admin.product-details.configuration.render'>,
-    ProductConfigurationComponents
+    AllComponents
   >;
 
   /**
@@ -520,7 +504,7 @@ export interface ExtensionTargets {
    */
   'admin.product-variant-details.configuration.render': RenderExtension<
     ProductVariantDetailsConfigurationApi<'admin.product-variant-details.configuration.render'>,
-    ProductConfigurationComponents
+    AllComponents
   >;
 
   /**