@brucesantos/design-space 0.13.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -6,6 +6,51 @@ Versionamento semântico. **Patch** para correção sem mudança de contrato,
6
6
  Mudança estrutural — pasta obrigatória nova, schema de cenário alterado — exige
7
7
  comando explícito e revisável, nunca merge silencioso.
8
8
 
9
+ ## 0.14.0 (2026-10-22)
10
+
11
+ **Minor.** Um entrypoint e um comando novos; sai o botão "Copiar para o PR".
12
+ Nenhum export, campo de cenário ou parâmetro de URL muda. Ver
13
+ [0018](../../docs/decisions/0018-descricao-do-pr-gerada-do-registro.md).
14
+
15
+ ### Adicionado
16
+
17
+ - **`design-space-pr`**: comando do pacote que escreve na descrição do PR os
18
+ critérios de aceite gerados do registro. No CI, num `pull_request`, compara o
19
+ produto do PR com o da base e reescreve só o bloco entre
20
+ `<!-- design-space:pr:start -->` e `<!-- design-space:pr:end -->`: as telas
21
+ que o PR cria ou altera, com link de cada cenário (`--origin`), `intent`,
22
+ pré-condições, ações, comportamento esperado numerado, regras com o enunciado
23
+ e a tabela componente → origem; os cenários que mudaram vêm marcados, e o
24
+ `ticket` do cenário entra como link. Nada no PR se preenche à mão: numa
25
+ descrição em branco, ela é só o bloco. Precisa de `GH_TOKEN` com
26
+ `pull-requests: write`. `--body <arquivo>` confere o resultado sem falar com o
27
+ GitHub.
28
+ - **`@brucesantos/design-space/pr`**: as funções puras por trás do comando —
29
+ `buildPrSection`, `mergePrBody`, `diffProducts` e `PR_MARKERS`.
30
+ - **`theme.labels.pr`** ganhou os textos do bloco.
31
+
32
+ ### Removido
33
+
34
+ - O botão **Copiar para o PR** do painel Informações. A descrição gerada
35
+ substitui o caminho manual.
36
+
37
+ ### Obsoleto
38
+
39
+ - `labels.info.copyForPr`, `copiedForPr` e `copyPrompt`, e `labels.pr.variations`,
40
+ `commit`, `immutableLink`, `controls`, `shortcuts` e `defaultOption` continuam
41
+ aceitos em `theme.labels` e não têm mais efeito. Saem na próxima major.
42
+
43
+ ### Para migrar
44
+
45
+ 1. Acrescente ao workflow do PR, depois de instalar as dependências, o passo
46
+ `pnpm exec design-space-pr --origin "<origem do preview>"` com
47
+ `GH_TOKEN: ${{ github.token }}` e `permissions: pull-requests: write`. Ver
48
+ `packages/template/docs/handoff.md`.
49
+ 2. Apague o modelo de PR do produto, ou ao menos a seção de comportamento
50
+ esperado, e qualquer script que comente links de cenário no PR.
51
+ 3. Revise os `expected` escritos com dado da fixture ("Unimed, ANS 999901"):
52
+ quem valida confere o sistema real.
53
+
9
54
  ## 0.13.0 (2026-10-15)
10
55
 
11
56
  **Minor.** Um campo opcional em `ComponentPreview` e um entrypoint novo; nenhum
package/README.md CHANGED
@@ -60,7 +60,7 @@ Sem `name`, a tela usa o título do primeiro cenário da rota e, na falta dele,
60
60
  **Rota com parâmetro** (desde a 0.9.1): `params` dá um valor de exemplo para cada
61
61
  `:param` (e para `*`, se houver). O motor usa o exemplo sempre que abre a tela
62
62
  sem cenário — na lateral, na variação padrão, no "Usado em" de Informações e
63
- no "Copiar para o PR":
63
+ no link da descrição do PR:
64
64
 
65
65
  ```ts
66
66
  { path: "/orders/:id", screen: OrderDetail, name: "Detalhe do pedido", params: { id: "1042" } }
@@ -180,10 +180,7 @@ function OrderList({ context }: ScreenProps) {
180
180
 
181
181
  Informações mostra rota, fluxo, descrição, os controles com o valor atual, o
182
182
  comportamento esperado (o do cenário ativo, senão `route.expected`) e os
183
- componentes (`route.components` mais os do cenário). **Copiar para o PR**, numa
184
- tela com fluxo, gera o markdown do fluxo inteiro: para cada tela, nome, rota,
185
- link absoluto (com os controles atuais na tela aberta), controles disponíveis,
186
- atalhos, comportamento esperado e a tabela componente → origem.
183
+ componentes (`route.components` mais os do cenário).
187
184
 
188
185
  A validação checa ids de grupo e de controle únicos por tela, `default` entre as
189
186
  opções e `Scenario.controls` usando controles e valores da tela do cenário; id de
@@ -230,7 +227,8 @@ para a URL quando difere do padrão efetivo. Persona do cenário e a escolhida n
230
227
  painel continuam vencendo. Id inexistente é erro de validação. Sem
231
228
  `defaultPersona`, nada muda.
232
229
  - `components` lista os ids de `ComponentPreview` usados na tela. Alimenta
233
- "Componentes usados", o "Usado em" de cada componente e o "Copiar para o PR".
230
+ "Componentes usados", o "Usado em" de cada componente e a tabela de
231
+ componentes da descrição do PR.
234
232
 
235
233
  ## O chrome
236
234
 
@@ -239,17 +237,45 @@ painel continuam vencendo. Id inexistente é erro de validação. Sem
239
237
  | Barra superior | Nome do produto; viewport (Celular 375, Tablet 768, Desktop 1280, Ajustar), girar, zoom 25–150%, revisão limpa, abrir em nova janela, copiar link, tema, painel e — quando a validação tem algo a dizer — o indicador de diagnóstico. |
240
238
  | Esquerda | **Telas** e **Componentes**, com contagem e busca sem acento nem caixa (nome, descrição, fluxo ou grupo, id e `source`). Telas agrupadas por fluxo (`route.group`), componentes por `group`. Redimensionável. |
241
239
  | Centro | O quadro do produto no tamanho do viewport, com zoom só de visualização. |
242
- | Direita | **Variações** (contexto no topo, controles da tela por componente e os cenários como atalhos; ou as fixtures do componente) e **Informações** (rota, fluxo, controles, intenção, pré-condições, ações, comportamento esperado, regras, componentes usados e **Copiar para o PR**). Redimensionável. |
240
+ | Direita | **Variações** (contexto no topo, controles da tela por componente e os cenários como atalhos; ou as fixtures do componente) e **Informações** (rota, fluxo, controles, intenção, pré-condições, ações, comportamento esperado, regras e componentes usados). Redimensionável. |
243
241
 
244
242
  Sem Home: a raiz abre a primeira tela na primeira variação ou, sem telas, o
245
243
  primeiro componente. O tema segue o sistema, e a troca é lembrada.
246
244
 
247
- ### Copiar para o PR
245
+ ### A descrição do PR (desde a 0.14)
248
246
 
249
- Gera markdown com o nome da tela, um link absoluto por variação (com o link do
250
- deployment e o commit quando o produto informa), a tabela componente → origem e
251
- o comportamento esperado de cada variação. Tela com fluxo gera o fluxo inteiro
252
- (ver [Fluxos e controles](#fluxos-e-controles-09)).
247
+ O critério de aceite é escrito uma vez, no cenário, e chega ao PR sem cópia: o
248
+ comando `design-space-pr`, que vem no pacote, roda no CI a cada push, compara o
249
+ registro do PR com o da base e reescreve a descrição (decisão 0018). O botão
250
+ "Copiar para o PR" saiu.
251
+
252
+ ```yaml
253
+ # no workflow do PR, com `permissions: pull-requests: write`
254
+ - name: Critérios de aceite na descrição do PR
255
+ if: github.event_name == 'pull_request'
256
+ run: pnpm exec design-space-pr --origin "<origem do preview deste PR>"
257
+ env:
258
+ GH_TOKEN: ${{ github.token }}
259
+ ```
260
+
261
+ - **Dentro do bloco** entre `<!-- design-space:pr:start -->` e
262
+ `<!-- design-space:pr:end -->`: as telas que o PR cria ou altera, com todos os
263
+ cenários de cada uma — link (com `--origin`), `intent`, pré-condições, ações,
264
+ comportamento esperado numerado, regras com o enunciado e a tabela componente
265
+ → origem. Os que mudaram vêm marcados como novo ou alterado; removidos
266
+ aparecem pelo nome. Abre com o recado para quem valida, inclusive agentes: o
267
+ bloco é a referência e vale mais que o ticket, os dados são sintéticos,
268
+ divergência se aponta.
269
+ - **Fora do bloco**, nada é tocado, e nada se preenche à mão: numa descrição em
270
+ branco, ela é só o bloco. O ticket, quando houver, vem do `ticket` do cenário.
271
+ - O produto é carregado pelo Vite do próprio produto, com a configuração dele; o
272
+ comando procura `src/app/product.ts` ou `.tsx` (ou `--entry`) e o export
273
+ `productDefinition`, `product` ou `default`.
274
+ - Para conferir sem abrir PR: `design-space-pr --body <arquivo> --base <dir>`
275
+ imprime a descrição nova.
276
+
277
+ As funções puras estão em `@brucesantos/design-space/pr`: `buildPrSection`,
278
+ `mergePrBody`, `diffProducts` e `PR_MARKERS`. O texto segue `theme.labels.pr`.
253
279
 
254
280
  ### O quadro
255
281
 
@@ -373,7 +399,7 @@ fluxo, filtro, página. O motor não o lê, só o carrega, e a regra é a mesma
373
399
  | `context.navigate` ou link comum para a mesma tela | Fica; o que o destino traz manda na mesma chave. |
374
400
  | `context.navigate` ou link comum para outra tela | Sai; só entra a que o destino traz (desde a 0.10.0). |
375
401
  | Abrir tela, cenário ou componente pela lateral ou pelos atalhos do chrome | Sai. |
376
- | "Copiar link" e "Copiar para o PR" | Vai junto. |
402
+ | "Copiar link" | Vai junto. |
377
403
 
378
404
  A tela pode escrever a própria query de duas formas: por `context.navigate`
379
405
  (`navigate("/orders?aba=historico", { replace: true })`) ou direto pela History
@@ -456,7 +482,7 @@ theme: {
456
482
  labels: {
457
483
  network: { success: "Success", error: "Error" },
458
484
  topbar: { copyLink: "Copy link" },
459
- info: { copyForPr: "Copy for PR" },
485
+ pr: EN_US_LABELS.pr,
460
486
  },
461
487
  }
462
488
  ```
@@ -0,0 +1,231 @@
1
+ #!/usr/bin/env node
2
+ /**
3
+ * design-space-pr — escreve na descrição do PR os critérios de aceite gerados
4
+ * do registro do produto. Ver a decisão 0018 do motor.
5
+ *
6
+ * No GitHub Actions, num evento `pull_request`, de dentro do produto:
7
+ *
8
+ * design-space-pr [--origin <url do preview>]
9
+ *
10
+ * busca a base do PR, compara os dois registros e reescreve o bloco gerado na
11
+ * descrição. O que estiver fora do bloco fica como está. Precisa de `GH_TOKEN`
12
+ * ou `GITHUB_TOKEN` com `pull-requests: write`.
13
+ *
14
+ * Fora dele, para conferir o resultado sem mexer em nada:
15
+ *
16
+ * design-space-pr --body <arquivo> [--base <diretório>] [--origin <url>] [--commit <sha>]
17
+ *
18
+ * imprime a descrição nova na saída padrão.
19
+ *
20
+ * `--entry <arquivo>` aponta o módulo do produto (padrão: `src/app/product.ts`
21
+ * ou `.tsx`). O export lido é `productDefinition`, `product` ou o `default`.
22
+ * `--dry-run` no modo GitHub imprime em vez de gravar.
23
+ *
24
+ * O produto é carregado pelo Vite do próprio produto, com a configuração dele,
25
+ * do mesmo jeito que o dev server carrega. Por isso o comando não leva Vite como
26
+ * dependência: usa o que o produto já tem.
27
+ */
28
+
29
+ import { execFileSync } from "node:child_process";
30
+ import { existsSync, mkdtempSync, readFileSync, rmSync, symlinkSync } from "node:fs";
31
+ import { createRequire } from "node:module";
32
+ import { tmpdir } from "node:os";
33
+ import { join, resolve } from "node:path";
34
+ import { pathToFileURL } from "node:url";
35
+ import { parseArgs } from "node:util";
36
+
37
+ import { buildPrSection, mergePrBody } from "../dist/pr.js";
38
+
39
+ const USAGE = `Uso:
40
+ design-space-pr [--origin <url>] [--entry <arquivo>] [--dry-run] no GitHub Actions, em pull_request
41
+ design-space-pr --body <arquivo> [--base <dir>] [--origin <url>] [--commit <sha>] [--entry <arquivo>]`;
42
+
43
+ const { values: args } = parseArgs({
44
+ options: {
45
+ body: { type: "string" },
46
+ base: { type: "string" },
47
+ origin: { type: "string" },
48
+ commit: { type: "string" },
49
+ entry: { type: "string" },
50
+ "dry-run": { type: "boolean", default: false },
51
+ help: { type: "boolean", short: "h", default: false },
52
+ },
53
+ });
54
+
55
+ if (args.help) {
56
+ console.log(USAGE);
57
+ process.exit(0);
58
+ }
59
+
60
+ const root = process.cwd();
61
+
62
+ /** Limite da descrição de PR no GitHub. A folga fica para o texto escrito por gente. */
63
+ const BODY_LIMIT = 65536;
64
+
65
+ try {
66
+ if (args.body !== undefined) await local();
67
+ else await github();
68
+ } catch (error) {
69
+ console.error(`design-space-pr: ${error instanceof Error ? error.message : String(error)}`);
70
+ process.exit(1);
71
+ }
72
+
73
+ /** Lê a descrição de um arquivo e imprime a nova. Não fala com ninguém. */
74
+ async function local() {
75
+ const body = readFileSync(resolve(args.body), "utf8");
76
+ const head = await loadProduct(root);
77
+ const base = args.base ? await loadBase(resolve(args.base)) : undefined;
78
+ const section = buildPrSection({ head, base, origin: args.origin, commit: args.commit });
79
+ process.stdout.write(mergePrBody(body, section));
80
+ }
81
+
82
+ /** Reescreve a descrição do PR do evento que disparou o workflow. */
83
+ async function github() {
84
+ const eventPath = process.env.GITHUB_EVENT_PATH;
85
+ const repository = process.env.GITHUB_REPOSITORY;
86
+ if (!eventPath || !repository) throw new Error(`fora do GitHub Actions, passe --body.\n${USAGE}`);
87
+
88
+ const pull = JSON.parse(readFileSync(eventPath, "utf8")).pull_request;
89
+ if (!pull) {
90
+ console.log("design-space-pr: o evento não é de pull request; nada a fazer.");
91
+ return;
92
+ }
93
+
94
+ const token = process.env.GH_TOKEN || process.env.GITHUB_TOKEN;
95
+ if (!token && !args["dry-run"]) throw new Error("falta GH_TOKEN ou GITHUB_TOKEN com pull-requests: write.");
96
+ const api = (process.env.GITHUB_API_URL || "https://api.github.com").replace(/\/+$/, "");
97
+ const request = async (method, path, payload) => {
98
+ const response = await fetch(`${api}${path}`, {
99
+ method,
100
+ headers: {
101
+ accept: "application/vnd.github+json",
102
+ "x-github-api-version": "2022-11-28",
103
+ ...(token ? { authorization: `Bearer ${token}` } : {}),
104
+ ...(payload ? { "content-type": "application/json" } : {}),
105
+ },
106
+ body: payload ? JSON.stringify(payload) : undefined,
107
+ });
108
+ if (!response.ok) throw new Error(`${method} ${path}: ${response.status} ${await response.text()}`);
109
+ return response.json();
110
+ };
111
+
112
+ const head = await loadProduct(root);
113
+ const base = await withBaseCheckout(await baseSha(pull, request, Boolean(token)), (dir) => loadBase(dir));
114
+ const section = buildPrSection({ head, base, origin: args.origin, commit: pull.head.sha, maxLength: BODY_LIMIT - 8000 });
115
+
116
+ // A descrição do evento é a do momento do push; alguém pode ter editado
117
+ // depois. Lê a atual para não apagar o que foi escrito no meio do caminho.
118
+ const path = `/repos/${repository}/pulls/${pull.number}`;
119
+ const current = token ? (await request("GET", path)).body : pull.body;
120
+ const next = mergePrBody(current, section);
121
+
122
+ if (args["dry-run"]) {
123
+ process.stdout.write(next);
124
+ return;
125
+ }
126
+ if (next === (current ?? "").replace(/\r\n/g, "\n")) {
127
+ console.log("design-space-pr: descrição já está em dia.");
128
+ return;
129
+ }
130
+ await request("PATCH", path, { body: next });
131
+ console.log(`design-space-pr: descrição do PR #${pull.number} atualizada.`);
132
+ }
133
+
134
+ /**
135
+ * O commit contra o qual comparar.
136
+ *
137
+ * Com o checkout padrão do evento, o diretório é o merge do PR com a base, e a
138
+ * comparação certa é com a ponta da base. Com o commit do PR checado (um deploy
139
+ * de preview costuma fazer isso), a ponta da base pode ter andado depois que a
140
+ * branch saiu, e o que entrou nela apareceria como removido; aí a comparação é
141
+ * com o ponto onde a branch saiu.
142
+ */
143
+ async function baseSha(pull, request, canAsk) {
144
+ if (!canAsk || git("rev-parse", "HEAD") !== pull.head.sha) return pull.base.sha;
145
+ try {
146
+ const compare = await request("GET", `/repos/${process.env.GITHUB_REPOSITORY}/compare/${pull.base.sha}...${pull.head.sha}`);
147
+ return compare.merge_base_commit?.sha ?? pull.base.sha;
148
+ } catch (error) {
149
+ console.error(`design-space-pr: sem o ponto de partida da branch (${firstLine(error)}); comparando com a ponta da base.`);
150
+ return pull.base.sha;
151
+ }
152
+ }
153
+
154
+ function git(...gitArgs) {
155
+ return execFileSync("git", gitArgs, { cwd: root, encoding: "utf8", stdio: ["ignore", "pipe", "pipe"] }).trim();
156
+ }
157
+
158
+ /**
159
+ * Põe a base do PR numa worktree temporária, com os `node_modules` do PR, e
160
+ * devolve o que `use` devolver. Sem a base, devolve `undefined` e o bloco lista
161
+ * todas as telas, que é melhor que nenhuma.
162
+ */
163
+ async function withBaseCheckout(sha, use) {
164
+ const dir = mkdtempSync(join(tmpdir(), "design-space-pr-"));
165
+ let added = false;
166
+ try {
167
+ git("fetch", "--no-tags", "--depth=1", "origin", sha);
168
+ git("worktree", "add", "--detach", dir, sha);
169
+ added = true;
170
+ // O produto pode morar numa subpasta do repositório.
171
+ const productDir = join(dir, git("rev-parse", "--show-prefix"));
172
+ symlinkSync(join(root, "node_modules"), join(productDir, "node_modules"), "dir");
173
+ return await use(productDir);
174
+ } catch (error) {
175
+ console.error(`design-space-pr: sem a base do PR (${firstLine(error)}); listando todas as telas.`);
176
+ return undefined;
177
+ } finally {
178
+ if (added) {
179
+ try {
180
+ git("worktree", "remove", "--force", dir);
181
+ } catch {
182
+ rmSync(dir, { recursive: true, force: true });
183
+ }
184
+ } else {
185
+ rmSync(dir, { recursive: true, force: true });
186
+ }
187
+ }
188
+ }
189
+
190
+ async function loadBase(dir) {
191
+ try {
192
+ return await loadProduct(dir);
193
+ } catch (error) {
194
+ console.error(`design-space-pr: não deu para ler o produto na base (${firstLine(error)}); listando todas as telas.`);
195
+ return undefined;
196
+ }
197
+ }
198
+
199
+ /** Carrega o produto pelo Vite instalado nele, sem abrir porta. */
200
+ async function loadProduct(dir) {
201
+ const entry = args.entry ?? ["src/app/product.ts", "src/app/product.tsx"].find((file) => existsSync(join(dir, file)));
202
+ if (!entry) throw new Error(`não achei src/app/product.ts nem .tsx em ${dir}; passe --entry.`);
203
+
204
+ const require = createRequire(join(dir, "package.json"));
205
+ const vite = await import(pathToFileURL(require.resolve("vite")).href);
206
+ const server = await vite.createServer({
207
+ root: dir,
208
+ server: { middlewareMode: true, hmr: false },
209
+ appType: "custom",
210
+ logLevel: "error",
211
+ // Só o carregamento em Node interessa; a varredura de dependências é do
212
+ // navegador e falha à toa na base, que usa os node_modules do PR.
213
+ optimizeDeps: { noDiscovery: true, entries: [] },
214
+ });
215
+ try {
216
+ const mod = await server.ssrLoadModule(`/${entry.replace(/^\.?\//, "")}`);
217
+ const product = ["productDefinition", "product", "default"].map((name) => mod[name]).find(isProduct);
218
+ if (!product) throw new Error(`${entry} não exporta um produto (procurei productDefinition, product e default).`);
219
+ return product;
220
+ } finally {
221
+ await server.close();
222
+ }
223
+ }
224
+
225
+ function isProduct(value) {
226
+ return Boolean(value) && typeof value === "object" && Array.isArray(value.routes) && Array.isArray(value.scenarios);
227
+ }
228
+
229
+ function firstLine(error) {
230
+ return String(error instanceof Error ? error.message : error).split("\n")[0];
231
+ }
@@ -0,0 +1,95 @@
1
+ import { P as a } from "./index-CaxlsfFr.js";
2
+ const i = "ds-frame", m = "data-ds-frame", h = "data-ds-component", u = [
3
+ a.chromeTheme,
4
+ a.chrome,
5
+ a.inspector,
6
+ a.panelTab,
7
+ a.zoom,
8
+ a.rotated
9
+ ];
10
+ function f(e, t) {
11
+ const r = new URLSearchParams(t);
12
+ for (const s of u) r.delete(s);
13
+ return r.delete(i), r.set(i, "1"), `${e || "/"}?${r.toString()}`;
14
+ }
15
+ function p(e, t, r) {
16
+ let { path: s, search: o } = r;
17
+ if (e)
18
+ try {
19
+ const c = new URL(e);
20
+ c.origin === t && ({ pathname: s, search: o } = c);
21
+ } catch {
22
+ }
23
+ const n = new URLSearchParams(o);
24
+ return n.delete(a.viewport), n.delete(a.customWidth), f(s, `?${n.toString()}`);
25
+ }
26
+ function g(e) {
27
+ const t = new URL(e, "http://design-space.invalid");
28
+ t.searchParams.delete(i);
29
+ const r = t.searchParams.toString();
30
+ return { path: t.pathname || "/", search: r ? `?${r}` : "" };
31
+ }
32
+ function R(e) {
33
+ const t = new URL(e, "http://design-space.invalid");
34
+ return `${t.pathname}|${t.searchParams.get(a.component) ?? ""}`;
35
+ }
36
+ function y(e, t) {
37
+ const r = new URLSearchParams(e), s = new URLSearchParams(t);
38
+ r.delete(i);
39
+ for (const n of u) {
40
+ r.delete(n);
41
+ const c = s.get(n);
42
+ c !== null && r.set(n, c);
43
+ }
44
+ const o = r.toString();
45
+ return o ? `?${o}` : "";
46
+ }
47
+ function d(e) {
48
+ if (!e || typeof e != "object") return !1;
49
+ const t = e;
50
+ if (t.ds !== 1 || typeof t.type != "string") return !1;
51
+ switch (t.type) {
52
+ case "ready":
53
+ case "location":
54
+ return typeof t.url == "string";
55
+ case "navigate":
56
+ return typeof t.url == "string";
57
+ case "shortcut":
58
+ return ["C", "K", "F"].includes(t.key);
59
+ default:
60
+ return !1;
61
+ }
62
+ }
63
+ function P(e, t) {
64
+ if (e.origin === t.origin && !(!t.source || e.source !== t.source))
65
+ return d(e.data) ? e.data : void 0;
66
+ }
67
+ function w(e, t, r) {
68
+ try {
69
+ e?.postMessage(t, r);
70
+ } catch {
71
+ }
72
+ }
73
+ function U(e = typeof window > "u" ? void 0 : window) {
74
+ if (!e) return !1;
75
+ if (new URLSearchParams(e.location.search).get(i) === "1") return !0;
76
+ try {
77
+ return !!e.frameElement?.hasAttribute(m);
78
+ } catch {
79
+ return !1;
80
+ }
81
+ }
82
+ export {
83
+ h as C,
84
+ i as F,
85
+ P as a,
86
+ R as b,
87
+ m as c,
88
+ g as f,
89
+ U as i,
90
+ y as m,
91
+ w as p,
92
+ p as s,
93
+ f as t
94
+ };
95
+ //# sourceMappingURL=index-BobUYxei.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index-BobUYxei.js","sources":["../src/frame/index.ts"],"sourcesContent":["/**\n * Protocolo entre o chrome e o quadro.\n *\n * A UI do produto roda dentro de um `<iframe>` da mesma origem e do mesmo\n * bundle, aberto com `ds-frame=1`. Duas razões, as duas concretas:\n *\n * 1. **Isolamento de CSS nos dois sentidos.** O preflight e o `body` do produto\n * não alcançam o chrome, e o chrome não alcança o produto.\n * 2. **Viewport real.** A largura do quadro é a largura da janela que o produto\n * enxerga, então `@media` funciona como em produção.\n *\n * Os dois documentos conversam só por `postMessage`, e cada lado só aceita\n * mensagem da mesma origem **e** da janela esperada — o pai aceita do próprio\n * quadro, o quadro aceita do próprio pai. Qualquer outra coisa é ignorada.\n */\n\nimport { PARAM } from \"../controls/params.js\";\n\n/** Parâmetro que põe `<DesignSpace>` em modo quadro. */\nexport const FRAME_PARAM = \"ds-frame\";\n\n/** Atributo do `<iframe>` do chrome. Serve de seletor para testes. */\nexport const FRAME_ATTRIBUTE = \"data-ds-frame\";\n\n/**\n * Marcação manual da raiz de um componente na UI:\n * `data-ds-component=\"<id do catálogo>\"`. O destaque de componentes acha\n * sozinho o que o catálogo declara em `implementation`; este atributo fica para\n * o que a árvore do React não resolve (decisão 0017).\n */\nexport const COMPONENT_ATTRIBUTE = \"data-ds-component\";\n\n/**\n * Parâmetros que só o chrome lê. Ficam fora do endereço do quadro: trocar zoom\n * ou tema do chrome não é assunto da UI do produto.\n */\nexport const CHROME_ONLY_PARAMS: readonly string[] = [\n PARAM.chromeTheme,\n PARAM.chrome,\n PARAM.inspector,\n PARAM.panelTab,\n PARAM.zoom,\n PARAM.rotated,\n];\n\n/**\n * Atalhos do chrome que o quadro repassa: revisão limpa (Shift+C), busca da\n * lateral (Cmd/Ctrl+K) e filtro do painel (Cmd/Ctrl+F).\n */\nexport type FrameShortcut = \"C\" | \"K\" | \"F\";\n\nexport type FrameMessage =\n /** Quadro → pai: montou, neste endereço. */\n | { ds: 1; type: \"ready\"; url: string }\n /** Quadro → pai: a UI do produto navegou. */\n | { ds: 1; type: \"navigate\"; url: string; replace: boolean }\n /** Quadro → pai: atalho do chrome pressionado com o foco dentro do quadro. */\n | { ds: 1; type: \"shortcut\"; key: FrameShortcut }\n /** Pai → quadro: novo estado, sem recarregar. */\n | { ds: 1; type: \"location\"; url: string };\n\n/**\n * Endereço do quadro para um estado do chrome: mesmo caminho, mesma query sem os\n * parâmetros do chrome, e `ds-frame=1` no fim. Determinística: o pai e o quadro\n * chegam à mesma string para o mesmo estado, e é isso que evita recarga à toa.\n */\nexport function toFrameUrl(path: string, search: string): string {\n const params = new URLSearchParams(search);\n for (const name of CHROME_ONLY_PARAMS) params.delete(name);\n params.delete(FRAME_PARAM);\n params.set(FRAME_PARAM, \"1\");\n return `${path || \"/\"}?${params.toString()}`;\n}\n\n/**\n * Endereço para abrir o quadro sozinho, numa janela própria. É o caminho para\n * ferramenta de captura que lê só o documento de cima e não entra no `<iframe>`.\n *\n * Parte do endereço que o quadro está mostrando de fato (`frameHref`), porque a\n * UI do produto pode ter navegado dentro dele; sem esse endereço — quadro ainda\n * em `about:blank`, em outra origem ou inacessível —, parte do estado do pai.\n * Nos dois casos sai pelo `toFrameUrl`: sem os parâmetros do chrome e com\n * `ds-frame=1`, mesmo que uma navegação completa do quadro o tenha perdido.\n *\n * O viewport também fica de fora. Na janela própria a largura é a da janela, e\n * sem o parâmetro o quadro cai em \"Ajustar\": `context.viewport` e `@media`\n * contam a mesma história. Com `viewport=mobile` numa janela larga, a tela que\n * decide pelo contexto mostraria celular esticado.\n */\nexport function standaloneFrameUrl(\n frameHref: string | undefined,\n origin: string,\n fallback: { path: string; search: string },\n): string {\n let { path, search } = fallback;\n if (frameHref) {\n try {\n // `about:blank` tem origem \"null\", então também cai no pai.\n const shown = new URL(frameHref);\n if (shown.origin === origin) ({ pathname: path, search } = shown);\n } catch {\n // Endereço inválido: fica com o do pai.\n }\n }\n const params = new URLSearchParams(search);\n params.delete(PARAM.viewport);\n params.delete(PARAM.customWidth);\n return toFrameUrl(path, `?${params.toString()}`);\n}\n\n/** Caminho e query de um endereço do quadro, sem o parâmetro de modo. */\nexport function fromFrameUrl(url: string): { path: string; search: string } {\n const parsed = new URL(url, \"http://design-space.invalid\");\n parsed.searchParams.delete(FRAME_PARAM);\n const query = parsed.searchParams.toString();\n return { path: parsed.pathname || \"/\", search: query ? `?${query}` : \"\" };\n}\n\n/**\n * O que obriga a trocar o `src` do quadro: outra tela (caminho) ou outro\n * componente. O resto — variação, persona, rede, dados — vai por mensagem.\n */\nexport function frameKey(url: string): string {\n const parsed = new URL(url, \"http://design-space.invalid\");\n return `${parsed.pathname}|${parsed.searchParams.get(PARAM.component) ?? \"\"}`;\n}\n\n/**\n * Query do quadro com os parâmetros do chrome que estavam no pai. Uma navegação\n * iniciada pelo produto não pode desligar o painel nem trocar o zoom.\n */\nexport function mergeChromeParams(frameSearch: string, parentSearch: string): string {\n const next = new URLSearchParams(frameSearch);\n const parent = new URLSearchParams(parentSearch);\n next.delete(FRAME_PARAM);\n for (const name of CHROME_ONLY_PARAMS) {\n next.delete(name);\n const value = parent.get(name);\n if (value !== null) next.set(name, value);\n }\n const query = next.toString();\n return query ? `?${query}` : \"\";\n}\n\nfunction isFrameMessage(data: unknown): data is FrameMessage {\n if (!data || typeof data !== \"object\") return false;\n const message = data as Partial<FrameMessage>;\n if (message.ds !== 1 || typeof message.type !== \"string\") return false;\n switch (message.type) {\n case \"ready\":\n case \"location\":\n return typeof (message as { url?: unknown }).url === \"string\";\n case \"navigate\":\n return typeof (message as { url?: unknown }).url === \"string\";\n case \"shortcut\":\n return [\"C\", \"K\", \"F\"].includes((message as { key?: unknown }).key as string);\n default:\n return false;\n }\n}\n\n/**\n * Aceita uma mensagem só quando vem da mesma origem e da janela esperada, e tem\n * a forma do protocolo. Qualquer outra — extensão, outro iframe, outra aba —\n * devolve `undefined`.\n */\nexport function acceptFrameMessage(\n event: Pick<MessageEvent, \"origin\" | \"source\" | \"data\">,\n expected: { origin: string; source: MessageEventSource | null | undefined },\n): FrameMessage | undefined {\n if (event.origin !== expected.origin) return undefined;\n if (!expected.source || event.source !== expected.source) return undefined;\n return isFrameMessage(event.data) ? event.data : undefined;\n}\n\n/** Envia para a outra janela, sempre restrito à própria origem. */\nexport function postFrameMessage(\n target: Window | null | undefined,\n message: FrameMessage,\n origin: string,\n): void {\n try {\n target?.postMessage(message, origin);\n } catch {\n // Janela fechada ou em outra origem: nada a sincronizar.\n }\n}\n\n/**\n * `true` quando este documento é o quadro: pedido pela URL ou carregado dentro\n * do `<iframe>` do chrome. O segundo caso cobre uma navegação completa dentro do\n * quadro que perdeu o parâmetro — sem ele, o chrome renderizaria dentro de si.\n */\nexport function isFrameMode(win: Window | undefined = typeof window === \"undefined\" ? undefined : window): boolean {\n if (!win) return false;\n if (new URLSearchParams(win.location.search).get(FRAME_PARAM) === \"1\") return true;\n try {\n return Boolean(win.frameElement?.hasAttribute(FRAME_ATTRIBUTE));\n } catch {\n return false;\n }\n}\n"],"names":["FRAME_PARAM","FRAME_ATTRIBUTE","COMPONENT_ATTRIBUTE","CHROME_ONLY_PARAMS","PARAM","toFrameUrl","path","search","params","name","standaloneFrameUrl","frameHref","origin","fallback","shown","fromFrameUrl","url","parsed","query","frameKey","mergeChromeParams","frameSearch","parentSearch","next","parent","value","isFrameMessage","data","message","acceptFrameMessage","event","expected","postFrameMessage","target","isFrameMode","win"],"mappings":";AAmBO,MAAMA,IAAc,YAGdC,IAAkB,iBAQlBC,IAAsB,qBAMtBC,IAAwC;AAAA,EACnDC,EAAM;AAAA,EACNA,EAAM;AAAA,EACNA,EAAM;AAAA,EACNA,EAAM;AAAA,EACNA,EAAM;AAAA,EACNA,EAAM;AACR;AAuBO,SAASC,EAAWC,GAAcC,GAAwB;AAC/D,QAAMC,IAAS,IAAI,gBAAgBD,CAAM;AACzC,aAAWE,KAAQN,EAAoB,CAAAK,EAAO,OAAOC,CAAI;AACzD,SAAAD,EAAO,OAAOR,CAAW,GACzBQ,EAAO,IAAIR,GAAa,GAAG,GACpB,GAAGM,KAAQ,GAAG,IAAIE,EAAO,UAAU;AAC5C;AAiBO,SAASE,EACdC,GACAC,GACAC,GACQ;AACR,MAAI,EAAE,MAAAP,GAAM,QAAAC,EAAA,IAAWM;AACvB,MAAIF;AACF,QAAI;AAEF,YAAMG,IAAQ,IAAI,IAAIH,CAAS;AAC/B,MAAIG,EAAM,WAAWF,MAAS,EAAE,UAAUN,GAAM,QAAAC,MAAWO;AAAA,IAC7D,QAAQ;AAAA,IAER;AAEF,QAAMN,IAAS,IAAI,gBAAgBD,CAAM;AACzC,SAAAC,EAAO,OAAOJ,EAAM,QAAQ,GAC5BI,EAAO,OAAOJ,EAAM,WAAW,GACxBC,EAAWC,GAAM,IAAIE,EAAO,SAAA,CAAU,EAAE;AACjD;AAGO,SAASO,EAAaC,GAA+C;AAC1E,QAAMC,IAAS,IAAI,IAAID,GAAK,6BAA6B;AACzD,EAAAC,EAAO,aAAa,OAAOjB,CAAW;AACtC,QAAMkB,IAAQD,EAAO,aAAa,SAAA;AAClC,SAAO,EAAE,MAAMA,EAAO,YAAY,KAAK,QAAQC,IAAQ,IAAIA,CAAK,KAAK,GAAA;AACvE;AAMO,SAASC,EAASH,GAAqB;AAC5C,QAAMC,IAAS,IAAI,IAAID,GAAK,6BAA6B;AACzD,SAAO,GAAGC,EAAO,QAAQ,IAAIA,EAAO,aAAa,IAAIb,EAAM,SAAS,KAAK,EAAE;AAC7E;AAMO,SAASgB,EAAkBC,GAAqBC,GAA8B;AACnF,QAAMC,IAAO,IAAI,gBAAgBF,CAAW,GACtCG,IAAS,IAAI,gBAAgBF,CAAY;AAC/C,EAAAC,EAAK,OAAOvB,CAAW;AACvB,aAAWS,KAAQN,GAAoB;AACrC,IAAAoB,EAAK,OAAOd,CAAI;AAChB,UAAMgB,IAAQD,EAAO,IAAIf,CAAI;AAC7B,IAAIgB,MAAU,QAAMF,EAAK,IAAId,GAAMgB,CAAK;AAAA,EAC1C;AACA,QAAMP,IAAQK,EAAK,SAAA;AACnB,SAAOL,IAAQ,IAAIA,CAAK,KAAK;AAC/B;AAEA,SAASQ,EAAeC,GAAqC;AAC3D,MAAI,CAACA,KAAQ,OAAOA,KAAS,SAAU,QAAO;AAC9C,QAAMC,IAAUD;AAChB,MAAIC,EAAQ,OAAO,KAAK,OAAOA,EAAQ,QAAS,SAAU,QAAO;AACjE,UAAQA,EAAQ,MAAA;AAAA,IACd,KAAK;AAAA,IACL,KAAK;AACH,aAAO,OAAQA,EAA8B,OAAQ;AAAA,IACvD,KAAK;AACH,aAAO,OAAQA,EAA8B,OAAQ;AAAA,IACvD,KAAK;AACH,aAAO,CAAC,KAAK,KAAK,GAAG,EAAE,SAAUA,EAA8B,GAAa;AAAA,IAC9E;AACE,aAAO;AAAA,EAAA;AAEb;AAOO,SAASC,EACdC,GACAC,GAC0B;AAC1B,MAAID,EAAM,WAAWC,EAAS,UAC1B,GAACA,EAAS,UAAUD,EAAM,WAAWC,EAAS;AAClD,WAAOL,EAAeI,EAAM,IAAI,IAAIA,EAAM,OAAO;AACnD;AAGO,SAASE,EACdC,GACAL,GACAhB,GACM;AACN,MAAI;AACF,IAAAqB,GAAQ,YAAYL,GAAShB,CAAM;AAAA,EACrC,QAAQ;AAAA,EAER;AACF;AAOO,SAASsB,EAAYC,IAA0B,OAAO,SAAW,MAAc,SAAY,QAAiB;AACjH,MAAI,CAACA,EAAK,QAAO;AACjB,MAAI,IAAI,gBAAgBA,EAAI,SAAS,MAAM,EAAE,IAAInC,CAAW,MAAM,IAAK,QAAO;AAC9E,MAAI;AACF,WAAO,EAAQmC,EAAI,cAAc,aAAalC,CAAe;AAAA,EAC/D,QAAQ;AACN,WAAO;AAAA,EACT;AACF;"}