@softize/opus 25.0.0 → 25.2.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 (46) hide show
  1. package/CHANGELOG.md +93 -0
  2. package/bin/cli.mjs +5 -0
  3. package/bin/lib/assistant-schema.d.mts +55 -0
  4. package/bin/lib/assistant-schema.mjs +286 -0
  5. package/bin/lib/check.mjs +173 -0
  6. package/bin/lib/copy.mjs +2 -0
  7. package/bin/lib/gen-manifest.mjs +3 -0
  8. package/bin/lib/gen-runner.mjs +29 -1
  9. package/bin/lib/mcp.mjs +1 -1
  10. package/docs/adr/0052-floating-layer-coexists-with-modal-surfaces.md +668 -0
  11. package/docs/adr/0053-read-action-declares-the-resource-assistant.md +443 -0
  12. package/docs/protocol.md +54 -0
  13. package/docs/releasing.md +8 -2
  14. package/docs/stacking-scale.md +53 -0
  15. package/package.json +10 -1
  16. package/registry/skills/create-opus-action/SKILL.md +8 -3
  17. package/registry/skills/create-opus-action/references/contract-and-binding.md +24 -1
  18. package/registry/skills/create-opus-action/references/evaluations.md +3 -0
  19. package/registry/skills/test-opus-action/SKILL.md +4 -1
  20. package/registry/skills/test-opus-action/references/evaluations.md +2 -0
  21. package/registry/skills/test-opus-action/references/harness.md +14 -0
  22. package/src/ai/index.ts +3 -0
  23. package/src/ai/resource-context.ts +113 -0
  24. package/src/core/assistant.ts +545 -0
  25. package/src/core/index.ts +23 -0
  26. package/src/core/runtime.ts +136 -0
  27. package/src/core/types.ts +34 -0
  28. package/src/mcp/index.ts +3 -0
  29. package/src/ui/components/primitives/dialog.tsx +285 -26
  30. package/src/ui/components/primitives/drawer.tsx +104 -13
  31. package/src/ui/components/primitives/floating-layer.tsx +79 -0
  32. package/src/ui/components/primitives/menu.tsx +17 -2
  33. package/src/ui/components/primitives/popover.tsx +6 -1
  34. package/src/ui/components/primitives/tooltip.tsx +6 -1
  35. package/src/ui/docs/content/actions.md +97 -1
  36. package/src/ui/docs/content/ai.md +4 -2
  37. package/src/ui/docs/content/cli.md +2 -1
  38. package/src/ui/docs/content/dialog.md +3 -0
  39. package/src/ui/docs/content/drawer.md +3 -0
  40. package/src/ui/docs/content/floating-layer.md +178 -0
  41. package/src/ui/docs/content/mcp.md +3 -1
  42. package/src/ui/docs/registry.tsx +6 -0
  43. package/src/ui/lib/dismiss-on-iframe.ts +4 -1
  44. package/src/ui/lib/modal-layers.ts +547 -0
  45. package/src/ui/meta.ts +6 -0
  46. package/src/ui/react.tsx +4 -0
@@ -0,0 +1,178 @@
1
+ Use `FloatingLayer` para uma região que acompanha a aplicação inteira e precisa continuar utilizável
2
+ por cima de qualquer `Dialog` ou `Drawer`, como o botão e o painel de um assistente. Quem está
3
+ preenchendo um formulário em um modal pode abrir o painel, perguntar e voltar ao formulário, que
4
+ continua aberto e com o que já foi digitado.
5
+
6
+ No exemplo, abra o formulário, digite um nome e use o assistente no canto inferior direito. O modal
7
+ não fecha, e fechar o painel devolve o foco ao campo em que você estava.
8
+
9
+ ```tsx preview
10
+ function AssistantDemo() {
11
+ const [editing, setEditing] = useState(false);
12
+ const [assistant, setAssistant] = useState(false);
13
+
14
+ return (
15
+ <>
16
+ <Dialog
17
+ open={editing}
18
+ onOpenChange={(open) => {
19
+ setEditing(open);
20
+ if (!open) setAssistant(false);
21
+ }}
22
+ >
23
+ <DialogTrigger asChild>
24
+ <Button variant="outline">Editar cliente</Button>
25
+ </DialogTrigger>
26
+ <DialogContent>
27
+ <DialogHeader>
28
+ <DialogTitle>Editar cliente</DialogTitle>
29
+ </DialogHeader>
30
+ <DialogBody>
31
+ <Input aria-label="Nome do cliente" placeholder="Nome do cliente" />
32
+ </DialogBody>
33
+ <DialogFooter>
34
+ <DialogClose asChild>
35
+ <Button>Salvar</Button>
36
+ </DialogClose>
37
+ </DialogFooter>
38
+ </DialogContent>
39
+ </Dialog>
40
+ {editing && (
41
+ <FloatingLayer onEscapeKeyDown={() => setAssistant(false)}>
42
+ {assistant ? (
43
+ <aside
44
+ aria-label="Assistente"
45
+ className="absolute right-4 bottom-4 flex w-80 flex-col gap-3 rounded-xl border border-border bg-background p-4 shadow-lg"
46
+ >
47
+ <p className="text-sm">Pergunte sobre o cliente que você está editando.</p>
48
+ <Textarea aria-label="Mensagem" placeholder="Sua pergunta" />
49
+ <Button variant="ghost" onClick={() => setAssistant(false)}>
50
+ Fechar o assistente
51
+ </Button>
52
+ </aside>
53
+ ) : (
54
+ <Button className="absolute right-4 bottom-4" onClick={() => setAssistant(true)}>
55
+ Abrir o assistente
56
+ </Button>
57
+ )}
58
+ </FloatingLayer>
59
+ )}
60
+ </>
61
+ );
62
+ }
63
+
64
+ render(<AssistantDemo />);
65
+ ```
66
+
67
+ O exemplo monta a camada só enquanto o formulário está aberto para não deixar um botão fixo nesta
68
+ página. Em uma aplicação, a camada costuma ficar montada o tempo todo, na raiz.
69
+
70
+ ## Posicionar os filhos
71
+
72
+ `FloatingLayer` porta os filhos para um hospedeiro próprio, `div[data-slot="floating-layer"]`, no
73
+ fim do `body`. O hospedeiro ocupa a janela inteira, fica acima dos modais e não recebe clique; cada
74
+ filho direto recebe. Por isso, posicione cada filho com `absolute` contra a janela, como `right-4
75
+ bottom-4`, e não espere que ele siga a moldura da página.
76
+
77
+ Com um modal aberto, o hospedeiro informa qual `Dialog` ou `Drawer` está no topo. Diálogos que exigem
78
+ resposta não entram nesse sinal, porque cobrem a camada enquanto estão abertos:
79
+
80
+ - `data-modal` vale `none`, `dialog` ou `drawer`;
81
+ - `data-modal-side` traz o lado do Drawer: `left`, `right`, `top` ou `bottom`.
82
+
83
+ O Opus não desloca nem redimensiona modais por causa da camada. Use esses atributos para tirar o
84
+ painel de cima do que a pessoa precisa ver. Um Drawer abre, por padrão, do lado direito, o mesmo
85
+ canto do botão do exemplo; com a variante `in-data-*` do Tailwind, o painel troca de lado enquanto
86
+ esse Drawer estiver aberto:
87
+
88
+ ```tsx
89
+ <aside
90
+ aria-label="Assistente"
91
+ className="absolute right-4 bottom-4 in-data-[modal-side=right]:right-auto in-data-[modal-side=right]:left-4"
92
+ >
93
+ …
94
+ </aside>
95
+ ```
96
+
97
+ Podem existir várias camadas ao mesmo tempo. A que monta depois fica por cima.
98
+
99
+ ## O que muda enquanto um modal está aberto
100
+
101
+ Sem nenhum modal aberto, a camada é uma região comum da página. Com um `Dialog` ou `Drawer` aberto,
102
+ o modal passa a tratar a camada como parte de dentro dele:
103
+
104
+ | Aspecto | Comportamento |
105
+ | --------------- | ------------------------------------------------------------------------------------------------------ |
106
+ | Clique | A camada recebe clique e não fecha o modal, mesmo que o elemento clicado suma no próprio clique. |
107
+ | Véu | Clicar no véu continua fechando o modal, respeitando `closeDisabled`. |
108
+ | Foco | O foco pode ir para a camada por clique ou por código e não é puxado de volta. |
109
+ | Tab | Depois do último elemento do modal vem a camada; depois da camada, o primeiro elemento do modal. |
110
+ | Rolagem | A camada rola; a página atrás continua travada. |
111
+ | Leitor de tela | O modal e a camada ficam visíveis; o resto da página continua escondido. |
112
+
113
+ Quando o painel fecha com o foco dentro dele, ou a camada inteira sai da tela, o foco volta ao
114
+ elemento do modal que a pessoa usava antes de entrar na camada. Se esse elemento não existir mais,
115
+ vai para o primeiro elemento do modal. No sentido inverso, um modal que fecha enquanto a pessoa
116
+ digita na camada não leva o foco de volta ao botão que o abriu: o foco fica na camada.
117
+
118
+ Os patterns construídos sobre `Dialog` e `Drawer`, como [`ActionFormDialog`](/ui/action-form-dialog),
119
+ [`ActionListDialog`](/ui/action-list-dialog) e [`Presentation`](/ui/presentation), ganham esse
120
+ comportamento sem nenhuma configuração.
121
+
122
+ ## Esc
123
+
124
+ O Esc age onde a pessoa está. Com o foco na camada, ou depois de um clique em uma área do painel que
125
+ não recebe foco, nenhum modal fecha e o Opus chama `onEscapeKeyDown` uma vez por tecla. Com o foco
126
+ no modal, o Esc fecha o modal, como sempre. Sem modal aberto, `onEscapeKeyDown` também é chamado
127
+ quando a pessoa está na camada.
128
+
129
+ Trate o Esc da camada só por `onEscapeKeyDown`. Para impedir que o modal feche, o Opus marca o evento
130
+ com `preventDefault` antes de ele chegar aos elementos da camada; um `onKeyDown` próprio para Esc no
131
+ painel trataria a tecla duas vezes ou leria um evento já marcado.
132
+
133
+ Um popover ou menu aberto dentro da camada fecha primeiro, e só o Esc seguinte chega a ela. O mesmo
134
+ vale, no sentido inverso, para um popover aberto dentro do modal: ele fecha antes, mesmo com a
135
+ pessoa na camada.
136
+
137
+ ## Conteúdo aberto de dentro da camada
138
+
139
+ `Popover`, `Menu`, `Tooltip`, `Select`, `Dialog` e `Drawer` abertos de dentro da camada vão para o
140
+ hospedeiro dela. Assim, o menu de uma conversa abre por cima do painel que o abriu, e não por baixo
141
+ dele.
142
+
143
+ Um `Dialog` ou `Drawer` aberto de dentro da camada é modal para tudo, inclusive para a própria
144
+ camada: prende o foco, fecha pelo véu e pelo Esc e não chama o `onEscapeKeyDown` da camada.
145
+
146
+ ## Diálogos de resposta obrigatória
147
+
148
+ `Dialog mode="alert"` e as confirmações de [`dialog.confirm`](/ui/dialog) exigem uma resposta antes
149
+ de qualquer outra coisa. Enquanto um deles está aberto, o véu dele cobre a camada, o foco não chega
150
+ a ela e o leitor de tela a esconde. Isso vale também para um `Dialog` aberto de dentro do alerta.
151
+ Ao responder, a camada volta a funcionar com o modal que estava aberto antes.
152
+
153
+ ## Rolagem no toque
154
+
155
+ Num arrasto de toque, a rolagem que chega ao fim de uma área do painel pode passar a rolar a página
156
+ atrás do modal. Aplique `overscroll-contain` nas áreas roláveis da camada, como o histórico de uma
157
+ conversa. A propriedade só age no contêiner que rola, por isso o Opus não consegue aplicá-la por
158
+ você.
159
+
160
+ ## Acessibilidade
161
+
162
+ - O hospedeiro não tem papel ARIA. Dê semântica aos filhos, como um `aside` com `aria-label` para o
163
+ painel e um nome claro para o botão que o abre.
164
+ - O hospedeiro carrega `aria-live="off"`, o valor padrão do atributo: a camada não anuncia mudanças
165
+ por conta própria, e regiões vivas de dentro dela, como a de um [`Ask`](/ui/ask), mantêm o próprio
166
+ comportamento. O atributo é o que mantém a camada visível ao leitor de tela com um modal aberto.
167
+ - O foco e o Tab descritos acima são verificados em Chromium por testes automatizados. Safari,
168
+ Firefox e a leitura com VoiceOver ainda não foram verificados: o roteiro manual da ADR 0052 roda
169
+ na adoção pela Grand Brasil, em Safari com VoiceOver e no Firefox, antes de ela chegar à versão
170
+ principal da plataforma. Leitores de tela do Windows, como o NVDA, ficam fora dessa verificação.
171
+
172
+ ## Propriedades de FloatingLayer
173
+
174
+ | Propriedade | Tipo | Padrão | Descrição |
175
+ | ----------------- | -------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
176
+ | `children` | `ReactNode` | | Elementos da camada. Cada filho direto recebe clique e se posiciona contra a janela. |
177
+ | `className` | `string` | | Classes do hospedeiro. A posição de cada filho continua sendo sua. |
178
+ | `onEscapeKeyDown` | `(event: KeyboardEvent) => void` | | Chamado uma vez por tecla quando a pessoa aperta Esc na camada, com ou sem modal aberto. Nenhum modal fecha nesse caso, e o Opus não fecha a camada. |
@@ -60,7 +60,9 @@ Quando a action declara o que faz com os dados, a tool traz também as anotaçõ
60
60
  `readOnlyHint` vem de `effect`. Numa action que escreve, `destructiveHint` vai sempre explícito, a
61
61
  partir de `ai.destructive`, porque o MCP trata a ausência numa escrita como destrutiva.
62
62
  Em `_meta`, `com.softize.opus/effect` repete o efeito e `com.softize.opus/personal-data` diz se a
63
- resposta contém dado pessoal. Veja [Actions](/docs/actions).
63
+ resposta contém dado pessoal. Na action dona de um tipo de recurso, `com.softize.opus/assistant`
64
+ traz o assistente declarado, para o host conhecê-lo pelo catálogo que já consulta e aplicar à saída
65
+ a mesma projeção com `projectAssistantContext`. Veja [Actions](/docs/actions).
64
66
 
65
67
  `CallTool` recusa com erro qualquer nome fora dessa lista; os demais seguem por `runtime.execute`.
66
68
  A exposição declarada em `ai` decide o que o cliente MCP pode executar, e a autorização do contexto
@@ -78,6 +78,7 @@ import detailMd from "./content/detail.md?raw";
78
78
  import dictionaryValueMd from "./content/dictionary-value.md?raw";
79
79
  import emptyValueMd from "./content/empty-value.md?raw";
80
80
  import drawerMd from "./content/drawer.md?raw";
81
+ import floatingLayerMd from "./content/floating-layer.md?raw";
81
82
  import menuMd from "./content/menu.md?raw";
82
83
  import emptyMd from "./content/empty.md?raw";
83
84
  import fieldMd from "./content/field.md?raw";
@@ -793,6 +794,11 @@ export const UI_SECTIONS: DocSection[] = [
793
794
  title: "Drawer",
794
795
  render: comp("Drawer", "drawer", drawerMd),
795
796
  },
797
+ {
798
+ slug: "floating-layer",
799
+ title: "Floating Layer",
800
+ render: comp("Floating Layer", "floating-layer", floatingLayerMd),
801
+ },
796
802
  { slug: "menu", title: "Menu", render: comp("Menu", "menu", menuMd) },
797
803
  {
798
804
  slug: "popover",
@@ -1,13 +1,16 @@
1
1
  import * as React from 'react'
2
2
 
3
3
  /**
4
- * Fecha a camada flutuante quando o clique cai DENTRO de um iframe.
4
+ * Fecha um popover ou menu aberto quando o clique cai DENTRO de um iframe.
5
5
  *
6
6
  * O navegador entrega o clique ao documento do iframe, e o documento de fora nunca fica
7
7
  * sabendo. Como toda dispensa por "clique fora" escuta eventos do documento de fora, o
8
8
  * popover/menu simplesmente NÃO fecha — fica pendurado sobre o conteúdo, e a pessoa
9
9
  * precisa achar um pedaço de página livre pra clicar.
10
10
  *
11
+ * Não confundir com a camada flutuante (`FloatingLayer`, ADR 0052), a região que convive com
12
+ * Dialog e Drawer modais; aqui o assunto são sobreposições transitórias presas a um gatilho.
13
+ *
11
14
  * Não é caso de borda pra nós: a cabine embute o preview num iframe, então metade da tela
12
15
  * é justamente a área onde clicar não fecha nada.
13
16
  *