Skip to content

Commit 0281703

Browse files
committed
chore(spec): regenerate api-surface + reference docs for #4587 (check:generated --fix, 2 proved stale)
api-surface.json: ./kernel loses MetadataEvent(type)/MetadataEventSchema and MetadataBulkRegisterRequest(type)/MetadataBulkRegisterRequestSchema; ./api gains the MetadataBulkRegisterRequest type alias beside its schema. Reference docs: the api/metadata-plugin.mdx page (which documented the removed kernel pair under the api section and advertised a then-nonexistent ./api type import) is no longer emitted; api/events.mdx now documents MetadataEvent, api/metadata.mdx documents MetadataBulkRegisterRequest, and kernel/metadata-plugin.mdx drops the removed schemas. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01M9uWvoEp9CoLzYjNExj9sL
1 parent 9610b13 commit 0281703

6 files changed

Lines changed: 39 additions & 93 deletions

File tree

content/docs/references/api/events.mdx

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Examples:
2626
## TypeScript Usage
2727

2828
```typescript
29-
import { DataEvent, DataEventType, MetadataEventType } from '@objectstack/spec/api';
30-
import type { DataEvent, DataEventType, MetadataEventType } from '@objectstack/spec/api';
29+
import { DataEvent, DataEventType, MetadataEvent, MetadataEventType } from '@objectstack/spec/api';
30+
import type { DataEvent, DataEventType, MetadataEvent, MetadataEventType } from '@objectstack/spec/api';
3131

3232
// Validate data
3333
const result = DataEvent.parse(data);
@@ -64,6 +64,24 @@ const result = DataEvent.parse(data);
6464
* `data.field.changed`
6565

6666

67+
---
68+
69+
## MetadataEvent
70+
71+
### Properties
72+
73+
| Property | Type | Required | Description |
74+
| :--- | :--- | :--- | :--- |
75+
| **id** | `string` || Unique event identifier |
76+
| **type** | `Enum<'metadata.object.created' \| 'metadata.object.updated' \| 'metadata.object.deleted' \| 'metadata.field.created' \| 'metadata.field.updated' \| 'metadata.field.deleted' \| 'metadata.view.created' \| 'metadata.view.updated' \| 'metadata.view.deleted' \| 'metadata.app.created' \| 'metadata.app.updated' \| 'metadata.app.deleted' \| 'metadata.agent.created' \| 'metadata.agent.updated' \| 'metadata.agent.deleted' \| 'metadata.tool.created' \| 'metadata.tool.updated' \| 'metadata.tool.deleted' \| 'metadata.flow.created' \| 'metadata.flow.updated' \| 'metadata.flow.deleted' \| 'metadata.action.created' \| 'metadata.action.updated' \| 'metadata.action.deleted' \| 'metadata.workflow.created' \| 'metadata.workflow.updated' \| 'metadata.workflow.deleted' \| 'metadata.dashboard.created' \| 'metadata.dashboard.updated' \| 'metadata.dashboard.deleted' \| 'metadata.report.created' \| 'metadata.report.updated' \| 'metadata.report.deleted' \| 'metadata.role.created' \| 'metadata.role.updated' \| 'metadata.role.deleted' \| 'metadata.permission.created' \| 'metadata.permission.updated' \| 'metadata.permission.deleted'>` | ✅ | Event type |
77+
| **metadataType** | `string` || Metadata type (object, view, agent, etc.) |
78+
| **name** | `string` || Metadata item name |
79+
| **packageId** | `string` | optional | Package ID |
80+
| **definition** | `any` | optional | Full definition (create/update only) |
81+
| **userId** | `string` | optional | User who triggered the event |
82+
| **timestamp** | `string` || Event timestamp |
83+
84+
6785
---
6886

6987
## MetadataEventType

content/docs/references/api/meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@
3232
"export",
3333
"identity",
3434
"metadata",
35-
"metadata-plugin",
3635
"notification",
3736
"package-api",
3837
"package-registry",

content/docs/references/api/metadata-plugin.mdx

Lines changed: 0 additions & 50 deletions
This file was deleted.

content/docs/references/api/metadata.mdx

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ the entire platform, including Hono, Next.js, and NestJS adapters.
5050
## TypeScript Usage
5151

5252
```typescript
53-
import { AppDefinitionResponse, ConceptListResponse, MetadataBulkResponse, MetadataBulkUnregisterRequest, MetadataDeleteResponse, MetadataDependenciesResponse, MetadataDependentsResponse, MetadataEffectiveResponse, MetadataExistsResponse, MetadataExportRequest, MetadataExportResponse, MetadataImportRequest, MetadataImportResponse, MetadataItemResponse, MetadataListResponse, MetadataNamesResponse, MetadataOverlayResponse, MetadataOverlaySaveRequest, MetadataQueryRequest, MetadataQueryResponse, MetadataRegisterRequest, MetadataTypeInfoResponse, MetadataTypesResponse, MetadataValidateRequest, MetadataValidateResponse, ObjectDefinitionResponse } from '@objectstack/spec/api';
54-
import type { AppDefinitionResponse, ConceptListResponse, MetadataBulkResponse, MetadataBulkUnregisterRequest, MetadataDeleteResponse, MetadataDependenciesResponse, MetadataDependentsResponse, MetadataEffectiveResponse, MetadataExistsResponse, MetadataExportRequest, MetadataExportResponse, MetadataImportRequest, MetadataImportResponse, MetadataItemResponse, MetadataListResponse, MetadataNamesResponse, MetadataOverlayResponse, MetadataOverlaySaveRequest, MetadataQueryRequest, MetadataQueryResponse, MetadataRegisterRequest, MetadataTypeInfoResponse, MetadataTypesResponse, MetadataValidateRequest, MetadataValidateResponse, ObjectDefinitionResponse } from '@objectstack/spec/api';
53+
import { AppDefinitionResponse, ConceptListResponse, MetadataBulkRegisterRequest, MetadataBulkResponse, MetadataBulkUnregisterRequest, MetadataDeleteResponse, MetadataDependenciesResponse, MetadataDependentsResponse, MetadataEffectiveResponse, MetadataExistsResponse, MetadataExportRequest, MetadataExportResponse, MetadataImportRequest, MetadataImportResponse, MetadataItemResponse, MetadataListResponse, MetadataNamesResponse, MetadataOverlayResponse, MetadataOverlaySaveRequest, MetadataQueryRequest, MetadataQueryResponse, MetadataRegisterRequest, MetadataTypeInfoResponse, MetadataTypesResponse, MetadataValidateRequest, MetadataValidateResponse, ObjectDefinitionResponse } from '@objectstack/spec/api';
54+
import type { AppDefinitionResponse, ConceptListResponse, MetadataBulkRegisterRequest, MetadataBulkResponse, MetadataBulkUnregisterRequest, MetadataDeleteResponse, MetadataDependenciesResponse, MetadataDependentsResponse, MetadataEffectiveResponse, MetadataExistsResponse, MetadataExportRequest, MetadataExportResponse, MetadataImportRequest, MetadataImportResponse, MetadataItemResponse, MetadataListResponse, MetadataNamesResponse, MetadataOverlayResponse, MetadataOverlaySaveRequest, MetadataQueryRequest, MetadataQueryResponse, MetadataRegisterRequest, MetadataTypeInfoResponse, MetadataTypesResponse, MetadataValidateRequest, MetadataValidateResponse, ObjectDefinitionResponse } from '@objectstack/spec/api';
5555

5656
// Validate data
5757
const result = AppDefinitionResponse.parse(data);
@@ -85,6 +85,19 @@ const result = AppDefinitionResponse.parse(data);
8585
| **data** | `{ name: string; label: string; icon?: string; description?: string }[]` || List of available concepts (Objects, Apps, Flows) |
8686

8787

88+
---
89+
90+
## MetadataBulkRegisterRequest
91+
92+
### Properties
93+
94+
| Property | Type | Required | Description |
95+
| :--- | :--- | :--- | :--- |
96+
| **items** | `{ type: string; name: string; data: Record<string, any> }[]` || Items to register |
97+
| **continueOnError** | `boolean` || Continue on individual failure |
98+
| **validate** | `boolean` || Validate before registering |
99+
100+
88101
---
89102

90103
## MetadataBulkResponse

content/docs/references/kernel/metadata-plugin.mdx

Lines changed: 3 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -72,26 +72,13 @@ cohesive plugin that "takes over" the entire platform's metadata management:
7272
## TypeScript Usage
7373

7474
```typescript
75-
import { MetadataBulkRegisterRequest, MetadataBulkResult, MetadataDependency, MetadataEvent, MetadataPluginConfig, MetadataPluginManifest, MetadataQuery, MetadataQueryResult, MetadataType, MetadataTypeRegistryEntry, MetadataValidationResult } from '@objectstack/spec/kernel';
76-
import type { MetadataBulkRegisterRequest, MetadataBulkResult, MetadataDependency, MetadataEvent, MetadataPluginConfig, MetadataPluginManifest, MetadataQuery, MetadataQueryResult, MetadataType, MetadataTypeRegistryEntry, MetadataValidationResult } from '@objectstack/spec/kernel';
75+
import { MetadataBulkResult, MetadataDependency, MetadataPluginConfig, MetadataPluginManifest, MetadataQuery, MetadataQueryResult, MetadataType, MetadataTypeRegistryEntry, MetadataValidationResult } from '@objectstack/spec/kernel';
76+
import type { MetadataBulkResult, MetadataDependency, MetadataPluginConfig, MetadataPluginManifest, MetadataQuery, MetadataQueryResult, MetadataType, MetadataTypeRegistryEntry, MetadataValidationResult } from '@objectstack/spec/kernel';
7777

7878
// Validate data
79-
const result = MetadataBulkRegisterRequest.parse(data);
79+
const result = MetadataBulkResult.parse(data);
8080
```
8181

82-
---
83-
84-
## MetadataBulkRegisterRequest
85-
86-
### Properties
87-
88-
| Property | Type | Required | Description |
89-
| :--- | :--- | :--- | :--- |
90-
| **items** | `{ type: string; name: string; data: Record<string, any>; namespace?: string }[]` || Items to register |
91-
| **continueOnError** | `boolean` || Continue if individual item fails |
92-
| **validate** | `boolean` || Validate before register |
93-
94-
9582
---
9683

9784
## MetadataBulkResult
@@ -121,24 +108,6 @@ const result = MetadataBulkRegisterRequest.parse(data);
121108
| **kind** | `Enum<'reference' \| 'extends' \| 'includes' \| 'triggers'>` || How the dependency is formed |
122109

123110

124-
---
125-
126-
## MetadataEvent
127-
128-
### Properties
129-
130-
| Property | Type | Required | Description |
131-
| :--- | :--- | :--- | :--- |
132-
| **event** | `Enum<'metadata.registered' \| 'metadata.updated' \| 'metadata.unregistered' \| 'metadata.validated' \| 'metadata.deployed' \| 'metadata.overlay.applied' \| 'metadata.overlay.removed' \| 'metadata.imported' \| 'metadata.exported'>` || Event type |
133-
| **metadataType** | `Enum<'object' \| 'field' \| 'hook' \| 'seed' \| 'mapping' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'email_template' \| 'doc' \| 'book' \| 'permission' \| 'position' \| 'agent' \| 'tool' \| 'skill'>` || Metadata type |
134-
| **name** | `string` || Metadata item name |
135-
| **namespace** | `string` | optional | Namespace |
136-
| **packageId** | `string` | optional | Owning package ID |
137-
| **timestamp** | `string` || Event timestamp |
138-
| **actor** | `string` | optional | User or system that triggered the event |
139-
| **payload** | `Record<string, any>` | optional | Event-specific payload |
140-
141-
142111
---
143112

144113
## MetadataPluginConfig

packages/spec/api-surface.json

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1611,8 +1611,6 @@
16111611
"MergeResultSchema (const)",
16121612
"MergeStrategyConfig (type)",
16131613
"MergeStrategyConfigSchema (const)",
1614-
"MetadataBulkRegisterRequest (type)",
1615-
"MetadataBulkRegisterRequestSchema (const)",
16161614
"MetadataBulkResult (type)",
16171615
"MetadataBulkResultSchema (const)",
16181616
"MetadataCategory (type)",
@@ -1627,8 +1625,6 @@
16271625
"MetadataDependencySchema (const)",
16281626
"MetadataDiffItem (type)",
16291627
"MetadataDiffItemSchema (const)",
1630-
"MetadataEvent (type)",
1631-
"MetadataEventSchema (const)",
16321628
"MetadataFallbackStrategy (type)",
16331629
"MetadataFallbackStrategySchema (const)",
16341630
"MetadataLock (type)",
@@ -2846,6 +2842,7 @@
28462842
"MarkNotificationsReadRequestSchema (const)",
28472843
"MarkNotificationsReadResponse (type)",
28482844
"MarkNotificationsReadResponseSchema (const)",
2845+
"MetadataBulkRegisterRequest (type)",
28492846
"MetadataBulkRegisterRequestSchema (const)",
28502847
"MetadataBulkResponse (type)",
28512848
"MetadataBulkResponseSchema (const)",

0 commit comments

Comments
 (0)