@shopify/ui-extensions 2025.10.13 → 2025.10.15

package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts

@@ -1,25 +1,57 @@
 import { SupportedDefinitionType } from '../shared';
+/**
+ * A metafield update or creation operation. Use this to set or modify metafield values that store validation function 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, `'min_quantity'` or `'shipping_restriction'`). */
     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 validation 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;
 }
+/**
+ * A metafield change operation that can either update or remove a metafield. Pass this to `applyMetafieldChange` to modify validation settings stored in metafields.
+ */
 type MetafieldChange = MetafieldUpdateChange | MetafieldRemoveChange;
+/**
+ * A failed metafield change operation result. Use the error message to understand what went wrong and fix the issue, such as validation errors, permission problems, or invalid metafield types.
+ */
 interface MetafieldChangeResultError {
+    /** Indicates the operation failed. Check this value to determine if you need to handle an error. */
     type: 'error';
+    /** A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants. */
     message: string;
 }
+/**
+ * A successful metafield change operation result. The metafield was updated or removed as requested and the changes are now saved.
+ */
 interface MetafieldChangeSuccess {
+    /** Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully. */
     type: 'success';
 }
+/**
+ * The result returned after attempting to change a metafield. Check the `type` property to determine if the operation succeeded (`'success'`) or failed (`'error'`), then handle the result appropriately in your extension.
+ */
 type MetafieldChangeResult = MetafieldChangeSuccess | MetafieldChangeResultError;
+/**
+ * A function that applies metafield changes to validation settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.
+ */
 export type ApplyMetafieldChange = (change: MetafieldChange) => Promise<MetafieldChangeResult>;
 export {};
 //# sourceMappingURL=metafields.d.ts.map

package/build/ts/surfaces/admin/api/checkout-rules/metafields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metafields.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/checkout-rules/metafields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,WAAW,CAAC;AAElD,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,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;AACrE,UAAU,0BAA0B;IAClC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,UAAU,sBAAsB;IAC9B,IAAI,EAAE,SAAS,CAAC;CACjB;AACD,KAAK,qBAAqB,GACtB,sBAAsB,GACtB,0BAA0B,CAAC;AAE/B,MAAM,MAAM,oBAAoB,GAAG,CACjC,MAAM,EAAE,eAAe,KACpB,OAAO,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"metafields.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/checkout-rules/metafields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,WAAW,CAAC;AAElD;;GAEG;AACH,UAAU,qBAAqB;IAC7B,6FAA6F;IAC7F,IAAI,EAAE,iBAAiB,CAAC;IACxB,2LAA2L;IAC3L,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,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;AAErE;;GAEG;AACH,UAAU,0BAA0B;IAClC,oGAAoG;IACpG,IAAI,EAAE,OAAO,CAAC;IACd,qIAAqI;IACrI,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,UAAU,sBAAsB;IAC9B,wHAAwH;IACxH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;GAEG;AACH,KAAK,qBAAqB,GACtB,sBAAsB,GACtB,0BAA0B,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,MAAM,EAAE,eAAe,KACpB,OAAO,CAAC,qBAAqB,CAAC,CAAC"}

package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts

@@ -2,11 +2,15 @@ import type { StandardApi } from '../standard/standard';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import { ApplyMetafieldChange } from './metafields';
 import { ValidationData } from './launch-options';
+/**
+ * The `ValidationSettingsApi` object provides methods for configuring cart and checkout validation functions. Access the following properties on the `ValidationSettingsApi` object to manage validation settings and metafields.
+ */
 export interface ValidationSettingsApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
     /**
-     * Applies a change to the validation settings.
+     * Updates or removes [metafields](/docs/apps/build/metafields) that store validation function configuration. Use this to save merchant settings for your validation function.
      */
     applyMetafieldChange: ApplyMetafieldChange;
+    /** The validation being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */
     data: ValidationData;
 }
 //# sourceMappingURL=validation-settings.d.ts.map

package/build/ts/surfaces/admin/api/checkout-rules/validation-settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation-settings.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/checkout-rules/validation-settings.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,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAEhD,MAAM,WAAW,qBAAqB,CACpC,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,IAAI,EAAE,cAAc,CAAC;CACtB"}
+{"version":3,"file":"validation-settings.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/checkout-rules/validation-settings.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,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,qBAAqB,CACpC,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,8HAA8H;IAC9H,IAAI,EAAE,cAAc,CAAC;CACtB"}

package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts

@@ -1,38 +1,51 @@
 import type { StandardApi } from '../standard/standard';
 import type { I18n } from '../../../../api';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
+/**
+ * The `CustomerSegmentTemplateApi` object provides methods for creating customer segment templates. Access the following properties on the `CustomerSegmentTemplateApi` object to build templates with translated content.
+ * @publicDocs
+ */
 export interface CustomerSegmentTemplateApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
+    /** Utilities for translating template content into the merchant's language. */
     i18n: I18n;
     /** @private */
     __enabledFeatures: string[];
 }
+/**
+ * Standard customer metafields that can be referenced as template dependencies.
+ */
 export type CustomerStandardMetafieldDependency = 'facts.birth_date';
+/**
+ * Defines a customer segment template that merchants can use to create targeted customer groups.
+ */
 export interface CustomerSegmentTemplate {
     /**
-     * The localized title of the template.
+     * The template title in the merchant's language.
      */
     title: string;
     /**
-     * The localized description of the template. An array can be used for multiple paragraphs.
+     * The template description in the merchant's language. Use an array for multiple paragraphs.
      */
     description: string | string[];
     /**
-     * The code snippet to render in the template with syntax highlighting. The `query` is not validated in the template.
+     * The segment query code to display in the template with syntax highlighting. This code is shown to merchants but not validated. Test your queries in the Shopify admin segment editor before including them in templates.
      */
     query: string;
     /**
-     * The code snippet to insert in the segment editor. If missing, `query` will be used. The `queryToInsert` is not validated in the template.
+     * The segment query code to insert when the merchant selects this template. If omitted, the `query` value is used instead. This code is inserted into the editor but not validated. Test your queries in the Shopify admin segment editor before including them in templates.
      */
     queryToInsert: string;
     /**
-     * The list of customer standard metafields or custom metafields used in the template's query.
+     * Customer metafields required by this template's query. Declare dependencies so the admin can guide merchants to set up required metafields before using the template.
      */
     dependencies?: {
+        /** Standard Shopify customer metafields used in the query. */
         standardMetafields?: CustomerStandardMetafieldDependency[];
+        /** Custom [metafield](/docs/apps/build/metafields) definitions used in the query. */
         customMetafields?: string[];
     };
     /**
-     * ISO 8601-encoded date and time string. A "New" badge will be rendered for templates introduced in the last month.
+     * The creation date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Templates created within the last month display a "New" badge.
      */
     createdOn: string;
 }

package/build/ts/surfaces/admin/api/customer-segment-template/customer-segment-template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customer-segment-template.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,MAAM,WAAW,0BAA0B,CACzC,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,WAAW,CAAC,eAAe,CAAC;IAEpC,IAAI,EAAE,IAAI,CAAC;IACX,eAAe;IACf,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,MAAM,mCAAmC,GAAG,kBAAkB,CAAC;AACrE,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,kBAAkB,CAAC,EAAE,mCAAmC,EAAE,CAAC;QAC3D,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"customer-segment-template.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF;;;GAGG;AACH,MAAM,WAAW,0BAA0B,CACzC,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC,+EAA+E;IAC/E,IAAI,EAAE,IAAI,CAAC;IACX,eAAe;IACf,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,kBAAkB,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,8DAA8D;QAC9D,kBAAkB,CAAC,EAAE,mCAAmC,EAAE,CAAC;QAC3D,qFAAqF;QACrF,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts

@@ -2,11 +2,15 @@ import type { BlockExtensionApi } from '../block/block';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import { ApplyMetafieldChange } from './metafields';
 import { DiscountFunctionSettingsData } from './launch-options';
+/**
+ * The `DiscountFunctionSettingsApi` object provides methods for configuring discount functions. Access the following properties on the `DiscountFunctionSettingsApi` object to manage function settings and metafields.
+ */
 export interface DiscountFunctionSettingsApi<ExtensionTarget extends AnyExtensionTarget> extends Omit<BlockExtensionApi<ExtensionTarget>, 'data'> {
     /**
-     * Applies a change to the discount function settings.
+     * Updates or removes [metafields](/docs/apps/build/metafields) that store discount function configuration. Use this to save merchant settings for your discount function.
      */
     applyMetafieldChange: ApplyMetafieldChange;
+    /** The discount being configured and its associated [metafields](/docs/apps/build/metafields) storing function settings. */
     data: DiscountFunctionSettingsData;
 }
 //# sourceMappingURL=discount-function-settings.d.ts.map

package/build/ts/surfaces/admin/api/discount-function-settings/discount-function-settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"discount-function-settings.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,OAAO,EAAC,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,4BAA4B,EAAC,MAAM,kBAAkB,CAAC;AAE9D,MAAM,WAAW,2BAA2B,CAC1C,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACxD;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,IAAI,EAAE,4BAA4B,CAAC;CACpC"}
+{"version":3,"file":"discount-function-settings.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/discount-function-settings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,OAAO,EAAC,oBAAoB,EAAC,MAAM,cAAc,CAAC;AAClD,OAAO,EAAC,4BAA4B,EAAC,MAAM,kBAAkB,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAC1C,eAAe,SAAS,kBAAkB,CAC1C,SAAQ,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IACxD;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,4HAA4H;IAC5H,IAAI,EAAE,4BAA4B,CAAC;CACpC"}

package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts

@@ -1,27 +1,45 @@
+/**
+ * A [metafield](/docs/apps/build/metafields) that stores discount function configuration data. Use metafields to persist settings that control how your discount function behaves, such as discount thresholds, eligibility rules, or custom discount logic parameters.
+ */
 interface Metafield {
+    /** A human-readable description explaining the metafield's purpose and how it affects discount behavior. Use this to document your settings for other developers. */
     description?: string;
+    /** The unique global identifier (GID) for this metafield. Use this ID to reference the metafield in GraphQL queries or updates. */
     id: string;
+    /** The namespace that organizes related metafields together. All metafields for a discount should use a consistent namespace to group related settings. */
     namespace: string;
+    /** The unique key identifying this metafield within its namespace. This key determines how you access the metafield value (for example, `'min_purchase_amount'` or `'eligible_customer_tags'`). */
     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;
+    /** 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: string;
 }
+/**
+ * The discount class that determines where the discount applies in the purchase flow. Use this to understand what type of discount the merchant is configuring (product-level, order-level, or shipping).
+ */
 export declare enum DiscountClass {
+    /** The discount applies to specific products or product variants. Use this for discounts that reduce the price of individual line items (for example, "20% off selected products"). */
     Product = "PRODUCT",
+    /** The discount applies to the entire order total. Use this for cart-wide discounts that reduce the subtotal (for example, "$10 off orders over $50"). */
     Order = "ORDER",
+    /** The discount applies to shipping costs. Use this for free shipping or reduced shipping rate discounts (for example, "Free shipping on orders over $100"). */
     Shipping = "SHIPPING"
 }
+/**
+ * A discount that is being configured by the merchant. Use this to access the discount's unique identifier when saving configuration changes or making GraphQL queries.
+ */
 interface Discount {
-    /**
-     * the discount's gid
-     */
+    /** The discount's unique global identifier (GID) in the [GraphQL Admin API](/docs/api/admin-graphql) format (for example, `gid://shopify/DiscountAutomaticApp/123`). Use this ID to associate settings with the correct discount or query discount data. */
     id: string;
 }
 /**
- * The object that exposes the validation with its settings.
+ * The `data` object exposed to discount function settings extensions in the `admin.discount-details.function-settings.render` target. Use this to access the current discount configuration and populate your settings interface with existing values.
  */
 export interface DiscountFunctionSettingsData {
+    /** The discount being configured by the merchant. Use this ID to associate configuration changes with the correct discount. */
     id: Discount;
+    /** An array of [metafields](/docs/apps/build/metafields) that store the discount function's configuration values. Use these metafields to populate your settings UI with the current discount configuration and display existing settings to merchants. */
     metafields: Metafield[];
 }
 export {};

package/build/ts/surfaces/admin/api/discount-function-settings/launch-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"launch-options.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/launch-options.ts"],"names":[],"mappings":"AAAA,UAAU,SAAS;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,oBAAY,aAAa;IACvB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,QAAQ,aAAa;CACtB;AAED,UAAU,QAAQ;IAChB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,QAAQ,CAAC;IACb,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB"}
+{"version":3,"file":"launch-options.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/launch-options.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,SAAS;IACjB,qKAAqK;IACrK,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mIAAmI;IACnI,EAAE,EAAE,MAAM,CAAC;IACX,2JAA2J;IAC3J,SAAS,EAAE,MAAM,CAAC;IAClB,mMAAmM;IACnM,GAAG,EAAE,MAAM,CAAC;IACZ,8HAA8H;IAC9H,KAAK,EAAE,MAAM,CAAC;IACd,sMAAsM;IACtM,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,uLAAuL;IACvL,OAAO,YAAY;IACnB,0JAA0J;IAC1J,KAAK,UAAU;IACf,gKAAgK;IAChK,QAAQ,aAAa;CACtB;AAED;;GAEG;AACH,UAAU,QAAQ;IAChB,4PAA4P;IAC5P,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,+HAA+H;IAC/H,EAAE,EAAE,QAAQ,CAAC;IACb,2PAA2P;IAC3P,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB"}

package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts

@@ -1,25 +1,57 @@
 import { SupportedDefinitionType } from '../shared';
+/**
+ * A metafield update or creation operation. Use this to set or modify metafield values that store discount function 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, `'min_purchase_amount'` or `'eligible_customer_tags'`). */
     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 discount 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;
 }
+/**
+ * A metafield change operation that can either update or remove a metafield. Pass this to `applyMetafieldChange` to modify discount settings stored in metafields.
+ */
 type MetafieldChange = MetafieldUpdateChange | MetafieldRemoveChange;
+/**
+ * A failed metafield change operation result. Use the error message to understand what went wrong and fix the issue, such as validation errors, permission problems, or invalid metafield types.
+ */
 interface MetafieldChangeResultError {
+    /** Indicates the operation failed. Check this value to determine if you need to handle an error. */
     type: 'error';
+    /** A human-readable error message explaining why the operation failed. Use this to debug issues or display feedback to merchants. */
     message: string;
 }
+/**
+ * A successful metafield change operation result. The metafield was updated or removed as requested and the changes are now saved.
+ */
 interface MetafieldChangeSuccess {
+    /** Indicates the operation succeeded. When this value is `'success'`, the metafield change was applied successfully. */
     type: 'success';
 }
+/**
+ * The result returned after attempting to change a metafield. Check the `type` property to determine if the operation succeeded (`'success'`) or failed (`'error'`), then handle the result appropriately in your extension.
+ */
 type MetafieldChangeResult = MetafieldChangeSuccess | MetafieldChangeResultError;
+/**
+ * A function that applies metafield changes to discount function settings. Call this function with an update or removal operation, then await the Promise to receive a result indicating success or failure. Use the result to provide feedback or handle errors in your settings interface.
+ */
 export type ApplyMetafieldChange = (change: MetafieldChange) => Promise<MetafieldChangeResult>;
 export {};
 //# sourceMappingURL=metafields.d.ts.map

package/build/ts/surfaces/admin/api/discount-function-settings/metafields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metafields.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/metafields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,WAAW,CAAC;AAElD,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,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;AACrE,UAAU,0BAA0B;IAClC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB;AACD,UAAU,sBAAsB;IAC9B,IAAI,EAAE,SAAS,CAAC;CACjB;AACD,KAAK,qBAAqB,GACtB,sBAAsB,GACtB,0BAA0B,CAAC;AAE/B,MAAM,MAAM,oBAAoB,GAAG,CACjC,MAAM,EAAE,eAAe,KACpB,OAAO,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"metafields.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/discount-function-settings/metafields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,WAAW,CAAC;AAElD;;GAEG;AACH,UAAU,qBAAqB;IAC7B,6FAA6F;IAC7F,IAAI,EAAE,iBAAiB,CAAC;IACxB,oMAAoM;IACpM,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,eAAe,GAAG,qBAAqB,GAAG,qBAAqB,CAAC;AAErE;;GAEG;AACH,UAAU,0BAA0B;IAClC,oGAAoG;IACpG,IAAI,EAAE,OAAO,CAAC;IACd,qIAAqI;IACrI,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,UAAU,sBAAsB;IAC9B,wHAAwH;IACxH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED;;GAEG;AACH,KAAK,qBAAqB,GACtB,sBAAsB,GACtB,0BAA0B,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CACjC,MAAM,EAAE,eAAe,KACpB,OAAO,CAAC,qBAAqB,CAAC,CAAC"}

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

@@ -1,99 +1,99 @@
 /**
- * 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.
+ * @publicDocs
  */
 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.
+ * @publicDocs
  */
 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.
+ * @publicDocs
  */
 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.
+ * @publicDocs
  */
 export type IntentResponse = SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse;
 /**
- * Activity handle for tracking intent workflow progress.
+ * A handle for tracking an in-progress intent workflow.
+ * @publicDocs
  */
 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
@@ -111,21 +111,22 @@ export interface IntentQuery extends IntentQueryOptions {
  * });
  * const response = await activity.complete;
  * ```
+ * @publicDocs
  */
 export interface IntentInvokeApi {
     (query: IntentQuery): Promise<IntentActivity>;
     (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;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,gIAAgI;IAChI,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;;GAGG;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;;;GAGG;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;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;;GAGG;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;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;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/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,14 @@ 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.
+ * @publicDocs
+ */
 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;;;GAGG;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"}