@protobase/cli 0.64.0 → 0.65.0

package/dist/cli/package.js

@@ -1,4 +1,4 @@
 //#region package.json
-var version = "0.64.0";
+var version = "0.65.0";
 //#endregion
 export { version };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/cli",
-  "version": "0.64.0",
+  "version": "0.65.0",
   "description": "The protobase command: scaffold, doctor, dev, build and serve a Protobase project.",
   "license": "Apache-2.0",
   "repository": {
@@ -42,12 +42,12 @@
   "dependencies": {
     "@better-auth/core": "^1.7.12",
     "@hono/node-server": "^2.1.3",
-    "@protobase/config": "0.64.0",
-    "@protobase/layout": "0.64.0",
-    "@protobase/query": "0.64.0",
-    "@protobase/schema": "0.64.0",
-    "@protobase/server": "0.64.0",
-    "@protobase/ui": "0.64.0",
+    "@protobase/config": "0.65.0",
+    "@protobase/layout": "0.65.0",
+    "@protobase/query": "0.65.0",
+    "@protobase/schema": "0.65.0",
+    "@protobase/server": "0.65.0",
+    "@protobase/ui": "0.65.0",
     "@react-email/render": "^2.1.0",
     "@scalar/hono-api-reference": "^0.12.10",
     "@tailwindcss/vite": "^4.3.3",

package/skills/protobase/references/features/navigation.md

@@ -5,6 +5,7 @@
 The sidebar, the user menu, the bottom bar on phones and the global search.
 
 - [Sidebar](../reference/sidebar.md): Resources and pages in groups, in the order you set.
+- [Sidebar icons](../reference/sidebar.md#sidebar-icons): Each resource shows the icon its view names in the sidebar, bottom bar and profile menu.
 - [Recent records](../reference/sidebar.md#recent-records): A sidebar entry lists a few records under it, with status dots or as titles alone, and marked per reader, such as unread ones in bold with a count.
 - [Create link](../reference/sidebar.md#create-link): A sidebar entry links to its create form, such as "New message" under Direct messages, for whoever may create.
 - [The current organization](../reference/sidebar.md#the-current-organization): A sidebar entry opens its list on the organization you work in, which you can clear to see every organization you are a member of.

package/skills/protobase/references/guides/billing-page.md

@@ -65,7 +65,7 @@ export const paymentMethodsView = view<typeof paymentMethods>('payment_methods')
     a.remove('remove', { label: 'Remove', confirm: 'The card is removed from your account.' }),
   ])
 
-export const invoicesView = view<typeof invoices>('invoices')
+export const invoicesView = view<typeof invoices>('invoices').icon('file-text')
   .title((r) => r.number)
   .names({ singular: 'Invoice', plural: 'Invoices' })
   .fields((r) => ({ number: r.number.format('code'), total: r.total.prefix('€').currency('EUR').decimals(2), issued_at: r.issued_at.label('Date'), status: r.status.valueLabels({ open: 'Open', paid: 'Paid' }).valueColors({ paid: 'green' }) }))

package/skills/protobase/references/guides/first-composed-page.md

@@ -122,6 +122,7 @@ import type { orders } from './data'
 export const ordersView = view<typeof orders>('orders')
   .title((r) => r.number)
   .names({ singular: 'Order', plural: 'Orders' })
+  .icon('shopping-cart')
   .nav({
     recent: {
       status: 'status',

package/skills/protobase/references/reference/sidebar.md

@@ -2,10 +2,20 @@
 
 # Sidebar
 
-How sidebar entries are grouped, how an entry lists recent records, with status dots or without, and how it links to its create form.
+How sidebar entries are grouped and which icon each shows, how an entry lists recent records, with status dots or without, and how it links to its create form.
 
 The admin's sidebar has one entry per resource view, grouped by `nav.group` (default: the database schema, with no group name for `public`) and sorted by `nav.order`, then by the order `config/index.ts` exports them, in `protobase dev` and in a built bundle alike. The app opens on the first entry. A view's [named lists](ui-config.md#more-than-one-list) are entries of their own, placed by their own `nav`. `nav({ hidden: true })` leaves a resource out, for line and link tables; a resource in the [user menu](user-menu.md) is left out too. [Composed pages](layouts.md#setup) have entries of their own, and groups that hold pages come first. A [remote resource](remote-resources.md) has its entry where its source's view places it; while its source cannot be reached, it sits under the source's label, marked "Cannot reach" with the source's name.
 
+## Sidebar icons
+
+Each resource shows the icon its view names, in the sidebar, the [bottom bar](bottom-bar.md) and the [user menu](user-menu.md), and its [named lists](ui-config.md#more-than-one-list) show the same icon:
+
+```ts
+export const ordersView = view<typeof orders>('orders').names({ singular: 'Order', plural: 'Orders' }).icon('shopping-cart')
+```
+
+`icon` is one of `bell`, `book-open`, `bookmark`, `building`, `credit-card`, `external-link`, `file-text`, `globe`, `heart`, `key`, `layout-dashboard`, `life-buoy`, `mail`, `package`, `receipt`, `settings`, `shield`, `shopping-cart`, `tags`, `users` or `warehouse`. A view without one, or with a name not in this list, shows a table icon, whatever the resource is called. A bottom bar tab's or user menu item's own `icon` wins over the view's.
+
 ## The current organization
 
 For a resource whose lists read [across organizations](access.md#lists-across-organizations), `nav({ tenant: 'current' })` opens its entry on the organization the session works in, while the person can still clear or widen it:

package/skills/protobase/references/reference/ui-config.md

@@ -55,7 +55,7 @@ export const repairsView = view<typeof repairs>('repairs')
 | `.fields((r) => ({ name: r.name.label(...) }))` | Hints per field, below. Calls add up. |
 | `.help(text)` | A line under the list's title. |
 | `.nav({ group, order, hidden, recent, tenant })` | Where the resource sits in the sidebar, its [recent-record group](sidebar.md#recent-records), and with `tenant: 'current'` that it opens on [the current organization](sidebar.md#the-current-organization). |
-| `.icon(name)` | Carried in `/meta` for apps that render their own shell; the admin picks sidebar icons by resource name. |
+| `.icon(name)` | The resource's icon in the sidebar, bottom bar and user menu; a table icon without one. See [Sidebar icons](sidebar.md#sidebar-icons). |
 | `.listOf((r) => r.listing_id)` | The list page shows the records this relation points at instead of the resource's own rows, such as the listings among a member's favorites. See [Favorites](#favorites). |
 | `.signIn({ title, description, benefits?, icon?, signUp? })` | What a visitor who is not signed in is told about the resource, in place of its list and by a card's favorite button. See [Sign-in prompts](#sign-in-prompts). |
 | `.form((r) => ({ name, fields, thanks, title?, perMinute? }))` | A public form at `/-/forms/<name>` that creates a record for anyone, signed in or not, behind a rate limit and a bot check. See [Public forms](forms.md). |
@@ -1036,6 +1036,7 @@ import type { orders } from './data'
 export const ordersView = view<typeof orders>('orders')
   .title((r) => r.number)
   .names({ singular: 'Order', plural: 'Orders' })
+  .icon('shopping-cart')
   .nav({
     recent: {
       status: 'status',

package/skills/protobase/references/reference/user-menu.md

@@ -26,7 +26,7 @@ export const accountMenu = userMenu((m) => [
 | `m.page(name, { label?, icon? })` | Opens a [composed page](layouts.md). The page leaves the sidebar. The label defaults to its title. |
 | `m.link(label, href, { icon? })` | Opens `href` in a new tab. Only `https://`, `http://` and `mailto:` are accepted. |
 
-`accounts` is the built-in [Users page](auth.md#users-page), which the config exports as `usersPage` from `@protobase/layout`; without the export, `createAdmin` refuses the item. Items keep their order. A line splits the menu into groups: these items, then the [organization](auth.md#organizations) pages when the app has organizations, then the person's own: "Account" for everyone (their [account page](auth.md#account-page): profile, [passkeys](auth.md#passkeys) and [two-factor authentication](auth.md#two-factor-authentication)) and "Sign-in policy" for admins (the [sign-in policy](auth.md#sign-in-policy), and the log of [staff sign-ins](auth.md#staff-sign-in)); then the [theme switch](theme.md#light-dark-or-the-system), and "Sign out" always comes last. `icon` is one of `bell`, `book-open`, `bookmark`, `building`, `credit-card`, `external-link`, `file-text`, `heart`, `key`, `layout-dashboard`, `life-buoy`, `mail`, `receipt`, `settings`, `shield`, `users`. A resource item without one uses the resource's sidebar icon, and a link item uses `external-link`.
+`accounts` is the built-in [Users page](auth.md#users-page), which the config exports as `usersPage` from `@protobase/layout`; without the export, `createAdmin` refuses the item. Items keep their order. A line splits the menu into groups: these items, then the [organization](auth.md#organizations) pages when the app has organizations, then the person's own: "Account" for everyone (their [account page](auth.md#account-page): profile, [passkeys](auth.md#passkeys) and [two-factor authentication](auth.md#two-factor-authentication)) and "Sign-in policy" for admins (the [sign-in policy](auth.md#sign-in-policy), and the log of [staff sign-ins](auth.md#staff-sign-in)); then the [theme switch](theme.md#light-dark-or-the-system), and "Sign out" always comes last. `icon` is one of the names a view's [sidebar icon](sidebar.md#sidebar-icons) takes. A resource item without one uses the resource's sidebar icon, and a link item uses `external-link`.
 
 Every caller gets the menu through `/meta`, without the resources and pages they cannot see, so a user who cannot read `organizations` has no "Organization" item. Links are shown to everyone. `createAdmin` refuses to start when an item names a resource or page that does not exist, and `configExports` refuses a config that exports two menus.