Skip to content

Align POS API and web component contracts - #4701

Draft
richard-gajda wants to merge 2 commits into
2026-10-rcfrom
richardgajda/pos-docs-components-20260918
Draft

richard-gajda wants to merge 2 commits into
2026-10-rcfrom
richardgajda/pos-docs-components-20260918

Conversation

@richard-gajda

@richard-gajda richard-gajda commented Sep 18, 2026 •

Copy link
Copy Markdown

Changes

  • Consolidate the POS API JSDoc corrections from the closed docs(pos): source-grounded Cart API JSDoc corrections (audit proposal) #4696–docs(pos): remove duplicate Window declaration in navigation-api (audit proposal) #4700 slices into this open draft so reference generation has maintained source inputs.
  • Correct method/version-specific Cart outcomes, RPC Storage error handling, startup session/connectivity/locale state, GraphQL rejection handling, modal target pairing, camera guards, and hardware acknowledgement/printing limitations.
  • Regenerate the complete POS component declaration set, not only components.d.ts. Public pos.* target imports now receive the inherited DOM/Preact declarations and nullable picker callback types.
  • Keep canonical public documentation records (including TabList) while removing duplicate public markers on rolled JSX aliases. Preserve private reachable helper types.
  • Update the existing patch changeset. No runtime implementation or package release is included.

Verification

  • SDK build, type-check, and lint passed.
  • A public pos.home.modal.render consumer accepts null for all four callbacks on each of five picker families, rejects a numeric callback, and resolves inherited Embed.src and TabList JSX types.
  • Four Action caller/modal examples type-check against their actual public target APIs using CLI-style declarations.
  • The actual docs generator built from generate-docs #461 at 87a1d05de8bdaaf76e80f0766056f274dcaef273 preserves nullable Product Search results and picker events. This is a local unreleased binding, not the SDK lockfile's published 1.2.2 dependency.
  • SDK test discovery found no related tests; no suite pass is claimed. Native device/hardware behavior was source-reviewed, not device-tested.

Keep this PR in draft. No merge or package publication.

@richard-gajda
richard-gajda force-pushed the richardgajda/pos-docs-components-20260918 branch from 0d98430 to 7a76045 Compare September 18, 2026 16:18
@richard-gajda
richard-gajda force-pushed the richardgajda/pos-docs-components-20260918 branch from 7a76045 to b998147 Compare September 18, 2026 16:21
@richard-gajda richard-gajda changed the title docs(pos): correct generated component contracts and input examples Align POS API and web component contracts Sep 28, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant