@softize/opus 18.5.0 → 20.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/CHANGELOG.md +275 -0
  2. package/bin/cli.mjs +5 -0
  3. package/bin/lib/check.mjs +198 -10
  4. package/bin/lib/copy.mjs +29 -0
  5. package/bin/lib/mcp.mjs +1 -1
  6. package/docs/adr/0023-surfaces-share-one-anatomy-and-two-layouts.md +298 -0
  7. package/docs/adr/0024-fill-height-propagates-by-context.md +118 -0
  8. package/docs/data-products.md +15 -9
  9. package/docs/protocol.md +3 -4
  10. package/docs/releasing.md +2 -2
  11. package/package.json +2 -2
  12. package/registry/skills/create-opus-action/scripts/scaffold.mjs +2 -1
  13. package/registry/templates/app/package.json +1 -1
  14. package/src/core/runtime.ts +96 -8
  15. package/src/core/types.ts +5 -2
  16. package/src/ui/components/patterns/action-form-card.tsx +11 -1
  17. package/src/ui/components/patterns/content-header.tsx +16 -12
  18. package/src/ui/components/patterns/fill-region.ts +150 -0
  19. package/src/ui/components/patterns/heading-level.ts +16 -0
  20. package/src/ui/components/patterns/list.tsx +103 -73
  21. package/src/ui/components/patterns/page.tsx +20 -4
  22. package/src/ui/components/patterns/pane.tsx +294 -0
  23. package/src/ui/components/patterns/presentation.tsx +81 -54
  24. package/src/ui/components/patterns/sidebar.tsx +13 -72
  25. package/src/ui/components/patterns/split.tsx +51 -38
  26. package/src/ui/components/patterns/surface-anatomy.ts +246 -0
  27. package/src/ui/components/patterns/surface-header.tsx +51 -6
  28. package/src/ui/components/patterns/surface-media.tsx +69 -0
  29. package/src/ui/components/patterns/trigger.tsx +12 -2
  30. package/src/ui/components/primitives/alert.tsx +9 -1
  31. package/src/ui/components/primitives/avatar.tsx +7 -3
  32. package/src/ui/components/primitives/card.tsx +91 -29
  33. package/src/ui/components/primitives/carousel.tsx +34 -5
  34. package/src/ui/components/primitives/checkbox.tsx +11 -3
  35. package/src/ui/components/primitives/command.tsx +14 -5
  36. package/src/ui/components/primitives/copyable.tsx +120 -10
  37. package/src/ui/components/primitives/detail.tsx +10 -13
  38. package/src/ui/components/primitives/dialog.tsx +179 -45
  39. package/src/ui/components/primitives/drawer.tsx +131 -24
  40. package/src/ui/components/primitives/empty.tsx +1 -1
  41. package/src/ui/components/primitives/icon-picker.tsx +6 -2
  42. package/src/ui/components/primitives/icon-tile.tsx +7 -0
  43. package/src/ui/components/primitives/input-group.tsx +9 -2
  44. package/src/ui/components/primitives/input-otp.tsx +1 -1
  45. package/src/ui/components/primitives/kbd.tsx +1 -1
  46. package/src/ui/components/primitives/label.tsx +3 -0
  47. package/src/ui/components/primitives/menu.tsx +5 -0
  48. package/src/ui/components/primitives/metric-card.tsx +98 -39
  49. package/src/ui/components/primitives/popover.tsx +1 -1
  50. package/src/ui/components/primitives/progress.tsx +9 -1
  51. package/src/ui/components/primitives/slider.tsx +62 -11
  52. package/src/ui/components/primitives/truncate.tsx +10 -1
  53. package/src/ui/docs/content/accordion.md +74 -27
  54. package/src/ui/docs/content/action-form-card.md +24 -15
  55. package/src/ui/docs/content/action-form-dialog.md +17 -7
  56. package/src/ui/docs/content/action-form.md +92 -77
  57. package/src/ui/docs/content/action-list-dialog.md +75 -38
  58. package/src/ui/docs/content/action-list.md +134 -52
  59. package/src/ui/docs/content/action-trigger.md +27 -10
  60. package/src/ui/docs/content/action-view.md +14 -14
  61. package/src/ui/docs/content/actions.md +161 -66
  62. package/src/ui/docs/content/ai.md +43 -44
  63. package/src/ui/docs/content/alert.md +83 -29
  64. package/src/ui/docs/content/ask.md +51 -26
  65. package/src/ui/docs/content/aspect-ratio.md +22 -24
  66. package/src/ui/docs/content/audit.md +23 -19
  67. package/src/ui/docs/content/auth.md +38 -19
  68. package/src/ui/docs/content/avatar.md +54 -5
  69. package/src/ui/docs/content/badge.md +29 -9
  70. package/src/ui/docs/content/breadcrumb.md +21 -8
  71. package/src/ui/docs/content/button.md +73 -43
  72. package/src/ui/docs/content/calendar.md +134 -26
  73. package/src/ui/docs/content/card.md +252 -35
  74. package/src/ui/docs/content/carousel.md +37 -6
  75. package/src/ui/docs/content/chat.md +118 -37
  76. package/src/ui/docs/content/checkbox.md +73 -7
  77. package/src/ui/docs/content/cli.md +94 -55
  78. package/src/ui/docs/content/collapsible.md +43 -19
  79. package/src/ui/docs/content/command.md +30 -8
  80. package/src/ui/docs/content/composer.md +23 -8
  81. package/src/ui/docs/content/content.md +37 -7
  82. package/src/ui/docs/content/copyable.md +39 -8
  83. package/src/ui/docs/content/customization.md +55 -46
  84. package/src/ui/docs/content/cycle.md +33 -18
  85. package/src/ui/docs/content/data-products.md +115 -0
  86. package/src/ui/docs/content/data-state.md +20 -6
  87. package/src/ui/docs/content/data.md +20 -19
  88. package/src/ui/docs/content/detail.md +12 -5
  89. package/src/ui/docs/content/dialog.md +219 -28
  90. package/src/ui/docs/content/dictionary-value.md +4 -4
  91. package/src/ui/docs/content/dock.md +54 -19
  92. package/src/ui/docs/content/dot.md +35 -5
  93. package/src/ui/docs/content/drawer.md +193 -22
  94. package/src/ui/docs/content/empty-value.md +20 -6
  95. package/src/ui/docs/content/empty.md +24 -3
  96. package/src/ui/docs/content/events.md +76 -16
  97. package/src/ui/docs/content/executions.md +9 -9
  98. package/src/ui/docs/content/field.md +21 -6
  99. package/src/ui/docs/content/getting-started.md +44 -34
  100. package/src/ui/docs/content/icon-picker.md +19 -13
  101. package/src/ui/docs/content/icon-tile.md +28 -5
  102. package/src/ui/docs/content/input-otp.md +58 -7
  103. package/src/ui/docs/content/input.md +22 -3
  104. package/src/ui/docs/content/item.md +53 -6
  105. package/src/ui/docs/content/kbd.md +5 -1
  106. package/src/ui/docs/content/label.md +13 -4
  107. package/src/ui/docs/content/log.md +5 -5
  108. package/src/ui/docs/content/markdown.md +5 -4
  109. package/src/ui/docs/content/mcp.md +49 -23
  110. package/src/ui/docs/content/menu.md +95 -10
  111. package/src/ui/docs/content/metric-card.md +68 -21
  112. package/src/ui/docs/content/observability.md +10 -9
  113. package/src/ui/docs/content/page.md +125 -11
  114. package/src/ui/docs/content/pagination.md +13 -5
  115. package/src/ui/docs/content/pane.md +300 -0
  116. package/src/ui/docs/content/popover.md +42 -5
  117. package/src/ui/docs/content/presentation.md +91 -47
  118. package/src/ui/docs/content/progress.md +27 -14
  119. package/src/ui/docs/content/queue.md +39 -21
  120. package/src/ui/docs/content/radio-group.md +26 -4
  121. package/src/ui/docs/content/router.md +29 -10
  122. package/src/ui/docs/content/runtime.md +90 -54
  123. package/src/ui/docs/content/scheduler.md +53 -21
  124. package/src/ui/docs/content/scroll-area.md +42 -35
  125. package/src/ui/docs/content/select.md +78 -33
  126. package/src/ui/docs/content/semantic-context.md +21 -2
  127. package/src/ui/docs/content/separator.md +15 -9
  128. package/src/ui/docs/content/sidebar.md +25 -45
  129. package/src/ui/docs/content/skeleton.md +13 -4
  130. package/src/ui/docs/content/slider.md +37 -9
  131. package/src/ui/docs/content/spinner.md +4 -3
  132. package/src/ui/docs/content/split.md +34 -20
  133. package/src/ui/docs/content/storage.md +8 -9
  134. package/src/ui/docs/content/switch.md +10 -7
  135. package/src/ui/docs/content/table.md +46 -8
  136. package/src/ui/docs/content/tabs.md +14 -4
  137. package/src/ui/docs/content/testing.md +76 -31
  138. package/src/ui/docs/content/textarea.md +5 -4
  139. package/src/ui/docs/content/toast.md +48 -7
  140. package/src/ui/docs/content/toggle.md +3 -3
  141. package/src/ui/docs/content/tokens.md +15 -26
  142. package/src/ui/docs/content/tooltip.md +18 -2
  143. package/src/ui/docs/content/truncate.md +36 -6
  144. package/src/ui/docs/content/ui.md +74 -22
  145. package/src/ui/docs/content/upgrading.md +45 -36
  146. package/src/ui/docs/plugin.ts +36 -2
  147. package/src/ui/docs/registry.tsx +14 -2
  148. package/src/ui/drivers/react.tsx +16 -8
  149. package/src/ui/meta.ts +38 -32
  150. package/src/ui/react.tsx +14 -0
  151. package/src/vite/design.ts +16 -4
@@ -1,16 +1,19 @@
1
1
  ## Notificação temporária
2
2
 
3
- Use `toast` para informar o resultado temporário de uma ação sem interromper o fluxo. Cada tipo usa o
4
- ícone correspondente do Opus. Escreva o título como rótulo, sem ponto final, e a descrição como uma
5
- frase. A moldura do ícone permanece quadrada e alinhada à primeira linha mesmo quando a descrição
6
- ocupa várias linhas. Corpo e padding seguem os mesmos `0.875rem` e `0.75rem` do Alert; os defaults
7
- internos do Sonner não definem a densidade da casa.
3
+ Use `toast` para informar o resultado temporário de uma ação sem interromper o fluxo. A notificação
4
+ some sozinha, então não use toast para algo que a pessoa precisa ler ou resolver depois; nesse caso,
5
+ mantenha a mensagem na página com [`Alert`](/ui/alert).
6
+
7
+ Cada tipo usa o ícone correspondente do Opus. Escreva o título como rótulo, sem ponto final, e a
8
+ descrição como uma frase. A moldura do ícone permanece quadrada e alinhada à primeira linha mesmo
9
+ quando a descrição ocupa várias linhas. Corpo e padding seguem os mesmos `0.875rem` e `0.75rem` do
10
+ `Alert`.
8
11
 
9
12
  ```tsx preview
10
13
  <Button variant="outline" onClick={() => toast.success('Workspace criado')}>Sucesso</Button>
11
14
  <Button
12
15
  variant="outline"
13
- onClick={() => toast.error('Falha no push', { description: 'O Multica não respondeu — tente de novo.' })}
16
+ onClick={() => toast.error('Falha no push', { description: 'O repositório remoto não respondeu. Tente de novo.' })}
14
17
  >
15
18
  Erro
16
19
  </Button>
@@ -52,7 +55,7 @@ oferecer uma ação.
52
55
  variant="outline"
53
56
  onClick={() =>
54
57
  toast.promise(new Promise((resolve) => setTimeout(resolve, 1800)), {
55
- loading: 'Publicando no Multica…',
58
+ loading: 'Publicando agentes…',
56
59
  success: 'Agentes publicados',
57
60
  error: 'Falha ao publicar',
58
61
  })
@@ -62,6 +65,28 @@ oferecer uma ação.
62
65
  </Button>
63
66
  ```
64
67
 
68
+ ## Carregamento e mensagens neutras
69
+
70
+ `toast.message`, como `toast`, exibe uma notificação sem ícone de tipo. `toast.loading` mostra o
71
+ indicador de progresso e não expira sozinho: guarde o identificador que ele retorna e passe-o em
72
+ `id` para trocar a mesma notificação pelo resultado. `toast.dismiss(id)` fecha uma notificação; sem argumento, fecha todas.
73
+
74
+ ```tsx preview
75
+ <Button
76
+ variant="outline"
77
+ onClick={() => {
78
+ const id = toast.loading('Sincronizando workspace…')
79
+ setTimeout(() => toast.success('Workspace sincronizado', { id }), 1800)
80
+ }}
81
+ >
82
+ Carregamento
83
+ </Button>
84
+ <Button variant="outline" onClick={() => toast.message('Rascunho salvo neste navegador')}>
85
+ Neutra
86
+ </Button>
87
+ <Button variant="ghost" onClick={() => toast.dismiss()}>Fechar todas</Button>
88
+ ```
89
+
65
90
  ## Toaster na raiz
66
91
 
67
92
  Monte um único `Toaster` na raiz do aplicativo. O tema vem da propriedade `theme`, cujo padrão é
@@ -80,11 +105,27 @@ Monte um único `Toaster` na raiz do aplicativo. O tema vem da propriedade `them
80
105
  | `theme` | `'light' \| 'dark' \| 'system'` | `'system'` | Define o tema das notificações; sem `next-themes`, a escolha pertence ao aplicativo. |
81
106
  | `position` | `'bottom-right' \| 'top-center' \| …` | `'bottom-right'` | Região da tela onde as notificações aparecem. |
82
107
 
108
+ ## Funções de toast
109
+
110
+ As funções de notificação (`toast` e suas variantes de contexto, `message` e `loading`) recebem o
111
+ título e as opções e retornam o identificador da notificação. `toast.promise` e `toast.dismiss` têm
112
+ assinaturas próprias, indicadas na tabela.
113
+
114
+ | Função | Descrição |
115
+ |---|---|
116
+ | `toast(title, options?)` | Notificação padrão, sem ícone de tipo. |
117
+ | `toast.success`, `toast.info`, `toast.warning`, `toast.error` | Notificação com o ícone e a cor do contexto correspondente. |
118
+ | `toast.message(title, options?)` | Equivale a `toast(title, options?)`: notificação sem ícone de tipo. |
119
+ | `toast.loading(title, options?)` | Notificação com indicador de progresso que não expira sozinha. |
120
+ | `toast.promise(promise, { loading, success, error })` | Acompanha a promessa e atualiza a mesma notificação. Não aceita `actions`. |
121
+ | `toast.dismiss(id?)` | Fecha a notificação indicada ou, sem argumento, todas. |
122
+
83
123
  ## Opções de toast
84
124
 
85
125
  | Opção | Tipo | Padrão | Descrição |
86
126
  |---|---|---|---|
87
127
  | `description` | `React.ReactNode` | | Complemento exibido abaixo do título. |
128
+ | `id` | `string \| number` | gerado | Identificador da notificação. Passe o de uma notificação existente para substituí-la, como depois de `toast.loading`. |
88
129
  | `actions` | `ToastAction[]` | | Coleção ordenada de ações; a última recebe destaque primário por padrão. |
89
130
  | `duration` | `number` | `4000` | Tempo de permanência da notificação, em milissegundos. O `Toaster` pode mudar o padrão, e `toast.loading` não expira sozinho. |
90
131
 
@@ -50,7 +50,7 @@ borda. `size` ajusta a altura.
50
50
 
51
51
  ## Desabilitado
52
52
 
53
- disabled esmaece e bloqueia o clique — o estado pressed permanece visível.
53
+ `disabled` esmaece o toggle e bloqueia o clique. O estado pressionado continua visível.
54
54
 
55
55
  ```tsx preview
56
56
  <Toggle disabled aria-label="Negrito">
@@ -66,10 +66,10 @@ disabled esmaece e bloqueia o clique — o estado pressed permanece visível.
66
66
 
67
67
  | Propriedade | Tipo | Padrão | Descrição |
68
68
  |---|---|---|---|
69
- | `pressed` | `boolean` | | O estado ligado/desligado no modo controlado — parear com onPressedChange. |
69
+ | `pressed` | `boolean` | | Estado no modo controlado. Use com `onPressedChange`. |
70
70
  | `onPressedChange` | `(pressed: boolean) => void` | | Chamado a cada alternância, com o novo estado. |
71
71
  | `defaultPressed` | `boolean` | `false` | Estado inicial no modo não controlado. |
72
- | `variant` | `'default' \| 'outline'` | `'default'` | default não tem borda (fundo só quando ativo); outline carrega a borda. |
72
+ | `variant` | `'default' \| 'outline'` | `'default'` | `default` não tem borda e só ganha fundo quando ativo; `outline` mantém a borda. |
73
73
  | `size` | `'sm' \| 'default' \| 'lg'` | `'default'` | Altura na escala única dos controles (2 · 2.25 · 2.5rem) — sm para toolbar densa, lg para alvo mais confortável. |
74
74
  | `shape` | `'default' \| 'pill'` | `'default'` | Geometria do controle; `pill` arredonda as extremidades. |
75
75
  | `disabled` | `boolean` | `false` | Esmaece e bloqueia o clique, preservando o estado visual. |
@@ -4,9 +4,10 @@ title: Tokens e tema
4
4
 
5
5
  # Tokens e tema
6
6
 
7
- O tema canônico vive no Opus (`theme.css`): tokens com a cor inteira na var, mapeados para o
8
- Tailwind via `@theme inline`. Os swatches abaixo leem as vars **ao vivo** — troque o tema do app
9
- e a página acompanha.
7
+ Use esta página para escolher a cor, a borda, a sombra, o texto ou o raio certo em uma tela e para
8
+ saber quais variáveis sobrescrever ao aplicar a marca do projeto. Os tokens ficam em `theme.css`:
9
+ cada variável guarda a cor inteira e é mapeada para as classes do Tailwind por `@theme inline`. Os
10
+ exemplos leem as variáveis ao vivo; troque o tema do app e a página acompanha.
10
11
 
11
12
  ## Superfícies e intenções
12
13
 
@@ -210,24 +211,20 @@ render(
210
211
 
211
212
  ## Divergências declaradas vs shadcn
212
213
 
213
- > A regra anti-drift: o que não está declarado aqui (e no `theme.css`) é drift e deve ser
214
- > sincronizado — skill `build-opus-ui`.
214
+ > Qualquer diferença em relação ao shadcn que não esteja declarada aqui (e no `theme.css`) é uma
215
+ > divergência a sincronizar, conforme a skill `build-opus-ui`.
215
216
 
216
- 1. Formato HSL nos tokens (o upstream migrou para oklch) — legibilidade e ferramentas nossas; os
217
- valores acompanham o upstream, só o formato difere.
218
- 2. Elevação no dark: `--card`/`--popover` ficam ACIMA de `--background` (10% vs 3.9%) — identidade
219
- da casa; dialog e card "sobem" da página de verdade.
217
+ 1. Formato HSL nos tokens (o upstream migrou para oklch), escolhido pela legibilidade; os valores
218
+ acompanham o upstream, só o formato difere.
219
+ 2. Elevação no tema escuro: `--card` e `--popover` ficam acima de `--background` (`10%` contra `3.9%`
220
+ de luminosidade), para que dialog e card se destaquem de fato da página.
220
221
  3. Radius mapeado (`xs` a `2xl`) preservando o sentido pré-v4 dos utilitários `rounded-*`. Esse
221
222
  trecho derivado permanece monotônico quando a base muda; aplicações que também usam `3xl`
222
223
  precisam revisar a transição para esse degrau nativo ao customizar `--radius`.
223
-
224
224
  4. Escala `shadow-*` recomposta em duas camadas claras e difusas — preserva os degraus do
225
- Tailwind e troca somente o peso visual. Os aliases antigos por papel foram removidos;
226
- componentes e consumidores usam diretamente a escala.
227
-
228
- 5. Bordas mais leves no light: `--border`/`--input` em 92.5% (upstream 89.8%) — par do canvas
225
+ Tailwind e troca somente o peso visual. Componentes e consumidores usam diretamente a escala.
226
+ 5. Bordas mais leves no tema claro: `--border`/`--input` em `92.5%` (upstream `89.8%`) — par do canvas
229
227
  quase-branco do body; superfícies elevadas usam essa mesma borda real.
230
-
231
228
  6. Radius base em `0.75rem` — superfícies principais ganham cantos mais presentes sem aproximar
232
229
  controles compactos de modais. A decisão detalhada acompanha o pacote em
233
230
  `docs/radius-scale.md`, com os defaults, o comportamento de superfícies aninhadas e as
@@ -235,14 +232,6 @@ render(
235
232
 
236
233
  ## Identidade por app
237
234
 
238
- > O tema do Opus é a base; cada app sobrescreve as vars para ter a própria identidade sem forkar componente.
239
-
240
- ```css
241
- /* index.css do app — depois do import do tema. */
242
- @import '@softize/opus/ui/theme.css';
243
-
244
- :root {
245
- --primary: hsl(262 83% 58%); /* A cor da marca do projeto. */
246
- --ring: hsl(262 83% 58%);
247
- }
248
- ```
235
+ O tema do Opus é a base, e cada app sobrescreve as variáveis para ter a própria identidade sem
236
+ copiar componentes. O passo a passo, com o exemplo de CSS, está em
237
+ [Customização](/ui/customization).
@@ -2,7 +2,8 @@
2
2
 
3
3
  Use `Tooltip` para informação curta e complementar. Como a dica não está disponível em todas as
4
4
  formas de interação, ela não pode conter informação essencial. Botões somente com ícone continuam
5
- precisando de `aria-label`.
5
+ precisando de `aria-label`. Para conteúdo que a pessoa precisa ler ou usar, como um formulário
6
+ curto, use [`Popover`](/ui/popover).
6
7
 
7
8
  ```tsx preview
8
9
  <Tooltip>
@@ -62,7 +63,22 @@ default nos formulários.
62
63
 
63
64
  | Propriedade | Tipo | Padrão | Descrição |
64
65
  |---|---|---|---|
65
- | `delayDuration` | `number` | `0` | Atraso antes da exibição, compartilhado pelos tooltips do aplicativo. |
66
+ | `delayDuration` | `number` | `0` | Atraso antes da exibição, em milissegundos, compartilhado pelos tooltips do aplicativo. |
67
+
68
+ ## Propriedades de Tooltip
69
+
70
+ | Propriedade | Tipo | Padrão | Descrição |
71
+ |---|---|---|---|
72
+ | `open` | `boolean` | | Estado da dica no modo controlado. |
73
+ | `onOpenChange` | `(open: boolean) => void` | | Chamado quando a dica abre ou fecha. |
74
+ | `defaultOpen` | `boolean` | `false` | Estado inicial no modo não controlado. |
75
+ | `delayDuration` | `number` | valor do `TooltipProvider` | Atraso antes da exibição desta dica, em milissegundos; substitui o do provider. |
76
+
77
+ ## Propriedades de TooltipTrigger
78
+
79
+ | Propriedade | Tipo | Padrão | Descrição |
80
+ |---|---|---|---|
81
+ | `asChild` | `boolean` | `false` | Faz do filho (por exemplo, um `Button`) o gatilho, em vez de renderizar outro `<button>`. |
66
82
 
67
83
  ## Propriedades de TooltipContent
68
84
 
@@ -1,7 +1,8 @@
1
1
  ## Truncar somente quando necessário
2
2
 
3
3
  Use `Truncate` para limitar um texto a uma linha e mostrar a dica somente quando houver transbordo.
4
- O componente mede novamente o conteúdo quando o tamanho muda. Se o texto couber, não cria tooltip.
4
+ O componente mede novamente o conteúdo quando o tamanho muda. Se o texto couber, não cria
5
+ [tooltip](/ui/tooltip).
5
6
 
6
7
  ```tsx preview
7
8
  <div className="w-48 rounded-md border p-2">
@@ -34,8 +35,20 @@ escondido.
34
35
  Uma composição que precisa do esmaecimento sem o tooltip aplica a utilitária `truncate-fade`,
35
36
  que cobre o último `1.5rem` da caixa, e decide quando ligá-la com o hook `useOverflowing` — a
36
37
  mesma medição que este componente usa. A máscara pressupõe corte real: em texto que cabe
37
- inteiro, ela esmaeceria o fim de uma palavra visível. É assim que o rótulo do `SidebarItem`
38
- funciona.
38
+ inteiro, ela esmaeceria o fim de uma palavra visível. É assim que o rótulo do `SidebarItem`, da
39
+ [`Sidebar`](/ui/sidebar), funciona.
40
+
41
+ ```ts
42
+ function useOverflowing<T extends HTMLElement>(content?: React.ReactNode): {
43
+ ref: React.RefObject<T | null>
44
+ overflowing: boolean
45
+ }
46
+ ```
47
+
48
+ Ligue `ref` ao elemento de uma linha que pode ser cortado. `overflowing` fica `true` quando o
49
+ conteúdo é mais largo que a caixa. A medida é refeita quando a caixa muda de tamanho e quando
50
+ `content` muda; passe nele o texto exibido, porque a troca de texto sem mudança de tamanho não é
51
+ percebida de outra forma.
39
52
 
40
53
  ```tsx
41
54
  const { ref, overflowing } = useOverflowing<HTMLSpanElement>(label)
@@ -58,9 +71,26 @@ quando o texto completo ainda não oferecer contexto suficiente.
58
71
  </div>
59
72
  ```
60
73
 
61
- Requer `TooltipProvider` na raiz (o esqueleto do `opus create` já monta). Largura vem do
62
- container ou de `className` (`max-w-*`) — o span é `block` e corta em reticências (`truncate`); com
63
- `fade`, esmaece o fim da linha em vez das reticências.
74
+ Requer `TooltipProvider` na raiz; o projeto criado por `opus create` já o monta. A largura vem do
75
+ contêiner ou de `className` (`max-w-*`): o `span` é `block` e corta em reticências (`truncate`);
76
+ com `fade`, esmaece o fim da linha em vez das reticências.
77
+
78
+ ## Acesso pelo teclado
79
+
80
+ A dica abre quando o ponteiro passa sobre o texto ou quando o texto recebe o foco. Com o texto
81
+ cortado, `Truncate` entra na ordem de tabulação e mostra o anel de foco dos controles, então quem
82
+ navega pelo teclado alcança a dica com Tab. Sem corte, o texto fica fora da ordem de tabulação,
83
+ porque não há nada escondido para revelar.
84
+
85
+ Dentro de um link ou botão, o próprio controle já recebe o foco. Passe `tabIndex={-1}` ao
86
+ `Truncate` para não criar uma segunda parada de tabulação no mesmo item. Nesse caso, a dica deixa de
87
+ abrir pelo teclado: dê ao controle o nome completo, com `aria-label`, ou mostre o texto completo em
88
+ outro lugar visível.
89
+
90
+ Leitores de tela leem o texto completo do elemento, mesmo cortado na tela; o conteúdo próprio
91
+ passado em `tooltip` só é anunciado enquanto a dica está aberta. Quando o texto completo for
92
+ necessário para a tarefa, mostre-o também em um lugar que não dependa da dica, como o detalhe do
93
+ registro.
64
94
 
65
95
  ## Propriedades de Truncate
66
96
 
@@ -5,53 +5,105 @@ title: Como consumir
5
5
  # Como consumir a UI
6
6
 
7
7
  Esta documentação é a referência visual e de uso de `@softize/opus/ui`. Os exemplos são renderizados
8
- com o tema e o contrato entregues aos aplicativos.
8
+ com o mesmo tema e os mesmos componentes entregues aos aplicativos.
9
9
 
10
- ## Por que esta doc existe
10
+ ## Por que esta documentação existe
11
11
 
12
- O catálogo do shadcn documenta seu próprio código e pode mostrar composições que não fazem parte do
12
+ O catálogo do shadcn documenta o próprio código e pode mostrar composições que não fazem parte do
13
13
  Opus. Consulte estas páginas para conhecer os componentes, as variações e os comportamentos
14
14
  suportados pelo pacote.
15
15
 
16
16
  Cada página combina exemplos vivos, código e uma referência de propriedades por componente. A
17
- orientação inicial vem de `componentMeta`, a mesma fonte usada pelo catálogo e pelas ferramentas.
17
+ orientação inicial de cada componente vem de `componentMeta`, a mesma fonte usada pelo catálogo e
18
+ pelas ferramentas.
18
19
 
19
- ## Como consumir
20
+ ## Importar componentes e tema
20
21
 
21
22
  Importe componentes e hooks de `@softize/opus/ui/react` e o tema por CSS. Não copie a implementação
22
23
  para o aplicativo quando a API pública já atender ao caso.
23
24
 
24
25
  ```tsx
25
- // Componentes e hooks — tudo do mesmo barrel.
26
+ // Componentes e hooks vêm do mesmo ponto de entrada.
26
27
  import { Button, Dialog, useAction } from '@softize/opus/ui/react'
27
28
  ```
28
29
 
29
30
  ```css
30
- /* index.css — o tema canônico + os componentes do Opus no scan do Tailwind. */
31
+ /* index.css — o tema do Opus e os componentes do pacote no scan do Tailwind. */
31
32
  @import '@softize/opus/ui/theme.css';
32
33
  @source '../node_modules/@softize/opus/src/ui/**/*.{ts,tsx}';
33
34
  ```
34
35
 
36
+ ## Montar os providers
37
+
38
+ Os hooks de action e os componentes que executam actions dependem de três providers na raiz da
39
+ aplicação. O app criado por `opus create` já nasce com eles:
40
+
41
+ ```tsx
42
+ // main.tsx
43
+ import { StrictMode } from 'react'
44
+ import { createRoot } from 'react-dom/client'
45
+ import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
46
+ import { OpusProvider, TooltipProvider } from '@softize/opus/ui/react'
47
+ import { fetchClient } from '@softize/opus/client/fetch'
48
+ import { App } from './App.tsx'
49
+
50
+ const queryClient = new QueryClient()
51
+ // Mesma origem: as actions respondem em /api. Aponte baseUrl para outro servidor quando houver.
52
+ const client = fetchClient({ baseUrl: '' })
53
+
54
+ createRoot(document.getElementById('root')!).render(
55
+ <StrictMode>
56
+ <QueryClientProvider client={queryClient}>
57
+ <OpusProvider client={client}>
58
+ <TooltipProvider>
59
+ <App />
60
+ </TooltipProvider>
61
+ </OpusProvider>
62
+ </QueryClientProvider>
63
+ </StrictMode>,
64
+ )
65
+ ```
66
+
67
+ - `QueryClientProvider` guarda o cache das consultas; `useListAction` e as invalidações entre
68
+ actions dependem dele.
69
+ - `OpusProvider` informa como chamar as actions. Fora dele, os hooks de action lançam erro ao
70
+ montar.
71
+ - `TooltipProvider` é exigido pelos tooltips da aplicação e por componentes do Opus que usam
72
+ tooltip, como `Dock` e `Truncate`.
73
+
74
+ `fetchClient` chama cada action por HTTP em `<baseUrl><apiPrefix>`; `apiPrefix` tem padrão `/api`,
75
+ o mesmo dos servidores do Opus. `headers` e `beforeRequest` acrescentam cabeçalhos fixos ou
76
+ calculados a cada chamada, como um token de acesso.
77
+
78
+ ## Propriedades de OpusProvider
79
+
80
+ | Propriedade | Tipo | Padrão | Descrição |
81
+ | --- | --- | --- | --- |
82
+ | `client` | `ClientAdapter` | obrigatório | Executa as actions chamadas pelos hooks e componentes; normalmente `fetchClient`. |
83
+ | `dicts` | `Record<string, DictLike>` | `{}` | Dicionários por referência, usados por `options: { kind: 'dictionary', ref }` em campos e filtros. Sem registro, o campo usa os dados do `t.dict` que viajam no schema do contrato. |
84
+ | `children` | `ReactNode` | obrigatório | A árvore que usa as actions. |
85
+
35
86
  ## Prebundle do Vite
36
87
 
37
- A entrada `@softize/opus/ui/react` é um `.tsx`, e o prebundle do Vite só considera entradas
38
- `.js`/`.ts`. Sem ajuste, o dev server avisa `Cannot optimize dependency` e serve a árvore do Opus
39
- arquivo a arquivo na carga fria. Há duas saídas, cada uma com um custo conhecido:
88
+ A entrada `@softize/opus/ui/react` é um arquivo `.tsx`, e o prebundle do Vite só considera entradas
89
+ `.js` e `.ts`. Sem ajuste, o dev server avisa `Cannot optimize dependency` e serve os arquivos do
90
+ Opus um a um na primeira carga. Há duas saídas, cada uma com um custo conhecido:
40
91
 
41
92
  - `optimizeDeps.include: ['@softize/opus/ui/react']` com `extensions: ['.tsx']` pré-empacota o
42
- Opus, mas pode duplicar `@tanstack/react-query` quando o app também o importa direto (dois
43
- `QueryClient`, hooks fora do provider).
44
- - `optimizeDeps.exclude: ['@softize/opus/ui/react']` evita a duplicação e infla a carga fria.
93
+ Opus, mas pode duplicar `@tanstack/react-query` quando o app também o importa diretamente. O
94
+ resultado são dois `QueryClient` e hooks que não encontram o provider.
95
+ - `optimizeDeps.exclude: ['@softize/opus/ui/react']` evita a duplicação e deixa a primeira carga
96
+ mais lenta.
45
97
 
46
- Escolha pelo sintoma que aparece no seu app e registre a decisão no `vite.config.ts`. A saída
47
- definitiva (entrada `.ts` no pacote) está no radar do Opus.
98
+ Escolha pelo sintoma que aparece no seu app e registre a decisão no `vite.config.ts`. Uma entrada
99
+ `.ts` no pacote, que resolveria os dois custos, ainda não existe.
48
100
 
49
- ## Origem e anti-drift
101
+ ## Origem dos componentes
50
102
 
51
- > Cada componente declara de onde veio — e a regra de sincronização vem junto.
103
+ Cada componente declara de onde veio, e essa origem define como ele acompanha mudanças:
52
104
 
53
- - **Origem shadcn** — port curado do shadcn (Radix + cmdk). Toda divergência do upstream é
54
- DECLARADA no componente ou no tema — o que diverge sem declaração é drift e deve ser
55
- sincronizado (skill `build-opus-ui`).
56
- - **Nativo do Opus** — nasceu aqui (os patterns de action). Não tem upstream para acompanhar; a
57
- referência é esta doc.
105
+ - **Origem shadcn:** adaptação do shadcn (Radix e cmdk). Toda divergência do original é declarada
106
+ no componente ou no tema. Uma divergência sem declaração deve ser sincronizada; a skill
107
+ `$build-opus-ui` orienta esse trabalho.
108
+ - **Nativo do Opus:** criado no próprio Opus, como os componentes de action. Não há versão externa a
109
+ acompanhar; a referência é esta documentação.
@@ -4,74 +4,83 @@ title: Atualizar o Opus
4
4
 
5
5
  # Atualizar o Opus
6
6
 
7
- Use este fluxo para atualizar o Opus por uma ou várias versões. O changelog explica as mudanças e os
8
- gates apontam as adaptações necessárias no projeto.
7
+ Use este fluxo para atualizar o Opus por uma ou várias versões. O [changelog](/changelog) explica
8
+ as mudanças, e os gates apontam as adaptações necessárias no projeto. Em projetos que usam as
9
+ skills do Opus, a skill `$upgrade-opus` conduz as mesmas etapas: lê o changelog, atualiza a
10
+ dependência, materializa os artefatos e aplica as migrações.
9
11
 
10
- ## 1. Identificar a versão disponível
12
+ ## 1. Atualizar a dependência
11
13
 
12
- O **Maestro** compara o pin (`opus.json`) com a versão instalada e com a fonte a cada
13
- sessão — o alerta no rodapé diz a distância (`v18.0.1 → v18.1.0`) e o **Atualizar** faz
14
- a parte mecânica: bump da dependência, re-materialização da camada de IA (skills,
15
- hooks, agentes) e re-sync do bloco gerenciado do CLAUDE.md.
16
-
17
- Fora do Maestro, faça essa parte à mão:
14
+ A versão adotada pelo projeto fica no `package.json` e no `opus.json` de cada app. Compare-a com a
15
+ versão publicada e atualize:
18
16
 
19
17
  ```bash
20
18
  pnpm outdated @softize/opus # distância até a versão publicada
21
- pnpm -r up @softize/opus@<versão> # em todo workspace que declara o Opus
22
- pnpm run setup # opus setup && base setup: re-materializa base.json e skills
19
+ pnpm -r up @softize/opus@<versão> # em todo pacote do workspace que declara o Opus
20
+ pnpm run setup # opus setup && base setup: materializa base.json e skills
23
21
  ```
24
22
 
25
- Rode `setup` no diretório de cada app que tem `opus.json`; num monorepo criado por
23
+ Rode `setup` no diretório de cada app que tem `opus.json`. Num monorepo criado por
26
24
  `opus create --monorepo`, a raiz não tem esse script, e `pnpm -r run setup` alcança todos os apps.
27
- O postinstall do pacote tenta materializar sozinho, mas é best-effort; se a camada materializada
28
- ainda corresponder à versão anterior, o `opus check` aborta com
25
+ O postinstall do pacote tenta materializar os artefatos sozinho, mas não garante o resultado. Se a
26
+ camada materializada ainda corresponder à versão anterior, o `opus check` para com
29
27
  `base.json: Opus aplicado X, instalado Y`.
30
28
 
29
+ Interfaces de desenvolvimento podem mostrar a diferença entre a versão aplicada na
30
+ sua cópia de trabalho e a adotada pela branch principal. Esse aviso não atualiza o pacote; a
31
+ atualização continua sendo este fluxo.
32
+
31
33
  ## 2. Ler as mudanças acumuladas
32
34
 
33
- O changelog **viaja no pacote** — depois do bump, está em
34
- `node_modules/@softize/opus/CHANGELOG.md`. Uma entrada por versão; quando quebra,
35
- a seção **Breaking** diz a migração (o que renomeou, o que fazer no seu código).
36
- A esteira de release **recusa** publicar versão sem entrada — o arquivo não defasa.
35
+ O changelog também acompanha o pacote: depois da atualização, ele está em
36
+ `node_modules/@softize/opus/CHANGELOG.md`. Cada versão tem uma entrada, e a publicação é recusada
37
+ quando a entrada falta. Quando uma versão quebra compatibilidade, a seção **Breaking** descreve o
38
+ que mudou e como migrar o seu código.
37
39
 
38
- - **minor e patch** (18.0 → 18.1): leia todas as entradas intermediárias. Minors podem pedir ação,
39
- como a troca de `PageHeader` por `PageIntro` no `PageShell` (17.2.0) ou o layout desktop fixo (18.1.0).
40
- - **major** (17.x → 18.0): além disso, aplique as seções Breaking de cada versão pulada, na ordem.
40
+ - **Minor e patch** (18.0 → 18.5): leia todas as entradas intermediárias, porque elas também podem
41
+ mudar comportamento observável. Na 18.1.1, por exemplo, uma action que não é `public` passou a
42
+ exigir usuário antes de executar os `loads`.
43
+ - **Major** (18.x → 19.0): além disso, aplique as seções Breaking de cada versão pulada, na ordem.
44
+ Na 19.0.0, por exemplo, os headers de `Card`, `Dialog` e `Drawer` passaram a aceitar somente os
45
+ slots da própria família.
41
46
 
42
47
  ## 3. Executar as verificações
43
48
 
44
- O Opus é publicado como código-fonte TypeScript: o que quebrou aparece com arquivo e linha.
45
- Rode, na ordem:
49
+ O Opus é publicado como código-fonte TypeScript, então uma incompatibilidade aparece com arquivo e
50
+ linha. Rode, na ordem:
46
51
 
47
52
  ```bash
48
- pnpm typecheck # a API nova cobra os tipos
49
- pnpm exec opus check # convenções (regras novas inclusas)
50
- pnpm exec opus copy --check # inventário de copy em dia
51
- pnpm exec base copy check # política de copy da base
53
+ pnpm typecheck # a API nova confere os tipos
54
+ pnpm exec opus check # convenções, inclusive regras novas
55
+ pnpm exec opus copy --check # inventário de copy atualizado
56
+ pnpm exec base copy check # política de copy da Base
52
57
  pnpm test # comportamento
53
- pnpm manifest:check # a spec projetada ficou fresca?
58
+ pnpm manifest:check # o manifest projetado continua atualizado
54
59
  ```
55
60
 
56
- Num monorepo, `typecheck` e `test` existem na raiz, mas `manifest:check` é script de cada app:
57
- rode-o no diretório do app ou com `pnpm -r run manifest:check`. Nenhum desses comandos migra o
61
+ Num monorepo, `typecheck` e `test` existem na raiz, mas `manifest:check` é um script de cada app:
62
+ rode-o no diretório do app ou com `pnpm -r run manifest:check`. Nenhum desses comandos altera o
58
63
  banco. Se o projeto tiver testes de integração, eles usam o banco que o próprio projeto configurar.
59
64
 
60
65
  ## 4. Migrar o banco, se houver
61
66
 
62
67
  Se o `opus.config.ts` declara `database`, confira o schema e aplique a migração como uma etapa
63
- separada, contra o banco do ambiente que você pretende alterar:
68
+ separada:
64
69
 
65
70
  ```bash
66
71
  pnpm exec opus db check # compara entidades e banco, sem escrever
67
72
  pnpm exec opus db migrate # aplica o schema idempotente; escreve no banco
68
73
  ```
69
74
 
70
- Com todas as verificações verdes, revise a atualização como qualquer outra mudança de código antes
71
- de entregá-la.
75
+ Os comandos `opus db` carregam o `.env` que está ao lado do `opus.config.ts` antes de abrir a
76
+ conexão, e uma variável já definida no ambiente vence o arquivo. Antes de migrar, confirme para
77
+ qual banco a factory `database` vai apontar. Para migrar outro ambiente, informe a variável no
78
+ próprio comando, como `DATABASE_URL=… pnpm exec opus db migrate` quando a factory lê essa variável.
79
+
80
+ Com todas as verificações aprovadas, revise a atualização como qualquer outra mudança de código
81
+ antes de entregá-la.
72
82
 
73
83
  ## Pulou muitas versões?
74
84
 
75
- O ritual não muda, só o volume: leia todas as entradas acumuladas, não só as seções Breaking
76
- (o changelog é uma lista, não um diff), aplique na ordem e deixe os gates validarem o conjunto.
77
- Não há caminho especial — é o mesmo laço, com mais iterações.
85
+ O fluxo é o mesmo, com mais entradas para ler. Leia todas as entradas acumuladas, não só as seções
86
+ Breaking, aplique as migrações na ordem das versões e deixe os gates validarem o conjunto.
@@ -11,6 +11,11 @@
11
11
  * `mountDocs`. Importando o MESMO CSS do app, a doc herda identidade e utilitários de
12
12
  * graça. É dev-only (apply: 'serve') — nada vai pro bundle de produção.
13
13
  *
14
+ * O CSS entra por um entry CSS virtual que importa o do app e acrescenta um `@source` para
15
+ * as páginas `.md` da doc do Opus. Os exemplos ```tsx preview usam classes que só aparecem
16
+ * nesses `.md`, e o Tailwind do app não varre o pacote instalado. O `@source` fica só nesse
17
+ * entry: o CSS de produção do app não muda.
18
+ *
14
19
  * Uso (vite.config.ts do app):
15
20
  * import { opusDocs } from '@softize/opus/ui/docs/plugin'
16
21
  * export default defineConfig({ plugins: [react(), tailwindcss(), opusDocs()] })
@@ -36,6 +41,29 @@ const VIRTUAL_ID = 'virtual:opus-docs-entry'
36
41
  // O `/@id/` é como o vite serve módulos por id; o `\0` (convenção de virtual) vira `__x00__` na URL.
37
42
  const RESOLVED_ID = '\0' + VIRTUAL_ID
38
43
  const ENTRY_URL = '/@id/__x00__' + VIRTUAL_ID
44
+ // A extensão `.css` faz o Vite e o @tailwindcss/vite tratarem o módulo virtual como folha de estilo.
45
+ const VIRTUAL_CSS_ID = 'virtual:opus-docs-entry.css'
46
+ const RESOLVED_CSS_ID = '\0' + VIRTUAL_CSS_ID
47
+
48
+ /**
49
+ * Pasta das páginas `.md` da doc do Opus, ao lado deste arquivo. O Node carrega o plugin pelo
50
+ * caminho real (resolve o symlink do pnpm/workspace), então `import.meta.url` já aponta para
51
+ * onde o scanner do Tailwind encontra os arquivos.
52
+ *
53
+ * Sem builtins do Node: o arquivo mora em `ui/`, e o gate de fronteira proíbe `node:*` ali.
54
+ * Sem `new URL('./content', import.meta.url)`: o Vite reescreve esse padrão como asset.
55
+ */
56
+ export function opusDocsContentDir(moduleUrl: string = import.meta.url): string {
57
+ const folder = moduleUrl.slice(0, moduleUrl.lastIndexOf('/'))
58
+ const path = decodeURIComponent(new URL(folder).pathname)
59
+ // No Windows o pathname vem como `/C:/…`; o Tailwind espera `C:/…`.
60
+ return (/^\/[A-Za-z]:\//.test(path) ? path.slice(1) : path) + '/content'
61
+ }
62
+
63
+ /** O CSS do entry virtual: o do app (tema + tailwind) + a varredura dos `.md` da doc. */
64
+ export function opusDocsEntryCss(appCss: string, contentDir: string = opusDocsContentDir()): string {
65
+ return [`@import ${JSON.stringify(appCss)};`, `@source ${JSON.stringify(contentDir + '/*.md')};`].join('\n')
66
+ }
39
67
 
40
68
  export function opusDocs(options: opusDocsOptions = {}): Plugin {
41
69
  const basePath = options.basePath ?? '/__docs'
@@ -48,12 +76,18 @@ export function opusDocs(options: opusDocsOptions = {}): Plugin {
48
76
  apply: 'serve',
49
77
  resolveId(id) {
50
78
  if (id === VIRTUAL_ID) return RESOLVED_ID
79
+ if (id === VIRTUAL_CSS_ID) return RESOLVED_CSS_ID
51
80
  return undefined
52
81
  },
53
- load(id) {
82
+ async load(id) {
83
+ if (id === RESOLVED_CSS_ID) {
84
+ // O `@import` do entry virtual não tem pasta de referência: vai com o caminho resolvido.
85
+ const resolved = await this.resolve(css)
86
+ return opusDocsEntryCss(resolved?.id ?? css)
87
+ }
54
88
  if (id !== RESOLVED_ID) return undefined
55
89
  // Sempre importa o CSS do app (tema + tailwind) antes de subir a doc.
56
- const head = `import ${JSON.stringify(css)}`
90
+ const head = `import ${JSON.stringify(VIRTUAL_CSS_ID)}`
57
91
  if (source === undefined || source === '') {
58
92
  // Sem `source`: a doc do próprio Opus (DOC_SECTIONS), como sempre.
59
93
  return [head, `import { mountDocs } from '@softize/opus/ui/docs/standalone'`, `mountDocs({ basePath: ${JSON.stringify(basePath)} })`].join('\n')
@@ -37,6 +37,7 @@ import executionsMd from "./content/executions.md?raw";
37
37
  import schedulerMd from "./content/scheduler.md?raw";
38
38
  import actionsMd from "./content/actions.md?raw";
39
39
  import dataMd from "./content/data.md?raw";
40
+ import dataProductsMd from "./content/data-products.md?raw";
40
41
  import storageMd from "./content/storage.md?raw";
41
42
  import aiMd from "./content/ai.md?raw";
42
43
  import mcpMd from "./content/mcp.md?raw";
@@ -125,6 +126,7 @@ import actionSearchDialogMd from "./content/action-list-dialog.md?raw";
125
126
  import pageMd from "./content/page.md?raw";
126
127
  import presentationMd from "./content/presentation.md?raw";
127
128
  import contentMd from "./content/content.md?raw";
129
+ import paneMd from "./content/pane.md?raw";
128
130
  import sidebarMd from "./content/sidebar.md?raw";
129
131
  import splitMd from "./content/split.md?raw";
130
132
  import routerMd from "./content/router.md?raw";
@@ -275,6 +277,11 @@ export const PROTOCOL_SECTIONS: DocSection[] = [
275
277
  render: doc(runtimeMd),
276
278
  },
277
279
  { slug: "data", title: "Camada de dados", render: doc(dataMd) },
280
+ {
281
+ slug: "data-products",
282
+ title: "Produtos de Dados",
283
+ render: doc(dataProductsMd),
284
+ },
278
285
  {
279
286
  slug: "testing",
280
287
  title: "Testes de action",
@@ -418,8 +425,13 @@ export const UI_SECTIONS: DocSection[] = [
418
425
  pages: [
419
426
  {
420
427
  slug: "split",
421
- title: "Split & Pane",
422
- render: pattern("Split & Pane", "split", splitMd),
428
+ title: "Split",
429
+ render: pattern("Split", "split", splitMd),
430
+ },
431
+ {
432
+ slug: "pane",
433
+ title: "Pane",
434
+ render: pattern("Pane", "pane", paneMd),
423
435
  },
424
436
  {
425
437
  slug: "sidebar",