Install

npm install '@rocicorp/[email protected]'

Summary

(vs [email protected])

🎁 Features

• New API endpoint /v1/apps/{app-id}/rooms/contents?roomID={room-id}
  • Returns the entire current content of the room as a single JSON Object.
• New cli option --output=json for npx reflect publish and npx reflect apps list. This will output the result of the two commands in JSON.
• The delete room API endpoint now closes connections automatically. Calling invalidate room connections beforehand is no longer necessary.
• Updated API endpoint /v1/apps/{app-id}/rooms:
  • Now accepts one or more roomID={room-id} query parameters to list the status of specific rooms.
• New (renamed) API endpoints: (moved {room-id} to query params to avoid decoding issues in the url path)
  • /v1/apps/{app-id}/rooms:create?roomID={room-id}
  • /v1/apps/{app-id}/rooms:close?roomID={room-id}
  • /v1/apps/{app-id}/rooms:delete?roomID={room-id}
  • /v1/apps/{app-id}/connections/rooms:invalidate?roomID={room-id}
  • /v1/apps/{app-id}/connections/users:invalidate?userID={user-id}
• Deprecated API endpoints: (support will be removed in a future release)
  • /v1/apps/{app-id}/rooms/{room-id}
  • /v1/apps/{app-id}/rooms/{room-id}:create
  • /v1/apps/{app-id}/rooms/{room-id}:close
  • /v1/apps/{app-id}/rooms/{room-id}:delete
  • /v1/apps/{app-id}/connections/rooms/{room-id}:invalidate
  • /v1/apps/{app-id}/connections/users/{user-id}:invalidate
• Renames createReflectServer option disconnectHandler to onClientDisconnect. The old name remains but is deprecated.
• Introduces onClientDelete option for createReflectServer. This will be called when the server deletes its bookkeeping for this client. After this point, the server will no longer accept connections from this client. This happens either when the client tells the server it is being destroyed (typical) or the server doesn’t hear from the client for 7 days. This hook can be used to clean up application-specific state associated with a client.

🧰 Fixes

• Remove spurious console log line about analytics on startup.
• Remove reflect.config.json and .env.defaultfrom scaffold template.
• Presence state for clients is now cleaned up much more aggressively in the common case where Reflect shuts down cleanly.

👨🏻‍🏫 Upgrading

• If you are using the REST endpoints, please update them to the new format. The old ones still work but will go away in a future breaking change.