Repository navigation
PR-119: Correct Fliplet.Socket docs for V3 apps and reconnects - #317
Open
farhantariq12b wants to merge 1 commit into
Open
farhantariq12b wants to merge 1 commit into
farhantariq12b wants to merge 1 commit into
Conversation
- State what the API does not do: store events, keep rooms private,
log in app users, send from App Actions, or leave a room
- Document the login option as Studio-accounts only, with its errors
- Add "Joining rooms": rejoin on every connect, app-scoped room names,
reserved user-/app-/organization- prefixes, no leave event
- Note that the sender receives its own events and offline sends are held
- Rewrite the Vue examples as V3 component objects (no <script setup> or
imports), keep the socket out of reactive state, and wrap templates in
raw tags so Jekyll stops stripping {{ }}
- Replace the presence example, which relied on a server push that does
not exist, with a heartbeat-based one
- Add a Native apps section
- Regenerate agent indexes
Co-Authored-By: Claude <noreply@anthropic.com>
Deploying fliplet-cli with
|
| Latest commit: |
90b0703
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://0d82d41d.fliplet-cli.pages.dev |
| Branch Preview URL: | https://docs-pr-119-socket-docs.fliplet-cli.pages.dev |
farhantariq12b
marked this pull request as ready for review
October 9, 2026 15:32
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
JIRA Issue
https://weboo.atlassian.net/browse/PR-119
Summary
Corrects
docs/API/fliplet-socket.md, the page the V3 AI builder reads for real-time features.loginoption: works only for Fliplet Studio accounts. App users getloginError. Removed the claim that App Actions can push touser-<id>rooms.connect(the server forgets rooms after a reconnect), include the app ID in room names, avoid theuser-/app-/organization-prefixes Fliplet uses, noleaveevent.socket.to(room).emit(): the sender receives its own event; events sent while offline are held until the connection returns.<script setup>andimport, which V3 apps can't run.{{ }}, leaving empty<li>templates.setup(), wrapped in{% raw %}, and keep the socket out of reactive state.presence:updateevent that nothing sends; the new one uses a heartbeat.server pushcapability keyword..well-knownandv3/capabilities.md.llms-full.txtalso picks up AI doc changes already on master that hadn't been regenerated (API/core/ai.md,ai/chatbot.mdand three other AI pages); no AI doc source changed here.Merge after the API PR for the same ticket (https://github.com/Fliplet/fliplet-api/pull/8772) is deployed. That PR makes the socket log in again after a reconnect, which this page describes.
Testing
node bin/build-agent-indexes.mjs --strictpasses (frontmatter, capabilities, cross-links).npm run test:unit: 164 of 166 pass. The 2 failing files can't loadjsdom(not installed in a fresh checkout) and test other docs.Every behavioral claim was tested against the local API (
api.fliplet.test):connectfires again after a reconnectconnectrestores deliveryleaveremoves a socket from a roomloginError404 "User not found"Fliplet.Socket.disconnect()'d socket reconnectsThe three Vue examples were run as written. They were extracted from the page and mounted in two Chrome tabs ("Alice" and "Bob") on a local V3 app preview:
Jekyll could not run locally (bundler version mismatch). The live V3 Vue guide uses the same
{% raw %}wrapping and renders correctly; please check the Cloudflare preview for this page.Testing notes
{{ person.name }}and{{ message.text }}, not an empty list item.Risk Assessment
🤖 Generated with Claude Code