@terpjs/contract 0.5.2 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/manifest.ts +8 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@terpjs/contract",
3
- "version": "0.5.2",
3
+ "version": "0.5.4",
4
4
  "type": "module",
5
5
  "description": "Terp frontend contract \u2014 the OpenAPI-generated TypeScript client, design tokens, and the stack-agnostic module/route/nav + auth types.",
6
6
  "exports": {
package/src/manifest.ts CHANGED
@@ -13,7 +13,14 @@
13
13
  export type RoleName = string;
14
14
 
15
15
  export interface ModuleRoute {
16
- /** URL path the route mounts at, e.g. "/billing" or "/billing/:id". */
16
+ /**
17
+ * URL path the route mounts at, e.g. `/billing` or `/billing/:id`.
18
+ *
19
+ * Parameters are spelled the stack-agnostic way (`:id`) — each adapter translates
20
+ * into its own router's dialect (`$id` for TanStack Router, `[id]` for SvelteKit).
21
+ * The React adapter also accepts `$id` directly, which is what shipped before the
22
+ * translation existed.
23
+ */
17
24
  path: string;
18
25
  /** Stack-agnostic view identifier the adapter resolves to a component. */
19
26
  view: string;