@base316/react 0.1.0 → 0.2.0

package/dist/manifest.json

@@ -0,0 +1,1161 @@
+{
+	"version": 1,
+	"composition": {
+		"rules": [
+			"Everything must be inside Base316Provider. Outside it, hooks throw.",
+			"Most components need a signed-in user. Gate on useSession and render SignIn when there is none — see `requires: session` on each entry.",
+			"A collection must exist before anything can bind to it. Define one in the dashboard under Collections, or through POST /v1/collections with a secret key.",
+			"No component takes a prop you must supply to make it behave. Naming the subject is different: a collection component needs `collection` and a detail view needs `recordId`, because those say *what* to show rather than patch *how* it works. Everything else has a default.",
+			"Each component bound to a collection holds its own data — DataTable, Kanban, Chart, RecordForm, RecordDetail, every one. None of them share a cache, so a write in one leaves the others showing what they already had. Put the form inside the table, where New and Edit refresh it; pass `onChanged` to refresh a sibling such as a Chart; or lift `useCollection` and render your own, which is what the hook is for.",
+			"Next.js App Router: put Base316Provider in a Client Component wrapper used by the root layout. Every component here is a Client Component; none of them run on the server."
+		],
+		"example": "import { Base316Provider, DataTable, RecordForm, SignIn, useSession } from \"@base316/react\";\n\nfunction Jobs() {\n  const session = useSession();\n\n  // Without this the table renders nothing and looks broken.\n  if (!session) return <SignIn />;\n\n  return (\n    <>\n      <DataTable collection=\"jobs\" onSelect={(record) => console.log(record.id)} />\n      <RecordForm collection=\"jobs\" />\n    </>\n  );\n}\n\nexport function App() {\n  return (\n    <Base316Provider publishableKey={process.env.NEXT_PUBLIC_BASE316_PUBLISHABLE_KEY!}>\n      <Jobs />\n    </Base316Provider>\n  );\n}"
+	},
+	"components": [
+		{
+			"name": "Base316Provider",
+			"kind": "provider",
+			"summary": "Holds the client, the session and the theme. Everything else must be inside it.",
+			"useWhen": "Once, around the part of the application that uses any other export here.",
+			"requires": [],
+			"props": [
+				{
+					"name": "publishableKey",
+					"summary": "The environment's publishable key.",
+					"required": true
+				},
+				{
+					"name": "baseUrl",
+					"summary": "Where the API lives. Defaults to production.",
+					"required": false
+				},
+				{
+					"name": "token",
+					"summary": "Supply to own session storage yourself. Left out, the session is kept in localStorage.",
+					"required": false
+				},
+				{
+					"name": "onTokenChange",
+					"summary": "Called when the session changes. Pair with `token` for an httpOnly cookie.",
+					"required": false
+				},
+				{
+					"name": "appearance",
+					"summary": "Colours, radius and font as tokens. Restyles everything at once.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"useBase316",
+				"useSession"
+			]
+		},
+		{
+			"name": "useBase316",
+			"kind": "hook",
+			"summary": "The client, the session token and the branding, from inside the provider.",
+			"useWhen": "Writing a component of your own that needs to call the API directly.",
+			"requires": [],
+			"props": [],
+			"seeAlso": [
+				"Base316Provider"
+			]
+		},
+		{
+			"name": "useSession",
+			"kind": "hook",
+			"summary": "The resolved session, or null. Carries `userId`, `user` (id, email, name, image, and the customer's own declared fields) and `tenants` — every team this person is in, each with their role.",
+			"useWhen": "Deciding what to render for a signed-in versus a signed-out visitor.",
+			"requires": [],
+			"props": []
+		},
+		{
+			"name": "SignIn",
+			"kind": "component",
+			"summary": "Password, passkey and magic-link sign-in in one form.",
+			"useWhen": "The application renders its own sign-in rather than redirecting to the hosted page.",
+			"requires": [],
+			"props": [
+				{
+					"name": "onSignedIn",
+					"summary": "Called once a session exists.",
+					"required": false
+				},
+				{
+					"name": "passkeys",
+					"summary": "Offer passkeys where supported. On by default.",
+					"required": false
+				},
+				{
+					"name": "magicLinkRedirectUrl",
+					"summary": "Where an emailed link lands, which must be registered on the environment. Without it, magic link is not offered at all.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"SignUp",
+				"ForgotPassword"
+			]
+		},
+		{
+			"name": "SignUp",
+			"kind": "component",
+			"summary": "Create an account with an email and a password.",
+			"useWhen": "Alongside SignIn, on a page that registers new users.",
+			"requires": [],
+			"props": [
+				{
+					"name": "onSignedUp",
+					"summary": "Called after the account is created.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"SignIn",
+				"VerifyEmail"
+			]
+		},
+		{
+			"name": "ForgotPassword",
+			"kind": "component",
+			"summary": "Ask for a reset link by email.",
+			"useWhen": "Linked from a sign-in form.",
+			"requires": [],
+			"props": [
+				{
+					"name": "onSent",
+					"summary": "Called with the address after the request.",
+					"required": false
+				},
+				{
+					"name": "signInUrl",
+					"summary": "Renders a link back to sign-in.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"ResetPassword"
+			]
+		},
+		{
+			"name": "ResetPassword",
+			"kind": "component",
+			"summary": "Set a new password from an emailed link.",
+			"useWhen": "On the page the reset link lands on.",
+			"requires": [],
+			"props": [
+				{
+					"name": "token",
+					"summary": "Read from `?token=` when omitted, and removed from the URL.",
+					"required": false
+				},
+				{
+					"name": "onReset",
+					"summary": "Called once the password is changed.",
+					"required": false
+				},
+				{
+					"name": "signInUrl",
+					"summary": "Renders a link onward to sign-in.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "With no token in the URL or props, explains that the link is needed.",
+			"seeAlso": [
+				"ForgotPassword"
+			]
+		},
+		{
+			"name": "VerifyEmail",
+			"kind": "component",
+			"summary": "Confirm an address from an emailed link.",
+			"useWhen": "On the page the verification link lands on.",
+			"requires": [],
+			"props": [
+				{
+					"name": "token",
+					"summary": "Read from `?token=` when omitted, and removed from the URL.",
+					"required": false
+				},
+				{
+					"name": "onVerified",
+					"summary": "Called once confirmed.",
+					"required": false
+				},
+				{
+					"name": "continueUrl",
+					"summary": "Renders a link onward.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"SignUp"
+			]
+		},
+		{
+			"name": "UserProfile",
+			"kind": "component",
+			"summary": "Name, email and the customer's own declared fields.",
+			"useWhen": "An account settings page.",
+			"requires": [
+				"session"
+			],
+			"props": [],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"ActiveSessions",
+				"TwoFactorManager",
+				"PasskeyManager"
+			]
+		},
+		{
+			"name": "ActiveSessions",
+			"kind": "component",
+			"summary": "Where the account is signed in, and a button to end the other devices.",
+			"useWhen": "A security settings page.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "onRevoked",
+					"summary": "Called with the number of sessions ended.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"TwoFactorManager"
+			]
+		},
+		{
+			"name": "DeviceApproval",
+			"kind": "component",
+			"summary": "Approve a sign-in that started on a CLI, a TV, or anything with no browser.",
+			"useWhen": "You point a device's verification URI at a page in your own app. Put this on that page.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "userCode",
+					"summary": "The code, when the URL already carries it. Skips the entry step; without it the person types the code.",
+					"required": false
+				},
+				{
+					"name": "onDecided",
+					"summary": "Called with whether they approved.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session — there is nobody to approve as, and collecting a code first would fail at the step that matters.",
+			"seeAlso": [
+				"SignIn",
+				"ActiveSessions"
+			]
+		},
+		{
+			"name": "PrivacyControls",
+			"kind": "component",
+			"summary": "Download a copy of everything held about you, or delete your account.",
+			"useWhen": "An account settings page. These are the two things a privacy notice promises and most products never build.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "confirmWord",
+					"summary": "What must be typed to confirm deletion. Defaults to the English word, which is wrong in every other language.",
+					"required": false
+				},
+				{
+					"name": "onErased",
+					"summary": "Called once the account is gone. Sign them out and send them somewhere.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"UserProfile",
+				"ActiveSessions"
+			]
+		},
+		{
+			"name": "TwoFactorManager",
+			"kind": "component",
+			"summary": "Turn two-factor authentication on or off, by authenticator app or a code to the inbox.",
+			"useWhen": "A security settings page. Offers both factors; the app is stronger, the emailed code is the one people who will not install an app actually use.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "enabled",
+					"summary": "Whether a factor already exists, which decides which side is shown.",
+					"required": false
+				},
+				{
+					"name": "onEnabled",
+					"summary": "Called once a factor is confirmed.",
+					"required": false
+				},
+				{
+					"name": "onDisabled",
+					"summary": "Called once it is removed.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"ActiveSessions",
+				"PasskeyManager"
+			]
+		},
+		{
+			"name": "PasskeyManager",
+			"kind": "component",
+			"summary": "Add and remove passkeys.",
+			"useWhen": "A security settings page, beside two-factor.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "title",
+					"summary": "Heading text.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"TwoFactorManager"
+			]
+		},
+		{
+			"name": "Branding",
+			"kind": "component",
+			"summary": "The environment's logo, name and tagline.",
+			"useWhen": "Above a sign-in form, so your pages match the hosted ones.",
+			"requires": [],
+			"props": [
+				{
+					"name": "showTagline",
+					"summary": "Include the tagline under the name.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			]
+		},
+		{
+			"name": "TeamMembers",
+			"kind": "component",
+			"summary": "Who is in a team, who has been invited, and the way in and out.",
+			"useWhen": "A Team or Members settings page. One component covers the list, the pending invitations, the invite box and leaving.",
+			"requires": [
+				"session"
+			],
+			"props": [
+				{
+					"name": "organizationId",
+					"summary": "Which team. Defaults to the only one this person is in; with several it says so rather than guessing.",
+					"required": false
+				},
+				{
+					"name": "onInvited",
+					"summary": "Called with `{ email, token, url }` — the address invited, the raw token, and the accept URL when `acceptUrl` was given. This is where your application sends the email. Without a handler the link is shown on screen instead, because the token is returned once and cannot be fetched again.",
+					"required": false
+				},
+				{
+					"name": "acceptUrl",
+					"summary": "The page hosting AcceptInvitation. The component appends `?invitation=<token>` and hands the finished link back as `url` on onInvited; without it, onInvited gets the raw token and you build the link yourself.",
+					"required": false
+				},
+				{
+					"name": "onLeft",
+					"summary": "Called after the viewer leaves the team.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session. Inviting and removing appear only for somebody whose role grants team.manage.",
+			"seeAlso": [
+				"AcceptInvitation"
+			]
+		},
+		{
+			"name": "AcceptInvitation",
+			"kind": "component",
+			"summary": "The other end of an invitation: what it is for, and joining.",
+			"useWhen": "On the page an invitation link lands on.",
+			"requires": [],
+			"props": [
+				{
+					"name": "token",
+					"summary": "Read from `?invitation=` when omitted.",
+					"required": false
+				},
+				{
+					"name": "onAccepted",
+					"summary": "Called with the organizationId once they have joined.",
+					"required": false
+				},
+				{
+					"name": "signUpUrl",
+					"summary": "For somebody with no account yet.",
+					"required": false
+				},
+				{
+					"name": "signInUrl",
+					"summary": "For somebody who has one.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Says what the invitation is for without a session, since the point is that they may have no account. Names the address to sign in as when the signed-in one does not match.",
+			"seeAlso": [
+				"TeamMembers",
+				"SignUp"
+			]
+		},
+		{
+			"name": "PricingTable",
+			"kind": "component",
+			"summary": "The published plans, and completing the purchase.",
+			"useWhen": "A pricing page, or an upgrade screen.",
+			"requires": [
+				"plans",
+				"paymentAccount"
+			],
+			"props": [
+				{
+					"name": "onSelectPlan",
+					"summary": "Take over what Choose does. Left out, the component changes the plan or starts a checkout itself.",
+					"required": false
+				},
+				{
+					"name": "currentPlanVersionId",
+					"summary": "Marks the current plan. Discovered from the session when omitted.",
+					"required": false
+				},
+				{
+					"name": "featuredPlanKey",
+					"summary": "Which plan to present as the default.",
+					"required": false
+				},
+				{
+					"name": "signInUrl",
+					"summary": "Where a signed-out visitor goes on choosing. Without it the button says so rather than failing.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Says plans are unavailable when the catalog is empty.",
+			"seeAlso": [
+				"SubscriptionManager",
+				"usePlans"
+			]
+		},
+		{
+			"name": "usePlans",
+			"kind": "hook",
+			"summary": "The plans, the current one, and the prorate-or-checkout branch — without markup.",
+			"useWhen": "You want your own pricing table but not your own billing logic.",
+			"requires": [
+				"plans"
+			],
+			"props": [],
+			"seeAlso": [
+				"PricingTable"
+			]
+		},
+		{
+			"name": "SubscriptionManager",
+			"kind": "component",
+			"summary": "The current plan, its renewal date, and cancelling.",
+			"useWhen": "A billing settings page.",
+			"requires": [
+				"session"
+			],
+			"props": [],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"PricingTable",
+				"Invoices"
+			]
+		},
+		{
+			"name": "Invoices",
+			"kind": "component",
+			"summary": "The signed-in user's invoices, newest first.",
+			"useWhen": "A billing settings page.",
+			"requires": [
+				"session"
+			],
+			"props": [],
+			"whenUnmet": "Renders nothing without a session.",
+			"seeAlso": [
+				"SubscriptionManager"
+			]
+		},
+		{
+			"name": "PayInvoice",
+			"kind": "component",
+			"summary": "Pay one invoice from a link, with no account needed.",
+			"useWhen": "A page reached from a payment link or a QR code — a walk-up customer.",
+			"requires": [
+				"paymentAccount"
+			],
+			"props": [
+				{
+					"name": "token",
+					"summary": "The link token, from the URL.",
+					"required": false
+				},
+				{
+					"name": "environmentId",
+					"summary": "Which environment the link belongs to.",
+					"required": false
+				},
+				{
+					"name": "onPaid",
+					"summary": "Called once payment succeeds.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"usePaymentLink"
+			]
+		},
+		{
+			"name": "usePaymentLink",
+			"kind": "hook",
+			"summary": "Watches a payment link and reports when it is paid.",
+			"useWhen": "Showing your own waiting screen beside a QR code.",
+			"requires": [],
+			"props": [],
+			"seeAlso": [
+				"PayInvoice"
+			]
+		},
+		{
+			"name": "ApiKeyManager",
+			"kind": "component",
+			"summary": "A customer managing their own API credentials and seeing their rate limits.",
+			"useWhen": "A developer-settings page inside your application.",
+			"requires": [
+				"session",
+				"apiResource"
+			],
+			"props": [
+				{
+					"name": "audience",
+					"summary": "Limit to one protected API. All of them when omitted.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing without a session; says so when no API resource is defined."
+		},
+		{
+			"name": "DataTable",
+			"kind": "component",
+			"summary": "A table of a collection's records, with columns derived from its fields.",
+			"useWhen": "Listing records. Reach for Kanban instead to group them by a status, or Chart to count or total them over time.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"bindsToCollection": true,
+			"props": [
+				{
+					"name": "collection",
+					"summary": "The collection key. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "columns",
+					"summary": "Which fields to show, in order. Every field when omitted.",
+					"required": false
+				},
+				{
+					"name": "renderCell",
+					"summary": "Replace the cell for one field.",
+					"required": false
+				},
+				{
+					"name": "onSelect",
+					"summary": "Row click. Rows are inert without it.",
+					"required": false
+				},
+				{
+					"name": "onChanged",
+					"summary": "Called after this table creates, edits or deletes a record. The table refreshes itself; use this to refresh anything else on the page bound to the same collection, such as a Chart.",
+					"required": false
+				},
+				{
+					"name": "hideSearch",
+					"summary": "Hide the search box.",
+					"required": false
+				},
+				{
+					"name": "readOnly",
+					"summary": "Hide New, Edit and Delete even for a writer.",
+					"required": false
+				},
+				{
+					"name": "emptyState",
+					"summary": "Shown when there is nothing to list.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Without the read permission it says which permission is missing, rather than showing an empty table.",
+			"seeAlso": [
+				"Kanban",
+				"Chart",
+				"RecordDetail",
+				"RecordForm",
+				"useCollection"
+			]
+		},
+		{
+			"name": "Kanban",
+			"kind": "component",
+			"summary": "A board, grouped by a choice field it finds on its own.",
+			"useWhen": "The records move through stages — a status, a pipeline.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"bindsToCollection": true,
+			"props": [
+				{
+					"name": "collection",
+					"summary": "The collection key. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "groupBy",
+					"summary": "Which field makes the columns. Discovered when omitted.",
+					"required": false
+				},
+				{
+					"name": "cardFields",
+					"summary": "What to show on a card.",
+					"required": false
+				},
+				{
+					"name": "onSelect",
+					"summary": "Card click.",
+					"required": false
+				},
+				{
+					"name": "emptyState",
+					"summary": "Shown in a column with nothing in it.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "A collection with no groupable field says to add a choice field, rather than drawing one column.",
+			"seeAlso": [
+				"DataTable",
+				"Chart"
+			]
+		},
+		{
+			"name": "Chart",
+			"kind": "component",
+			"summary": "Records over time, counted or totalled.",
+			"useWhen": "The question is how many or how much, by day, week or month.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"bindsToCollection": true,
+			"props": [
+				{
+					"name": "collection",
+					"summary": "The collection key. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "x",
+					"summary": "The date field. Discovered when omitted.",
+					"required": false
+				},
+				{
+					"name": "y",
+					"summary": "What to measure. Counts the records when omitted.",
+					"required": false
+				},
+				{
+					"name": "aggregate",
+					"summary": "sum, avg, min or max. Defaults to sum.",
+					"required": false
+				},
+				{
+					"name": "bucket",
+					"summary": "day, week or month. Defaults to day.",
+					"required": false
+				},
+				{
+					"name": "title",
+					"summary": "Overrides the derived caption.",
+					"required": false
+				},
+				{
+					"name": "height",
+					"summary": "Plot height in pixels.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "A collection with no date field says so. A field that cannot be summed is refused rather than quietly counted.",
+			"seeAlso": [
+				"DataTable",
+				"Kanban"
+			]
+		},
+		{
+			"name": "RecordDetail",
+			"kind": "component",
+			"summary": "One record in full, including the fields a table truncates.",
+			"useWhen": "After a row or card is clicked.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"bindsToCollection": true,
+			"props": [
+				{
+					"name": "collection",
+					"summary": "The collection key. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "recordId",
+					"summary": "Which record. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "tenant",
+					"summary": "Only when the user is in several.",
+					"required": false
+				},
+				{
+					"name": "readOnly",
+					"summary": "Hide Edit and Delete.",
+					"required": false
+				},
+				{
+					"name": "onDeleted",
+					"summary": "Called after deletion.",
+					"required": false
+				},
+				{
+					"name": "onClose",
+					"summary": "Renders a Close button when given.",
+					"required": false
+				},
+				{
+					"name": "children",
+					"summary": "Rendered under the fields.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"DataTable",
+				"RecordForm"
+			]
+		},
+		{
+			"name": "RecordForm",
+			"kind": "component",
+			"summary": "Create or edit a record, with inputs derived from the field types.",
+			"useWhen": "Adding a record, or editing one outside the detail view.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"bindsToCollection": true,
+			"props": [
+				{
+					"name": "collection",
+					"summary": "The collection key. Required in practice.",
+					"required": false
+				},
+				{
+					"name": "recordId",
+					"summary": "Omit to create, supply to edit.",
+					"required": false
+				},
+				{
+					"name": "tenant",
+					"summary": "Only when the user is in several.",
+					"required": false
+				},
+				{
+					"name": "onSaved",
+					"summary": "Called with the record id. Does not refresh a sibling table — see the composition rules.",
+					"required": false
+				},
+				{
+					"name": "onCancel",
+					"summary": "Renders a Cancel button when given.",
+					"required": false
+				},
+				{
+					"name": "defaults",
+					"summary": "Values to start with. Ignored when editing.",
+					"required": false
+				},
+				{
+					"name": "className",
+					"summary": "Your own classes on the wrapper.",
+					"required": false
+				},
+				{
+					"name": "style",
+					"summary": "Inline styles on the wrapper.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Computed fields get no input at all, because the server produces them.",
+			"seeAlso": [
+				"RecordDetail",
+				"RelationPicker"
+			]
+		},
+		{
+			"name": "RelationPicker",
+			"kind": "component",
+			"summary": "Choose a record in another collection by typing its name.",
+			"useWhen": "Building your own form. RecordForm uses this for relation fields already.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"props": [
+				{
+					"name": "field",
+					"summary": "The relation field descriptor.",
+					"required": true
+				},
+				{
+					"name": "value",
+					"summary": "The chosen record id, or null.",
+					"required": true
+				},
+				{
+					"name": "onChange",
+					"summary": "Called with the new id.",
+					"required": true
+				},
+				{
+					"name": "error",
+					"summary": "Message shown under the input.",
+					"required": false
+				},
+				{
+					"name": "disabled",
+					"summary": "Read-only.",
+					"required": false
+				},
+				{
+					"name": "tenant",
+					"summary": "Only when the user is in several.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"RecordForm"
+			]
+		},
+		{
+			"name": "useCollection",
+			"kind": "hook",
+			"summary": "A collection's schema, records, filters, paging, permissions and writes — without markup.",
+			"useWhen": "You want your own table, board or form but not your own data layer.",
+			"requires": [
+				"session",
+				"collection"
+			],
+			"bindsToCollection": true,
+			"props": [],
+			"seeAlso": [
+				"DataTable",
+				"FieldCell",
+				"FieldInput"
+			]
+		},
+		{
+			"name": "FieldCell",
+			"kind": "component",
+			"summary": "One field value, rendered the way the tables render it.",
+			"useWhen": "Building your own table over useCollection.",
+			"requires": [],
+			"props": [
+				{
+					"name": "value",
+					"summary": "The stored value.",
+					"required": true
+				},
+				{
+					"name": "field",
+					"summary": "The field descriptor.",
+					"required": true
+				},
+				{
+					"name": "related",
+					"summary": "A relation's resolved label.",
+					"required": false
+				}
+			],
+			"seeAlso": [
+				"FieldInput",
+				"useCollection"
+			]
+		},
+		{
+			"name": "FieldInput",
+			"kind": "component",
+			"summary": "The input for one field, chosen by its type.",
+			"useWhen": "Building your own form over useCollection.",
+			"requires": [],
+			"props": [
+				{
+					"name": "value",
+					"summary": "The current value.",
+					"required": true
+				},
+				{
+					"name": "field",
+					"summary": "The field descriptor.",
+					"required": true
+				},
+				{
+					"name": "onChange",
+					"summary": "Called with the new value.",
+					"required": true
+				},
+				{
+					"name": "error",
+					"summary": "Message shown under the input.",
+					"required": false
+				},
+				{
+					"name": "disabled",
+					"summary": "Read-only.",
+					"required": false
+				}
+			],
+			"whenUnmet": "Renders nothing for a computed field — the server produces those.",
+			"seeAlso": [
+				"FieldCell",
+				"RecordForm"
+			]
+		}
+	]
+}