@brucesantos/design-space 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,17 +14,15 @@ export type DeployContext = {
14
14
  commit: string | undefined;
15
15
  /** Primeiros 7 caracteres do commit. */
16
16
  shortCommit: string | undefined;
17
- /** `true` quando roda em preview ou produção na Vercel. */
17
+ /** `true` quando o produto informou preview ou produção. */
18
18
  isDeployed: boolean;
19
19
  };
20
20
  /**
21
- * Lê o contexto do deployment.
21
+ * Monta o contexto do deployment a partir do que o produto informou.
22
22
  *
23
- * `overrides` vem do produto e tem precedência. Ele existe porque o motor é uma
24
- * biblioteca já compilada: o `import.meta.env` deste arquivo foi resolvido no
25
- * build do pacote, não no build do produto. A leitura de ambiente abaixo só
26
- * funciona quando o motor roda a partir do código-fonte — em testes e no
27
- * workspace — e por isso não pode ser a única fonte.
23
+ * Campo ausente ou vazio cai no padrão local — string vazia é o que um `define`
24
+ * de bundler produz quando a variável não existe, e um cabeçalho de revisão com
25
+ * branch vazia é pior que um sem branch.
28
26
  */
29
27
  export declare function getDeployContext(overrides?: DeployOverrides): DeployContext;
30
28
  /**
@@ -40,11 +38,18 @@ export declare function scenarioUrl(scenario: Scenario, options?: {
40
38
  * URL imutável de aprovação (§10.2). Aponta para o commit exato, então a
41
39
  * aprovação não muda de conteúdo debaixo de quem aprovou.
42
40
  *
43
- * Requer o escopo do projeto na Vercel, que é a parte do domínio depois do
44
- * hash e não está exposta como variável — por isso vem do produto.
41
+ * O formato da URL é do provedor, não do motor, então vem do produto como
42
+ * template com `{commit}` ou `{shortCommit}`:
43
+ *
44
+ * ```ts
45
+ * commitUrl(scenario, { template: "https://acme-{shortCommit}-time.example.app" });
46
+ * commitUrl(scenario, { template: "https://{commit}.review.acme.dev" });
47
+ * ```
48
+ *
49
+ * Sem commit não há aprovação rastreável, e a função devolve `undefined` em vez
50
+ * de um link que aponta para o lugar errado.
45
51
  */
46
52
  export declare function commitUrl(scenario: Scenario, options: {
47
- project: string;
48
- scope: string;
53
+ template: string;
49
54
  commit?: string;
50
55
  }): string | undefined;
package/dist/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  export { DesignSpace, type DesignSpaceProps } from './shell/DesignSpace.js';
10
10
  export { Stage, StageEmpty, TabOrderOverlay, type StageProps } from './shell/Stage.js';
11
11
  export { Home, type HomeProps } from './shell/Home.js';
12
- export { KEYBOARD_LABELS, NETWORK_LABELS, STATUS_LABELS, STATUS_MEANING, } from './shell/labels.js';
12
+ export { DEFAULT_LABELS, KEYBOARD_LABELS, NETWORK_LABELS, STATUS_LABELS, STATUS_MEANING, resolveLabels, useLabels, type Labels, type LabelsOverride, } from './shell/labels.js';
13
13
  export { createRegistry, type ModuleNode, type Registry } from './registry/index.js';
14
14
  export { formatIssues, hasErrors, validateProduct, validateScenario, type ValidationIssue, } from './registry/validate.js';
15
15
  export { matchPath, resolveRoute, type RouteMatch } from './router/index.js';