Skip to content

Mark POS .observe extension targets as @deprecated #4146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
vctrchu wants to merge 6 commits into
base: 2026-04-rc
Choose a base branch
from
+31 −0
Draft

Mark POS .observe extension targets as @deprecated #4146

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
872fc2e
chore: mark .observe extension targets as @deprecated
vctrchu Mar 18, 2026
7386990
fix: use window.addEventListener in deprecation messages, remove cart…
vctrchu Mar 31, 2026
fbcbc31
Address review: deprecation version 2025-10, fix doc URLs to latest
vctrchu Apr 1, 2026
99ef265
Fix event names to match ui-api-design (lowercase concatenated, no un…
vctrchu Apr 1, 2026
4334abc
Simplify cart deprecation wording: point to pos.app.ready.data target
vctrchu Apr 1, 2026
8e9192b
Address review: inline URLs with {API_VERSION}, add 'the' article
vctrchu Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions packages/ui-extensions/src/surfaces/point-of-sale/extension-targets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,46 @@ import type {BasicComponents} from './components/targets/BasicComponents';
import type {TransactionCompleteWithReprintData} from './event/data';

export interface EventExtensionTargets {
/**
* Fires when a transaction completes successfully.
*
* @deprecated Deprecated as of `2025-10`. Use the
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) with
* `window.addEventListener('transactioncomplete', callback)` instead.
* @private
*/
Comment thread
fatbattk marked this conversation as resolved.
'pos.transaction-complete.event.observe': (
data: TransactionCompleteData,
) => Promise<BaseOutput>;
/**
* Fires when a cash tracking session starts.
*
* @deprecated Deprecated as of `2025-10`. Use the
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) with
* `window.addEventListener('cashtrackingsessionstart', callback)` instead.
* @private
*/
'pos.cash-tracking-session-start.event.observe': (
data: CashTrackingSessionStartData,
) => Promise<BaseOutput>;
/**
* Fires when a cash tracking session completes.
*
* @deprecated Deprecated as of `2025-10`. Use the
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data) with
* `window.addEventListener('cashtrackingsessioncomplete', callback)` instead.
* @private
*/
'pos.cash-tracking-session-complete.event.observe': (
data: CashTrackingSessionCompleteData,
) => Promise<BaseOutput>;
/**
* Fires when the cart is updated.
*
* @deprecated Deprecated as of `2025-10`. Use `api.cart.current.subscribe()` on the
* [`pos.app.ready.data` target](/docs/api/pos-ui-extensions/{API_VERSION}/targets/pos-app-ready-data).
* @private
*/
'pos.cart-update.event.observe': (
data: CartUpdateEventData,
) => Promise<BaseOutput>;
Expand Down
Loading