@shopify/ui-extensions 2026.10.0-rc.2 → 2026.10.0-rc.3

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

@@ -14,6 +14,16 @@ const POS_EVENT_NAMES = {
   CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete'
 };
 
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+const POS_INTERCEPT_NAMES = {
+  BEFORE_CHECKOUT: 'beforecheckout'
+};
+
 /**
  * Maps Shopify POS event names to their corresponding payload types.
  *
@@ -23,4 +33,42 @@ 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
+ */
+
+/**
+ * Dispatched when staff attempts to leave the active cart for checkout.
+ *
+ * @private
+ */
+
+/** @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.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/point-of-sale/events.mjs

@@ -10,6 +10,16 @@ const POS_EVENT_NAMES = {
   CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete'
 };
 
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+const POS_INTERCEPT_NAMES = {
+  BEFORE_CHECKOUT: 'beforecheckout'
+};
+
 /**
  * Maps Shopify POS event names to their corresponding payload types.
  *
@@ -19,4 +29,41 @@ 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
+ */
+
+/**
+ * Dispatched when staff attempts to leave the active cart for checkout.
+ *
+ * @private
+ */
+
+/** @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.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/point-of-sale/events.esnext

@@ -10,6 +10,16 @@ const POS_EVENT_NAMES = {
   CASH_TRACKING_SESSION_COMPLETE: 'cashtrackingsessioncomplete'
 };
 
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+const POS_INTERCEPT_NAMES = {
+  BEFORE_CHECKOUT: 'beforecheckout'
+};
+
 /**
  * Maps Shopify POS event names to their corresponding payload types.
  *
@@ -19,4 +29,41 @@ 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
+ */
+
+/**
+ * Dispatched when staff attempts to leave the active cart for checkout.
+ *
+ * @private
+ */
+
+/** @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.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';

package/build/ts/surfaces/point-of-sale/events.d.ts

@@ -1,5 +1,6 @@
 import type { TransactionCompleteEvent } from './events/transaction-complete-event';
 import type { CashTrackingSessionStartEvent, CashTrackingSessionCompleteEvent } from './events/cash-tracking-session-events';
+import type { Cart } from './types/cart';
 /**
  * Canonical event-name constants for POS host events. Prefer these over string
  * literals when calling `shopify.addEventListener` / `removeEventListener`.
@@ -11,6 +12,15 @@ export declare const POS_EVENT_NAMES: {
     readonly CASH_TRACKING_SESSION_START: "cashtrackingsessionstart";
     readonly CASH_TRACKING_SESSION_COMPLETE: "cashtrackingsessioncomplete";
 };
+/**
+ * Canonical workflow-name constants for POS host interceptions. Prefer these
+ * over string literals when calling `shopify.intercept`.
+ *
+ * @private
+ */
+export declare const POS_INTERCEPT_NAMES: {
+    readonly BEFORE_CHECKOUT: "beforecheckout";
+};
 /**
  * Maps Shopify POS event names to their corresponding payload types.
  *
@@ -30,5 +40,59 @@ export interface ShopifyEventMap {
     /** Dispatched when a cash tracking session closes after reconciliation. */
     [POS_EVENT_NAMES.CASH_TRACKING_SESSION_COMPLETE]: CashTrackingSessionCompleteEvent;
 }
+/**
+ * Maps POS interceptable workflow names to their corresponding `Event` types.
+ *
+ * Used as the generic type parameter for `shopify.intercept`.
+ *
+ * @private
+ */
+export interface ShopifyInterceptMap {
+    [POS_INTERCEPT_NAMES.BEFORE_CHECKOUT]: BeforeCheckoutEvent;
+}
+/**
+ * Dispatched when staff attempts to leave the active cart for checkout.
+ *
+ * @private
+ */
+export interface BeforeCheckoutEvent extends Event {
+    readonly type: typeof POS_INTERCEPT_NAMES.BEFORE_CHECKOUT;
+    /** The POS cart at the point checkout was requested. */
+    readonly cart: Cart;
+}
+/** @private */
+export type ShopifyInterceptor<TEvent extends Event> = (event: TEvent) => InterceptResult;
+/**
+ * The result an interceptor returns. An empty `operations` list allows the
+ * workflow; an `ERROR` validation blocks it.
+ *
+ * @private
+ */
+export interface InterceptResult {
+    operations: Operation[];
+}
+/**
+ * A single host operation produced by an interceptor.
+ *
+ * @private
+ */
+export interface Operation {
+    validationAdd?: ValidationAdd;
+}
+/** @private */
+export type ValidationLevel = 'WARNING' | 'ERROR';
+/**
+ * Adds a validation to the workflow being intercepted.
+ *
+ * @private
+ */
+export interface ValidationAdd {
+    /** `ERROR` blocks the workflow. `WARNING` does not. */
+    level: ValidationLevel;
+    /** Stable identifier for this validation. */
+    handle: string;
+    /** JSON-path locator for where the validation applies. */
+    target?: string;
+}
 export type { TransactionCompleteEvent, CashTrackingSessionStartEvent, CashTrackingSessionCompleteEvent, };
 //# sourceMappingURL=events.d.ts.map

package/build/ts/surfaces/point-of-sale/events.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,wBAAwB,EAAC,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EACV,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,uCAAuC,CAAC;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,CAAC,eAAe,CAAC,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IACjE,qDAAqD;IACrD,CAAC,eAAe,CAAC,2BAA2B,CAAC,EAAE,6BAA6B,CAAC;IAC7E,2EAA2E;IAC3E,CAAC,eAAe,CAAC,8BAA8B,CAAC,EAAE,gCAAgC,CAAC;CACpF;AAED,YAAY,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,gCAAgC,GACjC,CAAC"}
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,wBAAwB,EAAC,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EACV,6BAA6B,EAC7B,gCAAgC,EACjC,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,cAAc,CAAC;AAEvC;;;;;GAKG;AACH,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB;;CAEtB,CAAC;AAEX;;;;;;;GAOG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,CAAC,eAAe,CAAC,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IACjE,qDAAqD;IACrD,CAAC,eAAe,CAAC,2BAA2B,CAAC,EAAE,6BAA6B,CAAC;IAC7E,2EAA2E;IAC3E,CAAC,eAAe,CAAC,8BAA8B,CAAC,EAAE,gCAAgC,CAAC;CACpF;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,mBAAmB,CAAC,eAAe,CAAC,EAAE,mBAAmB,CAAC;CAC5D;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,KAAK;IAChD,QAAQ,CAAC,IAAI,EAAE,OAAO,mBAAmB,CAAC,eAAe,CAAC;IAC1D,wDAAwD;IACxD,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;CACrB;AAED,eAAe;AACf,MAAM,MAAM,kBAAkB,CAAC,MAAM,SAAS,KAAK,IAAI,CACrD,KAAK,EAAE,MAAM,KACV,eAAe,CAAC;AAErB;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,eAAe;AACf,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,OAAO,CAAC;AAElD;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,uDAAuD;IACvD,KAAK,EAAE,eAAe,CAAC;IAEvB,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;IAEf,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,YAAY,EACV,wBAAwB,EACxB,6BAA6B,EAC7B,gCAAgC,GACjC,CAAC"}

package/build/ts/surfaces/point-of-sale/globals.d.ts

@@ -1,5 +1,5 @@
 import type { Navigation } from './api/navigation-api/navigation-api';
-import type { ShopifyEventMap } from './events';
+import type { ShopifyEventMap, ShopifyInterceptMap, ShopifyInterceptor } from './events';
 /**
  * The `shopify` global provides APIs that are available to all POS extensions
  * without needing to access them through the target's `api` argument.
@@ -28,6 +28,13 @@ export interface BackgroundShopifyGlobal extends ShopifyGlobal {
      * `listener` reference must match the one used to register.
      */
     removeEventListener<K extends keyof ShopifyEventMap>(type: K, listener: (event: ShopifyEventMap[K]) => void): void;
+    /**
+     * Register an interceptor for a POS host workflow that can be blocked.
+     * Returns a function that unregisters the interceptor.
+     *
+     * @private
+     */
+    intercept<K extends keyof ShopifyInterceptMap>(type: K, interceptor: ShopifyInterceptor<ShopifyInterceptMap[K]>): () => void;
 }
 declare global {
     const navigation: Navigation;

package/build/ts/surfaces/point-of-sale/globals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"globals.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/globals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,qCAAqC,CAAC;AACpE,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,UAAU,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,WAAW,aAAa;CAAG;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,SAAS,MAAM,eAAe,EAC9C,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5C,IAAI,CAAC;IAER;;;OAGG;IACH,mBAAmB,CAAC,CAAC,SAAS,MAAM,eAAe,EACjD,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5C,IAAI,CAAC;CACT;AAED,OAAO,CAAC,MAAM,CAAC;IAEb,MAAM,UAAU,EAAE,UAAU,CAAC;IAO7B,MAAM,OAAO,EAAE,aAAa,CAAC;CAC9B"}
+{"version":3,"file":"globals.d.ts","sourceRoot":"","sources":["../../../../src/surfaces/point-of-sale/globals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,qCAAqC,CAAC;AACpE,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,UAAU,CAAC;AAElB;;;;;GAKG;AACH,MAAM,WAAW,aAAa;CAAG;AAEjC;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC5D;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,SAAS,MAAM,eAAe,EAC9C,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5C,IAAI,CAAC;IAER;;;OAGG;IACH,mBAAmB,CAAC,CAAC,SAAS,MAAM,eAAe,EACjD,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,KAAK,IAAI,GAC5C,IAAI,CAAC;IAER;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,mBAAmB,EAC3C,IAAI,EAAE,CAAC,EACP,WAAW,EAAE,kBAAkB,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,GACtD,MAAM,IAAI,CAAC;CACf;AAED,OAAO,CAAC,MAAM,CAAC;IAEb,MAAM,UAAU,EAAE,UAAU,CAAC;IAO7B,MAAM,OAAO,EAAE,aAAa,CAAC;CAC9B"}