Mark POS .observe extension targets as @deprecated#4146
Mark POS .observe extension targets as @deprecated#4146vctrchu wants to merge 1 commit into2026-04-rcfrom
Conversation
Add @deprecated and @Private JSDoc annotations to all 4 POS observe extension targets: - pos.transaction-complete.event.observe - pos.cash-tracking-session-start.event.observe - pos.cash-tracking-session-complete.event.observe - pos.cart-update.event.observe Each annotation includes the deprecation version (2026-04), migration path to pos.app.ready.data + shopify.addEventListener(), and a link to the new target's documentation. pos.cart-update.event.observe also references shopify.cart.current.subscribe() as an alternative for render targets. Resolves: shop/issues-retail#26066 Epic: shop/issues-retail#26019 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
Summary
Adds
@deprecatedand@privateJSDoc annotations to all 4 POS observe extension targets, pointing developers topos.app.ready.data+shopify.addEventListener()as the replacement.Targets deprecated
pos.transaction-complete.event.observe→addEventListener('transaction_complete', cb)pos.cash-tracking-session-start.event.observe→addEventListener('cash_tracking_session_start', cb)pos.cash-tracking-session-complete.event.observe→addEventListener('cash_tracking_session_complete', cb)pos.cart-update.event.observe→shopify.cart.current.subscribe()on render targets, oraddEventListener('cart_update', cb)on data targetNotes
@privateexcludes these from generated shopify.dev documentationResolves: https://github.com/shop/issues-retail/issues/26066
Epic: https://github.com/shop/issues-retail/issues/26019
Test plan
yarn buildpasses