Skip to content

Checkpoint request usage example - #727

Merged
benitav merged 8 commits into
mainfrom
checkpoint-request-usage-example
Oct 27, 2026
Merged

benitav merged 8 commits into
mainfrom
checkpoint-request-usage-example

Conversation

@benitav

@benitav benitav commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Adds Sync Catch-Up (checkpoint request) examples across SDKs in a new “Wait for Local Data to Catch Up” section, following refresh actions in our demo apps.

Took this opportunity to further improve the Usage Examples page and fix some issues.

General improvements:

  • Starts sections and examples with short explanations, prerequisites, and consistent Learn more links.
  • Replaces empty Node.js tabs with examples and points Capacitor readers to shared JavaScript Web examples.
  • Separates first-sync checks from catching up now, and links to generated connectors and relevant demos.

Fixes to existing examples:

  • Uploads: Replace handlers that skipped PATCH and DELETE with whole-transaction uploads, completing changes only after upload succeeds.
  • Transactions: Replace bulky or broken examples with focused functions. Correct Kotlin’s transaction context and web support, Swift’s synchronous calls, and Dart’s database type.
  • Status: Replace manual subscriptions and extra state with React hooks, Flutter StreamBuilder, Swift observation, and shorter .NET event loops.
  • Initial sync: Fix Swift’s spinner that never cleared, incomplete UI examples, and the redundant .NET priority wait.
  • Local writes: Correct mixed-platform components, undefined values, and unused IDs so examples perform the operation described.
  • Watch queries: Replace Flutter and Rust placeholders with real results, and remove TypeScript annotations from JavaScript snippets.
  • Progress: Correct the React Native progress scale, SDK property names, priority scope, and deprecated Dart/Kotlin priority types.
  • Swift migration: Move the CRUD struct limitation into the v1.14 upgrade warning, correcting the claim that the public API was unchanged.

Conventions:
SDKs now appear in the same order across the updated pages. Examples can leave out setup code, but the code shown must be correct and checked against the SDK source.

Verification: SDK source and demos reviewed; Vale, link checks, and JavaScript/TypeScript syntax checks pass. Native examples were not executed.

🤖 Updates were made by both Claude Code and Codex (one wrote, one reviewed). I scanned the code changes (the agents reviewed these against the source code) but reviewed all wording/explanations manually.

@mintlify

mintlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
powersync 🟢 Ready View Preview Oct 27, 2026, 10:16 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread .claude/CLAUDE.md Outdated
Comment thread client-sdks/usage-examples.mdx Outdated
Comment thread client-sdks/usage-examples.mdx
@benitav
benitav merged commit 8f2d69f into main Oct 27, 2026
7 checks passed
@benitav
benitav deleted the checkpoint-request-usage-example branch October 27, 2026 10:28

This branch was successfully deployed

1 active deployment
staging — db815efc Deployed Oct 27, 2026 by mintlify[bot]
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