Notes on Building a Convex Component
This project started with booking rooms and equipment for recording studios. These notes explain how that application became a reusable package. To use the component in your app, begin with the Quick Start.
Why a Component
A studio booking can reserve a room and several pieces of equipment for hours at a time. Availability therefore needs to account for complete intervals, shared quantities and changes such as cancellation or rescheduling.
The component keeps that inventory and its booking records together. Apps can reuse the backend while choosing their own interface, identity provider and business policies. Convex's component authoring guide explains the database isolation and package structure behind this approach.
From Local Development to a Package
Local component copies made it easy to iterate inside an application. Preparing an npm release required moving reusable fixes back into the package and checking that the packaged files behaved the same way as the development source.
The project now separates the component package from the demo and documentation app. Testing a packed release in a fresh consumer helps catch missing files, dependency mismatches and API differences that a local checkout can hide.
What Belongs in the Host
Inventory consistency belongs in the component. Authentication, organization access and booking policies belong in the host app. An isolated component cannot decide who should administer a particular customer's resources.
Public host functions check access before calling components.booking.*.
Optional internal helpers stay server-only. The authorization guide
shows how to keep setup, private booking details and maintenance operations behind
the appropriate boundary.
Release Lessons
- Test complete booking lifecycles, including failed and repeated operations.
- Verify the exported host API as well as the isolated component.
- Compile documentation examples against the package a consumer installs.
- Keep the first integration small; put optional features in separate guides.
The API reference describes the current integration contract. These development notes are background, not an additional setup path.