@shopify/ui-extensions 2026.10.0-rc.1 → 2026.10.0-rc.10

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

@@ -6,8 +6,14 @@ var api = require('./api.js');
 var subscription = require('./subscription.js');
 
 /**
- * Returns the market of the checkout, and automatically re-renders
- * your component if it changes.
+ * Returns the market of the checkout, carried over from the cart context.
+ * In cases where multiple markets match, this returns the most narrowly
+ * scoped country region market. Automatically re-renders your component
+ * if it changes.
+ *
+ * > Caution: This hook is deprecated and will be removed in a future version of the API.
+ *
+ * @deprecated This hook will be removed in a future version of the API.
  * @publicDocs
  */
 function useLocalizationMarket() {

package/build/cjs/surfaces/customer-account/preact/market.js

@@ -7,8 +7,14 @@ var subscription = require('./subscription.js');
 var errors = require('./errors.js');
 
 /**
- * Returns the market of the checkout, and automatically re-renders
- * your component if it changes.
+ * Returns the market associated with the order, carried over from the cart
+ * context. In cases where multiple markets match, this returns the most
+ * narrowly scoped country region market. Automatically re-renders your
+ * component if it changes.
+ *
+ * > Caution: This hook is deprecated and will be removed in a future version of the API.
+ *
+ * @deprecated This hook will be removed in a future version of the API.
  */
 function useLocalizationMarket() {
   const api$1 = api.useApi();

package/build/cjs/surfaces/point-of-sale/events.js

@@ -11,7 +11,19 @@ Object.defineProperty(exports, '__esModule', { value: true });
 const POS_EVENT_NAMES = {
   TRANSACTION_COMPLETE: 'transactioncomplete',
   CASH_TRACKING_SESSION_START: 'cashtrackingsessionstart',
-  CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete'
+  CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete',
+  SCAN: 'scan'
+};
+
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+const POS_INTERCEPT_NAMES = {
+  CART_VALIDATIONS: 'cartvalidations',
+  PAYMENT_VALIDATIONS: 'paymentvalidations'
 };
 
 /**
@@ -23,4 +35,120 @@ const POS_EVENT_NAMES = {
  * @publicDocs
  */
 
+/**
+ * Maps POS interceptable workflow names to their corresponding `Event` types.
+ *
+ * Used as the generic type parameter for `shopify.intercept`.
+ *
+ * @private
+ */
+
+/**
+ * The data carried by a `cartvalidations` event.
+ *
+ * @private
+ */
+
+/**
+ * The event a `cartvalidations` interceptor receives. Carries a snapshot of
+ * the POS cart taken when the event was produced.
+ *
+ * @private
+ */
+
+/**
+ * The kind of payment method being attempted.
+ *
+ * @private
+ */
+
+/**
+ * Identifies the payment method being attempted.
+ *
+ * `type` alone identifies singleton methods (for example `cash`). `identifier`
+ * disambiguates method types a shop can have several of (for example custom
+ * payment methods) as they become interceptable.
+ *
+ * @private
+ */
+
+/**
+ * The event a `paymentvalidations` interceptor receives. Carries the tender
+ * attempt's payment method and amount; split payments produce one event per
+ * tender, each with its own amount.
+ *
+ * @private
+ */
+
+/**
+ * The data carried by a `paymentvalidations` event.
+ *
+ * @private
+ */
+
+/**
+ * Targets the whole cart rather than a specific line item.
+ *
+ * @private
+ */
+
+/**
+ * Targets one cart line item by its `uuid` from this event's `cart` snapshot,
+ * for example `$.cart.lineItems['adfd6b06-4a24-4f5f-9f4b-ea21f4432dd4']`.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Targets the payment attempt being intercepted.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Where a validation applies, as an enumerated token. Targets are matched
+ * as exact strings, never evaluated as JSON paths.
+ *
+ * @private
+ */
+
+/**
+ * Maps POS interceptable workflow names to their valid validation targets.
+ *
+ * @private
+ */
+
+/**
+ * The interceptor callback for a POS interceptable workflow, keyed by the
+ * workflow name so the event and its valid validation targets stay paired.
+ *
+ * @private
+ */
+
+/**
+ * The result an interceptor returns. An empty `operations` list allows the
+ * workflow; an `ERROR` validation blocks it.
+ *
+ * @private
+ */
+
+/**
+ * A single host operation produced by an interceptor.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Adds a validation to the workflow being intercepted.
+ *
+ * @private
+ */
+
 exports.POS_EVENT_NAMES = POS_EVENT_NAMES;
+exports.POS_INTERCEPT_NAMES = POS_INTERCEPT_NAMES;

package/build/cjs/surfaces/point-of-sale/types/storage.js

@@ -17,4 +17,15 @@ class StorageError extends Error {
  * @publicDocs
  */
 
+/**
+ * Provides reactive, subscribable access to individual storage keys.
+ *
+ * Each property is a `ReadonlySignalLike` that reflects the current value of the
+ * corresponding storage key. Values are `undefined` when the key does not exist
+ * or is being loaded asynchronously.
+ *
+ * Mutations are performed through the existing `Storage` methods (`set`,
+ * `delete`, `clear`, etc.) — `SubscribableStorage` is read-only and reactive.
+ */
+
 exports.StorageError = StorageError;

package/build/cjs/surfaces/point-of-sale.js

@@ -8,4 +8,5 @@ var storage = require('./point-of-sale/types/storage.js');
 
 
 exports.POS_EVENT_NAMES = events.POS_EVENT_NAMES;
+exports.POS_INTERCEPT_NAMES = events.POS_INTERCEPT_NAMES;
 exports.StorageError = storage.StorageError;

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

@@ -2,8 +2,14 @@ import { useApi } from './api.mjs';
 import { useSubscription } from './subscription.mjs';
 
 /**
- * Returns the market of the checkout, and automatically re-renders
- * your component if it changes.
+ * Returns the market of the checkout, carried over from the cart context.
+ * In cases where multiple markets match, this returns the most narrowly
+ * scoped country region market. Automatically re-renders your component
+ * if it changes.
+ *
+ * > Caution: This hook is deprecated and will be removed in a future version of the API.
+ *
+ * @deprecated This hook will be removed in a future version of the API.
  * @publicDocs
  */
 function useLocalizationMarket() {

package/build/esm/surfaces/customer-account/preact/market.mjs

@@ -3,8 +3,14 @@ import { useSubscription } from './subscription.mjs';
 import { ExtensionHasNoFieldError } from './errors.mjs';
 
 /**
- * Returns the market of the checkout, and automatically re-renders
- * your component if it changes.
+ * Returns the market associated with the order, carried over from the cart
+ * context. In cases where multiple markets match, this returns the most
+ * narrowly scoped country region market. Automatically re-renders your
+ * component if it changes.
+ *
+ * > Caution: This hook is deprecated and will be removed in a future version of the API.
+ *
+ * @deprecated This hook will be removed in a future version of the API.
  */
 function useLocalizationMarket() {
   const api = useApi();

package/build/esm/surfaces/point-of-sale/events.mjs

@@ -7,7 +7,19 @@
 const POS_EVENT_NAMES = {
   TRANSACTION_COMPLETE: 'transactioncomplete',
   CASH_TRACKING_SESSION_START: 'cashtrackingsessionstart',
-  CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete'
+  CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete',
+  SCAN: 'scan'
+};
+
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+const POS_INTERCEPT_NAMES = {
+  CART_VALIDATIONS: 'cartvalidations',
+  PAYMENT_VALIDATIONS: 'paymentvalidations'
 };
 
 /**
@@ -19,4 +31,119 @@ const POS_EVENT_NAMES = {
  * @publicDocs
  */
 
-export { POS_EVENT_NAMES };
+/**
+ * Maps POS interceptable workflow names to their corresponding `Event` types.
+ *
+ * Used as the generic type parameter for `shopify.intercept`.
+ *
+ * @private
+ */
+
+/**
+ * The data carried by a `cartvalidations` event.
+ *
+ * @private
+ */
+
+/**
+ * The event a `cartvalidations` interceptor receives. Carries a snapshot of
+ * the POS cart taken when the event was produced.
+ *
+ * @private
+ */
+
+/**
+ * The kind of payment method being attempted.
+ *
+ * @private
+ */
+
+/**
+ * Identifies the payment method being attempted.
+ *
+ * `type` alone identifies singleton methods (for example `cash`). `identifier`
+ * disambiguates method types a shop can have several of (for example custom
+ * payment methods) as they become interceptable.
+ *
+ * @private
+ */
+
+/**
+ * The event a `paymentvalidations` interceptor receives. Carries the tender
+ * attempt's payment method and amount; split payments produce one event per
+ * tender, each with its own amount.
+ *
+ * @private
+ */
+
+/**
+ * The data carried by a `paymentvalidations` event.
+ *
+ * @private
+ */
+
+/**
+ * Targets the whole cart rather than a specific line item.
+ *
+ * @private
+ */
+
+/**
+ * Targets one cart line item by its `uuid` from this event's `cart` snapshot,
+ * for example `$.cart.lineItems['adfd6b06-4a24-4f5f-9f4b-ea21f4432dd4']`.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Targets the payment attempt being intercepted.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Where a validation applies, as an enumerated token. Targets are matched
+ * as exact strings, never evaluated as JSON paths.
+ *
+ * @private
+ */
+
+/**
+ * Maps POS interceptable workflow names to their valid validation targets.
+ *
+ * @private
+ */
+
+/**
+ * The interceptor callback for a POS interceptable workflow, keyed by the
+ * workflow name so the event and its valid validation targets stay paired.
+ *
+ * @private
+ */
+
+/**
+ * The result an interceptor returns. An empty `operations` list allows the
+ * workflow; an `ERROR` validation blocks it.
+ *
+ * @private
+ */
+
+/**
+ * A single host operation produced by an interceptor.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Adds a validation to the workflow being intercepted.
+ *
+ * @private
+ */
+
+export { POS_EVENT_NAMES, POS_INTERCEPT_NAMES };

package/build/esm/surfaces/point-of-sale/types/storage.mjs

@@ -13,4 +13,15 @@ class StorageError extends Error {
  * @publicDocs
  */
 
+/**
+ * Provides reactive, subscribable access to individual storage keys.
+ *
+ * Each property is a `ReadonlySignalLike` that reflects the current value of the
+ * corresponding storage key. Values are `undefined` when the key does not exist
+ * or is being loaded asynchronously.
+ *
+ * Mutations are performed through the existing `Storage` methods (`set`,
+ * `delete`, `clear`, etc.) — `SubscribableStorage` is read-only and reactive.
+ */
+
 export { StorageError };

package/build/esm/surfaces/point-of-sale.mjs

@@ -1,2 +1,2 @@
-export { POS_EVENT_NAMES } from './point-of-sale/events.mjs';
+export { POS_EVENT_NAMES, POS_INTERCEPT_NAMES } from './point-of-sale/events.mjs';
 export { StorageError } from './point-of-sale/types/storage.mjs';

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

@@ -2,8 +2,14 @@ import { useApi } from './api.esnext';
 import { useSubscription } from './subscription.esnext';
 
 /**
- * Returns the market of the checkout, and automatically re-renders
- * your component if it changes.
+ * Returns the market of the checkout, carried over from the cart context.
+ * In cases where multiple markets match, this returns the most narrowly
+ * scoped country region market. Automatically re-renders your component
+ * if it changes.
+ *
+ * > Caution: This hook is deprecated and will be removed in a future version of the API.
+ *
+ * @deprecated This hook will be removed in a future version of the API.
  * @publicDocs
  */
 function useLocalizationMarket() {

package/build/esnext/surfaces/customer-account/preact/market.esnext

@@ -3,8 +3,14 @@ import { useSubscription } from './subscription.esnext';
 import { ExtensionHasNoFieldError } from './errors.esnext';
 
 /**
- * Returns the market of the checkout, and automatically re-renders
- * your component if it changes.
+ * Returns the market associated with the order, carried over from the cart
+ * context. In cases where multiple markets match, this returns the most
+ * narrowly scoped country region market. Automatically re-renders your
+ * component if it changes.
+ *
+ * > Caution: This hook is deprecated and will be removed in a future version of the API.
+ *
+ * @deprecated This hook will be removed in a future version of the API.
  */
 function useLocalizationMarket() {
   const api = useApi();

package/build/esnext/surfaces/point-of-sale/events.esnext

@@ -7,7 +7,19 @@
 const POS_EVENT_NAMES = {
   TRANSACTION_COMPLETE: 'transactioncomplete',
   CASH_TRACKING_SESSION_START: 'cashtrackingsessionstart',
-  CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete'
+  CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete',
+  SCAN: 'scan'
+};
+
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+const POS_INTERCEPT_NAMES = {
+  CART_VALIDATIONS: 'cartvalidations',
+  PAYMENT_VALIDATIONS: 'paymentvalidations'
 };
 
 /**
@@ -19,4 +31,119 @@ const POS_EVENT_NAMES = {
  * @publicDocs
  */
 
-export { POS_EVENT_NAMES };
+/**
+ * Maps POS interceptable workflow names to their corresponding `Event` types.
+ *
+ * Used as the generic type parameter for `shopify.intercept`.
+ *
+ * @private
+ */
+
+/**
+ * The data carried by a `cartvalidations` event.
+ *
+ * @private
+ */
+
+/**
+ * The event a `cartvalidations` interceptor receives. Carries a snapshot of
+ * the POS cart taken when the event was produced.
+ *
+ * @private
+ */
+
+/**
+ * The kind of payment method being attempted.
+ *
+ * @private
+ */
+
+/**
+ * Identifies the payment method being attempted.
+ *
+ * `type` alone identifies singleton methods (for example `cash`). `identifier`
+ * disambiguates method types a shop can have several of (for example custom
+ * payment methods) as they become interceptable.
+ *
+ * @private
+ */
+
+/**
+ * The event a `paymentvalidations` interceptor receives. Carries the tender
+ * attempt's payment method and amount; split payments produce one event per
+ * tender, each with its own amount.
+ *
+ * @private
+ */
+
+/**
+ * The data carried by a `paymentvalidations` event.
+ *
+ * @private
+ */
+
+/**
+ * Targets the whole cart rather than a specific line item.
+ *
+ * @private
+ */
+
+/**
+ * Targets one cart line item by its `uuid` from this event's `cart` snapshot,
+ * for example `$.cart.lineItems['adfd6b06-4a24-4f5f-9f4b-ea21f4432dd4']`.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Targets the payment attempt being intercepted.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Where a validation applies, as an enumerated token. Targets are matched
+ * as exact strings, never evaluated as JSON paths.
+ *
+ * @private
+ */
+
+/**
+ * Maps POS interceptable workflow names to their valid validation targets.
+ *
+ * @private
+ */
+
+/**
+ * The interceptor callback for a POS interceptable workflow, keyed by the
+ * workflow name so the event and its valid validation targets stay paired.
+ *
+ * @private
+ */
+
+/**
+ * The result an interceptor returns. An empty `operations` list allows the
+ * workflow; an `ERROR` validation blocks it.
+ *
+ * @private
+ */
+
+/**
+ * A single host operation produced by an interceptor.
+ *
+ * @private
+ */
+
+/** @private */
+
+/**
+ * Adds a validation to the workflow being intercepted.
+ *
+ * @private
+ */
+
+export { POS_EVENT_NAMES, POS_INTERCEPT_NAMES };

package/build/esnext/surfaces/point-of-sale/types/storage.esnext

@@ -13,4 +13,15 @@ class StorageError extends Error {
  * @publicDocs
  */
 
+/**
+ * Provides reactive, subscribable access to individual storage keys.
+ *
+ * Each property is a `ReadonlySignalLike` that reflects the current value of the
+ * corresponding storage key. Values are `undefined` when the key does not exist
+ * or is being loaded asynchronously.
+ *
+ * Mutations are performed through the existing `Storage` methods (`set`,
+ * `delete`, `clear`, etc.) — `SubscribableStorage` is read-only and reactive.
+ */
+
 export { StorageError };

package/build/esnext/surfaces/point-of-sale.esnext

@@ -1,2 +1,2 @@
-export { POS_EVENT_NAMES } from './point-of-sale/events.esnext';
+export { POS_EVENT_NAMES, POS_INTERCEPT_NAMES } from './point-of-sale/events.esnext';
 export { StorageError } from './point-of-sale/types/storage.esnext';