@shopify/ui-extensions 2025.10.13 → 2025.10.14

package/build/ts/surfaces/admin/api/intents/intents.d.ts

@@ -1,99 +1,94 @@
 /**
- * User dismissed or closed the workflow without completing it.
+ * The response returned when a merchant closes or cancels the workflow without completing it. Check for this response to handle cancellation gracefully in your extension.
  */
 export interface ClosedIntentResponse {
+    /** Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing. */
     code?: 'closed';
 }
 /**
- * Successful intent completion.
+ * The response returned when a merchant successfully completes the workflow. Use this to access the created or updated resource data.
  */
 export interface SuccessIntentResponse {
+    /** Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated. */
     code?: 'ok';
+    /** Additional data returned by the workflow, such as the created or updated resource information with IDs and properties. */
     data?: {
         [key: string]: unknown;
     };
 }
 /**
- * Failed intent completion.
+ * The response returned when the workflow fails due to validation errors or other issues. Use this to display error messages and help merchants fix problems.
  */
 export interface ErrorIntentResponse {
+    /** Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion. */
     code?: 'error';
+    /** A general error message describing what went wrong. Use this to display feedback when specific field errors aren't available. */
     message?: string;
+    /** Specific validation issues or field errors. Present when validation fails on particular fields, allowing you to show targeted error messages. */
     issues?: {
-        /**
-         * The path to the field with the issue.
-         */
+        /** The path to the field that has an error (for example, `['product', 'title']`). Use this to identify which field caused the validation failure. */
         path?: string[];
-        /**
-         * The error message for the issue.
-         */
+        /** A description of what's wrong with this field. Display this to help merchants understand how to fix the error. */
         message?: string;
-        /**
-         * A code identifier for the issue.
-         */
+        /** A machine-readable error code for this issue. Use this for programmatic error handling or logging. */
         code?: string;
     }[];
 }
 /**
- * Result of an intent activity.
- * Discriminated union representing all possible completion outcomes.
+ * The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.
  */
 export type IntentResponse = SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse;
 /**
- * Activity handle for tracking intent workflow progress.
+ * A handle for tracking an in-progress intent workflow.
  */
 export interface IntentActivity {
     /**
-     * A Promise that resolves when the intent workflow completes, returning the response.
+     * A Promise that resolves when the workflow completes. Await this to get the outcome and handle success, failure, or cancellation appropriately.
      */
     complete?: Promise<IntentResponse>;
 }
 /**
- * The action to perform on a resource.
+ * The type of operation to perform: creating a new resource or editing an existing one.
  */
 export type IntentAction = 'create' | 'edit';
 /**
- * Supported resource types that can be targeted by intents.
+ * The types of Shopify resources that support intent-based creation and editing workflows.
  */
 export type IntentType = 'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant';
 /**
- * Options for invoking intents when using the query string format.
+ * Additional parameters for intent invocation when using the string query format. Use these options to provide resource IDs for editing or pass required context data for resource creation.
  */
 export interface IntentQueryOptions {
     /**
-     * The resource identifier for edit actions (e.g., 'gid://shopify/Product/123').
+     * The resource identifier for edit operations (for example, `'gid://shopify/Product/123'`). Required when editing existing resources. Omit this for create operations.
      */
     value?: string;
     /**
-     * Additional data required for certain intent types.
-     * For example:
-     * - Discount creation requires { type: 'amount-off-product' | 'amount-off-order' | 'buy-x-get-y' | 'free-shipping' }
-     * - ProductVariant creation requires { productId: 'gid://shopify/Product/123' }
-     * - Metaobject creation requires { type: 'shopify--color-pattern' }
+     * Additional context data required by specific intent types. For example, discount creation requires a discount type, variant creation requires a parent product ID, and [metaobject](/docs/apps/build/custom-data/metaobjects) creation requires a definition type.
      */
     data?: {
         [key: string]: unknown;
     };
 }
 /**
- * Structured description of an intent to invoke.
+ * A structured intent specification defining what workflow to launch. Use this format when you prefer object syntax over string query format.
  */
 export interface IntentQuery extends IntentQueryOptions {
     /**
-     * The operation to perform on the target resource.
+     * The operation to perform: `'create'` for new resources or `'edit'` for existing ones.
      */
     action: IntentAction;
     /**
-     * The resource type (e.g., 'shopify/Product').
+     * The type of resource to create or edit (for example, `'shopify/Product'`).
      */
     type: IntentType;
 }
 /**
- * The invoke API for triggering intent workflows.
+ * The [`invoke` method](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/intents-api#invoke-method) in the Intents API launches a Shopify admin workflow for creating or editing resources, such as products, customers, or discounts. It opens a native admin interface, waits for the merchant to complete the workflow, and returns the result including any created or updated resource data.
  *
- * @param intent - Either a string query or structured object describing the intent
- * @param options - Optional parameters when using string query format
- * @returns A Promise resolving to an activity handle for tracking the workflow
+ * @param intent - Either a string query (for example, `'create:shopify/Product'`) or structured object describing the intent
+ * @param options - Optional parameters when using string query format, such as resource IDs for editing or additional context data
+ * @returns A Promise resolving to an activity handle for tracking the workflow and accessing the completion result
  *
  * @example
  * ```javascript
@@ -117,15 +112,15 @@ export interface IntentInvokeApi {
     (intentURL: string, options?: IntentQueryOptions): Promise<IntentActivity>;
 }
 /**
- * Intent information provided to the receiver of an intent.
+ * The `Intents` object provides methods for launching standardized Shopify workflows to create or edit resources. Intents enable your extension to trigger native admin interfaces for products, customers, discounts, and other resources, then receive the results when merchants complete the workflow.
  */
 export interface Intents {
     /**
-     * The URL that was used to launch the intent.
+     * The URL that launched the current intent workflow, if your extension was opened through an intent. Use this to determine how your extension was invoked and access any parameters passed in the URL.
      */
     launchUrl?: string | URL;
     /**
-     * Invoke an intent workflow to create or edit Shopify resources.
+     * Launches an intent workflow for creating or editing Shopify resources. Returns a handle that resolves when the merchant completes, cancels, or encounters an error in the workflow. Use this to initiate resource creation or editing without building custom forms.
      */
     invoke?: IntentInvokeApi;
 }

package/build/ts/surfaces/admin/api/intents/intents.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"intents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,6BAA6B,GAC7B,oBAAoB,GACpB,8BAA8B,GAC9B,cAAc,GACd,iBAAiB,GACjB,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B"}
+{"version":3,"file":"intents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gIAAgI;IAChI,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,iIAAiI;IACjI,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,6HAA6H;IAC7H,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2IAA2I;IAC3I,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,oIAAoI;IACpI,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oJAAoJ;IACpJ,MAAM,CAAC,EAAE;QACP,qJAAqJ;QACrJ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB,qHAAqH;QACrH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,yGAAyG;QACzG,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,6BAA6B,GAC7B,oBAAoB,GACpB,8BAA8B,GAC9B,cAAc,GACd,iBAAiB,GACjB,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B"}

package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"intents.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA8hBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"intents.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6mBX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts

@@ -1,19 +1,39 @@
 import type { SupportedDefinitionType } from './metafields';
+/**
+ * A [metafield](/docs/apps/build/metafields) associated with an order routing rule. Use metafields to persist settings that control how your order routing function behaves, such as location preferences, routing criteria, or custom fulfillment rules.
+ */
 interface Metafield {
+    /** The unique global identifier (GID) for this metafield. Present for existing metafields, absent for new ones. Use this ID to reference the metafield in GraphQL operations. */
     id?: string | null;
+    /** The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'preferred_location'` or `'routing_priority'`). */
     key: string;
+    /** The metafield value stored as a string. Parse this value according to the metafield type to use it in your settings UI. */
     value?: string | null;
+    /** The namespace that organizes related metafields together. Use consistent namespaces to group related settings for your order routing rule. */
     namespace?: string;
+    /** The metafield [definition type](/docs/apps/build/metafields/list-of-data-types) that specifies the value format and validation rules. Use this to determine how to parse and display the value. */
     type?: SupportedDefinitionType;
 }
+/**
+ * An order routing rule configuration that determines how orders are routed to fulfillment locations. Use this to access the rule's current settings and populate your configuration interface.
+ */
 interface OrderRoutingRule {
+    /** The display label for the order routing rule shown to merchants in the admin. Use this to identify the rule in lists and settings pages. */
     label: string;
+    /** A description explaining the rule's purpose and how it routes orders. Use this to help merchants understand what the rule does. */
     description: string;
+    /** The unique global identifier (GID) for the order routing rule. Use this ID to associate configuration changes with the correct rule. */
     id: string;
+    /** The priority order for rule evaluation when multiple rules exist. Lower numbers are evaluated first (for example, a rule with priority 1 runs before priority 2). Use this to understand the rule's position in the evaluation sequence. */
     priority?: number;
+    /** An array of [metafields](/docs/apps/build/metafields) that store the routing rule's configuration values. Use these metafields to populate your settings UI with the current rule configuration. */
     metafields: Metafield[];
 }
+/**
+ * The `data` object exposed to order routing rule extensions in the `admin.settings.order-routing-rule.render` target. Use this to access the current rule configuration and build your settings interface.
+ */
 export interface Data {
+    /** The order routing rule being configured by the merchant. Use this to access the rule's properties and populate your settings UI with existing configuration values. */
     rule: OrderRoutingRule;
 }
 export {};

package/build/ts/surfaces/admin/api/order-routing-rule/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,uBAAuB,EAAC,MAAM,cAAc,CAAC;AAE1D,UAAU,SAAS;IACjB,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAChC;AAED,UAAU,gBAAgB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,gBAAgB,CAAC;CACxB"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,uBAAuB,EAAC,MAAM,cAAc,CAAC;AAE1D;;GAEG;AACH,UAAU,SAAS;IACjB,iLAAiL;IACjL,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,4LAA4L;IAC5L,GAAG,EAAE,MAAM,CAAC;IACZ,8HAA8H;IAC9H,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,iJAAiJ;IACjJ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sMAAsM;IACtM,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAChC;AAED;;GAEG;AACH,UAAU,gBAAgB;IACxB,+IAA+I;IAC/I,KAAK,EAAE,MAAM,CAAC;IACd,sIAAsI;IACtI,WAAW,EAAE,MAAM,CAAC;IACpB,2IAA2I;IAC3I,EAAE,EAAE,MAAM,CAAC;IACX,+OAA+O;IAC/O,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uMAAuM;IACvM,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,0KAA0K;IAC1K,IAAI,EAAE,gBAAgB,CAAC;CACxB"}

package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts

@@ -1,18 +1,41 @@
 declare const supportedDefinitionTypes: readonly ["boolean", "collection_reference", "color", "date", "date_time", "dimension", "file_reference", "json", "metaobject_reference", "mixed_reference", "money", "multi_line_text_field", "number_decimal", "number_integer", "page_reference", "product_reference", "rating", "rich_text_field", "single_line_text_field", "product_taxonomy_value_reference", "url", "variant_reference", "volume", "weight", "list.collection_reference", "list.color", "list.date", "list.date_time", "list.dimension", "list.file_reference", "list.metaobject_reference", "list.mixed_reference", "list.number_decimal", "list.number_integer", "list.page_reference", "list.product_reference", "list.rating", "list.single_line_text_field", "list.url", "list.variant_reference", "list.volume", "list.weight"];
+/**
+ * A metafield update or creation operation. Use this to set or modify metafield values that store order routing rule configuration data.
+ */
 interface MetafieldUpdateChange {
+    /** Identifies this as an update operation. Always set to `'updateMetafield'` for updates. */
     type: 'updateMetafield';
+    /** The unique key identifying the metafield within its namespace. Use descriptive keys that indicate the setting's purpose (for example, `'preferred_location'` or `'routing_priority'`). */
     key: string;
+    /** The namespace that organizes related metafields. When omitted, a default namespace is assigned. Use consistent namespaces to group related settings. */
     namespace?: string;
+    /** The metafield value to store. Can be a string or number depending on your configuration needs. */
     value: string | number;
+    /** The [data type](/docs/apps/build/metafields/list-of-data-types) that defines how the value is formatted and validated. When omitted, preserves the existing type for updates or uses a default for new metafields. Choose a type that matches your value format. */
     valueType?: SupportedDefinitionType;
 }
+/**
+ * A metafield removal operation. Use this to delete metafields that are no longer needed for your order routing rule configuration.
+ */
 interface MetafieldRemoveChange {
+    /** Identifies this as a removal operation. Always set to `'removeMetafield'` for deletions. */
     type: 'removeMetafield';
+    /** The unique key of the metafield to remove. Must match the key used when the metafield was created. */
     key: string;
+    /** The namespace containing the metafield to remove. Required to ensure the correct metafield is targeted, as the same key can exist in different namespaces. */
     namespace: string;
 }
+/**
+ * One or more metafield change operations to apply to order routing rule settings. Can be a single change or an array of changes for batch operations. Use arrays to apply multiple changes at once.
+ */
 type MetafieldsChange = MetafieldUpdateChange | MetafieldRemoveChange | MetafieldUpdateChange[] | MetafieldRemoveChange[];
+/**
+ * The supported [metafield definition types](/docs/apps/build/metafields/list-of-data-types) for storing order routing rule configuration data. Use these types to specify how metafield values should be formatted, validated, and displayed. Types prefixed with `list.` store arrays of values, while other types store single values.
+ */
 export type SupportedDefinitionType = (typeof supportedDefinitionTypes)[number];
+/**
+ * A function that applies metafield changes to order routing rule settings. Call this function with one or more change operations to update or remove metafields in batch. Use batch operations to apply multiple configuration changes efficiently.
+ */
 export type ApplyMetafieldsChange = (changes: MetafieldsChange[]) => void;
 export {};
 //# sourceMappingURL=metafields.d.ts.map

package/build/ts/surfaces/admin/api/order-routing-rule/metafields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metafields.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/metafields.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,wBAAwB,+wBA2CpB,CAAC;AAEX,UAAU,qBAAqB;IAC7B,IAAI,EAAE,iBAAiB,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED,UAAU,qBAAqB;IAC7B,IAAI,EAAE,iBAAiB,CAAC;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,KAAK,gBAAgB,GACjB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,EAAE,GACvB,qBAAqB,EAAE,CAAC;AAE5B,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAChF,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,IAAI,CAAC"}
+{"version":3,"file":"metafields.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/metafields.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,wBAAwB,+wBA2CpB,CAAC;AAEX;;GAEG;AACH,UAAU,qBAAqB;IAC7B,6FAA6F;IAC7F,IAAI,EAAE,iBAAiB,CAAC;IACxB,6LAA6L;IAC7L,GAAG,EAAE,MAAM,CAAC;IACZ,2JAA2J;IAC3J,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qGAAqG;IACrG,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;IACvB,uQAAuQ;IACvQ,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED;;GAEG;AACH,UAAU,qBAAqB;IAC7B,+FAA+F;IAC/F,IAAI,EAAE,iBAAiB,CAAC;IACxB,yGAAyG;IACzG,GAAG,EAAE,MAAM,CAAC;IACZ,iKAAiK;IACjK,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,KAAK,gBAAgB,GACjB,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,EAAE,GACvB,qBAAqB,EAAE,CAAC;AAE5B;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts

@@ -2,8 +2,13 @@ import type { StandardApi } from '../standard/standard';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import { ApplyMetafieldsChange } from './metafields';
 import { Data } from './data';
+/**
+ * The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.
+ */
 export interface OrderRoutingRuleApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
+    /** Updates or removes [metafields](/docs/apps/build/metafields) that store order routing rule configuration. */
     applyMetafieldsChange: ApplyMetafieldsChange;
+    /** The order routing rule being configured, including its metadata and associated [metafields](/docs/apps/build/metafields). */
     data: Data;
 }
 //# sourceMappingURL=order-routing-rule.d.ts.map

package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"order-routing-rule.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,OAAO,EAAC,qBAAqB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,WAAW,mBAAmB,CAAC,eAAe,SAAS,kBAAkB,CAC7E,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,IAAI,EAAE,IAAI,CAAC;CACZ"}
+{"version":3,"file":"order-routing-rule.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,OAAO,EAAC,qBAAqB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,eAAe,SAAS,kBAAkB,CAC7E,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC,gHAAgH;IAChH,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,gIAAgI;IAChI,IAAI,EAAE,IAAI,CAAC;CACZ"}

package/build/ts/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"order-routing-rule.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"order-routing-rule.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/picker/picker.d.ts

@@ -1,81 +1,109 @@
+/**
+ * A handle returned when opening a picker dialog. Use this to access the merchant's selection after they confirm or cancel the picker.
+ */
 interface Picker {
     /**
-     * A Promise that resolves with the selected item IDs when the user presses the "Select" button in the picker.
+     * A Promise that resolves with an array of selected item IDs when the merchant presses the **Select** button, or `undefined` if they cancel. Await this Promise to handle the selection result.
      */
     selected: Promise<string[] | undefined>;
 }
+/**
+ * The configuration for a table column header in the picker. Each header creates a labeled column that displays corresponding data from items.
+ */
 interface Header {
     /**
-     * The content to display in the table column header.
+     * The label text displayed at the top of the table column. Use clear, concise labels that describe the data in that column (for example, "Price", "Status", "Last Updated").
      */
     content?: string;
     /**
-     * The type of data to display in the column. The type is used to format the data in the column.
-     * If the type is 'number', the data in the column will be right-aligned, this should be used when referencing currency or numeric values.
-     * If the type is 'string', the data in the column will be left-aligned.
+     * The data type that controls column formatting and text alignment. Use `'number'` for currency, prices, or numeric values (displays right-aligned), or `'string'` for text content (displays left-aligned).
      * @defaultValue 'string'
      */
     type?: 'string' | 'number';
 }
+/**
+ * The configuration options for the custom picker dialog. Define the picker's appearance, selection behavior, and data structure.
+ */
 interface PickerOptions {
     /**
-     * The heading of the picker. This is displayed in the title of the picker modal.
+     * The heading displayed at the top of the picker modal. Use a clear, descriptive title that tells merchants what they're selecting.
      */
     heading: string;
     /**
-     * The data headers for the picker. These are used to display the table headers in the picker modal.
+     * The selection mode for the picker. Pass `true` to allow unlimited selections, `false` for single-item selection only, or a number to set a maximum selection limit (for example, `3` allows up to three items).
      */
     multiple?: boolean | number;
     /**
-     * The items to display in the picker. These are used to display the rows in the picker modal.
+     * The list of items that merchants can select from. Each item appears as a row in the picker table.
      */
     items: Item[];
     /**
-     * The data headers for the picker. These are used to display the table headers in the picker modal.
+     * The column headers for the picker table. Define headers to label and organize the data columns displayed for each item. The header order determines the column layout.
      */
     headers?: Header[];
 }
+/**
+ * The visual tone for picker badges indicating status or importance. Use different tones to communicate urgency or state: `'info'` for neutral information, `'success'` for positive states, `'warning'` for caution, or `'critical'` for urgent issues.
+ */
 export type Tone = 'info' | 'success' | 'warning' | 'critical';
+/**
+ * The progress state for picker badges showing completion status. Use this to indicate how complete an item is: `'incomplete'` for not started, `'partiallyComplete'` for in progress, or `'complete'` for finished.
+ */
 export type Progress = 'incomplete' | 'partiallyComplete' | 'complete';
+/**
+ * A single data point that can appear in a picker table cell. Can be text, a number, or undefined if the cell should be empty.
+ */
 type DataPoint = string | number | undefined;
+/**
+ * A badge displayed next to an item in the picker to show status or progress. Use badges to highlight important item attributes or states that affect selection decisions.
+ */
 interface PickerBadge {
+    /** The text content of the badge. Keep this short and descriptive (for example, "Draft", "Active", "Incomplete"). */
     content: string;
+    /** The visual tone indicating status or importance. Choose a tone that matches the badge's meaning. */
     tone?: Tone;
+    /** The progress indicator for the badge. Use this to show completion status for items that have progress states. */
     progress?: Progress;
 }
+/**
+ * An individual item that merchants can select in the picker. Each item appears as a row in the picker table.
+ */
 interface Item {
     /**
-     * The unique identifier of the item. This will be returned by the picker if selected.
+     * The unique identifier for this item. This ID is returned in the selection array when the merchant selects this item. Use an ID that helps you identify the item in your system (for example, template IDs, review IDs, or custom option keys).
      */
     id: string;
     /**
-     * The primary content to display in the first column of the row.
+     * The primary text displayed in the first column. This is typically the item's name or title and is the most prominent text in the row.
      */
     heading: string;
     /**
-     * The additional content to display in the second and third columns of the row, if provided.
+     * Additional data displayed in subsequent columns after the heading. Each value appears in its own column, and the order must match the `headers` array. For example, if headers are `["Price", "Status"]`, then data would be `[19.99, "Active"]`.
      */
     data?: DataPoint[];
     /**
-     * Whether the item is disabled or not. If the item is disabled, it cannot be selected.
+     * Whether the item can be selected. When `true`, the item is disabled and can't be selected. Disabled items appear grayed out and merchants can't choose them. Use this for items that are unavailable or don't meet selection criteria.
      * @defaultValue false
      */
     disabled?: boolean;
     /**
-     * Whether the item is selected or not when the picker is opened. The user may deselect the item if it is preselected.
+     * Whether the item is preselected when the picker opens. When `true`, the item appears selected by default. Merchants can still deselect preselected items. Use this to show current selections or suggest default choices.
      */
     selected?: boolean;
     /**
-     * The badges to display in the first column of the row. These are used to display additional information about the item, such as progress of an action or tone indicating the status of that item.
+     * Status or context badges displayed next to the heading in the first column. Use badges to highlight item state, completion status, or other important attributes (for example, "Draft", "Published", "Incomplete").
      */
     badges?: PickerBadge[];
     /**
-     * The thumbnail to display at the start of the row. This is used to display an image or icon for the item.
+     * A small preview image or icon displayed at the start of the row. Thumbnails help merchants visually identify items at a glance. Provide a URL to the image file.
      */
     thumbnail?: {
         url: string;
     };
 }
+/**
+ * The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.
+ */
 export type PickerApi = (options: PickerOptions) => Promise<Picker>;
 export {};
 //# sourceMappingURL=picker.d.ts.map

package/build/ts/surfaces/admin/api/picker/picker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"picker.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/picker/picker.ts"],"names":[],"mappings":"AAAA,UAAU,MAAM;IACd;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;CACzC;AAED,UAAU,MAAM;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAED,UAAU,aAAa;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAC/D,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,mBAAmB,GAAG,UAAU,CAAC;AACvE,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAC7C,UAAU,WAAW;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,UAAU,IAAI;IACZ;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"picker.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/picker/picker.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,MAAM;IACd;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;CACzC;AAED;;GAEG;AACH,UAAU,MAAM;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;CAC5B;AAED;;GAEG;AACH,UAAU,aAAa;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC5B;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,mBAAmB,GAAG,UAAU,CAAC;AAEvE;;GAEG;AACH,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;AAC7C;;GAEG;AACH,UAAU,WAAW;IACnB,qHAAqH;IACrH,OAAO,EAAE,MAAM,CAAC;IAChB,uGAAuG;IACvG,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,oHAAoH;IACpH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED;;GAEG;AACH,UAAU,IAAI;IACZ;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,EAAE,CAAC;IACnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB;;OAEG;IACH,SAAS,CAAC,EAAE;QAAC,GAAG,EAAE,MAAM,CAAA;KAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC"}

package/build/ts/surfaces/admin/api/picker/picker.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"picker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/picker/picker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA6GX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"picker.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/picker/picker.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAkIX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/print-action/print-action.d.ts

@@ -3,17 +3,20 @@ import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targ
 import type { Data } from '../shared';
 import type { ResourcePickerApi } from '../resource-picker/resource-picker';
 import type { PickerApi } from '../picker/picker';
+/**
+ * The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.
+ */
 export interface PrintActionExtensionApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
     /**
-     * Information about the currently viewed or selected items.
+     * An array of currently viewed or selected resource identifiers. Use this to access the IDs of items to include in the print document, such as selected orders or products.
      */
     data: Data;
     /**
-     * Renders the [Resource Picker](resource-picker), allowing users to select a resource for the extension to use as part of its flow.
+     * Opens the [Resource Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/resource-picker-api) modal for selecting products, variants, or collections. Use this to let merchants choose additional resources to include in the print document.
      */
     resourcePicker: ResourcePickerApi;
     /**
-     * Renders a custom [Picker](picker) dialog allowing users to select values from a list.
+     * Opens a custom [Picker API](/docs/api/admin-extensions/{API_VERSION}/target-apis/utility-apis/picker-api) dialog for selecting from a list of custom options. Use this when you need merchants to choose print settings or document configurations.
      */
     picker: PickerApi;
 }

package/build/ts/surfaces/admin/api/print-action/print-action.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"print-action.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/print-action/print-action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,kBAAkB,CAAC;AAEhD,MAAM,WAAW,uBAAuB,CACtC,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB"}
+{"version":3,"file":"print-action.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/print-action/print-action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,oCAAoC,CAAC;AAC1E,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,uBAAuB,CACtC,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB"}

package/build/ts/surfaces/admin/api/print-action/print-action.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"print-action.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/print-action/print-action.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"print-action.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/print-action/print-action.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts

@@ -1,41 +1,77 @@
 import type { BlockExtensionApi } from '../block/block';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import type { Data } from '../shared';
+/**
+ * A product configuration.
+ * @deprecated
+ */
 interface Product {
+    /** The product's unique global identifier (GID). */
     id: string;
+    /** The product's display name shown to merchants and customers. */
     title: string;
+    /** The URL-friendly unique identifier used in product URLs (for example, `'blue-t-shirt'`). */
     handle: string;
+    /** The publication status indicating whether the product is active (published), archived (discontinued), or draft (unpublished). */
     status: 'ACTIVE' | 'ARCHIVED' | 'DRAFT';
+    /** The total number of variants this product has. */
     totalVariants: number;
+    /** The total available inventory summed across all variants and locations. */
     totalInventory: number;
+    /** Whether the product has only the default variant with no custom options. When `true`, the product has no size, color, or other option variations. */
     hasOnlyDefaultVariant: boolean;
+    /** The URL to view this product on the online store. Use this to create "View in store" links. */
     onlineStoreUrl?: string;
+    /** Product options that define how variants differ (for example, Size, Color, Material). Each option has an ID, name, position, and array of possible values. */
     options: {
         id: string;
         name: string;
         position: number;
         values: string[];
     }[];
+    /** The product category or type used for organization (for example, "T-Shirt", "Shoes"). */
     productType: string;
+    /** The standardized product category taxonomy. Use this for product classification in search and organization. */
     productCategory?: string;
+    /** An array of component products that make up this bundle. Each component represents a product included in the bundle configuration. */
     productComponents: ProductComponent[];
 }
+/**
+ * A component product that is part of a bundle. Represents an individual product included in a bundle configuration.
+ * @deprecated
+ */
 export interface ProductComponent {
+    /** The component product's unique global identifier (GID). */
     id: string;
+    /** The product's display name. Use this to show which product is included in the bundle. */
     title: string;
+    /** The featured image displayed for this component product with ID, URL, and alt text properties. Use this for showing component previews in bundle configuration interfaces. */
     featuredImage?: {
         id?: string | null;
         url?: string | null;
         altText?: string | null;
     } | null;
+    /** The total number of variants this component product has. Use this to determine if variant selection is needed for this component. */
     totalVariants: number;
+    /** The admin URL for this component product. Use this to create links to the product's details page in the admin. */
     productUrl: string;
+    /** The count of variants from this product that are used as bundle components. Use this to understand how many variants are configured in bundles. */
     componentVariantsCount: number;
+    /** The count of variants from this product that aren't used in any bundles. Use this to identify available variants for adding to bundle configurations. */
     nonComponentVariantsCount: number;
 }
+/**
+ * The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.
+ */
 export interface ProductDetailsConfigurationApi<ExtensionTarget extends AnyExtensionTarget> extends BlockExtensionApi<ExtensionTarget> {
+    /** Product configuration data including the current product, selected items, and app URLs. Use this to access the product being configured and build your configuration interface. */
     data: Data & {
+        /**
+         * The product currently being viewed in the admin.
+         * @deprecated
+         */
         product: Product;
+        /** URLs for launching and navigating to your app, including the launch URL and base application URL. Use these to create links or redirect merchants to your app. */
         app: {
             launchUrl: string;
             applicationUrl: string;

package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"product-details-configuration.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/product-configuration/product-details-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAGpC,UAAU,OAAO;IACf,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IACxC,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,qBAAqB,EAAE,OAAO,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;KAClB,EAAE,CAAC;IACJ,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACvC;AAGD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE;QACd,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB,GAAG,IAAI,CAAC;IACT,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,8BAA8B,CAC7C,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,iBAAiB,CAAC,eAAe,CAAC;IAC1C,IAAI,EAAE,IAAI,GAAG;QAKX,OAAO,EAAE,OAAO,CAAC;QACjB,GAAG,EAAE;YACH,SAAS,EAAE,MAAM,CAAC;YAClB,cAAc,EAAE,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH"}
+{"version":3,"file":"product-details-configuration.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/product-configuration/product-details-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAEpC;;;GAGG;AACH,UAAU,OAAO;IACf,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC;IACd,+FAA+F;IAC/F,MAAM,EAAE,MAAM,CAAC;IACf,oIAAoI;IACpI,MAAM,EAAE,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;IACxC,qDAAqD;IACrD,aAAa,EAAE,MAAM,CAAC;IACtB,8EAA8E;IAC9E,cAAc,EAAE,MAAM,CAAC;IACvB,wJAAwJ;IACxJ,qBAAqB,EAAE,OAAO,CAAC;IAC/B,kGAAkG;IAClG,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iKAAiK;IACjK,OAAO,EAAE;QACP,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,EAAE,CAAC;KAClB,EAAE,CAAC;IACJ,4FAA4F;IAC5F,WAAW,EAAE,MAAM,CAAC;IACpB,kHAAkH;IAClH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yIAAyI;IACzI,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACvC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,EAAE,EAAE,MAAM,CAAC;IACX,4FAA4F;IAC5F,KAAK,EAAE,MAAM,CAAC;IACd,iLAAiL;IACjL,aAAa,CAAC,EAAE;QACd,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACnB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACzB,GAAG,IAAI,CAAC;IACT,wIAAwI;IACxI,aAAa,EAAE,MAAM,CAAC;IACtB,qHAAqH;IACrH,UAAU,EAAE,MAAM,CAAC;IACnB,sJAAsJ;IACtJ,sBAAsB,EAAE,MAAM,CAAC;IAC/B,4JAA4J;IAC5J,yBAAyB,EAAE,MAAM,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B,CAC7C,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,iBAAiB,CAAC,eAAe,CAAC;IAC1C,sLAAsL;IACtL,IAAI,EAAE,IAAI,GAAG;QACX;;;WAGG;QACH,OAAO,EAAE,OAAO,CAAC;QACjB,qKAAqK;QACrK,GAAG,EAAE;YACH,SAAS,EAAE,MAAM,CAAC;YAClB,cAAc,EAAE,MAAM,CAAC;SACxB,CAAC;KACH,CAAC;CACH"}

package/build/ts/surfaces/admin/api/product-configuration/product-details-configuration.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"product-details-configuration.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/product-configuration/product-details-configuration.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAgBX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"product-details-configuration.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/product-configuration/product-details-configuration.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAsFX,CAAC;AAEF,eAAe,IAAI,CAAC"}