@brucesantos/design-space 0.1.1 → 0.3.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 +143 -7
- package/README.md +129 -19
- package/dist/contrast-87-ijttm.js +268 -0
- package/dist/contrast-87-ijttm.js.map +1 -0
- package/dist/controls/params.d.ts +2 -0
- package/dist/controls/state.d.ts +2 -0
- package/dist/deploy/index.d.ts +16 -11
- package/dist/design-space.css +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1313 -862
- package/dist/index.js.map +1 -1
- package/dist/registry/index.d.ts +3 -2
- package/dist/registry/validate.d.ts +1 -1
- package/dist/router/index.d.ts +2 -2
- package/dist/shell/Controls.d.ts +2 -1
- package/dist/shell/Inspector.d.ts +3 -2
- package/dist/shell/Sidebar.d.ts +8 -2
- package/dist/shell/Topbar.d.ts +6 -5
- package/dist/shell/labels.d.ts +154 -0
- package/dist/testing/index.d.ts +4 -4
- package/dist/testing.js +2 -2
- package/dist/testing.js.map +1 -1
- package/dist/types/index.d.ts +62 -22
- package/dist/util/date.d.ts +3 -4
- package/package.json +1 -1
- package/dist/contrast-DsgJg12D.js +0 -265
- package/dist/contrast-DsgJg12D.js.map +0 -1
package/dist/registry/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Fixture, Flow, Module, Persona, ProductDefinition, Rule, Scenario, ScenarioStatus } from '../types/index.js';
|
|
1
|
+
import { ComponentPreview, Fixture, Flow, Module, Persona, ProductDefinition, Rule, Scenario, ScenarioStatus } from '../types/index.js';
|
|
2
2
|
import { ValidationIssue } from './validate.js';
|
|
3
3
|
export type ModuleNode = {
|
|
4
4
|
module: Module;
|
|
@@ -12,6 +12,7 @@ export type Registry = {
|
|
|
12
12
|
orphans: Scenario[];
|
|
13
13
|
issues: ValidationIssue[];
|
|
14
14
|
scenario: (id: string | undefined) => Scenario | undefined;
|
|
15
|
+
component: (id: string | undefined) => ComponentPreview | undefined;
|
|
15
16
|
persona: (id: string | undefined) => Persona | undefined;
|
|
16
17
|
fixture: (id: string | undefined) => Fixture | undefined;
|
|
17
18
|
rule: (id: string | undefined) => Rule | undefined;
|
|
@@ -24,7 +25,7 @@ export type Registry = {
|
|
|
24
25
|
/** Cenários que abrem a mesma rota. Serve para o seletor de situação. */
|
|
25
26
|
scenariosForRoute: (route: string) => Scenario[];
|
|
26
27
|
/**
|
|
27
|
-
* Busca por vocabulário de negócio. Um PO precisa achar "
|
|
28
|
+
* Busca por vocabulário de negócio. Um PO precisa achar "aprovação bloqueada"
|
|
28
29
|
* sem saber o id nem o nome do arquivo (§15.1 "Compreensão de negócio").
|
|
29
30
|
*/
|
|
30
31
|
search: (query: string) => Scenario[];
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ProductDefinition, Scenario } from '../types/index.js';
|
|
2
2
|
export type ValidationIssue = {
|
|
3
3
|
level: "error" | "warning";
|
|
4
|
-
/** Onde o problema está: `scenario:
|
|
4
|
+
/** Onde o problema está: `scenario:requests.approve-blocked`. */
|
|
5
5
|
where: string;
|
|
6
6
|
message: string;
|
|
7
7
|
};
|
package/dist/router/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ export type RouteMatch = {
|
|
|
9
9
|
*/
|
|
10
10
|
export declare function matchPath(pattern: string, path: string): Record<string, string> | null;
|
|
11
11
|
/**
|
|
12
|
-
* Resolve a rota ativa. Rotas mais específicas primeiro: entre `/
|
|
13
|
-
* e `/
|
|
12
|
+
* Resolve a rota ativa. Rotas mais específicas primeiro: entre `/requests/new`
|
|
13
|
+
* e `/requests/:id`, a literal ganha, independente da ordem de declaração.
|
|
14
14
|
*/
|
|
15
15
|
export declare function resolveRoute(routes: RouteDefinition[], path: string): RouteMatch | undefined;
|
package/dist/shell/Controls.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { ControlsState } from '../types/index.js';
|
|
|
3
3
|
export type ControlsProps = {
|
|
4
4
|
registry: Registry;
|
|
5
5
|
controls: ControlsState;
|
|
6
|
+
scenarioActive: boolean;
|
|
6
7
|
onChange: (patch: Partial<ControlsState>) => void;
|
|
7
8
|
};
|
|
8
|
-
export declare function Controls({ registry, controls, onChange }: ControlsProps): import("react").JSX.Element;
|
|
9
|
+
export declare function Controls({ registry, controls, scenarioActive, onChange }: ControlsProps): import("react").JSX.Element;
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { Registry } from '../registry/index.js';
|
|
2
2
|
import { AccessibleNode } from '../a11y/accessible-tree.js';
|
|
3
|
-
import { ControlsState, Scenario } from '../types/index.js';
|
|
3
|
+
import { ComponentPreview, ControlsState, Scenario } from '../types/index.js';
|
|
4
4
|
export type InspectorProps = {
|
|
5
5
|
registry: Registry;
|
|
6
6
|
scenario: Scenario | undefined;
|
|
7
|
+
component?: ComponentPreview;
|
|
7
8
|
controls: ControlsState;
|
|
8
9
|
focusedNode: AccessibleNode | undefined;
|
|
9
10
|
tabStopCount: number;
|
|
10
11
|
};
|
|
11
|
-
export declare function Inspector({ registry, scenario, controls, focusedNode, tabStopCount, }: InspectorProps): import("react").JSX.Element;
|
|
12
|
+
export declare function Inspector({ registry, scenario, component, controls, focusedNode, tabStopCount, }: InspectorProps): import("react").JSX.Element;
|
package/dist/shell/Sidebar.d.ts
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
import { Registry } from '../registry/index.js';
|
|
2
|
+
import { ControlsState, Scenario } from '../types/index.js';
|
|
2
3
|
export type SidebarProps = {
|
|
3
4
|
registry: Registry;
|
|
4
|
-
activeScenario:
|
|
5
|
+
activeScenario: Scenario | undefined;
|
|
6
|
+
activeComponent: string | undefined;
|
|
7
|
+
controls: ControlsState;
|
|
5
8
|
onOpenScenario: (scenarioId: string) => void;
|
|
9
|
+
onOpenComponent: (componentId: string) => void;
|
|
6
10
|
};
|
|
7
|
-
export declare function Sidebar({ registry, activeScenario, onOpenScenario }: SidebarProps): import("react").JSX.Element;
|
|
11
|
+
export declare function Sidebar({ registry, activeScenario, activeComponent, controls, onOpenScenario, onOpenComponent, }: SidebarProps): import("react").JSX.Element;
|
|
12
|
+
export declare function isSearchShortcut(event: Pick<KeyboardEvent, "key" | "metaKey" | "ctrlKey" | "altKey" | "shiftKey">): boolean;
|
|
13
|
+
export declare function nextItemId(ids: string[], currentId: string | undefined, offset: number): string | undefined;
|
package/dist/shell/Topbar.d.ts
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
import { DeployContext } from '../deploy/index.js';
|
|
2
|
-
import { ProductDefinition, Scenario } from '../types/index.js';
|
|
2
|
+
import { ChromeTheme, ProductDefinition, Scenario } from '../types/index.js';
|
|
3
3
|
export type TopbarProps = {
|
|
4
4
|
product: ProductDefinition;
|
|
5
5
|
scenario: Scenario | undefined;
|
|
6
6
|
deploy: DeployContext;
|
|
7
7
|
inspectorOpen: boolean;
|
|
8
|
-
|
|
8
|
+
chromeTheme: ChromeTheme;
|
|
9
9
|
onToggleInspector: () => void;
|
|
10
|
-
|
|
11
|
-
onHideChrome: () => void;
|
|
10
|
+
onToggleChromeTheme: () => void;
|
|
12
11
|
};
|
|
13
|
-
export declare function Topbar({ product, scenario, deploy, inspectorOpen,
|
|
12
|
+
export declare function Topbar({ product, scenario, deploy, inspectorOpen, chromeTheme, onToggleInspector, onToggleChromeTheme, }: TopbarProps): import("react").JSX.Element;
|
|
13
|
+
export declare function buildCleanReviewUrl(href: string): string;
|
|
14
|
+
export declare function buildHomeUrl(origin: string, chromeTheme: ChromeTheme): string;
|
package/dist/shell/labels.d.ts
CHANGED
|
@@ -1,5 +1,159 @@
|
|
|
1
1
|
import { KeyboardCoverage, NetworkState, ScenarioStatus } from '../types/index.js';
|
|
2
|
+
export type Labels = {
|
|
3
|
+
status: Record<ScenarioStatus, string>;
|
|
4
|
+
statusMeaning: Record<ScenarioStatus, string>;
|
|
5
|
+
network: Record<NetworkState, string>;
|
|
6
|
+
keyboard: Record<KeyboardCoverage, string>;
|
|
7
|
+
/** Rótulo de viewport por id: `fit`, `mobile`, `tablet`, `desktop`, `custom`. */
|
|
8
|
+
viewport: Record<string, string>;
|
|
9
|
+
topbar: {
|
|
10
|
+
homeTitle: (product: string) => string;
|
|
11
|
+
toggleNav: string;
|
|
12
|
+
copyLink: string;
|
|
13
|
+
copied: string;
|
|
14
|
+
copyPrompt: string;
|
|
15
|
+
cleanReview: string;
|
|
16
|
+
cleanReviewTitle: string;
|
|
17
|
+
panel: string;
|
|
18
|
+
lightMode: string;
|
|
19
|
+
darkMode: string;
|
|
20
|
+
branchTitle: (branch: string) => string;
|
|
21
|
+
commitTitle: (commit: string) => string;
|
|
22
|
+
envTitle: (env: string) => string;
|
|
23
|
+
};
|
|
24
|
+
sidebar: {
|
|
25
|
+
region: string;
|
|
26
|
+
flowsTab: string;
|
|
27
|
+
componentsTab: string;
|
|
28
|
+
searchPlaceholder: string;
|
|
29
|
+
searchLabel: string;
|
|
30
|
+
componentSearchPlaceholder: string;
|
|
31
|
+
componentSearchLabel: string;
|
|
32
|
+
searchShortcut: string;
|
|
33
|
+
noMatch: (query: string) => string;
|
|
34
|
+
matchCount: (total: number) => string;
|
|
35
|
+
noComponentMatch: (query: string) => string;
|
|
36
|
+
componentMatchCount: (total: number) => string;
|
|
37
|
+
emptyModule: string;
|
|
38
|
+
emptyComponents: string;
|
|
39
|
+
withoutModule: string;
|
|
40
|
+
scope: string;
|
|
41
|
+
scopeData: string;
|
|
42
|
+
scopePersona: string;
|
|
43
|
+
scopeNetwork: string;
|
|
44
|
+
};
|
|
45
|
+
controls: {
|
|
46
|
+
region: string;
|
|
47
|
+
persona: string;
|
|
48
|
+
fixture: string;
|
|
49
|
+
network: string;
|
|
50
|
+
viewport: string;
|
|
51
|
+
customWidth: string;
|
|
52
|
+
theme: string;
|
|
53
|
+
locale: string;
|
|
54
|
+
dataSource: string;
|
|
55
|
+
fixturesOption: string;
|
|
56
|
+
a11y: string;
|
|
57
|
+
keyboardMode: string;
|
|
58
|
+
keyboardModeTitle: string;
|
|
59
|
+
reducedMotion: string;
|
|
60
|
+
reducedMotionTitle: string;
|
|
61
|
+
textScale: string;
|
|
62
|
+
none: string;
|
|
63
|
+
};
|
|
64
|
+
inspector: {
|
|
65
|
+
region: string;
|
|
66
|
+
tabScenario: string;
|
|
67
|
+
tabA11y: string;
|
|
68
|
+
tabDiagnostics: string;
|
|
69
|
+
diagnosticsWithErrors: (count: number) => string;
|
|
70
|
+
noScenario: string;
|
|
71
|
+
componentReference: string;
|
|
72
|
+
componentGroup: string;
|
|
73
|
+
situation: string;
|
|
74
|
+
reproduction: string;
|
|
75
|
+
id: string;
|
|
76
|
+
route: string;
|
|
77
|
+
persona: string;
|
|
78
|
+
personaSwapped: string;
|
|
79
|
+
data: string;
|
|
80
|
+
network: string;
|
|
81
|
+
goal: (goal: string) => string;
|
|
82
|
+
permissions: string;
|
|
83
|
+
preconditions: string;
|
|
84
|
+
rules: string;
|
|
85
|
+
actions: string;
|
|
86
|
+
expected: string;
|
|
87
|
+
approval: string;
|
|
88
|
+
openApproved: string;
|
|
89
|
+
engineering: string;
|
|
90
|
+
a11yContract: string;
|
|
91
|
+
keyboard: string;
|
|
92
|
+
contrast: string;
|
|
93
|
+
contrastTarget: (target: string) => string;
|
|
94
|
+
announces: string;
|
|
95
|
+
focusedElement: string;
|
|
96
|
+
keyboardModeOff: string;
|
|
97
|
+
pressTab: (tabStops: number) => string;
|
|
98
|
+
role: string;
|
|
99
|
+
name: string;
|
|
100
|
+
noAccessibleName: string;
|
|
101
|
+
nameFrom: string;
|
|
102
|
+
description: string;
|
|
103
|
+
selector: string;
|
|
104
|
+
focusableButHidden: string;
|
|
105
|
+
tabStopsInStage: (tabStops: number) => string;
|
|
106
|
+
tokenContrast: string;
|
|
107
|
+
noContrastPairs: string;
|
|
108
|
+
pair: string;
|
|
109
|
+
ratio: string;
|
|
110
|
+
pairsFailing: (count: number) => string;
|
|
111
|
+
automatedIsFloor: string;
|
|
112
|
+
coverage: string;
|
|
113
|
+
scenariosRegistered: (count: number) => string;
|
|
114
|
+
scenarioContract: string;
|
|
115
|
+
noIssues: string;
|
|
116
|
+
};
|
|
117
|
+
home: {
|
|
118
|
+
lead: (total: number) => string;
|
|
119
|
+
withoutModule: string;
|
|
120
|
+
withoutModuleHint: string;
|
|
121
|
+
emptyModule: string;
|
|
122
|
+
keyboardBadge: string;
|
|
123
|
+
};
|
|
124
|
+
shell: {
|
|
125
|
+
restoreChrome: string;
|
|
126
|
+
noRoute: string;
|
|
127
|
+
noRouteHint: string;
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
/** Português. É o padrão, não uma obrigação. */
|
|
131
|
+
export declare const DEFAULT_LABELS: Labels;
|
|
132
|
+
/** English (United States), selectable by the product through `theme.labels`. */
|
|
133
|
+
export declare const EN_US_LABELS: Labels;
|
|
134
|
+
/** Override por grupo. O que não vier declarado fica no padrão. */
|
|
135
|
+
export type LabelsOverride = {
|
|
136
|
+
[Group in keyof Labels]?: Partial<Labels[Group]>;
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Mescla um grupo por vez. Dois níveis bastam porque a estrutura tem dois, e
|
|
140
|
+
* mesclagem profunda genérica engoliria erro de digitação em vez de deixar o
|
|
141
|
+
* TypeScript reclamar.
|
|
142
|
+
*/
|
|
143
|
+
export declare function resolveLabels(override?: LabelsOverride): Labels;
|
|
144
|
+
/**
|
|
145
|
+
* Rótulos resolvidos, para o chrome inteiro.
|
|
146
|
+
*
|
|
147
|
+
* O padrão do contexto é o português, então `Home` e `Stage` — exportados e
|
|
148
|
+
* montáveis fora do `DesignSpace` — continuam funcionando sem provider.
|
|
149
|
+
*/
|
|
150
|
+
export declare const LabelsContext: import('react').Context<Labels>;
|
|
151
|
+
export declare function useLabels(): Labels;
|
|
152
|
+
/** @deprecated Use `useLabels().status`, ou `DEFAULT_LABELS.status` fora de React. */
|
|
2
153
|
export declare const STATUS_LABELS: Record<ScenarioStatus, string>;
|
|
154
|
+
/** @deprecated Use `useLabels().statusMeaning`. */
|
|
3
155
|
export declare const STATUS_MEANING: Record<ScenarioStatus, string>;
|
|
156
|
+
/** @deprecated Use `useLabels().network`. */
|
|
4
157
|
export declare const NETWORK_LABELS: Record<NetworkState, string>;
|
|
158
|
+
/** @deprecated Use `useLabels().keyboard`. */
|
|
5
159
|
export declare const KEYBOARD_LABELS: Record<KeyboardCoverage, string>;
|
package/dist/testing/index.d.ts
CHANGED
|
@@ -26,10 +26,10 @@ export declare function pathFor(scenario: Scenario, overrides?: Partial<Controls
|
|
|
26
26
|
/**
|
|
27
27
|
* Cenários que valem uma jornada automatizada.
|
|
28
28
|
*
|
|
29
|
-
* Deliberadamente não é "todos": rodar Playwright em cenário `
|
|
30
|
-
* transforma exploração em trabalho de manutenção de
|
|
31
|
-
* "governança proporcional" (Princípio 9). O piso é o
|
|
32
|
-
* aprovado ou já existe em produção.
|
|
29
|
+
* Deliberadamente não é "todos": rodar Playwright em cenário `ported` ou
|
|
30
|
+
* `proposed` transforma importação ou exploração em trabalho de manutenção de
|
|
31
|
+
* teste, que é o oposto de "governança proporcional" (Princípio 9). O piso é o
|
|
32
|
+
* cenário que já foi aprovado ou já existe em produção.
|
|
33
33
|
*/
|
|
34
34
|
export declare function scenariosUnderTest(product: ProductDefinition, statuses?: ScenarioStatus[]): Scenario[];
|
|
35
35
|
/** Cenários que declaram jornada completável só por teclado. */
|
package/dist/testing.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { v as n, j as o, i, s as t } from "./contrast-
|
|
2
|
-
import { b as v, d as P, c as g, f as E } from "./contrast-
|
|
1
|
+
import { v as n, j as o, i, s as t } from "./contrast-87-ijttm.js";
|
|
2
|
+
import { b as v, d as P, c as g, f as E } from "./contrast-87-ijttm.js";
|
|
3
3
|
function a(e = "http://localhost:5173") {
|
|
4
4
|
const r = typeof process < "u" ? process.env : {};
|
|
5
5
|
return (r.PREVIEW_URL || r.BASE_URL || e).replace(/\/$/, "");
|
package/dist/testing.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"testing.js","sources":["../src/testing/index.ts"],"sourcesContent":["/**\n * `@brucesantos/design-space/testing`\n *\n * Utilitários para os testes do produto. Vive num entrypoint separado porque\n * nada aqui deve chegar ao bundle do preview.\n *\n * O que este módulo assume: o preview é público, sem proteção de acesso (D-11).\n * Como não há segredo de bypass nem header de automação a emitir, o Playwright\n * aponta direto para a URL do preview — e é por isso que estas funções só\n * precisam de uma origem.\n */\n\nimport { scenarioUrl } from \"../deploy/index.js\";\nimport { validateProduct, hasErrors, formatIssues } from \"../registry/validate.js\";\nimport {\n assertContrastPairs,\n checkContrastPair,\n checkContrastPairs,\n contrastRatio,\n} from \"../a11y/contrast.js\";\nimport type { ControlsState, ProductDefinition, Scenario, ScenarioStatus } from \"../types/index.js\";\n\n/**\n * Origem contra a qual os testes rodam.\n *\n * `PREVIEW_URL` é o que o gatilho `deployment_status` do GitHub Actions entrega\n * pronto (§10.6), o que dispensa qualquer lógica de descobrir onde o preview foi\n * publicado. Sem ela, cai no dev server local.\n */\nexport function testOrigin(fallback = \"http://localhost:5173\"): string {\n const env = typeof process !== \"undefined\" ? process.env : {};\n const url = env.PREVIEW_URL || env.BASE_URL || fallback;\n return url.replace(/\\/$/, \"\");\n}\n\n/** URL absoluta de um cenário para uso em `page.goto`. */\nexport function urlFor(\n scenario: Scenario,\n options: { origin?: string; overrides?: Partial<ControlsState> } = {},\n): string {\n return scenarioUrl(scenario, { origin: options.origin ?? testOrigin(), overrides: options.overrides });\n}\n\n/**\n * Caminho relativo de um cenário: `/rota?scenario=…`.\n *\n * É a forma preferida em Playwright, porque deixa o `baseURL` da configuração\n * decidir se o teste roda contra o preview ou contra o dev server. Um teste que\n * embute a origem passa a existir em duas versões, e a versão local é a que\n * ninguém roda.\n */\nexport function pathFor(\n scenario: Scenario,\n overrides: Partial<ControlsState> = {},\n): string {\n const url = new URL(scenarioUrl(scenario, { origin: \"http://design-space.invalid\", overrides }));\n return `${url.pathname}${url.search}`;\n}\n\n/**\n * Cenários que valem uma jornada automatizada.\n *\n * Deliberadamente não é \"todos\": rodar Playwright em cenário `
|
|
1
|
+
{"version":3,"file":"testing.js","sources":["../src/testing/index.ts"],"sourcesContent":["/**\n * `@brucesantos/design-space/testing`\n *\n * Utilitários para os testes do produto. Vive num entrypoint separado porque\n * nada aqui deve chegar ao bundle do preview.\n *\n * O que este módulo assume: o preview é público, sem proteção de acesso (D-11).\n * Como não há segredo de bypass nem header de automação a emitir, o Playwright\n * aponta direto para a URL do preview — e é por isso que estas funções só\n * precisam de uma origem.\n */\n\nimport { scenarioUrl } from \"../deploy/index.js\";\nimport { validateProduct, hasErrors, formatIssues } from \"../registry/validate.js\";\nimport {\n assertContrastPairs,\n checkContrastPair,\n checkContrastPairs,\n contrastRatio,\n} from \"../a11y/contrast.js\";\nimport type { ControlsState, ProductDefinition, Scenario, ScenarioStatus } from \"../types/index.js\";\n\n/**\n * Origem contra a qual os testes rodam.\n *\n * `PREVIEW_URL` é o que o gatilho `deployment_status` do GitHub Actions entrega\n * pronto (§10.6), o que dispensa qualquer lógica de descobrir onde o preview foi\n * publicado. Sem ela, cai no dev server local.\n */\nexport function testOrigin(fallback = \"http://localhost:5173\"): string {\n const env = typeof process !== \"undefined\" ? process.env : {};\n const url = env.PREVIEW_URL || env.BASE_URL || fallback;\n return url.replace(/\\/$/, \"\");\n}\n\n/** URL absoluta de um cenário para uso em `page.goto`. */\nexport function urlFor(\n scenario: Scenario,\n options: { origin?: string; overrides?: Partial<ControlsState> } = {},\n): string {\n return scenarioUrl(scenario, { origin: options.origin ?? testOrigin(), overrides: options.overrides });\n}\n\n/**\n * Caminho relativo de um cenário: `/rota?scenario=…`.\n *\n * É a forma preferida em Playwright, porque deixa o `baseURL` da configuração\n * decidir se o teste roda contra o preview ou contra o dev server. Um teste que\n * embute a origem passa a existir em duas versões, e a versão local é a que\n * ninguém roda.\n */\nexport function pathFor(\n scenario: Scenario,\n overrides: Partial<ControlsState> = {},\n): string {\n const url = new URL(scenarioUrl(scenario, { origin: \"http://design-space.invalid\", overrides }));\n return `${url.pathname}${url.search}`;\n}\n\n/**\n * Cenários que valem uma jornada automatizada.\n *\n * Deliberadamente não é \"todos\": rodar Playwright em cenário `ported` ou\n * `proposed` transforma importação ou exploração em trabalho de manutenção de\n * teste, que é o oposto de \"governança proporcional\" (Princípio 9). O piso é o\n * cenário que já foi aprovado ou já existe em produção.\n */\nexport function scenariosUnderTest(\n product: ProductDefinition,\n statuses: ScenarioStatus[] = [\"approved\", \"in-implementation\", \"implemented\"],\n): Scenario[] {\n return product.scenarios.filter((scenario) => statuses.includes(scenario.status));\n}\n\n/** Cenários que declaram jornada completável só por teclado. */\nexport function keyboardScenarios(product: ProductDefinition): Scenario[] {\n return product.scenarios.filter((scenario) => scenario.a11y.keyboard === \"full\");\n}\n\n/**\n * Falha o teste quando o contrato de cenário do produto tem erro.\n *\n * É o equivalente do typecheck para o que o TypeScript não alcança: fixture\n * inexistente, persona escrita errada, rota que não casa com nada.\n */\nexport function assertValidProduct(product: ProductDefinition): void {\n const issues = validateProduct(product);\n if (hasErrors(issues)) {\n throw new Error(`Contrato de cenário inválido:\\n${formatIssues(issues)}`);\n }\n}\n\n// Medição de contraste também é ferramenta de teste: o produto valida os\n// próprios tokens, e o motor só sabe medir.\nexport {\n assertContrastPairs,\n checkContrastPair,\n checkContrastPairs,\n contrastRatio,\n formatIssues,\n hasErrors,\n validateProduct,\n};\nexport { scenarioUrl } from \"../deploy/index.js\";\n"],"names":["testOrigin","fallback","env","urlFor","scenario","options","scenarioUrl","pathFor","overrides","url","scenariosUnderTest","product","statuses","keyboardScenarios","assertValidProduct","issues","validateProduct","hasErrors","formatIssues"],"mappings":";;AA6BO,SAASA,EAAWC,IAAW,yBAAiC;AACrE,QAAMC,IAAM,OAAO,UAAY,MAAc,QAAQ,MAAM,CAAA;AAE3D,UADYA,EAAI,eAAeA,EAAI,YAAYD,GACpC,QAAQ,OAAO,EAAE;AAC9B;AAGO,SAASE,EACdC,GACAC,IAAmE,IAC3D;AACR,SAAOC,EAAYF,GAAU,EAAE,QAAQC,EAAQ,UAAUL,KAAc,WAAWK,EAAQ,UAAA,CAAW;AACvG;AAUO,SAASE,EACdH,GACAI,IAAoC,IAC5B;AACR,QAAMC,IAAM,IAAI,IAAIH,EAAYF,GAAU,EAAE,QAAQ,+BAA+B,WAAAI,EAAA,CAAW,CAAC;AAC/F,SAAO,GAAGC,EAAI,QAAQ,GAAGA,EAAI,MAAM;AACrC;AAUO,SAASC,EACdC,GACAC,IAA6B,CAAC,YAAY,qBAAqB,aAAa,GAChE;AACZ,SAAOD,EAAQ,UAAU,OAAO,CAACP,MAAaQ,EAAS,SAASR,EAAS,MAAM,CAAC;AAClF;AAGO,SAASS,EAAkBF,GAAwC;AACxE,SAAOA,EAAQ,UAAU,OAAO,CAACP,MAAaA,EAAS,KAAK,aAAa,MAAM;AACjF;AAQO,SAASU,EAAmBH,GAAkC;AACnE,QAAMI,IAASC,EAAgBL,CAAO;AACtC,MAAIM,EAAUF,CAAM;AAClB,UAAM,IAAI,MAAM;AAAA,EAAkCG,EAAaH,CAAM,CAAC,EAAE;AAE5E;"}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
import { ComponentType, ReactNode } from 'react';
|
|
2
|
+
import { LabelsOverride } from '../shell/labels.js';
|
|
2
3
|
/**
|
|
3
4
|
* Estado de ciclo de vida do cenário (§18.1). Existe para evitar que a
|
|
4
5
|
* referência envelheça em silêncio quando o produto real muda.
|
|
5
6
|
*/
|
|
6
|
-
export type ScenarioStatus = "proposed" | "in-review" | "approved" | "in-implementation" | "implemented" | "superseded";
|
|
7
|
+
export type ScenarioStatus = "ported" | "proposed" | "in-review" | "approved" | "in-implementation" | "implemented" | "superseded";
|
|
7
8
|
export declare const SCENARIO_STATUSES: readonly ScenarioStatus[];
|
|
8
9
|
/** Nível de conformidade alvo. O padrão interno é WCAG 2.2 AA. */
|
|
9
10
|
export type ContrastTarget = "AA" | "AAA";
|
|
@@ -19,9 +20,9 @@ export type A11yContract = {
|
|
|
19
20
|
contrast: ContrastTarget;
|
|
20
21
|
/**
|
|
21
22
|
* Eventos que precisam ser anunciados para leitor de tela. São chaves de
|
|
22
|
-
* domínio, não seletores: `
|
|
23
|
+
* domínio, não seletores: `request.status`, `retry.result`.
|
|
23
24
|
*
|
|
24
|
-
* Um cenário de
|
|
25
|
+
* Um cenário de aprovação bloqueada em que a recusa não é anunciada está
|
|
25
26
|
* incompleto, não está pronto para aprovação.
|
|
26
27
|
*/
|
|
27
28
|
announces?: string[];
|
|
@@ -31,7 +32,7 @@ export type A11yContract = {
|
|
|
31
32
|
export type Persona = {
|
|
32
33
|
/** Identificador estável usado em URL e em cenário. */
|
|
33
34
|
id: string;
|
|
34
|
-
/** Nome no vocabulário do cliente: "
|
|
35
|
+
/** Nome no vocabulário do cliente: "Aprovador". */
|
|
35
36
|
name: string;
|
|
36
37
|
/** O que essa pessoa está tentando fazer. */
|
|
37
38
|
goal?: string;
|
|
@@ -46,7 +47,7 @@ export type Rule = {
|
|
|
46
47
|
statement: string;
|
|
47
48
|
/** Por que a regra existe. Contexto, não implementação. */
|
|
48
49
|
rationale?: string;
|
|
49
|
-
/** Onde a regra vive no código, quando existir: `src/rules/
|
|
50
|
+
/** Onde a regra vive no código, quando existir: `src/rules/requests.ts`. */
|
|
50
51
|
source?: string;
|
|
51
52
|
};
|
|
52
53
|
/**
|
|
@@ -72,9 +73,9 @@ export declare const NETWORK_STATES: readonly NetworkState[];
|
|
|
72
73
|
* disponíveis, regras e resultado esperado.
|
|
73
74
|
*/
|
|
74
75
|
export type Scenario = {
|
|
75
|
-
/** `modulo.situacao` em kebab-case: `
|
|
76
|
+
/** `modulo.situacao` em kebab-case: `requests.approve-blocked`. */
|
|
76
77
|
id: string;
|
|
77
|
-
/** Título no vocabulário do negócio: "
|
|
78
|
+
/** Título no vocabulário do negócio: "Aprovação bloqueada por falta de documento". */
|
|
78
79
|
title: string;
|
|
79
80
|
/** Rota que o cenário abre. Precisa casar com uma rota do produto. */
|
|
80
81
|
route: string;
|
|
@@ -82,8 +83,8 @@ export type Scenario = {
|
|
|
82
83
|
persona: string;
|
|
83
84
|
/**
|
|
84
85
|
* Permissões efetivas do cenário. Quando ausente, herda as da persona.
|
|
85
|
-
* Declarar aqui permite representar "
|
|
86
|
-
*
|
|
86
|
+
* Declarar aqui permite representar "solicitante sem permissão de aprovar"
|
|
87
|
+
* sem inventar uma segunda persona.
|
|
87
88
|
*/
|
|
88
89
|
permissions?: string[];
|
|
89
90
|
/** Id de uma fixture registrada no produto. */
|
|
@@ -125,7 +126,7 @@ export type Scenario = {
|
|
|
125
126
|
*/
|
|
126
127
|
export type Flow = {
|
|
127
128
|
id: string;
|
|
128
|
-
/** Título de negócio: "
|
|
129
|
+
/** Título de negócio: "Decidir uma solicitação". */
|
|
129
130
|
title: string;
|
|
130
131
|
description?: string;
|
|
131
132
|
steps: FlowStep[];
|
|
@@ -141,9 +142,9 @@ export type FlowStep = {
|
|
|
141
142
|
branches?: Record<string, string>;
|
|
142
143
|
};
|
|
143
144
|
export type Module = {
|
|
144
|
-
/** `
|
|
145
|
+
/** `requests`, `catalog`, `billing`. */
|
|
145
146
|
id: string;
|
|
146
|
-
/** Nome no vocabulário do cliente: "
|
|
147
|
+
/** Nome no vocabulário do cliente: "Solicitações". */
|
|
147
148
|
name: string;
|
|
148
149
|
description?: string;
|
|
149
150
|
/** Jornadas guiadas do módulo. Opcional: navegação livre é o padrão. */
|
|
@@ -166,6 +167,23 @@ export type ScreenProps = {
|
|
|
166
167
|
/** Contexto do cenário ativo, resolvido pelo motor. */
|
|
167
168
|
context: ScenarioContext;
|
|
168
169
|
};
|
|
170
|
+
/**
|
|
171
|
+
* Componente do produto exposto no catálogo do Design Space.
|
|
172
|
+
*
|
|
173
|
+
* O motor só organiza e renderiza a referência. Implementação, aparência e
|
|
174
|
+
* conteúdo continuam no repositório do produto.
|
|
175
|
+
*/
|
|
176
|
+
export type ComponentPreview = {
|
|
177
|
+
/** Identificador estável usado no deep link: `button.primary`. */
|
|
178
|
+
id: string;
|
|
179
|
+
/** Nome legível no vocabulário do produto. */
|
|
180
|
+
name: string;
|
|
181
|
+
/** Grupo de navegação: `Ações`, `Formulários`, `Feedback`. */
|
|
182
|
+
group?: string;
|
|
183
|
+
description?: string;
|
|
184
|
+
/** Composição visual fornecida e mantida pelo produto. */
|
|
185
|
+
preview: ComponentType;
|
|
186
|
+
};
|
|
169
187
|
/**
|
|
170
188
|
* A UI do produto nunca depende diretamente de um backend. A camada de
|
|
171
189
|
* adapters permite alimentar o mesmo cenário por fixture, REST, GraphQL ou
|
|
@@ -200,6 +218,18 @@ export type ProductTheme = {
|
|
|
200
218
|
modes?: string[];
|
|
201
219
|
/** Idiomas disponíveis, quando o produto tiver essa variação. */
|
|
202
220
|
locales?: string[];
|
|
221
|
+
/**
|
|
222
|
+
* Rótulos do chrome do motor. Sobrescreve por grupo o que estiver em
|
|
223
|
+
* `DEFAULT_LABELS`; o que não for declarado fica no padrão em português.
|
|
224
|
+
*
|
|
225
|
+
* Serve para o Design Space de um cliente que revisa em outro idioma: o chrome
|
|
226
|
+
* divide a tela com a UI do produto, e chrome em português ao lado de interface
|
|
227
|
+
* em inglês é ruído no meio da revisão.
|
|
228
|
+
*
|
|
229
|
+
* Isto é rótulo de **mecanismo**. Nome de módulo, título de cenário e nome de
|
|
230
|
+
* persona continuam vindo do catálogo do produto.
|
|
231
|
+
*/
|
|
232
|
+
labels?: LabelsOverride;
|
|
203
233
|
};
|
|
204
234
|
export type ContrastPair = {
|
|
205
235
|
/** Nome do par: `fg-1 sobre bg-app`. */
|
|
@@ -214,9 +244,9 @@ export type ContrastPair = {
|
|
|
214
244
|
largeText?: boolean;
|
|
215
245
|
};
|
|
216
246
|
export type ProductDefinition = {
|
|
217
|
-
/** `
|
|
247
|
+
/** `acme`. */
|
|
218
248
|
id: string;
|
|
219
|
-
/** "
|
|
249
|
+
/** "Acme". */
|
|
220
250
|
name: string;
|
|
221
251
|
/** Uma linha sobre o produto, exibida na entrada do Design Space. */
|
|
222
252
|
tagline?: string;
|
|
@@ -226,6 +256,8 @@ export type ProductDefinition = {
|
|
|
226
256
|
fixtures: Fixture[];
|
|
227
257
|
rules?: Rule[];
|
|
228
258
|
routes: RouteDefinition[];
|
|
259
|
+
/** Catálogo visual opcional, implementado integralmente pelo produto. */
|
|
260
|
+
components?: ComponentPreview[];
|
|
229
261
|
theme?: ProductTheme;
|
|
230
262
|
/**
|
|
231
263
|
* Adapters de dados disponíveis. `fixtures` é o padrão (D-05); qualquer
|
|
@@ -236,24 +268,25 @@ export type ProductDefinition = {
|
|
|
236
268
|
adapters?: DataSourceAdapter[];
|
|
237
269
|
};
|
|
238
270
|
/**
|
|
239
|
-
* Contexto do deployment, informado pelo produto.
|
|
271
|
+
* Contexto do deployment, informado pelo produto. **Opcional**: um Design
|
|
272
|
+
* Space que roda só local não precisa dele.
|
|
240
273
|
*
|
|
241
274
|
* O motor **não consegue** descobrir isso sozinho. Ele é uma biblioteca já
|
|
242
275
|
* compilada: o `import.meta.env` do código dele foi resolvido no build do
|
|
243
276
|
* pacote, não no build do produto, então não sobra nada para o bundler do
|
|
244
277
|
* produto substituir. Quem tem acesso ao próprio ambiente de build é o produto.
|
|
245
278
|
*
|
|
246
|
-
* Passe os valores do bundler:
|
|
279
|
+
* Passe os valores do bundler, com o nome que o seu build usar:
|
|
247
280
|
*
|
|
248
281
|
* ```ts
|
|
249
282
|
* deploy: {
|
|
250
|
-
* env: import.meta.env.
|
|
251
|
-
* branch: import.meta.env.
|
|
252
|
-
* commit: import.meta.env.
|
|
283
|
+
* env: import.meta.env.VITE_DEPLOY_ENV,
|
|
284
|
+
* branch: import.meta.env.VITE_DEPLOY_BRANCH,
|
|
285
|
+
* commit: import.meta.env.VITE_DEPLOY_COMMIT,
|
|
253
286
|
* }
|
|
254
287
|
* ```
|
|
255
288
|
*
|
|
256
|
-
* Sem isso o cabeçalho da revisão mostra "development" e
|
|
289
|
+
* Sem isso o cabeçalho da revisão mostra "development" e omite branch e
|
|
257
290
|
* commit — e é o commit que torna uma aprovação rastreável.
|
|
258
291
|
*/
|
|
259
292
|
deploy?: DeployOverrides;
|
|
@@ -268,8 +301,9 @@ export type ProductDefinition = {
|
|
|
268
301
|
}>;
|
|
269
302
|
};
|
|
270
303
|
/**
|
|
271
|
-
* Contexto do deployment informado pelo produto. Todos os campos são opcionais
|
|
272
|
-
* o
|
|
304
|
+
* Contexto do deployment informado pelo produto. Todos os campos são opcionais,
|
|
305
|
+
* e é essa a fonte única: o motor não lê ambiente nem conhece provedor de
|
|
306
|
+
* hospedagem. Campo ausente cai no padrão local.
|
|
273
307
|
*/
|
|
274
308
|
export type DeployOverrides = {
|
|
275
309
|
/** `development`, `preview` ou `production`. */
|
|
@@ -328,8 +362,12 @@ export type ViewportSetting = {
|
|
|
328
362
|
width?: number;
|
|
329
363
|
height?: number;
|
|
330
364
|
};
|
|
365
|
+
/** Aparência do chrome do Design Space. Não altera o tema da UI do produto. */
|
|
366
|
+
export type ChromeTheme = "dark" | "light";
|
|
331
367
|
export type ControlsState = {
|
|
332
368
|
scenario: string | undefined;
|
|
369
|
+
/** Referência visual ativa. Opcional para preservar objetos do contrato anterior. */
|
|
370
|
+
component?: string;
|
|
333
371
|
persona: string | undefined;
|
|
334
372
|
fixture: string | undefined;
|
|
335
373
|
network: NetworkState;
|
|
@@ -338,6 +376,8 @@ export type ControlsState = {
|
|
|
338
376
|
themeMode: string | undefined;
|
|
339
377
|
locale: string | undefined;
|
|
340
378
|
dataSource: string | undefined;
|
|
379
|
+
/** Tema visual do chrome; independente de `themeMode` do produto. */
|
|
380
|
+
chromeTheme?: ChromeTheme;
|
|
341
381
|
/** Chrome do Design Space oculto: revisão limpa e captura de tela. */
|
|
342
382
|
chrome: boolean;
|
|
343
383
|
keyboardMode: boolean;
|
package/dist/util/date.d.ts
CHANGED
|
@@ -8,10 +8,9 @@
|
|
|
8
8
|
*
|
|
9
9
|
* O bug que a originou: `new Date("2011-09-08")` é parseado como meia-noite
|
|
10
10
|
* **UTC**. Formatado em qualquer fuso a oeste de Greenwich — o Brasil inteiro —
|
|
11
|
-
* exibe o dia anterior.
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* dia.
|
|
11
|
+
* exibe o dia anterior. Em um produto isso apareceu como data de nascimento
|
|
12
|
+
* atrasada em um dia, o que deslocava a idade calculada e portanto uma regra que
|
|
13
|
+
* dependia dela; em outro, como vencimento errado por um dia.
|
|
15
14
|
*
|
|
16
15
|
* Os dois produtos escreveram a mesma correção separadamente. Quando isso
|
|
17
16
|
* acontece, o lugar da correção é o motor — senão o terceiro produto reescreve o
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brucesantos/design-space",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Motor neutro do Bananas Design Space: registry de cenários, shell, deep links, controles de persona/viewport/rede, inspetor de regras e ferramentas de acessibilidade. Não contém UI de cliente.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|