Skip to content

Commit 976dc9b

Browse files
committed
chore(spec): regenerate generated surfaces from the merged tree
os-regen four-step after merging origin/main: docs references, api-surface, authorable-surface (base + system). check:generated 10/10, check:spec-parsed-alias 756 OK, check:i18n-coverage none new.
1 parent c34b6f0 commit 976dc9b

6 files changed

Lines changed: 67 additions & 94 deletions

File tree

content/docs/references/index.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Protocol Reference
3-
description: Every schema published by @objectstack/spec — 1605 schemas across 14 protocol modules
3+
description: Every schema published by @objectstack/spec — 1606 schemas across 14 protocol modules
44
---
55

66
{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}
@@ -32,8 +32,8 @@ counts are sums of the rows they head. Regenerate with
3232
| [Shared Protocol](/docs/references/shared) | 8 | 31 | Primitives used across every protocol — identifiers, HTTP, expressions, error maps, enums. |
3333
| [Studio Protocol](/docs/references/studio) | 3 | 35 | Studio designer metadata — the authoring surfaces for the protocols above. |
3434
| [System Protocol](/docs/references/system) | 37 | 296 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
35-
| [UI Protocol](/docs/references/ui) | 16 | 146 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
36-
| **Total** | **200** | **1605** | 14 protocol modules |
35+
| [UI Protocol](/docs/references/ui) | 16 | 147 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
36+
| **Total** | **200** | **1606** | 14 protocol modules |
3737

3838
---
3939

@@ -366,7 +366,7 @@ The runtime environment — logging, jobs, cache, metrics, notifications, i18n a
366366

367367
## UI Protocol
368368

369-
**Source:** `packages/spec/src/ui/` · **Import:** `@objectstack/spec/ui` · **16 pages, 146 schemas**
369+
**Source:** `packages/spec/src/ui/` · **Import:** `@objectstack/spec/ui` · **16 pages, 147 schemas**
370370

371371
Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer.
372372

@@ -380,7 +380,7 @@ Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI lay
380380
| [`component.zod.ts`](/docs/references/ui/component) | `AIChatWindowProps`, `ElementButtonProps`, `ElementFilterProps`, `ElementFormProps`, `ElementImageProps`, `ElementMetadataViewerProps`, `ElementNumberProps`, `ElementRecordPickerProps`, `ElementTextInputProps`, `ElementTextProps`, `PageAccordionProps`, `PageCardProps`, `PageContainerProps`, `PageHeaderProps`, `PageTabsProps`, `RecordActivityProps`, `RecordChatterProps`, `RecordDetailsProps`, `RecordHighlightsField`, `RecordHighlightsProps`, `RecordPathProps`, `RecordRelatedListProps` |
381381
| [`dashboard.zod.ts`](/docs/references/ui/dashboard) | `Dashboard`, `DashboardHeader`, `DashboardHeaderAction`, `DashboardWidget`, `DashboardWidgetOptions`, `GlobalFilter`, `GlobalFilterOptionsFrom`, `WidgetActionType`, `WidgetColorVariant` |
382382
| [`dataset.zod.ts`](/docs/references/ui/dataset) | `Dataset`, `DatasetDimension`, `DatasetMeasure`, `DerivedMeasureOp` |
383-
| [`i18n.zod.ts`](/docs/references/ui/i18n) | `AriaProps`, `I18nLabel` |
383+
| [`i18n.zod.ts`](/docs/references/ui/i18n) | `AriaProps`, `I18nLabel`, `InlineLocaleMap` |
384384
| [`notification.zod.ts`](/docs/references/ui/notification) | `NotificationPosition`, `NotificationSeverity`, `NotificationType` |
385385
| [`page.zod.ts`](/docs/references/ui/page) | `ElementDataSource`, `InterfacePageConfig`, `Page`, `PageComponent`, `PageComponentType`, `PageRegion`, `PageType`, `PageVariable` |
386386
| [`report.zod.ts`](/docs/references/ui/report) | `JoinedReportBlock`, `Report`, `ReportChart`, `ReportSort`, `ReportType` |

content/docs/references/system/settings-manifest.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ const result = ResolvedSettingValueSchema.parse(data);
7777
| :--- | :--- | :--- | :--- |
7878
| **namespace** | `string` || Namespace (snake_case, globally unique) |
7979
| **version** | `integer` | optional | Manifest schema version |
80-
| **label** | `string` || Display label |
80+
| **label** | `string \| Record<string, string>` || Display label |
8181
| **icon** | `string` | optional | Icon (Lucide) |
8282
| **description** | `string` | optional | Short description |
8383
| **helpText** | `string` | optional | Markdown help text shown above specifiers |
@@ -86,7 +86,7 @@ const result = ResolvedSettingValueSchema.parse(data);
8686
| **writePermission** | `string` | optional | Permission required to write |
8787
| **category** | `string` | optional | Settings hub category |
8888
| **order** | `number` | optional | Display order |
89-
| **specifiers** | `{ type: Enum<'group' \| 'child_pane' \| 'info_banner' \| 'title_value' \| 'text' \| 'textarea' \| … +13 more>; id?: string; key?: string; label: string; … }[]` || Page contents (ordered) |
89+
| **specifiers** | `{ type: Enum<'group' \| 'child_pane' \| 'info_banner' \| 'title_value' \| 'text' \| 'textarea' \| … +13 more>; id?: string; key?: string; label: string \| Record<string, string>; … }[]` || Page contents (ordered) |
9090
| **visible** | `string \| { dialect: Enum<'cel' \| 'cron' \| 'template'>; source?: string; ast?: any; meta?: object }` | optional | Whole-manifest visibility |
9191
| **featureFlag** | `string` | optional | Gate manifest visibility on a feature flag |
9292
| **beta** | `boolean` | optional | Show a Beta chip on the page |
@@ -100,7 +100,7 @@ const result = ResolvedSettingValueSchema.parse(data);
100100

101101
| Property | Type | Required | Description |
102102
| :--- | :--- | :--- | :--- |
103-
| **manifest** | `{ namespace: string; version?: integer; label: string; icon?: string; … }` || |
103+
| **manifest** | `{ namespace: string; version?: integer; label: string \| Record<string, string>; icon?: string; … }` || |
104104
| **values** | `Record<string, { value: any; source: Enum<'env' \| 'global' \| 'tenant' \| 'user' \| 'default'>; locked: boolean; lockedReason?: string; … }>` || Effective values keyed by specifier.key |
105105

106106

@@ -115,7 +115,7 @@ const result = ResolvedSettingValueSchema.parse(data);
115115
| **type** | `Enum<'group' \| 'child_pane' \| 'info_banner' \| 'title_value' \| 'text' \| 'textarea' \| 'password' \| 'email' \| 'url' \| 'phone' \| 'number' \| 'toggle' \| 'select' \| 'radio' \| … +5 more>` || Specifier variant |
116116
| **id** | `string` | optional | Stable identifier (snake_case) |
117117
| **key** | `string` | optional | Storage key (snake_case) |
118-
| **label** | `string` || Display label |
118+
| **label** | `string \| Record<string, string>` || Display label |
119119
| **description** | `string` | optional | Help text |
120120
| **icon** | `string` | optional | Icon name (Lucide) |
121121
| **default** | `any` | optional | Default value |
@@ -129,7 +129,7 @@ const result = ResolvedSettingValueSchema.parse(data);
129129
| **writePermission** | `string` | optional | Permission required to write this specifier |
130130
| **deprecated** | `boolean` | optional | Mark deprecated |
131131
| **replacedBy** | `string` | optional | Replacement key (used when deprecated=true) |
132-
| **options** | `{ value: string \| number \| boolean; label: string; description?: string; icon?: string }[]` | optional | Options for select/radio/multiselect |
132+
| **options** | `{ value: string \| number \| boolean; label: string \| Record<string, string>; description?: string; icon?: string }[]` | optional | Options for select/radio/multiselect |
133133
| **valueDomain** | `Enum<'iana_time_zone' \| 'iso_4217_currency' \| 'iso_3166_alpha2'>` | optional | Standard value domain enforced on write (options degrade to a UI suggestion list) |
134134
| **min** | `number` | optional | |
135135
| **max** | `number` | optional | |
@@ -138,7 +138,7 @@ const result = ResolvedSettingValueSchema.parse(data);
138138
| **maxLength** | `integer` | optional | |
139139
| **pattern** | `string` | optional | Regex pattern (text only) |
140140
| **rows** | `integer` | optional | |
141-
| **handler** | `{ kind: 'http'; method?: Enum<'GET' \| 'POST' \| 'PUT' \| 'DELETE' \| 'PATCH'>; url: string; body?: Record<string, any>; … } \| { kind: 'action'; name: string; params?: Record<string, any>; confirmText?: string } \| { kind: 'navigate'; url: string; target?: Enum<'_self' \| '_blank'> }` | optional | Action handler (action_button) |
141+
| **handler** | `{ kind: 'http'; method?: Enum<'GET' \| 'POST' \| 'PUT' \| 'DELETE' \| 'PATCH'>; url: string; body?: Record<string, any>; … } \| { kind: 'action'; name: string; params?: Record<string, any>; confirmText?: string \| Record<string, string> } \| { kind: 'navigate'; url: string; target?: Enum<'_self' \| '_blank'> }` | optional | Action handler (action_button) |
142142
| **childNamespace** | `string` | optional | Sub-namespace (child_pane) |
143143
| **bannerText** | `string` | optional | Markdown body (info_banner) |
144144
| **bannerSeverity** | `Enum<'info' \| 'success' \| 'warning' \| 'error'>` | optional | |
@@ -184,7 +184,7 @@ This schema accepts one of the following structures:
184184
| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'DELETE' \| 'PATCH'>` || |
185185
| **url** | `string` || Endpoint URL; supports $`{...}` interpolation |
186186
| **body** | `Record<string, any>` | optional | Optional JSON body; supports $`{...}` interpolation |
187-
| **confirmText** | `string` | optional | Confirm dialog text before invoking (omit = no confirm) |
187+
| **confirmText** | `string \| Record<string, string>` | optional | Confirm dialog text before invoking (omit = no confirm) |
188188

189189
---
190190

@@ -197,7 +197,7 @@ This schema accepts one of the following structures:
197197
| **kind** | `'action'` || |
198198
| **name** | `string` || Registered action machine name |
199199
| **params** | `Record<string, any>` | optional | |
200-
| **confirmText** | `string` | optional | Display label (plain string; i18n keys are auto-generated by the framework) |
200+
| **confirmText** | `string \| Record<string, string>` | optional | Display label — the default-language string, or an inline locale map (`{ en, "zh-CN" }`) resolved at render time |
201201

202202
---
203203

@@ -223,7 +223,7 @@ This schema accepts one of the following structures:
223223
| Property | Type | Required | Description |
224224
| :--- | :--- | :--- | :--- |
225225
| **value** | `string \| number \| boolean` || Stored value |
226-
| **label** | `string` || Display label |
226+
| **label** | `string \| Record<string, string>` || Display label |
227227
| **description** | `string` | optional | Optional helper text |
228228
| **icon** | `string` | optional | Optional Lucide icon name |
229229

content/docs/references/ui/dataset.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ const result = DatasetSchema.parse(data);
4949
| Property | Type | Required | Description |
5050
| :--- | :--- | :--- | :--- |
5151
| **name** | `string` || Dataset unique name |
52-
| **label** | `string` || Dataset label |
53-
| **description** | `string` | optional | Display label (plain string; i18n keys are auto-generated by the framework) |
52+
| **label** | `string \| Record<string, string>` || Dataset label |
53+
| **description** | `string \| Record<string, string>` | optional | Display label — the default-language string, or an inline locale map (`{ en, "zh-CN" }`) resolved at render time |
5454
| **object** | `string` || Base object name |
5555
| **include** | `string[]` | optional | Relationship names/paths to join (derived from object graph; max 3 hops) |
5656
| **filter** | `any` | optional | Intrinsic dataset scope filter |
57-
| **dimensions** | `{ name: string; label?: string; field: string; type?: Enum<'string' \| 'number' \| 'date' \| 'boolean' \| 'lookup'>; … }[]` || Groupable axes |
58-
| **measures** | `{ name: string; label?: string; aggregate?: Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max' \| 'count_distinct'>; field?: string; … }[]` || Aggregatable values |
57+
| **dimensions** | `{ name: string; label?: string \| Record<string, string>; field: string; type?: Enum<'string' \| 'number' \| 'date' \| 'boolean' \| 'lookup'>; … }[]` || Groupable axes |
58+
| **measures** | `{ name: string; label?: string \| Record<string, string>; aggregate?: Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max' \| 'count_distinct'>; field?: string; … }[]` || Aggregatable values |
5959
| **protection** | `{ lock: Enum<'none' \| 'no-overlay' \| 'no-delete' \| 'full'>; reason: string; docsUrl?: string }` | optional | Package author protection block — lock policy for this dataset. |
6060
| **_lock** | `Enum<'none' \| 'no-overlay' \| 'no-delete' \| 'full'>` | optional | Item-level lock — controls overlay & delete (ADR-0010). |
6161
| **_lockReason** | `string` | optional | Human-readable reason shown when a write is refused by _lock. |
@@ -75,7 +75,7 @@ const result = DatasetSchema.parse(data);
7575
| Property | Type | Required | Description |
7676
| :--- | :--- | :--- | :--- |
7777
| **name** | `string` || Dimension name — referenced by presentations |
78-
| **label** | `string` | optional | Display label (plain string; i18n keys are auto-generated by the framework) |
78+
| **label** | `string \| Record<string, string>` | optional | Display label — the default-language string, or an inline locale map (`{ en, "zh-CN" }`) resolved at render time |
7979
| **field** | `string` || Base field, or `relationship[.relationship].field` path |
8080
| **type** | `Enum<'string' \| 'number' \| 'date' \| 'boolean' \| 'lookup'>` | optional | |
8181
| **dateGranularity** | `Enum<'day' \| 'week' \| 'month' \| 'quarter' \| 'year'>` | optional | |
@@ -90,7 +90,7 @@ const result = DatasetSchema.parse(data);
9090
| Property | Type | Required | Description |
9191
| :--- | :--- | :--- | :--- |
9292
| **name** | `string` || Measure name — e.g. "revenue"; defined once |
93-
| **label** | `string` | optional | Display label (plain string; i18n keys are auto-generated by the framework) |
93+
| **label** | `string \| Record<string, string>` | optional | Display label — the default-language string, or an inline locale map (`{ en, "zh-CN" }`) resolved at render time |
9494
| **aggregate** | `Enum<'count' \| 'sum' \| 'avg' \| 'min' \| 'max' \| 'count_distinct'>` | optional | Aggregation (sum/avg/count/...); omit when `derived` is set |
9595
| **field** | `string` | optional | Aggregated field; optional for count(*) |
9696
| **filter** | `any` | optional | |

packages/spec/api-surface/system.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -749,6 +749,7 @@
749749
"VectorClock (type)",
750750
"VectorClockSchema (const)",
751751
"ViewLike (interface)",
752+
"ViewTabLike (interface)",
752753
"WidgetLike (interface)",
753754
"WorkerConfig (type)",
754755
"WorkerConfigParsed (type)",
@@ -802,6 +803,7 @@
802803
"resolveSettingsOptionLabel (function)",
803804
"resolveSettingsSourceLabel (function)",
804805
"resolveSettingsTitle (function)",
806+
"resolveTabLabel (function)",
805807
"resolveViewDescription (function)",
806808
"resolveViewLabel (function)",
807809
"s3StorageExample (const)",

0 commit comments

Comments
 (0)