@shopify/ui-extensions 2026.1.0 → 2026.1.2

package/build/cjs/surfaces/checkout/preact/metafield.js

@@ -8,6 +8,7 @@ var metafields = require('./metafields.js');
 /**
  * Returns a single filtered `Metafield` or `undefined`.
  * @arg {MetafieldFilter} - filter the list of returned metafields to a single metafield
+ * @deprecated `useMetafield` is deprecated. Use `useAppMetafields` with cart metafields instead.
  */
 function useMetafield(filters) {
   const {

package/build/cjs/surfaces/checkout/preact/metafields.js

@@ -11,6 +11,7 @@ var subscription = require('./subscription.js');
  * Returns the current array of `metafields` applied to the checkout.
  * You can optionally filter the list.
  * @arg {MetafieldsFilters} - filter the list of returned metafields
+ * @deprecated `useMetafields` is deprecated. Use `useAppMetafields` with cart metafields instead.
  */
 function useMetafields(filters) {
   const metaFields = subscription.useSubscription(api.useApi().metafields);

package/build/esm/surfaces/checkout/preact/metafield.mjs

@@ -4,6 +4,7 @@ import { useMetafields } from './metafields.mjs';
 /**
  * Returns a single filtered `Metafield` or `undefined`.
  * @arg {MetafieldFilter} - filter the list of returned metafields to a single metafield
+ * @deprecated `useMetafield` is deprecated. Use `useAppMetafields` with cart metafields instead.
  */
 function useMetafield(filters) {
   const {

package/build/esm/surfaces/checkout/preact/metafields.mjs

@@ -7,6 +7,7 @@ import { useSubscription } from './subscription.mjs';
  * Returns the current array of `metafields` applied to the checkout.
  * You can optionally filter the list.
  * @arg {MetafieldsFilters} - filter the list of returned metafields
+ * @deprecated `useMetafields` is deprecated. Use `useAppMetafields` with cart metafields instead.
  */
 function useMetafields(filters) {
   const metaFields = useSubscription(useApi().metafields);

package/build/esnext/surfaces/checkout/preact/metafield.esnext

@@ -4,6 +4,7 @@ import { useMetafields } from './metafields.esnext';
 /**
  * Returns a single filtered `Metafield` or `undefined`.
  * @arg {MetafieldFilter} - filter the list of returned metafields to a single metafield
+ * @deprecated `useMetafield` is deprecated. Use `useAppMetafields` with cart metafields instead.
  */
 function useMetafield(filters) {
   const {

package/build/esnext/surfaces/checkout/preact/metafields.esnext

@@ -7,6 +7,7 @@ import { useSubscription } from './subscription.esnext';
  * Returns the current array of `metafields` applied to the checkout.
  * You can optionally filter the list.
  * @arg {MetafieldsFilters} - filter the list of returned metafields
+ * @deprecated `useMetafields` is deprecated. Use `useAppMetafields` with cart metafields instead.
  */
 function useMetafields(filters) {
   const metaFields = useSubscription(useApi().metafields);

package/build/ts/api.d.ts

@@ -1,60 +1,57 @@
 /**
- * This defines the i18n.translate() signature.
+ * The translation function signature for internationalization. Use this to translate string keys defined in your locale files into localized content for the current user's language.
  */
 export interface I18nTranslate {
     /**
-     * This returns a translated string matching a key in a locale file.
+     * Returns a translated string matching a key in a locale file. Use this to display localized text in your extension based on the merchant's language preferences. Supports interpolation with replacement values and pluralization with the `count` option. Returns a string when replacements are primitives, or an array when replacements include UI components.
+     *
+     * @param key - The translation key from your locale file (for example, "banner.title")
+     * @param options - Optional replacement values for interpolation or the special `count` property for pluralization
      *
      * @example translate("banner.title")
+     * @example translate("items.count", { count: 5 })
      */
     <ReplacementType = string>(key: string, options?: Record<string, ReplacementType | string | number>): ReplacementType extends string | number ? string : (string | ReplacementType)[];
 }
+/**
+ * Internationalization utilities for formatting and translating content according to the user's locale. Use these methods to display numbers, currency, dates, and translated strings that match the merchant's language and regional preferences.
+ */
 export interface I18n {
     /**
-     * Returns a localized number.
-     *
-     * This function behaves like the standard `Intl.NumberFormat()`
-     * with a style of `decimal` applied. It uses the buyer's locale by default.
+     * Returns a localized number formatted according to the user's locale. Use this to display numbers like quantities, percentages, or measurements in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `decimal` applied. Uses the current user's locale by default.
      *
-     * @param options.inExtensionLocale - if true, use the extension's locale
+     * @param number - The number to format
+     * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale
+     * @param options - Additional Intl.NumberFormatOptions for customizing the number format
      */
     formatNumber: (number: number | bigint, options?: {
         inExtensionLocale?: boolean;
     } & Intl.NumberFormatOptions) => string;
     /**
-     * Returns a localized currency value.
+     * Returns a localized currency value formatted according to the user's locale and currency conventions. Use this to display prices, totals, or financial amounts in the appropriate format for the merchant's region. This function behaves like the standard `Intl.NumberFormat()` with a style of `currency` applied. Uses the current user's locale by default.
      *
-     * This function behaves like the standard `Intl.NumberFormat()`
-     * with a style of `currency` applied. It uses the buyer's locale by default.
-     *
-     * @param options.inExtensionLocale - if true, use the extension's locale
+     * @param number - The currency amount to format
+     * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale
+     * @param options - Additional Intl.NumberFormatOptions for customizing the currency format, such as the currency code
      */
     formatCurrency: (number: number | bigint, options?: {
         inExtensionLocale?: boolean;
     } & Intl.NumberFormatOptions) => string;
     /**
-     * Returns a localized date value.
+     * Returns a localized date value formatted according to the user's locale and date conventions. Use this to display dates and times in the appropriate format for the merchant's region, such as order dates, timestamps, or schedule information. This function behaves like the standard `Intl.DateTimeFormat()` and uses the current user's locale by default. Formatting options can be passed to customize the date display style.
      *
-     * This function behaves like the standard `Intl.DateTimeFormatOptions()` and uses
-     * the buyer's locale by default. Formatting options can be passed in as
-     * options.
+     * @param date - The Date object to format
+     * @param options.inExtensionLocale - If true, use the extension's default locale instead of the user's locale
+     * @param options - Additional Intl.DateTimeFormatOptions for customizing the date format
      *
-     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat0
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat
      * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options
-     *
-     * @param options.inExtensionLocale - if true, use the extension's locale
      */
     formatDate: (date: Date, options?: {
         inExtensionLocale?: boolean;
     } & Intl.DateTimeFormatOptions) => string;
     /**
-     * Returns translated content in the buyer's locale,
-     * as supported by the extension.
-     *
-     * - `options.count` is a special numeric value used in pluralization.
-     * - The other option keys and values are treated as replacements for interpolation.
-     * - If the replacements are all primitives, then `translate()` returns a single string.
-     * - If replacements contain UI components, then `translate()` returns an array of elements.
+     * Returns translated content in the user's locale, as supported by the extension. Use this to display localized strings from your extension's locale files. The special `options.count` property enables pluralization. Other option keys and values are treated as replacements for interpolation in your translation strings. Returns a single string when replacements are primitives, or an array when replacements contain UI components.
      */
     translate: I18nTranslate;
 }

package/build/ts/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,CAAC,eAAe,GAAG,MAAM,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC,GAC1D,eAAe,SAAS,MAAM,GAAG,MAAM,GACtC,MAAM,GACN,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,IAAI;IACnB;;;;;;;OAOG;IACH,YAAY,EAAE,CACZ,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,OAAO,CAAC,EAAE;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAC,mBAAmB,KAC/D,MAAM,CAAC;IAEZ;;;;;;;OAOG;IACH,cAAc,EAAE,CACd,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,OAAO,CAAC,EAAE;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAC,mBAAmB,KAC/D,MAAM,CAAC;IAEZ;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,CACV,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAC,qBAAqB,KACjE,MAAM,CAAC;IAEZ;;;;;;;;OAQG;IACH,SAAS,EAAE,aAAa,CAAC;CAC1B"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/api.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;OAQG;IACH,CAAC,eAAe,GAAG,MAAM,EACvB,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC,GAC1D,eAAe,SAAS,MAAM,GAAG,MAAM,GACtC,MAAM,GACN,CAAC,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;;;;;OAMG;IACH,YAAY,EAAE,CACZ,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,OAAO,CAAC,EAAE;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAC,mBAAmB,KAC/D,MAAM,CAAC;IAEZ;;;;;;OAMG;IACH,cAAc,EAAE,CACd,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,OAAO,CAAC,EAAE;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAC,mBAAmB,KAC/D,MAAM,CAAC;IAEZ;;;;;;;;;OASG;IACH,UAAU,EAAE,CACV,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,IAAI,CAAC,qBAAqB,KACjE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,aAAa,CAAC;CAC1B"}

package/build/ts/extension.d.ts

@@ -1,10 +1,31 @@
+/**
+ * Defines the structure of a render extension, which displays UI in the Shopify admin.
+ */
 export interface RenderExtension<Api, ComponentsSet extends string> {
+    /**
+     * The API object providing access to extension capabilities, data, and methods. The specific API type depends on the extension target and determines what functionality is available to your extension, such as authentication, storage, data access, and GraphQL querying.
+     */
     api: Api;
+    /**
+     * The set of UI components available for rendering your extension. This defines which Polaris components and custom components can be used to build your extension's interface. The available components vary by extension target.
+     */
     components: ComponentsSet;
+    /**
+     * The render function output. Your extension's render function should return void or a Promise that resolves to void. Use this to perform any necessary setup, rendering, or async operations when your extension loads.
+     */
     output: void | Promise<void>;
 }
+/**
+ * Defines the structure of a runnable extension, which executes logic and returns data without rendering UI.
+ */
 export interface RunnableExtension<Api, Output> {
+    /**
+     * The API object providing access to extension capabilities and methods. The specific API type depends on the extension target and determines what functionality is available to your extension.
+     */
     api: Api;
+    /**
+     * The function output. Your extension function should return the expected output type or a Promise that resolves to that type. The output type is determined by your specific extension target and use case.
+     */
     output: Output | Promise<Output>;
 }
 //# sourceMappingURL=extension.d.ts.map

package/build/ts/extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../src/extension.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe,CAAC,GAAG,EAAE,aAAa,SAAS,MAAM;IAChE,GAAG,EAAE,GAAG,CAAC;IACT,UAAU,EAAE,aAAa,CAAC;IAC1B,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAC5C,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAClC"}
+{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../src/extension.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,GAAG,EAAE,aAAa,SAAS,MAAM;IAChE;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,GAAG,EAAE,MAAM;IAC5C;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAClC"}

package/build/ts/shared.d.ts

@@ -1,5 +1,5 @@
 /**
- * Union of supported API versions
+ * The supported GraphQL Admin API versions. Use this to specify which API version your GraphQL queries should execute against. Each version includes specific features, bug fixes, and breaking changes. The `unstable` version provides access to the latest features but may change without notice.
  */
 export type ApiVersion = '2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | '2025-01' | '2025-04' | 'unstable' | '2025-07' | '2025-10' | '2026-01';
 /**
@@ -99,7 +99,7 @@ interface ValidationError {
 }
 /**
  * A function that updates a signal and returns a result indicating success or failure.
- * The function is typically used alongisde a ReadonlySignalLike object.
+ * The function is typically used along with a `ReadonlySignalLike` object.
  */
 export type UpdateSignalFunction<T> = (value: T) => Result<T>;
 export {};

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

@@ -1,24 +1,17 @@
-import type { StandardApi } from '../standard/standard';
+import type { StandardRenderingExtensionApi } from '../standard/standard-rendering';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import type { Data } from '../shared';
-import type { ResourcePickerApi } from '../resource-picker/resource-picker';
-import type { PickerApi } from '../picker/picker';
-export interface ActionExtensionApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
+/**
+ * The `ActionExtensionApi` object provides methods for action extensions that render in modal overlays. Access the following properties on the `ActionExtensionApi` object to interact with the current context, control the modal, and display picker dialogs.
+ */
+export interface ActionExtensionApi<ExtensionTarget extends AnyExtensionTarget> extends StandardRenderingExtensionApi<ExtensionTarget> {
     /**
-     * Closes the extension. Calling this method is equivalent to the merchant clicking the "x" in the corner of the overlay.
+     * Closes the extension modal. Use this when your extension completes its task or the merchant wants to exit. Equivalent to clicking the close button in the overlay corner.
      */
     close: () => void;
     /**
-     * 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 in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.
      */
     data: Data;
-    /**
-     * Renders the [Resource Picker](resource-picker), allowing users to select a resource for the extension to use as part of its flow.
-     */
-    resourcePicker: ResourcePickerApi;
-    /**
-     * Renders a custom [Picker](picker) dialog allowing users to select values from a list.
-     */
-    picker: PickerApi;
 }
 //# sourceMappingURL=action.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/action/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,kBAAkB,CAAC,eAAe,SAAS,kBAAkB,CAC5E,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB"}
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/action/action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,6BAA6B,EAAC,MAAM,gCAAgC,CAAC;AAClF,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,eAAe,SAAS,kBAAkB,CAC5E,SAAQ,6BAA6B,CAAC,eAAe,CAAC;IACtD;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;CACZ"}

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

@@ -1 +1 @@
-{"version":3,"file":"action.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/action/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":"action.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/action/action.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAuFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

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

@@ -1,33 +1,29 @@
-import type { StandardApi } from '../standard/standard';
+import type { StandardRenderingExtensionApi } from '../standard/standard-rendering';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import type { Data } from '../shared';
-import type { ResourcePickerApi } from '../resource-picker/resource-picker';
-import type { PickerApi } from '../picker/picker';
+/**
+ * The `Navigation` object provides methods for navigating between extensions and admin pages.
+ */
 export interface Navigation {
     /**
-     * Navigate to a specific route.
+     * Navigates to a specific extension or admin route. Currently supports navigating from a block extension to an action extension on the same resource page.
      *
+     * @param url - The destination URL, typically in the format 'extension://extension-handle' for other extensions
      * @example navigation.navigate('extension://my-admin-action-extension-handle')
      */
     navigate: (url: string | URL) => void;
 }
-export interface BlockExtensionApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
+/**
+ * The `BlockExtensionApi` object provides methods for block extensions that render inline content on admin pages. Access the following properties on the `BlockExtensionApi` object to interact with the current context, navigate to other extensions, and display picker dialogs.
+ */
+export interface BlockExtensionApi<ExtensionTarget extends AnyExtensionTarget> extends StandardRenderingExtensionApi<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 in the current context, such as selected products in an index page or the product being viewed on a details page. The available IDs depend on the extension target and user interactions.
      */
     data: Data;
     /**
-     * Provides methods to navigate to other features in the Admin. Currently, only navigation from an admin block to an admin action extension *on the same resource page* is supported.
-     * For example, you can navigate from an admin block on the product details page (`admin.product-details.block.render`) to an admin action on the product details page (`admin.product-details.action.render`).
+     * Navigates to other extensions or admin pages. Currently supports navigation from a block to an action extension on the same resource page. For example, navigate from a product details block (`admin.product-details.block.render`) to a product details action (`admin.product-details.action.render`).
      */
     navigation: Navigation;
-    /**
-     * Renders the [Resource Picker](resource-picker), allowing users to select a resource for the extension to use as part of its flow.
-     */
-    resourcePicker: ResourcePickerApi;
-    /**
-     * Renders a custom [Picker](picker) dialog allowing users to select values from a list.
-     */
-    picker: PickerApi;
 }
 //# sourceMappingURL=block.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"block.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/block/block.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,UAAU;IACzB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,kBAAkB,CAC3E,SAAQ,WAAW,CAAC,eAAe,CAAC;IACpC;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAC;IAElC;;OAEG;IACH,MAAM,EAAE,SAAS,CAAC;CACnB"}
+{"version":3,"file":"block.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/block/block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,6BAA6B,EAAC,MAAM,gCAAgC,CAAC;AAClF,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,eAAe,SAAS,kBAAkB,CAC3E,SAAQ,6BAA6B,CAAC,eAAe,CAAC;IACtD;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;CACxB"}

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

@@ -1 +1 @@
-{"version":3,"file":"block.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/block/block.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":"block.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/block/block.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

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

@@ -1,32 +1,43 @@
+/**
+ * A [metafield](/docs/apps/build/metafields) that stores validation function configuration data. Use metafields to persist settings that control how your validation function behaves, such as minimum quantities, restricted shipping zones, or custom validation rules.
+ */
 interface Metafield {
+    /** A human-readable description explaining the metafield's purpose and how it affects validation 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 validation 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_quantity'` or `'blocked_countries'`). */
     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;
 }
+/**
+ * A validation configuration that exists and is active in the shop. Use this object to access the validation's current settings and metafields when merchants edit an existing validation.
+ */
 interface Validation {
-    /**
-     * the validation's gid when active in a shop
-     */
+    /** The validation's unique global identifier (GID). Use this ID to reference the validation in GraphQL operations or when saving updated settings. */
     id: string;
-    /**
-     * the metafields owned by the validation
-     */
+    /** An array of [metafields](/docs/apps/build/metafields) that store the validation's configuration values. Use these metafields to populate your settings UI with the current validation configuration. */
     metafields: Metafield[];
 }
+/**
+ * A [Shopify Function](/docs/apps/build/functions) that implements cart and checkout validation logic. This identifies which function the settings interface is configuring.
+ */
 interface ShopifyFunction {
-    /**
-     * the validation function's unique identifier
-     */
+    /** The [Shopify Function's](/docs/apps/build/functions) unique global identifier (GID). Use this ID to associate settings changes with the correct function. */
     id: string;
 }
 /**
- * The object that exposes the validation with its settings.
+ * The `data` object exposed to validation settings extensions in the `admin.settings.validation.render` target. Use this to access the current validation configuration and populate your settings interface with existing values.
  */
 export interface ValidationData {
+    /** The validation configuration containing the validation ID and metafields. Present when editing an existing validation, absent when creating a new validation. Use the presence of this value to determine if you're in create or edit mode. */
     validation?: Validation;
+    /** The [Shopify Function](/docs/apps/build/functions) that implements the validation logic. Use this ID to associate configuration changes with the correct function. */
     shopifyFunction: ShopifyFunction;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"launch-options.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/checkout-rules/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;AACD,UAAU,UAAU;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED,UAAU,eAAe;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,eAAe,EAAE,eAAe,CAAC;CAClC"}
+{"version":3,"file":"launch-options.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/checkout-rules/launch-options.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,SAAS;IACjB,uKAAuK;IACvK,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mIAAmI;IACnI,EAAE,EAAE,MAAM,CAAC;IACX,6JAA6J;IAC7J,SAAS,EAAE,MAAM,CAAC;IAClB,uLAAuL;IACvL,GAAG,EAAE,MAAM,CAAC;IACZ,8HAA8H;IAC9H,KAAK,EAAE,MAAM,CAAC;IACd,sMAAsM;IACtM,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,UAAU,UAAU;IAClB,sJAAsJ;IACtJ,EAAE,EAAE,MAAM,CAAC;IACX,2MAA2M;IAC3M,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,UAAU,eAAe;IACvB,gKAAgK;IAChK,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,kPAAkP;IAClP,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,yKAAyK;IACzK,eAAe,EAAE,eAAe,CAAC;CAClC"}

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

@@ -1,12 +1,16 @@
-import type { StandardApi } from '../standard/standard';
+import type { StandardRenderingExtensionApi } from '../standard/standard-rendering';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import { ApplyMetafieldChange } from './metafields';
 import { ValidationData } from './launch-options';
-export interface ValidationSettingsApi<ExtensionTarget extends AnyExtensionTarget> extends StandardApi<ExtensionTarget> {
+/**
+ * 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 StandardRenderingExtensionApi<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,6BAA6B,EAAC,MAAM,gCAAgC,CAAC;AAClF,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,6BAA6B,CAAC,eAAe,CAAC;IACtD;;OAEG;IACH,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,8HAA8H;IAC9H,IAAI,EAAE,cAAc,CAAC;CACtB"}

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

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

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

@@ -1,38 +1,50 @@
 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.
+ */
 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;;GAEG;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/customer-segment-template/customer-segment-template.doc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customer-segment-template.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/customer-segment-template/customer-segment-template.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":"customer-segment-template.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BAqFX,CAAC;AAEF,eAAe,IAAI,CAAC"}

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

@@ -2,12 +2,17 @@ import type { BlockExtensionApi } from '../block/block';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
 import { ApplyMetafieldChange } from './metafields';
 import { DiscountFunctionSettingsData, DiscountsApi } 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;
+    /** The `discounts` object provides reactive access to discount configuration, including discount classes and the discount method. Use the signals to read current values and the update functions to modify discount classes in your settings UI. These values automatically update when changed by the merchant or system. */
     discounts: DiscountsApi;
 }
 //# 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,EAAE,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAE5E,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;IACnC,SAAS,EAAE,YAAY,CAAC;CACzB"}
+{"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,EAAE,YAAY,EAAC,MAAM,kBAAkB,CAAC;AAE5E;;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;IACnC,+TAA+T;IAC/T,SAAS,EAAE,YAAY,CAAC;CACzB"}

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

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