Skip to content

Correct opt-in loading, error handling, and authorization guidance - #29

Open
roncohen wants to merge 1 commit into
mainfrom
fix/opt-in-loading-and-errors
Open

Correct opt-in loading, error handling, and authorization guidance#29
roncohen wants to merge 1 commit into
mainfrom
fix/opt-in-loading-and-errors

Conversation

@roncohen

Copy link
Copy Markdown
Contributor

Summary

  • Explicitly enable Suspense in the quick start, handle both loading states without Suspense, and avoid treating unavailable metadata as an authoritative empty list.
  • Handle skipped/non-OK mutation responses and promise rejections, and add a reload example with independent pending/error state.
  • Document the publishable-key/company-scope trust model, confirmation failures after remote changes, conditional bootstrap metadata refreshes, and browser-context re-evaluation caveats.
  • Synchronize Browser/React/Vue SDK examples and fix opt-in reference types for Browser/React/Vue/React Native, including the duplicate React README.

Preserves the latest guide restructuring, prerequisites, and handbook links on main. No authorization enforcement or hook API changes are implied; metadata failures use documented manual retry.

Companion SDK change

reflagcom/javascript#729 preserves readable HTTP error responses, adds regression coverage, and makes the reference-generation fixes durable. Publish that SDK change before relying on readable failed-response bodies in existing SDK installations.

Validation

  • All four updated guide/SDK README examples typechecked.
  • Opt-in reference sections matched the corrected generated output during implementation.
  • Companion SDK validation: 117 targeted SDK tests and 3 documentation tests passed, plus SDK builds, type tests, and scoped TypeDoc generation.
  • git diff --check passed.

Only opt-in documentation changes are included; unrelated local API docs and assets are excluded.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

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.

2 participants