@acropole/skills 1.7.0 → 1.7.1
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.
- package/README.md +9 -7
- package/bin/install.js +41 -9
- package/package.json +1 -1
- package/skills/acropole/SKILL.md +2 -2
- package/skills/acropole/references/fluxos/atualizar-libs-2026-10.md +51 -15
- package/skills/angular/SKILL.md +2 -1
- package/skills/angular/references/armadilhas.md +3 -3
- package/skills/auto-servico/references/roteiros.md +1 -1
- package/skills/auto-servico/references/tools.md +1 -1
- package/skills/hefesto/SKILL.md +7 -4
- package/skills/hefesto/references/diagnostico.md +1 -0
- package/skills/hefesto/references/mcp-roteiros.md +48 -7
- package/skills/orquestracao/SKILL.md +3 -1
- package/skills/orquestracao/scripts/coord.sh +10 -2
- package/skills/trismegisto/SKILL.md +57 -16
- package/skills/trismegisto/references/angular-api.md +3666 -64
- package/skills/trismegisto/references/angular-exports.md +8562 -2554
- package/skills/trismegisto/references/angular-recipes.md +315 -0
- package/skills/trismegisto/references/angular-types.md +92 -0
- package/skills/trismegisto/references/angular.md +67 -10
- package/skills/trismegisto/references/catalogo/icones.json +7 -0
- package/skills/trismegisto/references/catalogo/seletores.json +12102 -3443
- package/skills/trismegisto/references/catalogo/tokens.json +114 -0
- package/skills/trismegisto/references/spine-api.md +1105 -154
- package/skills/trismegisto/references/spine-recipes.md +28 -21
- package/skills/trismegisto/references/spine.md +29 -19
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Catálogo de API — @trismegisto/spine
|
|
2
2
|
|
|
3
|
-
> **Gerado** por `scripts/gerar/trismegisto-spine.mjs` a partir do código-fonte da versão 3.
|
|
3
|
+
> **Gerado** por `scripts/gerar/trismegisto-spine.mjs` a partir do código-fonte da versão 3.3.11, a cada `npm run sync` do @acropole/skills.
|
|
4
4
|
> Gerado do código-fonte do `@trismegisto/spine`. Confira a versão instalada no `package.json` do pacote em `node_modules`.
|
|
5
5
|
|
|
6
6
|
Uma seção por ponto de entrada (o `import` exato). Dentro dela: componentes (seletor, inputs/outputs),
|
|
@@ -56,6 +56,7 @@ Preferências do usuário que não são de tema (tema/família/densidade continu
|
|
|
56
56
|
- `readonly startPage: signal<SpineStartPagePreference>(…)` — Tela que abre depois do login.
|
|
57
57
|
- `readonly noticeTypes: signal<Readonly<Record<string, boolean>>>(…)` — Tipos de aviso que a pessoa ligou/desligou (`id` → ligado); tipo ausente segue o `defaultEnabled` dele.
|
|
58
58
|
- `readonly browserNotices: signal(…)` — Aviso do navegador (Notification API) quando a aba está em segundo plano.
|
|
59
|
+
- `readonly splitTabs: signal(…)` — Dividir a área de abas em painéis (lado a lado ou empilhados). Padrão: desligado, um painel só.
|
|
59
60
|
- `setCharacterKeys(enabled: boolean): void` — Liga/desliga os atalhos de tecla única na hora, guarda e avisa as outras abas.
|
|
60
61
|
- `setLanguage(value: string): void` — Troca o idioma da lib e do spine na hora, guarda e avisa as outras abas. Vazio = padrão do app.
|
|
61
62
|
- `setTextScale(value: number): void` — Tamanho do texto na hora (1 = 100%), guarda e avisa as outras abas.
|
|
@@ -67,6 +68,7 @@ Preferências do usuário que não são de tema (tema/família/densidade continu
|
|
|
67
68
|
- `setNoticeType(id: string, enabled: boolean): void` — Liga/desliga um tipo de aviso, guarda e avisa as outras abas.
|
|
68
69
|
- `setNoticeTypes(value: Readonly<Record<string, boolean>>): void` — Troca o mapa inteiro de tipos de aviso (restaurar, sincronização com a conta).
|
|
69
70
|
- `setBrowserNotices(enabled: boolean): void` — Liga/desliga o aviso do navegador, guarda e avisa as outras abas (a permissão é pedida por quem chama).
|
|
71
|
+
- `setSplitTabs(enabled: boolean): void` — Liga/desliga a divisão da área de abas em painéis, guarda e avisa as outras abas.
|
|
70
72
|
- `setTimeZone(value: string): void`
|
|
71
73
|
- `supportedTimeZones(): string[]` — Todos os fusos IANA que o navegador conhece (vazio em navegador antigo).
|
|
72
74
|
|
|
@@ -94,14 +96,18 @@ Chaves de `localStorage` do shell por usuário: `<clientId>_<lista>_<sub>`, com
|
|
|
94
96
|
|
|
95
97
|
### Funções
|
|
96
98
|
|
|
97
|
-
- `function routerIdOf(route: Route | null | undefined): string | null` — `router_id` da tela (nó 'page')
|
|
99
|
+
- `function routerIdOf(route: Route | null | undefined): string | null` — `router_id` da tela (nó 'page'); `null` em nó de grupo.
|
|
98
100
|
- `function mergeRouteTree(routes: readonly Route[] | null | undefined): Route[]` — Funde nós IRMÃOS que apontam para o mesmo endereço (`route_redirect`), em toda a árvore.
|
|
99
101
|
- `function spineRoutesOf(view: { routes?: readonly Route[] | null } | null | undefined): Route[]` — A árvore fundida da view atual (`ViewService.currentView`) — ver `mergeRouteTree`.
|
|
100
|
-
- `function
|
|
102
|
+
- `function registerSpineBuiltinPage(page: SpineBuiltinPage): void` — Registra (ou troca) uma página do spine. Chamado no bootstrap, por quem liga o recurso (ex.: `provideShell`).
|
|
103
|
+
- `function spineBuiltinPageAt(url: string): SpineBuiltinPage | null` — A página do spine no endereço (sem query/fragmento), ou null.
|
|
104
|
+
- `function spineBuiltinPageById(routerId: string | null | undefined): SpineBuiltinPage | null` — A página do spine pelo `router_id` sintético (o que o distribuidor recebe), ou null.
|
|
105
|
+
- `function clearSpineBuiltinPages(): void` — Só para testes: esquece as páginas registradas.
|
|
106
|
+
- `function provideUi(config?: SpineConfig): EnvironmentProviders` — Bootstrap do spine: tema, favicon, prefixo de armazenamento do app e ícones.
|
|
101
107
|
- `function resolveSpineLogo(logo: SpineLogoConfig | false | null | undefined): SpineLogoSources | null` — Normaliza `SpineConfig.logo`: omitido → convenção; `false`/vazio → sem imagem (`null`).
|
|
108
|
+
- `function resolveSpineImage(logo: SpineLogoConfig | false | null | undefined, fallback: string | null): SpineLogoSources | null` — Normaliza uma imagem de marca do app: omitida → `fallback`, a convenção dela; `false`/vazio → sem imagem (`null`).
|
|
102
109
|
- `function applySpineFavicon(doc: Document, href: string): HTMLLinkElement | null` — Aponta o favicon do documento para `href`: atualiza o primeiro `<link rel="icon">` (ou `shortcut icon`) e remove os outros (senão o navegador pode continuar escolhendo um deles); sem nenhum, cria um no `<head>`. O `type` acompanha a extensão (some quando ela…
|
|
103
110
|
- `function applyRuntimeEnvironment(environment: RuntimeEnvironmentShape): RuntimeEnvironmentInfo` — Ajusta o `environment` ao lugar onde o app está rodando — chamar no `main.ts`, ANTES do `bootstrapApplication` e DEPOIS do `loadRuntimeConfig` (que traz o `config.json` do deploy: o que ele definir explicitamente não é derivado aqui). Antes cada app tinha a s…
|
|
104
|
-
- `function provideSpineNews(items: readonly SpineNewsItem[]): EnvironmentProviders` — Registra as novidades do app (no `app.config.ts`, junto do `provideUi`). Ficam no código, no mesmo commit da funcionalidade que anunciam. A ordem da lista é a ordem dos slides.
|
|
105
111
|
- `function currentSpineMessages(): SpineMessages` — Textos do spine no idioma ativo para quem não tem injeção (funções puras como o `unwrap` do `@trismegisto/spine/graphql`, chamado em qualquer lugar do app). É o mesmo catálogo vivo do `SPINE_MESSAGES` — segue `setLocale` — assim que o shell o injetou; antes d…
|
|
106
112
|
- `function provideSpineMessages(config: SpineI18nConfig): Provider` — Sobrescreve textos do spine e/ou acrescenta idiomas. O idioma em si vem de `provideHermesI18n`.
|
|
107
113
|
|
|
@@ -110,16 +116,18 @@ Chaves de `localStorage` do shell por usuário: `<clientId>_<lista>_<sub>`, com
|
|
|
110
116
|
- `HERMES_DS_IMPORTS`: `readonly Type<unknown>[]` — Ponto único de import dos componentes standalone do `@trismegisto/angular` usados nos templates do spine. O DS novo é standalone-only (sem agregador), então este array cumpre o mesmo papel prático: um `@Component({ imports: [...HERMES_DS_IMPORTS] })` em vez d…
|
|
111
117
|
- `SPINE_CONFIG`: `InjectionToken<SpineConfig>`
|
|
112
118
|
- `SPINE_DEFAULT_LOGO`: `'assets/images/logo.svg'` — Convenção quando o app não configura `logo`: `src/assets/images/logo.svg` servido em `assets/images/`.
|
|
119
|
+
- `SPINE_DEFAULT_AGENT_AVATAR`: `'assets/images/agent/avatar.png'` — Rosto do agente de IA (`SpineAiAgentConfig.avatar`): quadrado, em `src/assets/images/`.
|
|
120
|
+
- `SPINE_DEFAULT_AGENT_IMAGE`: `'assets/images/agent/figure.png'` — Imagem do agente de IA (`SpineAiAgentConfig.image`): de qualquer proporção, em `src/assets/images/`.
|
|
113
121
|
- `APP_PACKAGE_INFO`: `InjectionToken<PackageInfo>`
|
|
114
122
|
- `SPINE_IDLE_OPTIONS`: `readonly number[]` — Minutos de inatividade oferecidos em "Encerrar por inatividade" (0 = nunca).
|
|
115
123
|
- `SPINE_ADMIN_API`: `InjectionToken<string>` — Base da API do argos-admin-server (ex.: `https://exemplo.com.br/argos/admin/api`) — recursos do próprio usuário (`/me/*`, hoje os tokens de aplicação) que o painel de configurações usa. Quem chama `provideAutoService({ adminApi })` já fornece este token (é a…
|
|
116
124
|
- `SPINE_USER_STORAGE_KEYS` — Listas do shell guardadas no navegador, por usuário.
|
|
117
|
-
- `SPINE_NEWS`: `InjectionToken<readonly (readonly SpineNewsItem[])[]>` — Multi: cada chamada de `provideSpineNews` contribui com uma lista.
|
|
118
125
|
- `SPINE_MESSAGES_PT_BR`: `SpineMessages`
|
|
119
126
|
- `SPINE_MESSAGES_EN`: `SpineMessages`
|
|
120
127
|
- `SPINE_MESSAGES_ES`: `SpineMessages`
|
|
121
128
|
- `SPINE_I18N_CONFIG`: `InjectionToken<SpineI18nConfig>`
|
|
122
129
|
- `SPINE_MESSAGES`: `InjectionToken<SpineMessages>` — Textos do spine no idioma ativo da lib (`HermesI18nService.locale`): uma troca de idioma com `setLocale` atualiza a lib e o spine juntos, sem recarregar. Leitura igual à do `HERMES_MESSAGES` (`inject(SPINE_MESSAGES).header.settings`), viva também em template.
|
|
130
|
+
- `SPINE_ICONS`: `readonly RegisteredIcon[]` — Os 133 ícones que o spine usa por dentro.
|
|
123
131
|
|
|
124
132
|
### Tipos
|
|
125
133
|
|
|
@@ -129,12 +137,6 @@ Chaves de `localStorage` do shell por usuário: `<clientId>_<lista>_<sub>`, com
|
|
|
129
137
|
interface Route {
|
|
130
138
|
route_display_name?: string | null;
|
|
131
139
|
route_icon?: string | null;
|
|
132
|
-
/**
|
|
133
|
-
* @deprecated use `router_id` (ou `routerIdOf`). Nome histórico: no nó 'page' o argos-auth-server
|
|
134
|
-
* sempre mandou aqui o `router_id` (nunca o `web.routes.route_id`, que é `routed_id`). Continua
|
|
135
|
-
* vindo, com o mesmo valor, para spines/Orfeu antigos.
|
|
136
|
-
*/
|
|
137
|
-
route_id?: string | null;
|
|
138
140
|
route_name?: string | null;
|
|
139
141
|
route_order?: number | null;
|
|
140
142
|
route_path?: string | null;
|
|
@@ -148,8 +150,7 @@ interface Route {
|
|
|
148
150
|
* Identidade da TELA: o router do client (`web.router.router_id`, a posição da tela na
|
|
149
151
|
* navegação). Só no nó 'page' -- nó de grupo (navigation/menu/...) é compartilhado por vários
|
|
150
152
|
* routers e não tem um próprio. É por ele que o spine acha o componente (`COMPONENT_ROUTES`),
|
|
151
|
-
* o documento e a descrição.
|
|
152
|
-
* no `route_id` (mesmo valor).
|
|
153
|
+
* o documento e a descrição.
|
|
153
154
|
*/
|
|
154
155
|
router_id?: string | null;
|
|
155
156
|
/** Texto curto da tela (`web.router.description`), exibido na barra da página abaixo do título. */
|
|
@@ -162,6 +163,19 @@ interface Route {
|
|
|
162
163
|
}
|
|
163
164
|
```
|
|
164
165
|
|
|
166
|
+
#### `SpineBuiltinPage` (interface)
|
|
167
|
+
|
|
168
|
+
Página que o PRÓPRIO spine desenha, fora da árvore de rotas do backend (ex.: "Sugestões do app", de quem pede).
|
|
169
|
+
|
|
170
|
+
```ts
|
|
171
|
+
interface SpineBuiltinPage {
|
|
172
|
+
/** O nó da página: `route_redirect` (o endereço, ex. "/sugestoes"), nome, ícone e `router_id` (a chave). */
|
|
173
|
+
readonly route: Route;
|
|
174
|
+
/** Componente da página, via `import()` (fica num chunk próprio). */
|
|
175
|
+
readonly load: () => Promise<Type<unknown>>;
|
|
176
|
+
}
|
|
177
|
+
```
|
|
178
|
+
|
|
165
179
|
#### `DensitySetting` (interface)
|
|
166
180
|
|
|
167
181
|
```ts
|
|
@@ -176,10 +190,11 @@ interface DensitySetting {
|
|
|
176
190
|
interface SpineConfig {
|
|
177
191
|
clientId: string;
|
|
178
192
|
/**
|
|
179
|
-
*
|
|
180
|
-
* (`
|
|
181
|
-
*
|
|
182
|
-
* se monta e exporta no
|
|
193
|
+
* Sobrescritas do app (opcional): nome e cores de uma família da lib (`replace: { poseidon: minhaFamilia }`) e o
|
|
194
|
+
* desenho de uma fonte da lib (`replaceFonts: { figtree: minhaFonte }`), mais as iniciais (`defaultFamily`,
|
|
195
|
+
* `defaultFont`). O app não acrescenta família nem fonte: o id salvo é sempre o da lib, e um app sem a sobrescrita
|
|
196
|
+
* mostra a original. Ver `extendThemeConfig` do `@trismegisto/primitives`; a família se monta e exporta no
|
|
197
|
+
* `hm-theme-builder`.
|
|
183
198
|
*/
|
|
184
199
|
theme?: HermesThemeExtension;
|
|
185
200
|
/** Nome do app exibido ao lado do logo no header (ex.: "Meu App"). Padrão: "Hermes". */
|
|
@@ -229,6 +244,10 @@ interface SpineMcpServer {
|
|
|
229
244
|
readScopes?: string;
|
|
230
245
|
/** Valor de `x-mcp-scopes` no modo leitura e escrita (ex.: `deploy.*`). Omitido: o servidor só é oferecido para leitura. */
|
|
231
246
|
writeScopes?: string;
|
|
247
|
+
/** Só oferecido a quem tem um destes níveis (nome do badge, sem diferenciar maiúsculas), e o token sai com um deles. Omitido: qualquer nível. */
|
|
248
|
+
onlyBadges?: readonly string[];
|
|
249
|
+
/** Nunca oferecido com estes níveis (nome do badge, sem diferenciar maiúsculas): o token não sai com eles. */
|
|
250
|
+
exceptBadges?: readonly string[];
|
|
232
251
|
}
|
|
233
252
|
```
|
|
234
253
|
|
|
@@ -247,15 +266,48 @@ interface SpineNoticeType {
|
|
|
247
266
|
}
|
|
248
267
|
```
|
|
249
268
|
|
|
269
|
+
#### `SpineAiAgentConfig` (interface)
|
|
270
|
+
|
|
271
|
+
```ts
|
|
272
|
+
interface SpineAiAgentConfig {
|
|
273
|
+
http: string;
|
|
274
|
+
ws: string;
|
|
275
|
+
/** O nome do agente: no balão, no painel, no ícone do cabeçalho e nas iniciais do avatar. Padrão: "Agente de IA". */
|
|
276
|
+
title?: string;
|
|
277
|
+
/**
|
|
278
|
+
* O rosto do agente, quadrado: no balão, nas mensagens e no alto do painel. Funciona como `SpineConfig.logo`:
|
|
279
|
+
* - omitido: convenção `assets/images/agent/avatar.png` (`SPINE_DEFAULT_AGENT_AVATAR`), basta o arquivo existir no app;
|
|
280
|
+
* - `'assets/...'`: um arquivo só, para os dois temas;
|
|
281
|
+
* - `{ light, dark? }`: `dark` é usado no tema escuro;
|
|
282
|
+
* - `false`: sem imagem, e sem nenhuma requisição.
|
|
283
|
+
* Se não carregar, ficam o ícone no balão e as iniciais de `title` nas mensagens.
|
|
284
|
+
*/
|
|
285
|
+
avatar?: SpineLogoConfig | false;
|
|
286
|
+
/** O rosto enquanto o agente trabalha numa resposta. Sem convenção: omitido, vale `avatar`. */
|
|
287
|
+
avatarThinking?: SpineLogoConfig | false;
|
|
288
|
+
/**
|
|
289
|
+
* A figura do agente, de qualquer proporção, ao lado do convite e na conversa vazia. Mesmas formas de `avatar`, com a convenção
|
|
290
|
+
* `assets/images/agent/figure.png` (`SPINE_DEFAULT_AGENT_IMAGE`). Se não carregar, o convite fica só com o texto.
|
|
291
|
+
*/
|
|
292
|
+
image?: SpineLogoConfig | false;
|
|
293
|
+
/** O convite ao lado do balão. O texto padrão diz que dá para perguntar sobre a aplicação. */
|
|
294
|
+
greeting?: { title?: string; text?: string };
|
|
295
|
+
}
|
|
296
|
+
```
|
|
297
|
+
|
|
250
298
|
#### `SpineFeatures` (interface)
|
|
251
299
|
|
|
252
300
|
Recursos opcionais do painel de configurações. Cada um só aparece quando ligado aqui (e, quando depende do Argos, com a API da conta disponível — `AUTH_CONFIG` com `authority`/`realmId`).
|
|
253
301
|
|
|
254
302
|
```ts
|
|
255
303
|
interface SpineFeatures {
|
|
304
|
+
/** Conversa com o agente de IA do app, num botão flutuante no canto inferior direito. Fala com o gateway de agentes:
|
|
305
|
+
* `http` e `ws` são os endereços dele. Qual é o agente o app não informa: o gateway o descobre pelo client do token.
|
|
306
|
+
* Só leitura ou não, quem decide é o backend do agente. */
|
|
307
|
+
aiAgent?: SpineAiAgentConfig;
|
|
256
308
|
/** Sessões › "Conectar um agente de IA": gera um token de aplicação e a configuração MCP pronta para colar.
|
|
257
309
|
* Precisa de `SPINE_ADMIN_API` (tokens de aplicação). */
|
|
258
|
-
|
|
310
|
+
mcpConnect?: { servers: readonly SpineMcpServer[] };
|
|
259
311
|
/** MFA › "Atividade da conta": entradas e tentativas que falharam desta conta (últimos 90 dias, API da conta). */
|
|
260
312
|
accountActivity?: boolean;
|
|
261
313
|
/** Conta › "Encerrar por inatividade". `true` = opções padrão; `{ min, max }` limita os minutos (com `max` a
|
|
@@ -270,6 +322,24 @@ interface SpineFeatures {
|
|
|
270
322
|
/** Preferências (aparência, região, acessibilidade, favoritos, tela inicial…) guardadas também na conta do Argos,
|
|
271
323
|
* para acompanharem a pessoa em qualquer navegador. Sem a API da conta, ficam só no navegador. */
|
|
272
324
|
accountPreferences?: boolean;
|
|
325
|
+
/** Configuração inicial em tela cheia no primeiro acesso (aparência e o essencial). Ligada por padrão; `false`
|
|
326
|
+
* desliga. "Feita" vale para a pessoa em todos os apps quando as preferências estão na conta. */
|
|
327
|
+
initialSetup?: boolean;
|
|
328
|
+
/** Avaliações (1 a 5 estrelas e um comentário): "Avaliar esta tela" na barra da página e "Avaliar o {app}" no menu
|
|
329
|
+
* do perfil; quem administra vê os resultados no auto-serviço (tela Avaliações). Ligado por padrão quando há
|
|
330
|
+
* `SPINE_ADMIN_API` (`/me/ratings`), como as sugestões; `false` desliga. Sem a API, nada aparece. */
|
|
331
|
+
ratings?: boolean;
|
|
332
|
+
/** Sugestões de melhoria: "Sugerir melhoria" na barra da página (com "Minhas sugestões"); quem administra acompanha
|
|
333
|
+
* num kanban no auto-serviço (tela Sugestões). Ligado por padrão quando há `SPINE_ADMIN_API`
|
|
334
|
+
* (`/me/suggestions`); `false` desliga. Sem a API, nada aparece. */
|
|
335
|
+
suggestions?: boolean;
|
|
336
|
+
/** Link "Pular para o conteúdo" (`hm-skip-link`) como primeira parada do Tab, levando o foco à área de trabalho.
|
|
337
|
+
* Desligado por padrão. */
|
|
338
|
+
skipLink?: boolean;
|
|
339
|
+
/** Aviso de alterações não salvas: com a tela registrada (`registerSpineUnsavedChanges`), fechar a aba dela (ou o
|
|
340
|
+
* painel, "fechar as outras"…) e trocar de tela dentro dela pedem confirmação, e o navegador avisa ao recarregar ou
|
|
341
|
+
* fechar a página. Desligado por padrão. */
|
|
342
|
+
unsavedChanges?: boolean;
|
|
273
343
|
}
|
|
274
344
|
```
|
|
275
345
|
|
|
@@ -351,6 +421,8 @@ interface QuickAccessItem {
|
|
|
351
421
|
readonly redirect: string;
|
|
352
422
|
/** Ancestor labels, top-down. `[]` = top-level page; absent = stored by an older version. */
|
|
353
423
|
readonly trail?: readonly string[];
|
|
424
|
+
/** When the page was last opened (epoch ms), for "12 min ago" on the home screen. Only on recents. */
|
|
425
|
+
readonly visitedAt?: number;
|
|
354
426
|
}
|
|
355
427
|
```
|
|
356
428
|
|
|
@@ -386,52 +458,9 @@ interface RuntimeEnvironmentInfo {
|
|
|
386
458
|
}
|
|
387
459
|
```
|
|
388
460
|
|
|
389
|
-
#### `SpineNewsIllustration` (interface)
|
|
390
|
-
|
|
391
|
-
Ilustração gerada pelo spine, nas cores do tema em vigor: o ícone da novidade no centro e, opcionalmente, selos (ícone + rótulo) orbitando em volta. Ícones são nomes do @trismegisto/icons.
|
|
392
|
-
|
|
393
|
-
```ts
|
|
394
|
-
interface SpineNewsIllustration {
|
|
395
|
-
readonly icon: string;
|
|
396
|
-
readonly satellites?: readonly { readonly icon: string; readonly label: string }[];
|
|
397
|
-
}
|
|
398
|
-
```
|
|
399
|
-
|
|
400
|
-
#### `SpineNewsSlide` (interface)
|
|
401
|
-
|
|
402
|
-
Um slide do painel de novidades.
|
|
403
|
-
|
|
404
|
-
```ts
|
|
405
|
-
interface SpineNewsSlide {
|
|
406
|
-
readonly title: string;
|
|
407
|
-
readonly text: string;
|
|
408
|
-
/** Ilustração desenhada pelo spine (recomendado — acompanha tema claro/escuro e família). */
|
|
409
|
-
readonly illustration?: SpineNewsIllustration;
|
|
410
|
-
/** Imagem própria (caminho em `assets/` do app); vence a `illustration`. Sem nenhuma das duas, o
|
|
411
|
-
* slide é só texto. */
|
|
412
|
-
readonly image?: string;
|
|
413
|
-
/** Descrição da imagem pra quem não a vê. Vazia marca a imagem como decorativa. */
|
|
414
|
-
readonly alt?: string;
|
|
415
|
-
}
|
|
416
|
-
```
|
|
417
|
-
|
|
418
|
-
#### `SpineNewsItem` (interface)
|
|
419
|
-
|
|
420
|
-
Uma novidade do app: aparece sozinha uma vez por navegador, depois do tour de boas-vindas, e fica marcada como vista ao ser exibida.
|
|
421
|
-
|
|
422
|
-
```ts
|
|
423
|
-
interface SpineNewsItem {
|
|
424
|
-
/** Chave estável. Trocar o id faz a novidade aparecer de novo para todo mundo. */
|
|
425
|
-
readonly id: string;
|
|
426
|
-
readonly slides: readonly SpineNewsSlide[];
|
|
427
|
-
/** Data (AAAA-MM-DD) a partir da qual a novidade deixa de ser oferecida. Opcional. */
|
|
428
|
-
readonly until?: string;
|
|
429
|
-
}
|
|
430
|
-
```
|
|
431
|
-
|
|
432
461
|
#### `SpineMessages` (interface)
|
|
433
462
|
|
|
434
|
-
Textos do próprio spine (cabeçalho, navegação, configurações,
|
|
463
|
+
Textos do próprio spine (cabeçalho, navegação, configurações, configuração inicial, telas do auto-serviço…), no mesmo formato do `HermesMessages` da lib: seção → chave, parâmetros nomeados (`{name}`) e plural por `PluralMessage`. Alguns textos levam marcação simples (`<b>`, `<strong>`, `<code>`) e são exibidos com `[innerHTML]` — estão indicados no comentário. Os que têm parâmetro saem por `forma…
|
|
435
464
|
|
|
436
465
|
_Declaração longa — veja `@trismegisto/spine` em `node_modules` (arquivo de tipos do ponto de entrada)._
|
|
437
466
|
|
|
@@ -454,8 +483,8 @@ interface SpineI18nConfig {
|
|
|
454
483
|
|
|
455
484
|
### Reexportados
|
|
456
485
|
|
|
457
|
-
- `loadRuntimeConfig` — o mesmo símbolo de `@trismegisto/primitives`
|
|
458
|
-
- `LoadRuntimeConfigOptions` — o mesmo símbolo de `@trismegisto/primitives`
|
|
486
|
+
- `loadRuntimeConfig` — o mesmo símbolo de `@trismegisto/primitives/runtime-config`
|
|
487
|
+
- `LoadRuntimeConfigOptions` — o mesmo símbolo de `@trismegisto/primitives/runtime-config`
|
|
459
488
|
|
|
460
489
|
## `@trismegisto/spine/audit`
|
|
461
490
|
|
|
@@ -902,6 +931,8 @@ interface LoginAttempt {
|
|
|
902
931
|
user_username: string | null;
|
|
903
932
|
user_name: string | null;
|
|
904
933
|
user_email: string | null;
|
|
934
|
+
/** Foto do usuário (a guardada pelo Argos ou a do provedor federado); servidor antigo não manda. */
|
|
935
|
+
user_picture?: string | null;
|
|
905
936
|
/** Identificador digitado no login local (pode não ser de usuário nenhum). */
|
|
906
937
|
username: string | null;
|
|
907
938
|
method: LoginAttemptMethod;
|
|
@@ -979,7 +1010,8 @@ interface AuditTopRow {
|
|
|
979
1010
|
- `createGroup(clientId: string, body: AutoServiceGroupCreate)`
|
|
980
1011
|
- `updateGroup(clientId: string, groupId: string, body: AutoServiceGroupUpdate)`
|
|
981
1012
|
- `deleteGroup(clientId: string, groupId: string)`
|
|
982
|
-
- `getGroupMembers(clientId: string, groupId: string)
|
|
1013
|
+
- `getGroupMembers(clientId: string, groupId: string, query: AutoServiceMembersQuery = {}): Observable<AutoServiceMembersPage>` — Uma página dos membros (o servidor pagina: padrão 50, até 200 por página), pela ordem do login, com busca por nome, login ou e-mail. Observable (não Promise): as telas pedem as páginas até o fim e cancelam a pendente ao…
|
|
1014
|
+
- `getMemberSuggestions(clientId: string, groupId: string, limit = 8)` — Sugestões para adicionar ao grupo: quem já está em outro grupo deste sistema e ainda não neste, com foto e os grupos.
|
|
983
1015
|
- `addGroupMember(clientId: string, groupId: string, userId: string, role: string | null)`
|
|
984
1016
|
- `updateGroupMemberRole(clientId: string, groupId: string, userId: string, role: string | null)`
|
|
985
1017
|
- `removeGroupMember(clientId: string, groupId: string, userId: string)`
|
|
@@ -1018,9 +1050,12 @@ interface AuditTopRow {
|
|
|
1018
1050
|
- `AUTO_SERVICE_CLIENT_TEMPLATE_ROUTER_ID`: `'ad100003-0000-4000-8000-000000000001'`
|
|
1019
1051
|
- `AUTO_SERVICE_AUDIT_TEMPLATE_ROUTER_ID`: `'ad100004-0000-4000-8000-000000000001'`
|
|
1020
1052
|
- `AUTO_SERVICE_LOGIN_ATTEMPTS_TEMPLATE_ROUTER_ID`: `'ad100005-0000-4000-8000-000000000001'`
|
|
1053
|
+
- `AUTO_SERVICE_NEWS_TEMPLATE_ROUTER_ID`: `'ad100006-0000-4000-8000-000000000001'`
|
|
1054
|
+
- `AUTO_SERVICE_SUGGESTIONS_TEMPLATE_ROUTER_ID`: `'ad100007-0000-4000-8000-000000000001'`
|
|
1055
|
+
- `AUTO_SERVICE_RATINGS_TEMPLATE_ROUTER_ID`: `'ad100008-0000-4000-8000-000000000001'`
|
|
1021
1056
|
- `AUTO_SERVICE_HOME_TEMPLATE_ROUTER_ID`: `'6a9a13db-f31b-494e-b51c-79af0ac28b60'`
|
|
1022
|
-
- `AUTO_SERVICE_SCREENS
|
|
1023
|
-
- `AUTO_SERVICE_DOCUMENTS`: `Readonly<Record<keyof typeof AUTO_SERVICE_SCREENS, RouteDocument>>` — Documentação das
|
|
1057
|
+
- `AUTO_SERVICE_SCREENS` — As 9 telas do auto-serviço, carregadas sob demanda. Cada `import()` relativo vira um chunk próprio no FESM publicado (`trismegisto-spine-auto-service-<tela>-<hash>.mjs`), que o bundler do app mantém fora do carregamento inicial. Não exporte as telas no `publi…
|
|
1058
|
+
- `AUTO_SERVICE_DOCUMENTS`: `Readonly<Record<keyof typeof AUTO_SERVICE_SCREENS, RouteDocument>>` — Documentação das 9 telas (botão de documentação da barra da página e índice "Documentação do sistema"): o manual de uso (`load`) e a especificação técnica (`loadTechnical`, só com `SpineConfig.technicalDocs`). O Markdown fica em módulos `.ts` próprios em `./d…
|
|
1024
1059
|
|
|
1025
1060
|
### Tipos
|
|
1026
1061
|
|
|
@@ -1083,6 +1118,47 @@ interface AutoServiceGroup {
|
|
|
1083
1118
|
}
|
|
1084
1119
|
```
|
|
1085
1120
|
|
|
1121
|
+
#### `AutoServiceMembersQuery` (interface)
|
|
1122
|
+
|
|
1123
|
+
Página e filtros de `GET /groups/:groupId/members`.
|
|
1124
|
+
|
|
1125
|
+
```ts
|
|
1126
|
+
interface AutoServiceMembersQuery {
|
|
1127
|
+
page?: number;
|
|
1128
|
+
limit?: number;
|
|
1129
|
+
search?: string;
|
|
1130
|
+
}
|
|
1131
|
+
```
|
|
1132
|
+
|
|
1133
|
+
#### `AutoServiceMembersPage` (interface)
|
|
1134
|
+
|
|
1135
|
+
Uma página de membros: `total` conta quem passa pela busca.
|
|
1136
|
+
|
|
1137
|
+
```ts
|
|
1138
|
+
interface AutoServiceMembersPage {
|
|
1139
|
+
members: any[];
|
|
1140
|
+
total: number;
|
|
1141
|
+
page: number;
|
|
1142
|
+
limit: number;
|
|
1143
|
+
}
|
|
1144
|
+
```
|
|
1145
|
+
|
|
1146
|
+
#### `AutoServiceMemberSuggestion` (interface)
|
|
1147
|
+
|
|
1148
|
+
Sugestão de membro (`GET /groups/:groupId/member-suggestions`): está em outros grupos do sistema (`groups`).
|
|
1149
|
+
|
|
1150
|
+
```ts
|
|
1151
|
+
interface AutoServiceMemberSuggestion {
|
|
1152
|
+
id: string;
|
|
1153
|
+
username: string;
|
|
1154
|
+
email: string | null;
|
|
1155
|
+
name: string | null;
|
|
1156
|
+
picture: string | null;
|
|
1157
|
+
group_count: number;
|
|
1158
|
+
groups: string[];
|
|
1159
|
+
}
|
|
1160
|
+
```
|
|
1161
|
+
|
|
1086
1162
|
#### `AutoServiceGroupType` (interface)
|
|
1087
1163
|
|
|
1088
1164
|
Tipo de grupo (crachá) do realm (`GET /group-types`).
|
|
@@ -1288,27 +1364,27 @@ Aviso discreto de conexão no topo do shell, sobre o `connectionState$` e o `rea
|
|
|
1288
1364
|
|
|
1289
1365
|
_Sem inputs/outputs._
|
|
1290
1366
|
|
|
1291
|
-
#### `spine-
|
|
1367
|
+
#### `spine-initial-setup` — `SpineInitialSetupComponent`
|
|
1292
1368
|
|
|
1293
|
-
|
|
1369
|
+
Tela cheia da configuração inicial (ver `SpineInitialSetupService`): sem cabeçalho nem menu, por cima do shell (que fica `inert` enquanto ela está aberta). Cada escolha vale na hora — chama os mesmos serviços do painel de configurações —, e a prévia ao lado é desenhada com os tokens do tema, então acompanha tudo.
|
|
1294
1370
|
|
|
1295
1371
|
_Sem inputs/outputs._
|
|
1296
1372
|
|
|
1297
1373
|
#### `spine-shortcuts-cheatsheet` — `ShortcutsCheatsheetComponent`
|
|
1298
1374
|
|
|
1299
|
-
Painel de atalhos (cheatsheet). Abre com "?" (via `ShortcutService.help$`) e lista, com o `hm-shortcut-list` da lib, os atalhos agrupados — com busca e o interruptor dos atalhos de tecla única (WCAG 2.1.4; a escolha persiste no `SpinePreferencesService`).
|
|
1375
|
+
Painel de atalhos (cheatsheet). Abre com "?" (via `ShortcutService.help$`) e lista, com o `hm-shortcut-list` da lib, os atalhos agrupados — com busca e o interruptor dos atalhos de tecla única (WCAG 2.1.4; a escolha persiste no `SpinePreferencesService`). Leva também ao essencial.
|
|
1300
1376
|
|
|
1301
1377
|
_Sem inputs/outputs._
|
|
1302
1378
|
|
|
1303
1379
|
#### `spine-settings-panel` — `SettingsPanelComponent`
|
|
1304
1380
|
|
|
1305
|
-
Painel de configurações do shell (substitui as telas do antigo módulo "Sistema"): Conta (perfil, nível, sessão, sair), MFA (verificação em duas etapas e códigos de recuperação do Argos), Sessões (token de acesso, tokens de aplicação e sessões e dispositivos do Argos), Aparência, Acessibilidade (tamanho do texto, animações), Região (idioma, fuso, formato de hora, primeiro dia da semana), Atalhos, Dados do navegador (limpar listas, restaurar preferências), Ajuda (novidades,
|
|
1381
|
+
Painel de configurações do shell (substitui as telas do antigo módulo "Sistema"): Conta (perfil, nível, sessão, sair), MFA (verificação em duas etapas e códigos de recuperação do Argos), Sessões (token de acesso, tokens de aplicação e sessões e dispositivos do Argos), Aparência, Acessibilidade (tamanho do texto, animações), Região (idioma, fuso, formato de hora, primeiro dia da semana), Atalhos, Dados do navegador (limpar listas, restaurar preferências), Ajuda (novidades, configuração inicial,…
|
|
1306
1382
|
|
|
1307
1383
|
_Sem inputs/outputs._
|
|
1308
1384
|
|
|
1309
|
-
#### `spine-
|
|
1385
|
+
#### `spine-mcp-connect` — `McpConnectComponent`
|
|
1310
1386
|
|
|
1311
|
-
Sessões › "Conectar um agente de IA" (`SpineFeatures.
|
|
1387
|
+
Sessões › "Conectar um agente de IA" (`SpineFeatures.mcpConnect`): em um passo, cria um token de aplicação pessoal (`x-app-token`, a mesma API de "Tokens de aplicação") e monta a configuração MCP pronta para o Claude Code, com os servidores escolhidos e os escopos do acesso escolhido (só leitura ou leitura e escrita). Só aparecem os servidores que aceitam algum nível do usuário, sem seletor quando há um só; os níveis oferecidos são os aceitos por todos os servidores marcados, porque o token é u…
|
|
1312
1388
|
|
|
1313
1389
|
_Sem inputs/outputs._
|
|
1314
1390
|
|
|
@@ -1320,10 +1396,89 @@ _Sem inputs/outputs._
|
|
|
1320
1396
|
|
|
1321
1397
|
#### `spine-news` — `SpineNewsComponent`
|
|
1322
1398
|
|
|
1323
|
-
Painel de novidades
|
|
1399
|
+
Painel lateral de novidades e o modal de leitura. Montado uma vez no layout; quem abre é o `SpineNewsService` (aviso da entrada, menu do perfil, Início, configurações).
|
|
1400
|
+
|
|
1401
|
+
_Sem inputs/outputs._
|
|
1402
|
+
|
|
1403
|
+
#### `spine-rating-stars` — `SpineRatingStarsComponent`
|
|
1404
|
+
|
|
1405
|
+
Estrelas de uma nota de 0 a 10, com meia estrela: 10 = 5 estrelas, 7 = 3,5, 0 = nenhuma. Ao lado, a nota em número ("7/10"; média com uma casa, "8,4/10").
|
|
1406
|
+
|
|
1407
|
+
| Nome | Tipo | Tipo TS | Padrão | Descrição |
|
|
1408
|
+
|---|---|---|---|---|
|
|
1409
|
+
| `value` | model | `number \| null` | `null` | Nota de 0 a 10 (média pode ter casa decimal); `null` = sem nota. Editável: muda com o clique e o teclado. |
|
|
1410
|
+
| `readonly` | input | `boolean` | `false` | Só mostra (sem foco nem clique). |
|
|
1411
|
+
| `showValue` | input | `boolean` | `true` | A nota em número ao lado ("7/10"). |
|
|
1412
|
+
| `showName` | input | `boolean` | `false` | Editável: também o rótulo qualitativo ("Muito bom") ao lado da nota. |
|
|
1413
|
+
| `size` | input | `'small' \| 'medium' \| 'large'` | `'medium'` | |
|
|
1414
|
+
| `label` | input | `string` | `''` | Nome acessível do slider (ou `labelledBy`, o id de um rótulo visível). |
|
|
1415
|
+
| `labelledBy` | input | `string` | `''` | |
|
|
1416
|
+
| `describedBy` | input | `string` | `''` | |
|
|
1417
|
+
| `invalid` | input | `boolean` | `false` | |
|
|
1418
|
+
|
|
1419
|
+
#### `ng-template[spinePageActions]` — `SpinePageActionsDirective`
|
|
1420
|
+
|
|
1421
|
+
Ações que valem para a tela inteira (período, "Atualizar", "Atualizado em…") na barra da página, à direita do título:
|
|
1324
1422
|
|
|
1325
1423
|
_Sem inputs/outputs._
|
|
1326
1424
|
|
|
1425
|
+
#### `spine-inbox-button` — `SpineInboxButtonComponent`
|
|
1426
|
+
|
|
1427
|
+
O sino do cabeçalho: a central de notificações (`SpineInboxService`). O número é quantos itens têm novidade; o painel lista as novidades das fontes, a mais recente primeiro, e escolher uma abre onde ela está. Sem fonte registrada, não desenha nada.
|
|
1428
|
+
|
|
1429
|
+
_Sem inputs/outputs._
|
|
1430
|
+
|
|
1431
|
+
#### `spine-suggestion-chat` — `SpineSuggestionChatComponent`
|
|
1432
|
+
|
|
1433
|
+
A conversa de uma sugestão como chat (`hm-message-scroller` + `hm-message` + `hm-bubble`), com o campo de resposta embaixo. Usado nos dois lados: a página de quem pede (`side="solicitante"`) e o detalhe da tarefa da equipe (`side="equipe"`).
|
|
1434
|
+
|
|
1435
|
+
Slots: `[spineChatComposer]`, `[spineChatReadOnly]`
|
|
1436
|
+
|
|
1437
|
+
| Nome | Tipo | Tipo TS | Padrão | Descrição |
|
|
1438
|
+
|---|---|---|---|---|
|
|
1439
|
+
| `items` | input | `readonly SpineChatMessage[]` | `[]` | As mensagens, do mais antigo ao mais novo. |
|
|
1440
|
+
| `side` | input (obrigatório) | `SpineChatSide` | | O papel desta tela: as mensagens da pessoa escritas deste lado ficam à direita. |
|
|
1441
|
+
| `me` | input | `string` | `''` | O `user_id` de quem está com a tela aberta. |
|
|
1442
|
+
| `label` | input | `string` | `''` | |
|
|
1443
|
+
| `empty` | input | `string` | `''` | |
|
|
1444
|
+
| `hasMore` | input | `boolean` | `false` | |
|
|
1445
|
+
| `loading` | input | `boolean` | `false` | |
|
|
1446
|
+
| `canWrite` | input | `boolean` | `true` | |
|
|
1447
|
+
| `composerLabel` | input | `string` | `''` | |
|
|
1448
|
+
| `placeholder` | input | `string` | `''` | |
|
|
1449
|
+
| `sendLabel` | input | `string` | `''` | |
|
|
1450
|
+
| `sending` | input | `boolean` | `false` | |
|
|
1451
|
+
| `error` | input | `string` | `''` | |
|
|
1452
|
+
| `draft` | model | `string` | `''` | O texto do campo (em mão dupla: quem usa limpa depois de enviar). |
|
|
1453
|
+
| `attachmentLoader` | input | `SpineAttachmentLoader \| null` | `null` | Busca o arquivo de um anexo; sem ele, os anexos das mensagens não aparecem. |
|
|
1454
|
+
| `canRemoveAttachment` | input | `(attachment: SpineSuggestionAttachment) => boolean` | `() => false` | Quem está com a tela pode tirar o anexo? |
|
|
1455
|
+
| `canAttach` | input | `boolean` | `false` | Mostra o clipe no campo: a próxima mensagem leva arquivos. |
|
|
1456
|
+
| `files` | model | `readonly File[]` | `[]` | Os arquivos escolhidos para a próxima mensagem (em mão dupla: quem usa limpa depois de enviar). |
|
|
1457
|
+
| `removeAttachment` | output | `SpineSuggestionAttachment` | | |
|
|
1458
|
+
| `loadHistory` | output | `void` | | |
|
|
1459
|
+
| `send` | output | `string` | | Enviar: o texto aparado (nunca vazio). |
|
|
1460
|
+
|
|
1461
|
+
#### `spine-suggestion-attachments` — `SpineSuggestionAttachmentsComponent`
|
|
1462
|
+
|
|
1463
|
+
Os anexos de uma sugestão ou de uma mensagem: as imagens na galeria (miniaturas, e o lightbox ao abrir) e os documentos (PDF, Markdown, texto) como arquivo, com o botão de baixar. Usado na página de quem pede e no detalhe da tarefa da equipe.
|
|
1464
|
+
|
|
1465
|
+
| Nome | Tipo | Tipo TS | Padrão | Descrição |
|
|
1466
|
+
|---|---|---|---|---|
|
|
1467
|
+
| `attachments` | input | `readonly SpineSuggestionAttachment[]` | `[]` | |
|
|
1468
|
+
| `loader` | input (obrigatório) | `SpineAttachmentLoader` | | |
|
|
1469
|
+
| `canRemove` | input | `(attachment: SpineSuggestionAttachment) => boolean` | `() => false` | Quem está com a tela pode tirar este anexo? (o que a própria pessoa enviou, ou qualquer um na equipe). |
|
|
1470
|
+
| `remove` | output | `SpineSuggestionAttachment` | | |
|
|
1471
|
+
|
|
1472
|
+
#### `spine-tag-row` — `SpineTagRowComponent`
|
|
1473
|
+
|
|
1474
|
+
Selos numa linha só, no modelo dos rótulos do quadro (fundo claro da cor e o ponto na cor cheia): cabem os que cabem na largura e o resto vira "+N", com os nomes na dica e para o leitor de tela. Mede de novo quando a largura muda (ResizeObserver) e quando a lista muda; sem medida (servidor, teste sem layout), mostra todos.
|
|
1475
|
+
|
|
1476
|
+
| Nome | Tipo | Tipo TS | Padrão | Descrição |
|
|
1477
|
+
|---|---|---|---|---|
|
|
1478
|
+
| `items` | input | `readonly SpineTagRowItem[]` | `[]` | |
|
|
1479
|
+
| `label` | input | `string` | `''` | |
|
|
1480
|
+
| `empty` | input | `string` | `''` | Texto quando não há nenhum (vazio = nada). |
|
|
1481
|
+
|
|
1327
1482
|
#### `spine-docs` — `SpineDocsComponent`
|
|
1328
1483
|
|
|
1329
1484
|
Modal de documentação das telas: índice (com busca) à esquerda e leitura à direita. Montado uma vez pelo `spine-layout`; abrir, fechar e o que se lê vêm todos do `SpineDocsService`.
|
|
@@ -1342,26 +1497,25 @@ Renderiza Markdown (GFM) como HTML com a tipografia do design system. O texto é
|
|
|
1342
1497
|
|
|
1343
1498
|
#### `SpineLogoutService` · `providedIn: root`
|
|
1344
1499
|
|
|
1345
|
-
Saída da sessão pelo shell: todo botão/atalho de sair do spine passa por aqui (menu do perfil, painel de configurações,
|
|
1500
|
+
Saída da sessão pelo shell: todo botão/atalho de sair do spine passa por aqui (menu do perfil, painel de configurações, tela `/blocked`).
|
|
1346
1501
|
|
|
1347
1502
|
- `readonly pending: signal(…)` — Saída em andamento (o botão mostra "saindo…" / fica desabilitado).
|
|
1348
1503
|
- `logout(): Promise<boolean>` — Sai da sessão. Resolve `true` quando saiu (o `@orfeu/angular` já navega para o `/logoff`) e `false` quando o Argos não confirmou: a sessão continua e o aviso de erro aparece. Nunca rejeita. Cliques repetidos durante a s…
|
|
1349
1504
|
|
|
1350
|
-
#### `
|
|
1505
|
+
#### `SpineInitialSetupService` · `providedIn: root`
|
|
1351
1506
|
|
|
1352
|
-
|
|
1507
|
+
Configuração inicial em tela cheia (`spine-initial-setup`, montada no layout): no primeiro acesso a pessoa escolhe tema, cor, densidade, tamanho do texto, fonte e animações, com a prévia ao lado, e depois vê o essencial (busca, abas, favoritos, configurações). Pode pular a qualquer momento: pular também conta como feita.
|
|
1353
1508
|
|
|
1354
|
-
- `readonly
|
|
1355
|
-
- `readonly
|
|
1356
|
-
- `
|
|
1357
|
-
- `
|
|
1358
|
-
- `
|
|
1359
|
-
- `
|
|
1509
|
+
- `readonly enabled` — Ligada (padrão) ou desligada pelo app (`SpineFeatures.initialSetup: false`).
|
|
1510
|
+
- `readonly isOpen: signal(…)`
|
|
1511
|
+
- `readonly mode: signal<SpineInitialSetupMode>(…)`
|
|
1512
|
+
- `readonly step: signal<SpineInitialSetupStep>(…)`
|
|
1513
|
+
- `maybeOpen(): void` — Chamado uma vez pelo layout na entrada: abre se a configuração ainda não foi feita. Espera a conta responder (`setupDone` deixa de ser `null`), sem prazo: quem decide é a conta, e a falha dela cai no que o navegador sab…
|
|
1514
|
+
- `open(): void` — Abre a configuração inteira (aparência e o essencial), mesmo já feita: "Refazer" nas configurações.
|
|
1515
|
+
- `openEssentials(): void` — Só os cartões do essencial ("Rever o essencial": menu do perfil, atalhos, tela inicial).
|
|
1360
1516
|
- `next(): void`
|
|
1361
|
-
- `
|
|
1362
|
-
- `finish(): void` —
|
|
1363
|
-
- `get isFirst: boolean`
|
|
1364
|
-
- `get isLast: boolean`
|
|
1517
|
+
- `back(): void`
|
|
1518
|
+
- `finish(): void` — Concluída ou pulada: marca como feita e fecha.
|
|
1365
1519
|
|
|
1366
1520
|
#### `ShortcutService` · `providedIn: root` · implements OnDestroy
|
|
1367
1521
|
|
|
@@ -1369,8 +1523,6 @@ Atalhos de teclado globais do sistema, sobre o `HermesShortcutService` da lib (u
|
|
|
1369
1523
|
|
|
1370
1524
|
- `readonly help$: Subject<void>` — Emite quando o usuário pede o painel de atalhos (tecla "?" ou menu do perfil).
|
|
1371
1525
|
- `readonly panelItems: computed<readonly HermesShortcutItem[]>(…)` — O que o painel lista (`<hm-shortcut-list [registered]="false" [items]="panelItems()">`): os atalhos registrados no `HermesShortcutService`, com os favoritos numa linha só, e os só exibidos. Acompanha registro/remoção e…
|
|
1372
|
-
- `get shortcuts: ShortcutItem[]` — Lista do painel em texto, no idioma e na plataforma atuais. @deprecated Use o `hm-shortcut-list` com `panelItems()` (ou `HermesShortcutService.list()`). Mantido para quem montava o próprio painel; sai numa próxima versã…
|
|
1373
|
-
- `groups(): ShortcutGroup[]` — Atalhos por grupo, na ordem navegação → ações → geral, com o nome do grupo traduzido. @deprecated Use o `hm-shortcut-list` (agrupa, traduz e desenha as teclas). Sai numa próxima versão.
|
|
1374
1526
|
- `setActions(actions: ShortcutActions): void` — Liga as ações e registra os atalhos no `HermesShortcutService` (idempotente: chamadas seguintes só trocam as ações).
|
|
1375
1527
|
|
|
1376
1528
|
#### `SpineSettingsService` · `providedIn: root`
|
|
@@ -1394,6 +1546,19 @@ Tokens de aplicação pessoais (`x-app-token`) do usuário logado — `argos-adm
|
|
|
1394
1546
|
- `create(body: { badge_id: string; name: string; validity_days: number }): Promise<CreatedAppToken>`
|
|
1395
1547
|
- `revoke(id: string): Promise<void>`
|
|
1396
1548
|
|
|
1549
|
+
#### `SpineMyGroupsService` · `providedIn: root`
|
|
1550
|
+
|
|
1551
|
+
Grupos de que a pessoa é membro e o que a função dela permite — `argos-admin /me/groups`. Sempre da aplicação LOGADA (o servidor tira o client do access-token da sessão) e sempre com o token da sessão (o servidor recusa x-app-token). A regra de quem faz o quê é do servidor; aqui só se mostra o que ele diz (`can_add`, `assignable_roles`, `can_change_roles`).
|
|
1552
|
+
|
|
1553
|
+
- `readonly available`
|
|
1554
|
+
- `readonly groups: signal<ManagedGroup[]>(…)`
|
|
1555
|
+
- `refresh(): Promise<void>` — Relê os grupos; qualquer falha deixa a lista vazia (a seção some em vez de mostrar um erro sem contexto).
|
|
1556
|
+
- `members(groupId: string, query: GroupMembersQuery = {}): Observable<GroupMembersPage>` — Uma página dos membros, pela ordem do login. Observable (não Promise): a tela pede as páginas até o fim e cancela a pendente ao sair.
|
|
1557
|
+
- `searchUsers(search: string, limit = 10): Promise<{ users: RealmUser[] }>`
|
|
1558
|
+
- `addMember(groupId: string, userId: string, role: GroupRole | null = null): Promise<void>` — `role` ausente ou null: entra sem função (o único jeito de o Editor incluir).
|
|
1559
|
+
- `updateRole(groupId: string, userId: string, role: GroupRole | null): Promise<void>`
|
|
1560
|
+
- `removeMember(groupId: string, userId: string): Promise<void>`
|
|
1561
|
+
|
|
1397
1562
|
#### `SpineAccountSecurityService` · `providedIn: root`
|
|
1398
1563
|
|
|
1399
1564
|
Conta do usuário no Argos (verificação em duas etapas, códigos de recuperação, sessões) pela API da conta com Bearer: o access token da sessão do app (`@orfeu/angular`), no header `Authorization` — o mesmo jeito que o Orfeu fala com o Argos (ex.: `switchBadge`). O Argos reconhece a sessão SSO pelo `sid` do token; não há cookie envolvido. Token vencido (`401 invalid_token`): renova uma vez (`silentRenew`) e repete. `available` é falso sem `AUTH_CONFIG` utilizável.
|
|
@@ -1410,6 +1575,8 @@ Conta do usuário no Argos (verificação em duas etapas, códigos de recuperaç
|
|
|
1410
1575
|
- `setDefaultBadge(badgeId: string | null): Promise<{ default_badge_id: string | null }>` — Crachá com que o login entra nesta aplicação (`null` volta ao padrão: o de menor nível).
|
|
1411
1576
|
- `preferences(): Promise<AccountPreferences>`
|
|
1412
1577
|
- `savePreferences(preferences: Record<string, unknown>): Promise<AccountPreferences>` — Substitui o documento de preferências desta aplicação na conta (até 16 KB).
|
|
1578
|
+
- `globalPreferences(): Promise<AccountPreferences>` — Preferências da pessoa que valem em todos os apps (`GET {api}/preferences/global`).
|
|
1579
|
+
- `saveGlobalPreferences(preferences: Record<string, unknown>): Promise<AccountPreferences>` — Substitui o documento global (até 16 KB).
|
|
1413
1580
|
|
|
1414
1581
|
#### `SpineIdleService` · `providedIn: root`
|
|
1415
1582
|
|
|
@@ -1450,15 +1617,17 @@ Avisos do app (`SpineFeatures.notices`): o app declara os tipos que emite (`{ id
|
|
|
1450
1617
|
|
|
1451
1618
|
#### `SpineAccountPreferencesService` · `providedIn: root`
|
|
1452
1619
|
|
|
1453
|
-
Preferências na conta (`SpineFeatures.accountPreferences`): espelha no Argos (`GET/PUT {api}/preferences`, por usuário e aplicação) o que o painel de configurações guarda no navegador — tema, cor, densidade, fonte, menu lateral, idioma, fuso, relógio, primeiro dia da semana, tamanho do texto, animações, atalhos de tecla única, inatividade, tela inicial, tipos de aviso e favoritos. As telas Aparência, Região etc. não mudam: o armazenamento local continua sendo a fonte de cada tela
|
|
1620
|
+
Preferências na conta (`SpineFeatures.accountPreferences`): espelha no Argos (`GET/PUT {api}/preferences`, por usuário e aplicação) o que o painel de configurações guarda no navegador — tema, cor, densidade, fonte, menu lateral, dividir abas, idioma, fuso, relógio, primeiro dia da semana, tamanho do texto, animações, atalhos de tecla única, inatividade, tela inicial, tipos de aviso e favoritos. As telas Aparência, Região etc. não mudam: o armazenamento local continua sendo a fonte de cada tela,…
|
|
1454
1621
|
|
|
1455
1622
|
- `readonly enabled` — Recurso ligado e API da conta disponível.
|
|
1456
1623
|
- `readonly status: signal<SpineAccountPreferencesStatus>(…)`
|
|
1457
1624
|
- `readonly syncedAt: signal<Date | null>(…)` — Hora da última leitura/gravação bem-sucedida.
|
|
1625
|
+
- `readonly setupDone: signal<boolean | null>(…)` — Configuração inicial feita (ou pulada). `null` enquanto a conta não respondeu.
|
|
1458
1626
|
- `readonly snapshot: computed<SpineAccountPreferencesDoc>(…)` — O documento que o navegador tem agora.
|
|
1459
1627
|
- `start(): Promise<void>` — Lê a conta e aplica (uma vez por sessão do app; chamadas seguintes devolvem a mesma promessa). Nunca rejeita.
|
|
1460
1628
|
- `ready(timeoutMs = READY_TIMEOUT_MS): Promise<void>` — Como `start()`, mas sem esperar mais que `timeoutMs` (o login não fica parado se o Argos demorar).
|
|
1461
1629
|
- `syncNow(): Promise<void>` — Grava agora o que estiver pendente ("Sincronizar agora"); relê a conta se ela ainda não respondeu.
|
|
1630
|
+
- `completeSetup(): void` — Marca a configuração inicial como feita (concluída ou pulada): vai para a conta com o resto, ou fica aqui.
|
|
1462
1631
|
|
|
1463
1632
|
#### `SpineDocsService` · `providedIn: root`
|
|
1464
1633
|
|
|
@@ -1482,29 +1651,137 @@ Estado da documentação das telas: o que está registrado em `COMPONENT_ROUTES`
|
|
|
1482
1651
|
|
|
1483
1652
|
#### `SpineNewsService` · `providedIn: root`
|
|
1484
1653
|
|
|
1485
|
-
|
|
1654
|
+
Novidades do app, escritas por quem o administra (auto-serviço ou painel central do Argos) e lidas de `argos-admin /me/news` — sempre da aplicação LOGADA e só as publicadas, na validade e para o público da pessoa (o servidor filtra). Sem `SPINE_ADMIN_API` (ou sem HTTP) não há novidades e nada aparece, sem erro.
|
|
1486
1655
|
|
|
1487
|
-
- `readonly
|
|
1656
|
+
- `readonly available` — Há onde buscar (argos-admin configurado).
|
|
1488
1657
|
- `readonly isOpen: signal(…)`
|
|
1489
|
-
- `readonly
|
|
1490
|
-
- `
|
|
1491
|
-
- `
|
|
1492
|
-
- `
|
|
1658
|
+
- `readonly requested: signal<string | null>(…)` — Novidade a abrir junto com o painel (o Início pede uma específica); o painel consome e limpa.
|
|
1659
|
+
- `readonly latest: signal<readonly SpineNewsSummary[]>(…)` — As mais recentes (primeira página), lidas em `refresh`.
|
|
1660
|
+
- `readonly hasAny: computed(…)` — Há alguma novidade para a pessoa — o item "Novidades" do menu só aparece com isto.
|
|
1661
|
+
- `readonly highlights: computed(…)` — As mais recentes para o card do Início; `unseen` = ainda não aberta neste navegador.
|
|
1662
|
+
- `readonly unseenCount: computed(…)` — Quantas das mais recentes ainda não foram abertas (a contagem do menu do perfil).
|
|
1663
|
+
- `readonly seenVersion: signal(…)` — Muda quando o "já visto" é gravado, para quem lê `isUnseen`/`highlights` reler.
|
|
1664
|
+
- `readonly favoritesVersion: signal(…)` — Muda quando os favoritos mudam, para quem lê `isFavorite` reler.
|
|
1665
|
+
- `refresh(): Promise<void>` — Relê as mais recentes; qualquer falha deixa a lista vazia (o item some em vez de mostrar um erro sem contexto).
|
|
1666
|
+
- `page(page: number, limit: number): Promise<SpineNewsPage>` — Uma página da lista (`page` a partir de 1). Falha propaga: o painel mostra o erro com "Tentar de novo".
|
|
1667
|
+
- `detail(id: string): Promise<SpineNewsDetail>` — Uma novidade com o corpo.
|
|
1668
|
+
- `announceOnEntry(): Promise<void>` — Chamado uma vez pelo layout na entrada: lê as mais recentes, espera a configuração inicial se decidir (e terminar, se abriu) e avisa no canto as ainda não anunciadas. Nunca abre o painel sozinho.
|
|
1669
|
+
- `showAll(): void` — Abre o painel lateral com a lista; as mais recentes deixam de ser anunciadas (o selo "Nova" fica até abrir).
|
|
1670
|
+
- `showItem(id: string): void` — Abre o painel já com uma novidade aberta (o card do Início).
|
|
1493
1671
|
- `close(): void`
|
|
1672
|
+
- `isUnseen(id: string): boolean` — Ainda não aberta neste navegador. Lê `seenVersion` (reage a `markSeen`).
|
|
1673
|
+
- `markSeen(id: string): void` — Abriu a novidade: vista (e anunciada) neste navegador.
|
|
1674
|
+
- `markUnseen(id: string): void` — "Marcar como não lida": volta o selo "Nova" (e conta de novo no menu e no Início); não volta a ser anunciada.
|
|
1675
|
+
- `isFavorite(id: string): boolean` — Favorita neste navegador. Lê `favoritesVersion` (reage a `toggleFavorite`).
|
|
1676
|
+
- `toggleFavorite(id: string): void` — Liga ou desliga o favorito (marcador do painel).
|
|
1677
|
+
|
|
1678
|
+
#### `SpineRatingsService` · `providedIn: root`
|
|
1679
|
+
|
|
1680
|
+
Avaliações da pessoa (nota de 0 a 10, 5 estrelas com meia, e um comentário) — `argos-admin /me/ratings`, sempre da aplicação LOGADA (o servidor tira o client do token da sessão) e uma por escopo/tela: avaliar de novo substitui. Liga com `SpineFeatures.ratings` e só com `SPINE_ADMIN_API`; sem os dois, `enabled` é falso e nada de avaliação aparece.
|
|
1681
|
+
|
|
1682
|
+
- `readonly enabled` — Ligado por padrão (como as sugestões): só `features.ratings: false` desliga; sem a API da conta ou HTTP, nada.
|
|
1683
|
+
- `readonly windowTarget: signal<SpineRatingTarget | null>(…)` — O que a janela de avaliação está avaliando; `null` = fechada. Uma janela só, para a ferramenta e para a tela.
|
|
1684
|
+
- `readonly appRated: signal(…)` — A pessoa já avaliou a ferramenta (servidor, lido uma vez por `checkAppRated`, ou gravado agora).
|
|
1685
|
+
- `readonly appAverage: signal<SpineRatingAverage | null>(…)` — Média da ferramenta (`loadAppAverage`); `null` enquanto não foi lida.
|
|
1686
|
+
- `openApp(): void` — "Avaliar o {app}": abre a janela (ou troca o conteúdo dela) para a ferramenta.
|
|
1687
|
+
- `openScreen(target: SpineRatingTarget): void` — "Avaliar esta tela": abre a janela (ou troca o conteúdo dela) para a tela.
|
|
1688
|
+
- `closeWindow(): void`
|
|
1689
|
+
- `isRated(target: SpineRatingTarget): boolean`
|
|
1690
|
+
- `checkAppRated(): Promise<void>` — Lê uma vez se a pessoa já avaliou a ferramenta (a estrela do cabeçalho). Falha de rede deixa vazia, sem aviso: avaliar continua funcionando, só a estrela não sabe da avaliação antiga.
|
|
1691
|
+
- `loadAppAverage(): Promise<SpineRatingAverage>` — Média e total da ferramenta (`GET /me/ratings/summary`); quem mostra trata a falha.
|
|
1692
|
+
- `mine(target: SpineRatingTarget): Promise<SpineRating | null>` — A avaliação atual da pessoa nesse alvo (para pré-preencher), ou `null` se ainda não avaliou.
|
|
1693
|
+
- `save(target: SpineRatingTarget, score: number, comment: string): Promise<SpineRating>` — Cria ou atualiza a avaliação (nota 0 a 10); comentário vazio vai como `null`.
|
|
1694
|
+
|
|
1695
|
+
#### `SpinePageActionsSlot` · `@Injectable` (fornecido por quem usa)
|
|
1696
|
+
|
|
1697
|
+
Lugar das ações da tela na barra da página (`spine-page-bar`): um por painel do workspace, fornecido pelo `spine-page-panel`. A tela não fala com ele direto: usa `<ng-template spinePageActions>`.
|
|
1698
|
+
|
|
1699
|
+
- `readonly template: signal<TemplateRef<unknown> | null>(…)`
|
|
1700
|
+
|
|
1701
|
+
#### `SpineWorkspaceNavService` · `providedIn: root`
|
|
1702
|
+
|
|
1703
|
+
Dono do `WorkspaceStore` do shell — mesmo padrão do `WorkspaceNavService` do docs/website (`packages/hermes-ui/docs/website/src/app/workspace-nav.service.ts`), adaptado pra ler a árvore de rotas do BACKEND (`ViewService.currentView`) em vez de um `page-registry.ts` estático. Cada página visitada vira uma aba, pertencente a um painel; a navegação real do `Router` (routerLink, busca, sidebar) sempre atualiza a aba ativa do painel FOCADO.
|
|
1704
|
+
|
|
1705
|
+
- `readonly split: computed(…)` — A pessoa pode dividir a área de abas em painéis (a preferência "Dividir abas").
|
|
1706
|
+
- `readonly limits` — Até onde dá para dividir (o shell passa para o `hm-workspace`; `openTab` com `beside` respeita).
|
|
1707
|
+
- `readonly store: WorkspaceStore`
|
|
1708
|
+
- `readonly root: computed(…)`
|
|
1709
|
+
- `readonly focusedPanelId: computed(…)`
|
|
1710
|
+
- `readonly focusedChain: computed<Route[] | null>(…)` — Cadeia resolvida (header→…→page) da aba ativa do painel FOCADO — é o que `spine-sidebar` (menu) e `spine-navigation` (breadcrumb) leem pra saber "onde estamos", no lugar do antigo `viewService.logControl$`/`breadCrumb$`…
|
|
1711
|
+
- `reconcileWithView(): void` — As abas abertas passam a obedecer à view atual: aba de tela que a pessoa não pode mais abrir fecha (e o conteúdo dela é destruído junto); painel que ficaria sem aba nenhuma mostra o Início no lugar; a aba ativa de cada…
|
|
1712
|
+
- `tabFor(url: string): TabItem` — A aba de uma tela pelo endereço: o `id` é o caminho; com query, o endereço vai no `url` (a mesma aba da tela).
|
|
1713
|
+
- `mergePanels(): void` — Junta todos os painéis no focado, sem perder aba: as abas ficam na ordem dos painéis (da esquerda para a direita, de cima para baixo), uma aba repetida em dois painéis vira uma só (vale a do focado), e a aba ativa do pa…
|
|
1714
|
+
- `openNewTab(panelId: string): void` — O `+` de um painel: abre a home ali, como um navegador.
|
|
1715
|
+
- `openTab(url: string, options: SpineOpenTabOptions = {}): void` — Abre (ou foca) a aba de um endereço com parâmetros — um registro por aba na mesma tela: `openTab('/vendas/pedidos?pedido=123&secao=itens', { label: 'Pedido 123', match: ['pedido'] })`. Se alguma aba (em qualquer painel)…
|
|
1716
|
+
- `setTabLabel(panelId: string, tabId: string, label: string, icon?: string): void` — O nome (e o ícone) de uma aba, dado pela tela (`SPINE_TAB.setLabel`).
|
|
1717
|
+
- `navigateTab(panelId: string, tabId: string, url: string): void` — A tela muda o endereço da própria aba (`SPINE_TAB.navigate`). A mesma tela, mantendo a identidade: só o `url` da aba muda (sem recriar a tela) e, se ela é a visível do painel focado, o endereço do navegador acompanha (s…
|
|
1718
|
+
- `navigateLocally(panelId: string, href: string): void` — Navegação LOCAL a um painel específico (usada pelo `PanelLocalLinkDirective`) — troca o ASSUNTO da aba ativa daquele painel, não empilha uma aba nova.
|
|
1719
|
+
|
|
1720
|
+
#### `SpineInboxService` · `providedIn: root`
|
|
1721
|
+
|
|
1722
|
+
A central de notificações (o sino do cabeçalho): junta as novidades das fontes registradas (`provideSpineInboxSource`), a mais recente primeiro. Relê enquanto alguém acompanha (`watch`): de minuto em minuto com a aba à vista e ao voltar para ela. Quem muda o que conta como novidade (ler uma conversa, por exemplo) chama `refresh()`.
|
|
1723
|
+
|
|
1724
|
+
- `readonly enabled` — Alguma fonte registrada: sem nenhuma, o sino não aparece.
|
|
1725
|
+
- `readonly entries: signal<readonly SpineInboxEntry[]>(…)`
|
|
1726
|
+
- `readonly total: signal(…)` — Itens com novidade, somando as fontes (o número do sino).
|
|
1727
|
+
- `readonly loading: signal(…)`
|
|
1728
|
+
- `readonly failed: signal(…)` — Nenhuma fonte respondeu na última leitura.
|
|
1729
|
+
- `refresh(): Promise<void>` — Relê todas as fontes. Uma fonte que falha não derruba as outras.
|
|
1730
|
+
- `open(entry: SpineInboxEntry): Promise<void>` — A pessoa escolheu um item: a fonte abre (e marca como visto); depois a central relê.
|
|
1731
|
+
- `watch(destroyRef: DestroyRef): void` — Passa a reler sozinha enquanto `destroyRef` viver (o sino no cabeçalho): lê agora, de minuto em minuto com a aba à vista e ao voltar para a aba. Vários acompanhando dividem o mesmo relógio.
|
|
1732
|
+
|
|
1733
|
+
#### `SpineSuggestionsService` · `providedIn: root`
|
|
1734
|
+
|
|
1735
|
+
- `create(draft: SpineSuggestionDraft): Promise<SpineSuggestion>`
|
|
1736
|
+
- `get(id: string): Promise<SpineVisibleSuggestion>` — Uma que a pessoa vê, pelo id (404 se não vê).
|
|
1737
|
+
- `lookup(key: string): Promise<SpineVisibleSuggestion>` — Pela chave ("SUG-12"): o link "?sugestao=SUG-12" abre a sugestão na página.
|
|
1738
|
+
- `reply(id: string, comment: string): Promise<SpineSuggestionMessage>` — Escreve na conversa (quem pediu ou um envolvido): a vez passa para os responsáveis.
|
|
1739
|
+
- `attach(id: string, file: File, commentId: string | null = null): Promise<SpineSuggestionAttachment>` — Anexa um arquivo à sugestão (`commentId` = ao próprio comentário). O corpo é o arquivo; o nome vai na query.
|
|
1740
|
+
- `attachmentFile(id: string, attachmentId: string): Promise<Blob>` — O arquivo do anexo (a imagem não vai direto no `<img>`: a leitura precisa do token da sessão).
|
|
1741
|
+
- `removeAttachment(id: string, attachmentId: string): Promise<void>` — Tira um anexo que a própria pessoa enviou.
|
|
1742
|
+
- `markRead(id: string): Promise<void>` — Marca a conversa como lida por quem consulta (zera o `unread`).
|
|
1743
|
+
- `byScreen(path: string): Promise<SpineSuggestion[]>` — As ainda abertas da tela, de qualquer pessoa: o modal oferece apoiar em vez de repetir.
|
|
1744
|
+
- `vote(id: string): Promise<void>`
|
|
1745
|
+
- `unvote(id: string): Promise<void>`
|
|
1746
|
+
|
|
1747
|
+
#### `SpineUnsavedChangesService` · `providedIn: root`
|
|
1748
|
+
|
|
1749
|
+
O lado do shell do aviso de alterações não salvas (`SpineFeatures.unsavedChanges`, desligado por padrão). Ligado: o `hm-workspace` recebe um store que pergunta antes de fechar aba com alteração; trocar de tela dentro da aba pergunta também; e o navegador avisa ao recarregar/fechar a página. Desligado: `store` é o mesmo do `SpineWorkspaceNavService` e nada muda.
|
|
1750
|
+
|
|
1751
|
+
- `readonly enabled` — O recurso está ligado no app.
|
|
1752
|
+
- `readonly store: WorkspaceStore` — O store que o shell passa para o `hm-workspace`.
|
|
1753
|
+
- `start(): () => void` — Liga o aviso do navegador (só com o recurso ligado). Devolve a função que desliga.
|
|
1754
|
+
- `canReplaceActive(panelId: string): boolean | Promise<boolean>` — Pode trocar a tela da aba ativa do painel? Sem o recurso ou sem alteração nela, `true` na hora.
|
|
1494
1755
|
|
|
1495
1756
|
### Funções
|
|
1496
1757
|
|
|
1497
|
-
- `function findTourTarget(selector: string): HTMLElement | null` — Primeiro elemento do seletor que está de fato na tela (tem tamanho e conteúdo). Não usa `offsetParent`: ele é `null` pra `position: fixed` (a sidebar) e pra `display: contents`, e o passo sumia do tour mesmo com o alvo visível. Com as abas vivas do workspace…
|
|
1498
1758
|
- `function resolveSettingsSection(section: string): string` — Chave de seção que vale hoje: troca uma chave antiga pela nova; as demais passam iguais.
|
|
1499
1759
|
- `function provideSettingsSection(section: SpineSettingsSection): Provider` — Registra uma seção do app no painel de configurações (aparece depois das do spine, antes de "Sobre"). Pode ser chamado várias vezes, uma por seção.
|
|
1500
1760
|
- `function argosAccountApi(authority: string | null | undefined, realm: string | null | undefined): string | null` — Base da API da conta no Argos: `{authority}/api/realms/{realm}/account` — o mesmo `{authority}/api` que o `@orfeu/angular` usa para o OIDC (a `authority` já traz o contexto do serviço, ex.: `https://host/argos`). Sem `authority`/`realm` (ou com o `CHANGE_ME`…
|
|
1501
1761
|
- `function accountErrorCode(err: unknown): string` — Código de erro que o Argos devolveu (`{ error: 'invalid_code' }`), ou `''`.
|
|
1502
1762
|
- `function buildMcpConfig(servers: readonly SpineMcpServer[], token: string, write: boolean, origin: string): string` — Monta o `.mcp.json` do Claude Code: uma entrada por servidor, todas com o mesmo token. Com `write`, cada servidor que tem `writeScopes` pede esses escopos; os demais (e todos sem `write`) vão com `readScopes`, ou sem o header (o MCP já é só leitura sem ele).…
|
|
1763
|
+
- `function serverAcceptsBadge(server: SpineMcpServer, badgeName: string): boolean` — O servidor aceita um token deste nível? Decide por `onlyBadges`/`exceptBadges`, sem diferenciar maiúsculas.
|
|
1503
1764
|
- `function idleLimits(features: SpineFeatures | undefined): SpineIdleLimits` — Opções e limites de inatividade do app. Sem o recurso, `enabled` é falso e não há opções.
|
|
1504
1765
|
- `function effectiveIdleMinutes(chosen: number, limits: SpineIdleLimits): number` — Minutos que valem de fato: a escolha da pessoa dentro dos limites do app (0 = não encerra).
|
|
1505
1766
|
- `function isInternalPath(url: unknown): url is string` — Caminho interno seguro (`/x`, nunca `//host` nem `http:`).
|
|
1506
1767
|
- `function stable(value: unknown): string` — JSON com as chaves dos objetos em ordem (a conta pode devolver outra ordem).
|
|
1768
|
+
- `function spineScoreBand(score: number): SpineScoreBand` — Faixa do rótulo qualitativo de uma nota: 0–2 ruim, 3–4 regular, 5–6 bom, 7–8 muito bom, 9–10 excelente.
|
|
1769
|
+
- `function spineStarFills(score: number | null | undefined): SpineStarFill[]` — Preenchimento das 5 estrelas para a nota (uma média vai para a meia estrela mais próxima: 8,4 = 4 estrelas).
|
|
1770
|
+
- `function spinePathOf(url: string): string` — O caminho de um endereço (sem query nem fragmento).
|
|
1771
|
+
- `function spineParamsOf(url: string): SpineTabParams` — A query de um endereço, como objeto.
|
|
1772
|
+
- `function spineNormalizeUrl(url: string): string` — Caminho + query com os nomes em ordem: o mesmo endereço escrito de dois jeitos vira um só (sem o fragmento).
|
|
1773
|
+
- `function provideSpineInboxSource(factory: () => SpineInboxSource | null): Provider` — Registra uma fonte na central de notificações. A fábrica roda num contexto de injeção (`inject()` vale) e pode devolver `null` para não registrar nada.
|
|
1774
|
+
- `function provideSpineAiAgentPage(): EnvironmentProviders` — Registra a página no bootstrap, antes da primeira navegação: o F5 em /agente passa pelo `ViewGuard`. Vai no `provideShell`.
|
|
1775
|
+
- `function spineSuggestionsEnabled(): boolean` — Sugestões ligadas: o recurso não foi desligado (`SpineFeatures.suggestions`) e há para onde mandar (`SPINE_ADMIN_API`).
|
|
1776
|
+
- `function provideSpineSuggestionsPage(): EnvironmentProviders` — Registra a página no bootstrap (antes da primeira navegação: o F5 em /sugestoes passa pelo `ViewGuard`). Vai no `provideShell`; com as sugestões desligadas, não registra nada e o endereço cai no fallback de sempre.
|
|
1777
|
+
- `function suggestionScreens(routes: readonly Route[] | null | undefined): SuggestionScreenOption[]` — As telas que a pessoa alcança, da árvore de rotas que ela já recebe (`spineRoutesOf(view)`), na ordem do menu: cada nó com endereço e nome, com o caminho dos ancestrais com endereço (o mesmo "Módulo › … › Tela" da barra da página). Um endereço aparece uma vez…
|
|
1778
|
+
- `function screenModule(label: string | null | undefined): string` — O módulo (primeiro nível) de um caminho legível: "Vendas › Pedidos" → "Vendas".
|
|
1779
|
+
- `function screenName(label: string | null | undefined): string` — O nome da tela (último nível) de um caminho legível: "Vendas › Pedidos › Consulta" → "Consulta".
|
|
1780
|
+
- `function attachmentSizeText(locale: string): string` — O tamanho máximo de um anexo, no idioma de quem lê ("5 MB").
|
|
1781
|
+
- `function attachmentErrorText(err: unknown, fallback: string): string` — O motivo de um envio recusado, como o argos-admin explica (`detail`), ou o texto genérico.
|
|
1782
|
+
- `function spineTagColor(id: string): number` — Cor categórica estável para um id (o mesmo grupo sempre na mesma cor, em qualquer tela).
|
|
1507
1783
|
- `function sanitizeSpineMarkdownHtml(html: string): string | null` — HTML limpo pelo perfil do spine, ou `null` quando não há DOM (SSR: melhor não renderizar).
|
|
1784
|
+
- `function registerSpineUnsavedChanges(check: () => boolean): () => void` — Registra a verificação de alterações da tela, presa à aba do workspace em que ela está (`SPINE_TAB`): com `SpineFeatures.unsavedChanges` ligado, fechar ESSA aba (ou o painel dela, ou "fechar as outras") e trocar de tela dentro dela pergunta antes. Chame num c…
|
|
1508
1785
|
|
|
1509
1786
|
### Constantes e tokens
|
|
1510
1787
|
|
|
@@ -1514,61 +1791,54 @@ Painel de novidades do app (ver `provideSpineNews`). Decide o que está devido
|
|
|
1514
1791
|
- `SPINE_SETTINGS_SECTIONS`: `InjectionToken<SpineSettingsSection[]>`
|
|
1515
1792
|
- `SPINE_IDLE_WARNING_SECONDS`: `60` — Segundos de aviso antes de encerrar.
|
|
1516
1793
|
- `SPINE_PREFERENCES_SAVE_DELAY_MS`: `1500` — Espera depois da última mudança antes de gravar.
|
|
1794
|
+
- `SPINE_GLOBAL_PREFERENCE_KEYS` — Chaves que são da pessoa, não do app: com o Argos que tem `{api}/preferences/global`, vão no documento global e valem em todos os apps (escolhidas uma vez). O resto (menu lateral, dividir abas, atalhos, inatividade, tela inicial, avisos, favoritos) continua n…
|
|
1795
|
+
- `ratingTargetKey` — Chave de um alvo ("app" ou "screen:<rota>"): o que foi avaliado nesta sessão e a troca de alvo da janela.
|
|
1796
|
+
- `SPINE_RATING_COMMENT_MAX`: `500` — Teto do comentário (o mesmo do servidor e da coluna).
|
|
1797
|
+
- `SPINE_RATING_SCORE_MAX`: `10` — Nota máxima: 10 = 5 estrelas cheias (cada estrela vale 2, meia estrela vale 1).
|
|
1798
|
+
- `SPINE_TAB`: `InjectionToken<SpineTab>`
|
|
1799
|
+
- `SPINE_WORKSPACE_LIMITS`: `WorkspaceGridLimits` — Limite da grade de painéis do shell: no máximo 2 lado a lado e 2 empilhados (os quatro cantos da tela).
|
|
1800
|
+
- `SPINE_INBOX_SOURCES`: `InjectionToken<readonly (SpineInboxSource | null)[]>` — As fontes registradas (multi). Uma fábrica pode devolver `null` (recurso desligado): fica de fora.
|
|
1801
|
+
- `SPINE_INBOX_POLL_MS`: `60_000` — De quanto em quanto tempo a central relê, com a aba do navegador à vista.
|
|
1802
|
+
- `SPINE_AI_AGENT_PAGE_PATH`: `'/agente'` — A tela dedicada ao agente de IA: uma página do PRÓPRIO spine (ver `registerSpineBuiltinPage`), em todo app com `SpineFeatures.aiAgent`, sem cadastro de rota por client. Abre como qualquer tela do workspace (aba, painel, F5, link) e continua a mesma conversa d…
|
|
1803
|
+
- `SPINE_AI_AGENT_PAGE_ID`: `'spine:agente'` — Chave sintética da página no distribuidor de telas (não é UUID: não colide com router do banco).
|
|
1804
|
+
- `SPINE_SUGGESTION_KINDS` — Tipos de sugestão, como o Argos guarda (`web.app_suggestions.kind`).
|
|
1805
|
+
- `SPINE_SUGGESTION_STATUSES` — Os status, na ordem das colunas. Toda sugestão nasce `em_analise` (o antigo "Nova" saiu; ainda aparece no histórico, pelo `legacyStatuses` do catálogo). `concluida` e `recusada` encerram: recusada sai do quadro na hora, concluída depois de alguns dias (o serv…
|
|
1806
|
+
- `SPINE_SUGGESTION_PUBLIC_STATUSES` — Os status que aparecem em "Sugestões do app" (as de todo mundo): a recusada não entra (nem a arquivada pela equipe).
|
|
1807
|
+
- `SPINE_SUGGESTION_PUBLIC_SORTS` — Ordem de "Sugestões do app": as mais apoiadas (padrão do servidor) ou as mais novas.
|
|
1808
|
+
- `SPINE_SUGGESTION_STATUS_COLORS`: `Record<SpineSuggestionStatus, TagColor>` — Cor da etiqueta de status (a mesma em "Minhas sugestões" e no kanban do auto-serviço).
|
|
1809
|
+
- `SPINE_SUGGESTION_STATUS_ICONS`: `Record<SpineSuggestionStatus, string>` — Ícone de cada status (coluna do kanban, etiqueta do arquivo).
|
|
1810
|
+
- `SPINE_SUGGESTION_KIND_ICONS`: `Record<SpineSuggestionKind, string>` — Ícone e cor de cada tipo (o modal de nova sugestão e o cartão do kanban).
|
|
1811
|
+
- `SPINE_SUGGESTION_KIND_COLORS`: `Record<SpineSuggestionKind, TagColor>`
|
|
1812
|
+
- `SPINE_SUGGESTION_LIMITS` — Limites do servidor (colunas da migration): o formulário corta antes.
|
|
1813
|
+
- `SPINE_ATTACHMENT_LIMITS` — Anexos da sugestão e dos comentários (imagens, PDF, Markdown e texto), como o argos-admin aceita: até `maxFiles` por sugestão ou comentário, de até `maxBytes` cada. O servidor confere o tipo pelo conteúdo; `accept` só filtra a escolha.
|
|
1814
|
+
- `SPINE_SUGGESTION_REASONS` — Por que a pessoa vê a sugestão (o servidor decide; uma sugestão pode ter vários).
|
|
1815
|
+
- `SPINE_SUGGESTION_WAITING` — Com quem está a vez na conversa: quem pediu (a equipe respondeu) ou a equipe (quem pediu escreveu).
|
|
1816
|
+
- `SPINE_SUGGESTION_WAITING_COLORS`: `Record<SpineSuggestionWaiting, TagColor>` — Cor do selo "Aguardando…": a vez de quem pede chama atenção; a da equipe, não.
|
|
1817
|
+
- `SPINE_SUGGESTION_VISIBLE_SORTS`
|
|
1818
|
+
- `SPINE_SUGGESTIONS_PAGE_PATH`: `'/sugestoes'` — A página "Sugestões do app" de quem pede: uma página do PRÓPRIO spine (ver `registerSpineBuiltinPage`), em todo app com sugestões ligadas, sem cadastro de rota por client. Abre como qualquer tela do workspace (aba, painel, F5, link).
|
|
1819
|
+
- `SPINE_SUGGESTIONS_PAGE_ID`: `'spine:sugestoes'` — Chave sintética da página no distribuidor de telas (não é UUID: não colide com router do banco).
|
|
1820
|
+
- `SPINE_SUGGESTION_PAGE_PARAM`: `'sugestao'` — "?sugestao=SUG-12": abrir a página com ela abre a sugestão no painel (o mesmo parâmetro do quadro da equipe).
|
|
1821
|
+
- `SPINE_SUGGESTION_TAB_PARAM`: `'aba'` — "&aba=conversa": junto com `sugestao`, abre a gaveta na Conversa (sem ele, em Detalhes).
|
|
1822
|
+
- `SPINE_SUGGESTION_TAB_CONVERSATION`: `'conversa'`
|
|
1823
|
+
- `NEW_SCREEN_VALUE`: `'nova-tela'` — Valor da opção "Nova tela" no seletor (não é rota: nenhuma rota começa sem "/").
|
|
1517
1824
|
- `SPINE_MARKDOWN_PURIFY_CONFIG`: `Config` — Perfil do DOMPurify para o Markdown do spine (documentação de tela, novidades). Mais restrito que o padrão: o HTML entra no DOM do shell (sem shadow DOM), então - `<style>` e o atributo `style` ficam de fora (CSS valeria para a página inteira: esconder/redese…
|
|
1518
1825
|
|
|
1519
1826
|
### Tipos
|
|
1520
1827
|
|
|
1521
|
-
#### `
|
|
1828
|
+
#### `SpineInitialSetupMode` (type)
|
|
1522
1829
|
|
|
1523
|
-
|
|
1830
|
+
`full`: aparência e depois o essencial (primeiro acesso, "Refazer"). `essentials`: só os cartões do essencial.
|
|
1524
1831
|
|
|
1525
1832
|
```ts
|
|
1526
|
-
type
|
|
1833
|
+
type SpineInitialSetupMode = 'full' | 'essentials';
|
|
1527
1834
|
```
|
|
1528
1835
|
|
|
1529
|
-
#### `
|
|
1836
|
+
#### `SpineInitialSetupStep` (type)
|
|
1530
1837
|
|
|
1531
|
-
|
|
1532
|
-
interface OnboardingStep {
|
|
1533
|
-
/** seletor CSS do alvo; ausente = passo centralizado (boas-vindas/encerramento). */
|
|
1534
|
-
target?: string;
|
|
1535
|
-
title: string;
|
|
1536
|
-
/** pode conter HTML simples (<b>). */
|
|
1537
|
-
description: string;
|
|
1538
|
-
}
|
|
1539
|
-
```
|
|
1540
|
-
|
|
1541
|
-
#### `ShortcutGroupId` (type)
|
|
1542
|
-
|
|
1543
|
-
Grupo do painel de atalhos. Id estável; o nome exibido vem do catálogo da lib (`shortcuts.groups`).
|
|
1838
|
+
Etapa na tela: a escolha de aparência ou os cartões do essencial.
|
|
1544
1839
|
|
|
1545
1840
|
```ts
|
|
1546
|
-
type
|
|
1547
|
-
```
|
|
1548
|
-
|
|
1549
|
-
#### `ShortcutItem` (interface)
|
|
1550
|
-
|
|
1551
|
-
Item exibido no painel de atalhos (cheatsheet, aberto com "?").
|
|
1552
|
-
|
|
1553
|
-
```ts
|
|
1554
|
-
interface ShortcutItem {
|
|
1555
|
-
/** Teclas já em texto, na plataforma atual (`'Ctrl + K'`, `'⌘K'`, `'G depois H'`). */
|
|
1556
|
-
keys: string;
|
|
1557
|
-
description: string;
|
|
1558
|
-
group: ShortcutGroupId;
|
|
1559
|
-
}
|
|
1560
|
-
```
|
|
1561
|
-
|
|
1562
|
-
#### `ShortcutGroup` (interface)
|
|
1563
|
-
|
|
1564
|
-
Atalhos agrupados, já com o nome do grupo no idioma ativo.
|
|
1565
|
-
|
|
1566
|
-
```ts
|
|
1567
|
-
interface ShortcutGroup {
|
|
1568
|
-
id: ShortcutGroupId;
|
|
1569
|
-
name: string;
|
|
1570
|
-
items: ShortcutItem[];
|
|
1571
|
-
}
|
|
1841
|
+
type SpineInitialSetupStep = 'appearance' | 'essentials';
|
|
1572
1842
|
```
|
|
1573
1843
|
|
|
1574
1844
|
#### `ShortcutActions` (interface)
|
|
@@ -1579,9 +1849,8 @@ Ações concretas que o atalho dispara — ligadas pelo LayoutComponent.
|
|
|
1579
1849
|
interface ShortcutActions {
|
|
1580
1850
|
navigate?: (url: string) => void; // navega para uma rota (ex.: '/home', favorito)
|
|
1581
1851
|
toggleTheme?: () => void; // alterna claro/escuro
|
|
1582
|
-
toggleFullscreen?: () => void; // tela cheia
|
|
1583
|
-
logout?: () => void; // sair
|
|
1584
1852
|
openSettings?: () => void; // painel de configurações
|
|
1853
|
+
toggleSidebar?: () => void; // abre/recolhe o menu lateral
|
|
1585
1854
|
}
|
|
1586
1855
|
```
|
|
1587
1856
|
|
|
@@ -1656,6 +1925,99 @@ interface CreatedAppToken {
|
|
|
1656
1925
|
}
|
|
1657
1926
|
```
|
|
1658
1927
|
|
|
1928
|
+
#### `GroupRole` (type)
|
|
1929
|
+
|
|
1930
|
+
Função da pessoa no grupo, como o Argos guarda. Sem função (null) é o membro comum, que só vê os outros.
|
|
1931
|
+
|
|
1932
|
+
```ts
|
|
1933
|
+
type GroupRole = 'Administrador' | 'Editor';
|
|
1934
|
+
```
|
|
1935
|
+
|
|
1936
|
+
#### `ManagedGroup` (interface)
|
|
1937
|
+
|
|
1938
|
+
Um grupo desta aplicação de que a pessoa é membro, com o que a função dela permite (decidido pelo servidor).
|
|
1939
|
+
|
|
1940
|
+
```ts
|
|
1941
|
+
interface ManagedGroup {
|
|
1942
|
+
id: string;
|
|
1943
|
+
name: string;
|
|
1944
|
+
description: string | null;
|
|
1945
|
+
enabled: boolean;
|
|
1946
|
+
type: { id: string; name: string; level: number };
|
|
1947
|
+
my_role: GroupRole | null;
|
|
1948
|
+
/** Inclui pessoas (Administrador e Editor). */
|
|
1949
|
+
can_add: boolean;
|
|
1950
|
+
/** Funções que a pessoa pode dar a quem inclui, além de "sem função" (Administrador: as duas; Editor: nenhuma). */
|
|
1951
|
+
assignable_roles: GroupRole[];
|
|
1952
|
+
/** Só Administrador troca a função dos outros membros. */
|
|
1953
|
+
can_change_roles: boolean;
|
|
1954
|
+
/** Resumo dos membros (servidor que já manda): total e os primeiros, com foto. */
|
|
1955
|
+
members_count?: number;
|
|
1956
|
+
members_preview?: { user_id: string; username: string; name: string | null; picture: string | null }[];
|
|
1957
|
+
}
|
|
1958
|
+
```
|
|
1959
|
+
|
|
1960
|
+
#### `GroupMember` (interface)
|
|
1961
|
+
|
|
1962
|
+
```ts
|
|
1963
|
+
interface GroupMember {
|
|
1964
|
+
user_id: string;
|
|
1965
|
+
username: string;
|
|
1966
|
+
email: string | null;
|
|
1967
|
+
name: string | null;
|
|
1968
|
+
enabled: boolean;
|
|
1969
|
+
role: GroupRole | null;
|
|
1970
|
+
picture: string | null;
|
|
1971
|
+
joined_at: string | null;
|
|
1972
|
+
added_by_username: string | null;
|
|
1973
|
+
}
|
|
1974
|
+
```
|
|
1975
|
+
|
|
1976
|
+
#### `GroupMembersQuery` (interface)
|
|
1977
|
+
|
|
1978
|
+
Página e filtros da lista de membros (o servidor pagina: padrão 50, até 200 por página).
|
|
1979
|
+
|
|
1980
|
+
```ts
|
|
1981
|
+
interface GroupMembersQuery {
|
|
1982
|
+
page?: number;
|
|
1983
|
+
limit?: number;
|
|
1984
|
+
/** Trecho do nome, do login ou do e-mail. */
|
|
1985
|
+
search?: string;
|
|
1986
|
+
}
|
|
1987
|
+
```
|
|
1988
|
+
|
|
1989
|
+
#### `GroupMembersPage` (interface)
|
|
1990
|
+
|
|
1991
|
+
Uma página de membros, com a função de quem pede e o que ela permite (como em `ManagedGroup`).
|
|
1992
|
+
|
|
1993
|
+
```ts
|
|
1994
|
+
interface GroupMembersPage {
|
|
1995
|
+
my_role: GroupRole | null;
|
|
1996
|
+
can_add: boolean;
|
|
1997
|
+
assignable_roles: GroupRole[];
|
|
1998
|
+
can_change_roles: boolean;
|
|
1999
|
+
members: GroupMember[];
|
|
2000
|
+
/** Quantos passam pela busca (sem busca, o grupo inteiro). */
|
|
2001
|
+
total: number;
|
|
2002
|
+
page: number;
|
|
2003
|
+
limit: number;
|
|
2004
|
+
}
|
|
2005
|
+
```
|
|
2006
|
+
|
|
2007
|
+
#### `RealmUser` (interface)
|
|
2008
|
+
|
|
2009
|
+
```ts
|
|
2010
|
+
interface RealmUser {
|
|
2011
|
+
id: string;
|
|
2012
|
+
username: string;
|
|
2013
|
+
email: string | null;
|
|
2014
|
+
name: string | null;
|
|
2015
|
+
enabled: boolean;
|
|
2016
|
+
/** Foto (o argos-admin já manda com a busca): a pessoa incluída entra na lista com ela. */
|
|
2017
|
+
picture?: string | null;
|
|
2018
|
+
}
|
|
2019
|
+
```
|
|
2020
|
+
|
|
1659
2021
|
#### `AccountMethod` (interface)
|
|
1660
2022
|
|
|
1661
2023
|
Um método de verificação em duas etapas, como o Argos devolve (nunca o segredo do TOTP).
|
|
@@ -1798,7 +2160,7 @@ Um aviso do app (`SpineNoticesService.notify`).
|
|
|
1798
2160
|
```ts
|
|
1799
2161
|
interface SpineNotice {
|
|
1800
2162
|
title: string;
|
|
1801
|
-
/** Detalhe (segunda linha do aviso do navegador; no aviso da tela
|
|
2163
|
+
/** Detalhe (segunda linha do aviso do navegador; no aviso da tela é o texto, com `title` no título). */
|
|
1802
2164
|
body?: string;
|
|
1803
2165
|
/** Caminho interno (`/solicitacoes/42`) aberto pelo "Abrir" do aviso e pelo clique no aviso do navegador. */
|
|
1804
2166
|
url?: string;
|
|
@@ -1838,10 +2200,23 @@ interface SpineAccountPreferencesDoc {
|
|
|
1838
2200
|
startPage?: SpineStartPagePreference;
|
|
1839
2201
|
notices?: Record<string, boolean>;
|
|
1840
2202
|
browserNotices?: boolean;
|
|
2203
|
+
/** Dividir a área de abas em painéis (`SpinePreferencesService.splitTabs`). */
|
|
2204
|
+
splitTabs?: boolean;
|
|
1841
2205
|
favorites?: unknown[];
|
|
1842
2206
|
}
|
|
1843
2207
|
```
|
|
1844
2208
|
|
|
2209
|
+
#### `SpineGlobalPreferencesDoc` (type)
|
|
2210
|
+
|
|
2211
|
+
Documento global (`PUT {api}/preferences/global`): aparência e região, mais a configuração inicial feita.
|
|
2212
|
+
|
|
2213
|
+
```ts
|
|
2214
|
+
type SpineGlobalPreferencesDoc = Pick<SpineAccountPreferencesDoc, 'v' | (typeof SPINE_GLOBAL_PREFERENCE_KEYS)[number]> & {
|
|
2215
|
+
/** A configuração inicial já foi feita (ou pulada): não aparece de novo em nenhum app. */
|
|
2216
|
+
setupDone?: boolean;
|
|
2217
|
+
};
|
|
2218
|
+
```
|
|
2219
|
+
|
|
1845
2220
|
#### `SpineAccountPreferencesStatus` (type)
|
|
1846
2221
|
|
|
1847
2222
|
`local`: só no navegador (recurso desligado, sem API da conta, ou Argos sem o endpoint).
|
|
@@ -1878,6 +2253,587 @@ interface DocsGroup {
|
|
|
1878
2253
|
type DocsView = 'usage' | 'technical';
|
|
1879
2254
|
```
|
|
1880
2255
|
|
|
2256
|
+
#### `SpineNewsAuthor` (interface)
|
|
2257
|
+
|
|
2258
|
+
Quem escreveu a novidade, como o argos-admin devolve (nome ou usuário, e a foto).
|
|
2259
|
+
|
|
2260
|
+
```ts
|
|
2261
|
+
interface SpineNewsAuthor {
|
|
2262
|
+
readonly name: string;
|
|
2263
|
+
readonly picture: string | null;
|
|
2264
|
+
}
|
|
2265
|
+
```
|
|
2266
|
+
|
|
2267
|
+
#### `SpineNewsKind` (type)
|
|
2268
|
+
|
|
2269
|
+
Tipo da novidade: só texto (`informativo`); "o que há de novo", com introdução e a lista de mudanças (`implementacao`); ou "como era x como ficou", com introdução e o antes e o agora (`alteracao`).
|
|
2270
|
+
|
|
2271
|
+
```ts
|
|
2272
|
+
type SpineNewsKind = 'informativo' | 'implementacao' | 'alteracao';
|
|
2273
|
+
```
|
|
2274
|
+
|
|
2275
|
+
#### `SpineNewsSummary` (interface)
|
|
2276
|
+
|
|
2277
|
+
Uma novidade na lista (`GET /me/news`): sem o corpo.
|
|
2278
|
+
|
|
2279
|
+
```ts
|
|
2280
|
+
interface SpineNewsSummary {
|
|
2281
|
+
readonly id: string;
|
|
2282
|
+
/** Servidor antigo não manda: vale `informativo`. */
|
|
2283
|
+
readonly kind?: SpineNewsKind;
|
|
2284
|
+
readonly title: string;
|
|
2285
|
+
readonly summary: string;
|
|
2286
|
+
readonly published_at: string;
|
|
2287
|
+
readonly author: SpineNewsAuthor | null;
|
|
2288
|
+
}
|
|
2289
|
+
```
|
|
2290
|
+
|
|
2291
|
+
#### `SpineNewsDetail` (interface)
|
|
2292
|
+
|
|
2293
|
+
Uma novidade aberta (`GET /me/news/:id`): com o conteúdo, já saneado pelo servidor ao gravar. `body_html` é o texto (no informativo) ou a introdução (nos outros tipos); `items` é a lista da implementação; `before_html` e `after_html`, os dois lados da alteração.
|
|
2294
|
+
|
|
2295
|
+
```ts
|
|
2296
|
+
interface SpineNewsDetail extends SpineNewsSummary {
|
|
2297
|
+
readonly body_html: string;
|
|
2298
|
+
readonly items?: readonly string[];
|
|
2299
|
+
readonly before_html?: string;
|
|
2300
|
+
readonly after_html?: string;
|
|
2301
|
+
/** Alterada depois de publicada: quem editou por último e quando (servidor antigo não manda). */
|
|
2302
|
+
readonly edited?: (SpineNewsAuthor & { readonly at: string }) | null;
|
|
2303
|
+
}
|
|
2304
|
+
```
|
|
2305
|
+
|
|
2306
|
+
#### `SpineNewsPage` (interface)
|
|
2307
|
+
|
|
2308
|
+
Uma página da lista.
|
|
2309
|
+
|
|
2310
|
+
```ts
|
|
2311
|
+
interface SpineNewsPage {
|
|
2312
|
+
readonly news: readonly SpineNewsSummary[];
|
|
2313
|
+
readonly total: number;
|
|
2314
|
+
readonly page: number;
|
|
2315
|
+
readonly limit: number;
|
|
2316
|
+
}
|
|
2317
|
+
```
|
|
2318
|
+
|
|
2319
|
+
#### `SpineNewsFilter` (type)
|
|
2320
|
+
|
|
2321
|
+
Filtro em pílula do topo do painel.
|
|
2322
|
+
|
|
2323
|
+
```ts
|
|
2324
|
+
type SpineNewsFilter = 'all' | 'unread' | 'favorites';
|
|
2325
|
+
```
|
|
2326
|
+
|
|
2327
|
+
#### `SpineRatingScope` (type)
|
|
2328
|
+
|
|
2329
|
+
O que se avalia: a ferramenta inteira (`app`) ou uma tela (`screen`).
|
|
2330
|
+
|
|
2331
|
+
```ts
|
|
2332
|
+
type SpineRatingScope = 'app' | 'screen';
|
|
2333
|
+
```
|
|
2334
|
+
|
|
2335
|
+
#### `SpineRatingTarget` (interface)
|
|
2336
|
+
|
|
2337
|
+
Alvo de uma avaliação. Tela: `screenPath` é a chave (a rota); `screenLabel`, o caminho legível que vai junto.
|
|
2338
|
+
|
|
2339
|
+
```ts
|
|
2340
|
+
interface SpineRatingTarget {
|
|
2341
|
+
scope: SpineRatingScope;
|
|
2342
|
+
screenPath?: string | null;
|
|
2343
|
+
screenLabel?: string | null;
|
|
2344
|
+
}
|
|
2345
|
+
```
|
|
2346
|
+
|
|
2347
|
+
#### `SpineRating` (interface)
|
|
2348
|
+
|
|
2349
|
+
A avaliação da pessoa como o argos-admin devolve (`/me/ratings`).
|
|
2350
|
+
|
|
2351
|
+
```ts
|
|
2352
|
+
interface SpineRating {
|
|
2353
|
+
scope: SpineRatingScope;
|
|
2354
|
+
screen_path: string | null;
|
|
2355
|
+
screen_label: string | null;
|
|
2356
|
+
/** 0 a 10 (10 = 5 estrelas; 7 = 3,5). */
|
|
2357
|
+
score: number;
|
|
2358
|
+
comment: string | null;
|
|
2359
|
+
created_at: string;
|
|
2360
|
+
updated_at: string;
|
|
2361
|
+
}
|
|
2362
|
+
```
|
|
2363
|
+
|
|
2364
|
+
#### `SpineRatingAverage` (interface)
|
|
2365
|
+
|
|
2366
|
+
Média da ferramenta que qualquer pessoa logada vê (`/me/ratings/summary`): 0 a 10 com uma casa, ou `null`.
|
|
2367
|
+
|
|
2368
|
+
```ts
|
|
2369
|
+
interface SpineRatingAverage {
|
|
2370
|
+
average: number | null;
|
|
2371
|
+
total: number;
|
|
2372
|
+
}
|
|
2373
|
+
```
|
|
2374
|
+
|
|
2375
|
+
#### `SpineScoreBand` (type)
|
|
2376
|
+
|
|
2377
|
+
```ts
|
|
2378
|
+
type SpineScoreBand = 1 | 2 | 3 | 4 | 5;
|
|
2379
|
+
```
|
|
2380
|
+
|
|
2381
|
+
#### `SpineStarFill` (type)
|
|
2382
|
+
|
|
2383
|
+
```ts
|
|
2384
|
+
type SpineStarFill = 'empty' | 'half' | 'full';
|
|
2385
|
+
```
|
|
2386
|
+
|
|
2387
|
+
#### `SpineTabParams` (type)
|
|
2388
|
+
|
|
2389
|
+
Query de uma aba, como objeto (o último valor de cada nome).
|
|
2390
|
+
|
|
2391
|
+
```ts
|
|
2392
|
+
type SpineTabParams = Readonly<Record<string, string>>;
|
|
2393
|
+
```
|
|
2394
|
+
|
|
2395
|
+
#### `SpineTab` (interface)
|
|
2396
|
+
|
|
2397
|
+
A aba do workspace em que a tela está montada (`inject(SPINE_TAB)` na tela). Com o keepAlive, várias abas da MESMA tela ficam vivas ao mesmo tempo (um registro por aba); `window.location`/`ActivatedRoute` só refletem a aba do painel focado. Aqui cada tela lê e escreve a SUA.
|
|
2398
|
+
|
|
2399
|
+
```ts
|
|
2400
|
+
interface SpineTab {
|
|
2401
|
+
/** Identidade estável da aba (o caminho, ou o caminho com os parâmetros que a identificam). */
|
|
2402
|
+
readonly id: Signal<string>;
|
|
2403
|
+
/** O painel em que a aba está agora. */
|
|
2404
|
+
readonly panelId: Signal<string>;
|
|
2405
|
+
/** O endereço atual da aba, com a query. */
|
|
2406
|
+
readonly url: Signal<string>;
|
|
2407
|
+
/** A query da aba. */
|
|
2408
|
+
readonly params: Signal<SpineTabParams>;
|
|
2409
|
+
/** A aba é a visível do painel focado (é a que o endereço do navegador mostra). */
|
|
2410
|
+
readonly focused: Signal<boolean>;
|
|
2411
|
+
/** Troca o nome (e, se vier, o ícone) da aba; persiste no F5 nas abas com parâmetros. */
|
|
2412
|
+
setLabel(label: string, icon?: string): void;
|
|
2413
|
+
/**
|
|
2414
|
+
* Muda o endereço da própria aba. Com `queryParams`, mescla na query atual (`merge`, padrão) ou troca a query
|
|
2415
|
+
* inteira (`merge: false`); `null`/`undefined` tira o parâmetro. Mesma tela: só a query muda, a tela não é recriada.
|
|
2416
|
+
* Outra tela (um caminho diferente): é a navegação no lugar da aba, como um link dentro do painel.
|
|
2417
|
+
*/
|
|
2418
|
+
navigate(target: string | { queryParams: Readonly<Record<string, string | number | boolean | null | undefined>>; merge?: boolean }): void;
|
|
2419
|
+
}
|
|
2420
|
+
```
|
|
2421
|
+
|
|
2422
|
+
#### `SpineOpenTabOptions` (interface)
|
|
2423
|
+
|
|
2424
|
+
Como abrir uma aba pelo app (`openTab`).
|
|
2425
|
+
|
|
2426
|
+
```ts
|
|
2427
|
+
interface SpineOpenTabOptions {
|
|
2428
|
+
/** Nome da aba (senão, o da rota). A tela pode trocar depois (`SPINE_TAB.setLabel`). */
|
|
2429
|
+
label?: string;
|
|
2430
|
+
icon?: string;
|
|
2431
|
+
/**
|
|
2432
|
+
* Os parâmetros que IDENTIFICAM a aba: com `['dispositivo']`, o mesmo dispositivo em outra seção reaproveita a aba
|
|
2433
|
+
* aberta, e trocar a seção dentro dela não abre outra. Sem `match`, todos os parâmetros do endereço identificam.
|
|
2434
|
+
*/
|
|
2435
|
+
match?: readonly string[];
|
|
2436
|
+
/**
|
|
2437
|
+
* Abre num painel novo ao lado do focado (para comparar), em vez de no próprio painel focado. Só vale com a
|
|
2438
|
+
* preferência "Dividir abas" ligada (`SpinePreferencesService.splitTabs`); desligada (o padrão), a aba abre no painel
|
|
2439
|
+
* focado, como sem `beside`. No limite da grade (`SPINE_WORKSPACE_LIMITS`, 2 colunas), abre no painel que já está
|
|
2440
|
+
* ao lado, sem dividir.
|
|
2441
|
+
*/
|
|
2442
|
+
beside?: boolean;
|
|
2443
|
+
}
|
|
2444
|
+
```
|
|
2445
|
+
|
|
2446
|
+
#### `SpineInboxItem` (interface)
|
|
2447
|
+
|
|
2448
|
+
Uma novidade na central de notificações (o sino do cabeçalho).
|
|
2449
|
+
|
|
2450
|
+
```ts
|
|
2451
|
+
interface SpineInboxItem {
|
|
2452
|
+
/** Único dentro da fonte. */
|
|
2453
|
+
readonly id: string;
|
|
2454
|
+
readonly title: string;
|
|
2455
|
+
/** A novidade em uma linha ("Ana: pode mandar um exemplo?"). */
|
|
2456
|
+
readonly body?: string;
|
|
2457
|
+
/** Quando aconteceu (a novidade mais recente do item): ordena a lista e vira "há 5 min". */
|
|
2458
|
+
readonly at: string | Date;
|
|
2459
|
+
/** Quantas novidades o item junta (mostra "+N" a partir de 2). */
|
|
2460
|
+
readonly count?: number;
|
|
2461
|
+
/** Quem fez: a foto (ou as iniciais) na linha; sem pessoa, o ícone da fonte. */
|
|
2462
|
+
readonly person?: { readonly name: string; readonly picture?: string | null } | null;
|
|
2463
|
+
}
|
|
2464
|
+
```
|
|
2465
|
+
|
|
2466
|
+
#### `SpineInboxSource` (interface)
|
|
2467
|
+
|
|
2468
|
+
Uma fonte da central de notificações: o que há de novo PARA a pessoa num recurso (sugestões, aprovações, chamados…). Não são os toasts (`HermesToastService`/`NotificationService`), que passam: aqui fica até a pessoa ver. Registre com `provideSpineInboxSource`; o sino só aparece com alguma fonte.
|
|
2469
|
+
|
|
2470
|
+
```ts
|
|
2471
|
+
interface SpineInboxSource {
|
|
2472
|
+
readonly id: string;
|
|
2473
|
+
/** O nome da fonte ("Sugestões"), acima dos itens dela. */
|
|
2474
|
+
readonly label: string;
|
|
2475
|
+
/** Ícone da fonte (@trismegisto/icons), nos itens sem pessoa. */
|
|
2476
|
+
readonly icon?: string;
|
|
2477
|
+
/** As novidades (as mais recentes, até umas 20) e o total de itens com novidade (o número do sino). */
|
|
2478
|
+
load(): Promise<{ readonly items: readonly SpineInboxItem[]; readonly total: number }>;
|
|
2479
|
+
/** A pessoa escolheu o item: marque como visto e abra onde ele está. A central relê depois. */
|
|
2480
|
+
open(item: SpineInboxItem): void | Promise<void>;
|
|
2481
|
+
}
|
|
2482
|
+
```
|
|
2483
|
+
|
|
2484
|
+
#### `SpineInboxEntry` (interface)
|
|
2485
|
+
|
|
2486
|
+
Um item na lista do sino, com a fonte dele.
|
|
2487
|
+
|
|
2488
|
+
```ts
|
|
2489
|
+
interface SpineInboxEntry {
|
|
2490
|
+
/** `fonte:item`, único na lista. */
|
|
2491
|
+
readonly key: string;
|
|
2492
|
+
readonly source: SpineInboxSource;
|
|
2493
|
+
readonly item: SpineInboxItem;
|
|
2494
|
+
}
|
|
2495
|
+
```
|
|
2496
|
+
|
|
2497
|
+
#### `SpineSuggestionKind` (type)
|
|
2498
|
+
|
|
2499
|
+
```ts
|
|
2500
|
+
type SpineSuggestionKind = (typeof SPINE_SUGGESTION_KINDS)[number];
|
|
2501
|
+
```
|
|
2502
|
+
|
|
2503
|
+
#### `SpineSuggestionStatus` (type)
|
|
2504
|
+
|
|
2505
|
+
```ts
|
|
2506
|
+
type SpineSuggestionStatus = (typeof SPINE_SUGGESTION_STATUSES)[number];
|
|
2507
|
+
```
|
|
2508
|
+
|
|
2509
|
+
#### `SpineSuggestionPublicStatus` (type)
|
|
2510
|
+
|
|
2511
|
+
```ts
|
|
2512
|
+
type SpineSuggestionPublicStatus = (typeof SPINE_SUGGESTION_PUBLIC_STATUSES)[number];
|
|
2513
|
+
```
|
|
2514
|
+
|
|
2515
|
+
#### `SpineSuggestionPublicSort` (type)
|
|
2516
|
+
|
|
2517
|
+
```ts
|
|
2518
|
+
type SpineSuggestionPublicSort = (typeof SPINE_SUGGESTION_PUBLIC_SORTS)[number];
|
|
2519
|
+
```
|
|
2520
|
+
|
|
2521
|
+
#### `SpineSuggestionAttachment` (interface)
|
|
2522
|
+
|
|
2523
|
+
Um anexo como o argos-admin devolve. `kind` = `image` (abre na galeria) ou `file` (baixa).
|
|
2524
|
+
|
|
2525
|
+
```ts
|
|
2526
|
+
interface SpineSuggestionAttachment {
|
|
2527
|
+
id: string;
|
|
2528
|
+
file_name: string;
|
|
2529
|
+
content_type: string;
|
|
2530
|
+
kind: 'image' | 'file';
|
|
2531
|
+
size: number;
|
|
2532
|
+
width: number | null;
|
|
2533
|
+
height: number | null;
|
|
2534
|
+
/** O comentário a que pertence (null = da própria sugestão). */
|
|
2535
|
+
comment_id: string | null;
|
|
2536
|
+
uploaded_by: string | null;
|
|
2537
|
+
created_at: string;
|
|
2538
|
+
}
|
|
2539
|
+
```
|
|
2540
|
+
|
|
2541
|
+
#### `SpineSuggestionPerson` (interface)
|
|
2542
|
+
|
|
2543
|
+
```ts
|
|
2544
|
+
interface SpineSuggestionPerson { user_id: string; username: string | null; name: string | null; picture: string | null }
|
|
2545
|
+
```
|
|
2546
|
+
|
|
2547
|
+
#### `SpineSuggestion` (interface)
|
|
2548
|
+
|
|
2549
|
+
Uma sugestão como o argos-admin devolve (`/me/suggestions` e `/auto-service/:clientId/suggestions`).
|
|
2550
|
+
|
|
2551
|
+
```ts
|
|
2552
|
+
interface SpineSuggestion {
|
|
2553
|
+
id: string;
|
|
2554
|
+
/** A chave da sugestão no app ("SUG-12"), a mesma que a equipe usa no quadro. */
|
|
2555
|
+
key?: string;
|
|
2556
|
+
kind: SpineSuggestionKind;
|
|
2557
|
+
title: string;
|
|
2558
|
+
description: string;
|
|
2559
|
+
screen: SpineSuggestionScreen;
|
|
2560
|
+
status: SpineSuggestionStatus;
|
|
2561
|
+
position: number;
|
|
2562
|
+
votes: number;
|
|
2563
|
+
/** Quem consulta também apoia (só nas leituras da pessoa). */
|
|
2564
|
+
voted: boolean;
|
|
2565
|
+
comments_count: number;
|
|
2566
|
+
last_comment: { comment: string; created_at: string } | null;
|
|
2567
|
+
/** Desde quando está no status atual (o último evento para ele; sem evento, a criação). */
|
|
2568
|
+
status_at?: string;
|
|
2569
|
+
/** Com quem está a vez na conversa (null = em dia). */
|
|
2570
|
+
waiting_on?: SpineSuggestionWaiting | null;
|
|
2571
|
+
waiting_since?: string | null;
|
|
2572
|
+
created_at: string;
|
|
2573
|
+
updated_at: string;
|
|
2574
|
+
/** Só no auto-serviço: quem pediu, com a foto (null = pessoa removida). */
|
|
2575
|
+
author?: SpineSuggestionPerson | null;
|
|
2576
|
+
/** Só em "já pediram nesta tela": a sugestão é de quem consulta (autora ou relatora). */
|
|
2577
|
+
mine?: boolean;
|
|
2578
|
+
/** Só em "Minhas": quem consulta é relatora (a sugestão dela foi agrupada nesta), não a autora. */
|
|
2579
|
+
reporter?: boolean;
|
|
2580
|
+
/** Só em "Minhas": as sugestões de quem consulta agrupadas nesta ("SUG-30 agrupada em SUG-12"). */
|
|
2581
|
+
merged_from?: Array<{ id: string; key: string; title: string }>;
|
|
2582
|
+
}
|
|
2583
|
+
```
|
|
2584
|
+
|
|
2585
|
+
#### `SpineAppSuggestion` (interface)
|
|
2586
|
+
|
|
2587
|
+
Uma sugestão em "Sugestões do app" (`/me/suggestions/all`): só o que é público do pedido, de quem quer que seja — nada do quadro de trabalho da equipe, e os comentários contados e o último são só os públicos.
|
|
2588
|
+
|
|
2589
|
+
```ts
|
|
2590
|
+
interface SpineAppSuggestion {
|
|
2591
|
+
id: string;
|
|
2592
|
+
key: string;
|
|
2593
|
+
kind: SpineSuggestionKind;
|
|
2594
|
+
title: string;
|
|
2595
|
+
/** Texto puro (a descrição inteira, até 4000). */
|
|
2596
|
+
description: string;
|
|
2597
|
+
screen: SpineSuggestionScreen;
|
|
2598
|
+
status: SpineSuggestionStatus;
|
|
2599
|
+
votes: number;
|
|
2600
|
+
/** Quem consulta apoia. */
|
|
2601
|
+
voted: boolean;
|
|
2602
|
+
/** É de quem consulta: não dá para apoiar (o servidor responde `409 own_suggestion`). */
|
|
2603
|
+
mine: boolean;
|
|
2604
|
+
comments_count: number;
|
|
2605
|
+
last_comment: { comment: string; created_at: string } | null;
|
|
2606
|
+
created_at: string;
|
|
2607
|
+
/** Quem pediu, com a foto (null = pessoa removida). */
|
|
2608
|
+
author: SpineSuggestionPerson | null;
|
|
2609
|
+
}
|
|
2610
|
+
```
|
|
2611
|
+
|
|
2612
|
+
#### `SpineSuggestionComment` (interface)
|
|
2613
|
+
|
|
2614
|
+
Comentário público de uma sugestão (`/me/suggestions/:id/comments`); `status` = a mudança que ele acompanha.
|
|
2615
|
+
|
|
2616
|
+
```ts
|
|
2617
|
+
interface SpineSuggestionComment {
|
|
2618
|
+
id: string;
|
|
2619
|
+
comment: string;
|
|
2620
|
+
status: SpineSuggestionStatus | null;
|
|
2621
|
+
created_at: string;
|
|
2622
|
+
author: SpineSuggestionPerson | null;
|
|
2623
|
+
/** Os anexos do comentário (vazio no servidor sem anexos). */
|
|
2624
|
+
attachments?: SpineSuggestionAttachment[];
|
|
2625
|
+
}
|
|
2626
|
+
```
|
|
2627
|
+
|
|
2628
|
+
#### `SpineAppSuggestionsQuery` (interface)
|
|
2629
|
+
|
|
2630
|
+
```ts
|
|
2631
|
+
interface SpineAppSuggestionsQuery {
|
|
2632
|
+
limit: number;
|
|
2633
|
+
offset: number;
|
|
2634
|
+
status?: SpineSuggestionPublicStatus | '';
|
|
2635
|
+
/** Título, descrição, tela ou a chave ("SUG-12"). */
|
|
2636
|
+
q?: string;
|
|
2637
|
+
/** Só as pedidas nesta rota. */
|
|
2638
|
+
screen?: string;
|
|
2639
|
+
sort?: SpineSuggestionPublicSort;
|
|
2640
|
+
}
|
|
2641
|
+
```
|
|
2642
|
+
|
|
2643
|
+
#### `SpineSuggestionDraft` (interface)
|
|
2644
|
+
|
|
2645
|
+
```ts
|
|
2646
|
+
interface SpineSuggestionDraft {
|
|
2647
|
+
kind: SpineSuggestionKind;
|
|
2648
|
+
title: string;
|
|
2649
|
+
/** Texto puro (o formato antigo; o servidor ainda aceita). */
|
|
2650
|
+
description?: string;
|
|
2651
|
+
/** A descrição em rich text (o editor do modal); o servidor saneia e deriva o texto puro. */
|
|
2652
|
+
description_html?: string;
|
|
2653
|
+
/** Tela do menu (`router_id` e a rota) ou `new: true` com o nome da tela que ainda não existe em `label`. */
|
|
2654
|
+
screen: { path: string | null; label: string | null; router_id?: string | null; new?: boolean };
|
|
2655
|
+
}
|
|
2656
|
+
```
|
|
2657
|
+
|
|
2658
|
+
#### `SpineSuggestionReason` (type)
|
|
2659
|
+
|
|
2660
|
+
```ts
|
|
2661
|
+
type SpineSuggestionReason = (typeof SPINE_SUGGESTION_REASONS)[number];
|
|
2662
|
+
```
|
|
2663
|
+
|
|
2664
|
+
#### `SpineSuggestionWaiting` (type)
|
|
2665
|
+
|
|
2666
|
+
```ts
|
|
2667
|
+
type SpineSuggestionWaiting = (typeof SPINE_SUGGESTION_WAITING)[number];
|
|
2668
|
+
```
|
|
2669
|
+
|
|
2670
|
+
#### `SpineSuggestionVisibleSort` (type)
|
|
2671
|
+
|
|
2672
|
+
```ts
|
|
2673
|
+
type SpineSuggestionVisibleSort = (typeof SPINE_SUGGESTION_VISIBLE_SORTS)[number];
|
|
2674
|
+
```
|
|
2675
|
+
|
|
2676
|
+
#### `SpineSuggestionScreen` (interface)
|
|
2677
|
+
|
|
2678
|
+
A tela de uma sugestão: a do menu (`router_id`, rota e o caminho legível) ou uma nova (`new`, o nome no `label`).
|
|
2679
|
+
|
|
2680
|
+
```ts
|
|
2681
|
+
interface SpineSuggestionScreen { path: string | null; label: string | null; router_id?: string | null; new?: boolean }
|
|
2682
|
+
```
|
|
2683
|
+
|
|
2684
|
+
#### `SpineVisibleSuggestion` (interface)
|
|
2685
|
+
|
|
2686
|
+
Uma sugestão que a pessoa VÊ (`/me/suggestions/visible` e o detalhe): as dela, as do grupo dela e as em que ela está envolvida, com os motivos (`reasons`), se ela pode conversar (`can_comment`, quem tem motivo pessoal) e com quem está a vez (`waiting_on`).
|
|
2687
|
+
|
|
2688
|
+
```ts
|
|
2689
|
+
interface SpineVisibleSuggestion {
|
|
2690
|
+
id: string;
|
|
2691
|
+
key: string;
|
|
2692
|
+
kind: SpineSuggestionKind;
|
|
2693
|
+
title: string;
|
|
2694
|
+
description: string;
|
|
2695
|
+
/** A descrição em rich text (saneada pelo servidor); vazia sem descrição. */
|
|
2696
|
+
description_html?: string;
|
|
2697
|
+
screen: SpineSuggestionScreen;
|
|
2698
|
+
status: SpineSuggestionStatus;
|
|
2699
|
+
status_at?: string;
|
|
2700
|
+
votes: number;
|
|
2701
|
+
voted: boolean;
|
|
2702
|
+
mine: boolean;
|
|
2703
|
+
reasons: SpineSuggestionReason[];
|
|
2704
|
+
can_comment: boolean;
|
|
2705
|
+
waiting_on: SpineSuggestionWaiting | null;
|
|
2706
|
+
waiting_since: string | null;
|
|
2707
|
+
comments_count: number;
|
|
2708
|
+
last_comment: { comment: string; created_at: string } | null;
|
|
2709
|
+
/** Mensagens de outras pessoas que quem consulta ainda não leu. */
|
|
2710
|
+
unread: number;
|
|
2711
|
+
archived: boolean;
|
|
2712
|
+
merged_from: Array<{ id: string; key: string; title: string }>;
|
|
2713
|
+
groups: Array<{ id: string; name: string }>;
|
|
2714
|
+
author: SpineSuggestionPerson | null;
|
|
2715
|
+
assignees: SpineSuggestionPerson[];
|
|
2716
|
+
created_at: string;
|
|
2717
|
+
updated_at: string;
|
|
2718
|
+
last_activity_at?: string;
|
|
2719
|
+
/** Os anexos da própria sugestão (só na leitura de uma: `get`, `lookup`, `create`). */
|
|
2720
|
+
attachments?: SpineSuggestionAttachment[];
|
|
2721
|
+
}
|
|
2722
|
+
```
|
|
2723
|
+
|
|
2724
|
+
#### `SpineVisibleCounts` (type)
|
|
2725
|
+
|
|
2726
|
+
Contagens do conjunto visível inteiro (sem os filtros), para os filtros rápidos da página.
|
|
2727
|
+
|
|
2728
|
+
```ts
|
|
2729
|
+
type SpineVisibleCounts = Record<SpineSuggestionReason, number> & { waiting_me: number; unread: number };
|
|
2730
|
+
```
|
|
2731
|
+
|
|
2732
|
+
#### `SpineVisibleQuery` (interface)
|
|
2733
|
+
|
|
2734
|
+
```ts
|
|
2735
|
+
interface SpineVisibleQuery {
|
|
2736
|
+
limit: number;
|
|
2737
|
+
offset: number;
|
|
2738
|
+
reason?: SpineSuggestionReason | '';
|
|
2739
|
+
status?: SpineSuggestionStatus | '';
|
|
2740
|
+
kind?: SpineSuggestionKind | '';
|
|
2741
|
+
waiting?: SpineSuggestionWaiting | '';
|
|
2742
|
+
screen?: string;
|
|
2743
|
+
newScreen?: boolean;
|
|
2744
|
+
q?: string;
|
|
2745
|
+
sort?: SpineSuggestionVisibleSort;
|
|
2746
|
+
}
|
|
2747
|
+
```
|
|
2748
|
+
|
|
2749
|
+
#### `SpineSuggestionMessage` (interface)
|
|
2750
|
+
|
|
2751
|
+
Mensagem da conversa (comentário público): `from_requester` = escrita por quem pediu ou um envolvido.
|
|
2752
|
+
|
|
2753
|
+
```ts
|
|
2754
|
+
interface SpineSuggestionMessage extends SpineSuggestionComment {
|
|
2755
|
+
from_requester?: boolean;
|
|
2756
|
+
}
|
|
2757
|
+
```
|
|
2758
|
+
|
|
2759
|
+
#### `SpineSuggestionUpdate` (interface)
|
|
2760
|
+
|
|
2761
|
+
Uma sugestão acompanhada com novidade (`/me/suggestions/updates`): a central de notificações.
|
|
2762
|
+
|
|
2763
|
+
```ts
|
|
2764
|
+
interface SpineSuggestionUpdate {
|
|
2765
|
+
id: string;
|
|
2766
|
+
key: string;
|
|
2767
|
+
title: string;
|
|
2768
|
+
status: SpineSuggestionStatus;
|
|
2769
|
+
/** Quantas novidades desde a última leitura (comentários públicos e mudanças de status de outras pessoas). */
|
|
2770
|
+
count: number;
|
|
2771
|
+
/** A mais recente: o comentário (até 200) ou o status novo, e quem fez. */
|
|
2772
|
+
last: { kind: 'comment' | 'status'; status: SpineSuggestionStatus | null; comment: string | null; at: string; author: SpineSuggestionPerson | null };
|
|
2773
|
+
}
|
|
2774
|
+
```
|
|
2775
|
+
|
|
2776
|
+
#### `SuggestionScreenOption` (interface)
|
|
2777
|
+
|
|
2778
|
+
Uma tela que dá para escolher no "Sugerir melhoria": a rota, o `router_id` e o caminho legível ("Módulo › Tela").
|
|
2779
|
+
|
|
2780
|
+
```ts
|
|
2781
|
+
interface SuggestionScreenOption {
|
|
2782
|
+
path: string;
|
|
2783
|
+
routerId: string | null;
|
|
2784
|
+
/** O nome da tela (o último nível). */
|
|
2785
|
+
name: string;
|
|
2786
|
+
/** O caminho inteiro, como a barra da página mostra ("Vendas › Pedidos › Consulta"): é o que vai para o `screen.label`. */
|
|
2787
|
+
label: string;
|
|
2788
|
+
icon: string;
|
|
2789
|
+
}
|
|
2790
|
+
```
|
|
2791
|
+
|
|
2792
|
+
#### `SpineChatSide` (type)
|
|
2793
|
+
|
|
2794
|
+
De que lado da conversa a tela está: a de quem pede (página) ou a da equipe (detalhe da tarefa).
|
|
2795
|
+
|
|
2796
|
+
```ts
|
|
2797
|
+
type SpineChatSide = 'solicitante' | 'equipe';
|
|
2798
|
+
```
|
|
2799
|
+
|
|
2800
|
+
#### `SpineChatMessage` (interface)
|
|
2801
|
+
|
|
2802
|
+
Uma mensagem da conversa de uma sugestão, do jeito que o chat desenha (a página e o detalhe convertem para isto).
|
|
2803
|
+
|
|
2804
|
+
```ts
|
|
2805
|
+
interface SpineChatMessage {
|
|
2806
|
+
id: string;
|
|
2807
|
+
text: string;
|
|
2808
|
+
created_at: string;
|
|
2809
|
+
author: SpineSuggestionPerson | null;
|
|
2810
|
+
/** Escrita como quem pede (pela página); `false` = como equipe (pelo detalhe da tarefa). */
|
|
2811
|
+
from_requester: boolean;
|
|
2812
|
+
/** Comentário interno da equipe (só aparece do lado da equipe). */
|
|
2813
|
+
internal?: boolean;
|
|
2814
|
+
/** A mudança de status que o comentário acompanha. */
|
|
2815
|
+
status?: SpineSuggestionStatus | null;
|
|
2816
|
+
/** Os anexos da mensagem. */
|
|
2817
|
+
attachments?: readonly SpineSuggestionAttachment[];
|
|
2818
|
+
}
|
|
2819
|
+
```
|
|
2820
|
+
|
|
2821
|
+
#### `SpineAttachmentLoader` (type)
|
|
2822
|
+
|
|
2823
|
+
Busca o arquivo de um anexo (pela API, com o token da sessão: a imagem não vai direto num `<img src>`).
|
|
2824
|
+
|
|
2825
|
+
```ts
|
|
2826
|
+
type SpineAttachmentLoader = (attachment: SpineSuggestionAttachment) => Promise<Blob>;
|
|
2827
|
+
```
|
|
2828
|
+
|
|
2829
|
+
#### `SpineTagRowItem` (interface)
|
|
2830
|
+
|
|
2831
|
+
Um selo da linha: o nome e, se quiser, a cor (1..8, a paleta categórica do tema); sem cor, uma estável pelo id.
|
|
2832
|
+
|
|
2833
|
+
```ts
|
|
2834
|
+
interface SpineTagRowItem { id: string; name: string; color?: number }
|
|
2835
|
+
```
|
|
2836
|
+
|
|
1881
2837
|
## `@trismegisto/spine/modal`
|
|
1882
2838
|
|
|
1883
2839
|
### Componentes e diretivas
|
|
@@ -1929,12 +2885,16 @@ interface ModalContent<TResult = any> {
|
|
|
1929
2885
|
|
|
1930
2886
|
#### `spine-notification` — `NotificationComponent`
|
|
1931
2887
|
|
|
2888
|
+
Compatibilidade: os avisos do `NotificationService` saem no `hm-toast-stack` do `HermesToastService` (3.3.0). `<spine-notification>` só monta uma pilha de toasts; se já houver outra na tela (a do `spine-layout`), o serviço escolhe uma e nada aparece em dobro. Em tela nova, use `<hm-toast-stack />` direto.
|
|
2889
|
+
|
|
1932
2890
|
_Sem inputs/outputs._
|
|
1933
2891
|
|
|
1934
2892
|
### Serviços e classes
|
|
1935
2893
|
|
|
1936
2894
|
#### `NotificationService` · `providedIn: root`
|
|
1937
2895
|
|
|
2896
|
+
Avisos de resposta (envelope `{ status, message }` dos GraphQL, falha do logout...). Desde a 3.3.0 eles aparecem no mesmo `hm-toast-stack` do `HermesToastService`, junto com os avisos do app (`SpineNoticesService`): antes o `spine-notification` desenhava uma coluna própria de `hm-alert` no mesmo canto, por cima dos toasts. `notifications$` continua publicando a lista (com a expiração de cada um) para quem já lia.
|
|
2897
|
+
|
|
1938
2898
|
- `readonly notifications$: Observable<Notification[]>`
|
|
1939
2899
|
- `resolveAlertType(status: number): AlertType` — O `status` do envelope `{ status, message, data }` dos GraphQL decide o tipo do toast — o mesmo contrato em todo app: 2xx sucesso, 3xx atenção (concluiu com ressalva), 4xx/5xx erro, o resto informação. Por faixa (antes…
|
|
1940
2900
|
- `addNotification(notification: NotificationInput): void`
|
|
@@ -2003,14 +2963,13 @@ Gate de navegação REAL (deep link, F5, `router.navigateByUrl` do painel focado
|
|
|
2003
2963
|
#### `ComponentDistributorService` · `providedIn: root`
|
|
2004
2964
|
|
|
2005
2965
|
- `readonly lastMissingRouterId: signal(…)` — `router_id` da última falha (sem entrada registrada ou import quebrado) — lido por `NoContentComponent` pra montar a descrição (ver comentário dela). Sinal só, não por instância: se dois painéis erram ao mesmo tempo, o…
|
|
2006
|
-
- `get lastMissingRouteId` — Depreciado: use `lastMissingRouterId` (sempre foi o router_id).
|
|
2007
2966
|
- `get entries: readonly ComponentRoute[]` — Todas as entradas registradas (app + pacotes plugáveis) -- lidas pela documentação.
|
|
2008
2967
|
- `getComponent(routerId: string, source_template_router_id?: string | null): Promise<Type<any>>`
|
|
2009
2968
|
|
|
2010
2969
|
### Funções
|
|
2011
2970
|
|
|
2012
|
-
- `function componentRouterId(route: ComponentRoute): string | undefined` — `id` (router_id) da entrada
|
|
2013
|
-
- `function componentRouteLoader(route: ComponentRoute): (() => Promise<Type<any>>) | undefined` — Carregador da entrada
|
|
2971
|
+
- `function componentRouterId(route: ComponentRoute): string | undefined` — `id` (router_id) da entrada. O formato antigo (`route_id`) saiu na 3.3.1.
|
|
2972
|
+
- `function componentRouteLoader(route: ComponentRoute): (() => Promise<Type<any>>) | undefined` — Carregador da entrada. O formato antigo (`component`) saiu na 3.3.1.
|
|
2014
2973
|
- `function isChunkLoadError(err: unknown): boolean` — O import dinâmico falhou porque o arquivo da tela não existe mais no servidor — saiu um build novo enquanto a aba estava aberta e os chunks antigos foram trocados. Mensagens dos navegadores: Chrome/Edge "Failed to fetch dynamically imported module", Firefox "…
|
|
2015
2974
|
- `function findRouteThrough(routes: Route[], urlAtLevel: string): Route | null` — Acha uma rota cujo `route_redirect` bate com `urlAtLevel`, atravessando ancestrais "transparentes" (sem `route_redirect` próprio — só agrupam os filhos).
|
|
2016
2975
|
- `function findFirstNavigable(routes: Route[]): string | null` — Primeira rota navegável (DFS), atravessando grupos transparentes — usada como fallback quando a URL alvo não bate com nada na view atual.
|
|
@@ -2022,7 +2981,6 @@ Gate de navegação REAL (deep link, F5, `router.navigateByUrl` do painel focado
|
|
|
2022
2981
|
|
|
2023
2982
|
- `ROUTE_ID_HEADER`: `'X-Route-Id'` — Must match `@orfeu/node`/`orfeu` (Python)'s `ROUTE_ID_HEADER` (`x-route-id`).
|
|
2024
2983
|
- `CLIENT_ID_HEADER`: `'X-Client-Id'` — Must match `@orfeu/node`/`orfeu` (Python)'s `CLIENT_ID_HEADER` (`x-client-id`): which app (client) the action came from.
|
|
2025
|
-
- `componentRouteId` — Depreciado: use `componentRouterId` (o id da entrada é o router_id da tela).
|
|
2026
2984
|
- `COMPONENT_ROUTES`: `InjectionToken<ComponentRoute[]>`
|
|
2027
2985
|
|
|
2028
2986
|
### Tipos
|
|
@@ -2060,12 +3018,6 @@ interface ComponentRoute {
|
|
|
2060
3018
|
/** Documentação da tela, exibida pelo botão de documentação da barra da página. */
|
|
2061
3019
|
document?: RouteDocument;
|
|
2062
3020
|
|
|
2063
|
-
/** @deprecated use `id`. Mantido para os mapas antigos (o valor sempre foi o router_id); `id` vence
|
|
2064
|
-
* quando os dois vêm. */
|
|
2065
|
-
route_id?: string;
|
|
2066
|
-
/** @deprecated use `load`. */
|
|
2067
|
-
component?: () => Promise<Type<any>>;
|
|
2068
|
-
|
|
2069
3021
|
// Alternativa a `id`: source_template_router_id casa com QUALQUER client vinculado ao
|
|
2070
3022
|
// template de origem daquele router (uso por pacotes plugáveis tipo @trismegisto/spine/auto-service,
|
|
2071
3023
|
// que não conhecem o router_id materializado de cada client -- só o router_id do próprio
|
|
@@ -2129,7 +3081,6 @@ _Sem inputs/outputs._
|
|
|
2129
3081
|
- `APP_ROUTES`: `Routes`
|
|
2130
3082
|
- `PUBLIC_ROUTES`: `Routes`
|
|
2131
3083
|
- `PRIVATE_ROUTES`: `Routes` — Quem desenha o conteúdo agora é o `hm-workspace` (ver `LayoutComponent`/ `layout/src/workspace/`), nunca um `<router-outlet>` aninhado — a árvore de 6 níveis (header/navigation/menu/item/submenu/page) que existia aqui foi substituída por `resolveSpineRoute`,…
|
|
2132
|
-
- `BASE_COMPONENTS`: `ComponentRoute[]` — Componentes que o próprio shell traz, ligados pelo `router_id` (web.router) da árvore de rotas do argos.
|
|
2133
3084
|
|
|
2134
3085
|
### Tipos
|
|
2135
3086
|
|