Skip to content

Commit 82b80b9

Browse files
committed
fix(ci): commit api-surface snapshot (9 intentional additions) + regenerated action reference doc
- api-surface: the #2874 registry exports (PUBLIC_AUTH_FEATURES et al.) are intentional public API - snapshot updated via gen:api-surface. - references/ui/action.mdx: regenerated. ActionParamSchema now ends in a .transform() (the requiresFeature lowering), which z.toJSONSchema cannot represent on the output side, so the generator drops the ActionParam block - the same pre-existing behavior as ActionSchema and ObjectSchema. The authoritative ActionParam field documentation lives in the hand-written protocol doc (content/docs/protocol/objectui/actions.mdx), updated in this PR. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HGofzwNXvtahMGk8TQqXdx
1 parent b703765 commit 82b80b9

2 files changed

Lines changed: 11 additions & 23 deletions

File tree

content/docs/references/ui/action.mdx

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ to the field name and is used as the request-body key).
4848
## TypeScript Usage
4949

5050
```typescript
51-
import { ActionAi, ActionLocation, ActionParam, ActionType } from '@objectstack/spec/ui';
52-
import type { ActionAi, ActionLocation, ActionParam, ActionType } from '@objectstack/spec/ui';
51+
import { ActionAi, ActionLocation, ActionType } from '@objectstack/spec/ui';
52+
import type { ActionAi, ActionLocation, ActionType } from '@objectstack/spec/ui';
5353

5454
// Validate data
5555
const result = ActionAi.parse(data);
@@ -86,27 +86,6 @@ const result = ActionAi.parse(data);
8686
* `global_nav`
8787

8888

89-
---
90-
91-
## ActionParam
92-
93-
### Properties
94-
95-
| Property | Type | Required | Description |
96-
| :--- | :--- | :--- | :--- |
97-
| **name** | `string` | optional | |
98-
| **field** | `string` | optional | Snake case identifier (lowercase with underscores only) |
99-
| **objectOverride** | `string` | optional | Snake case identifier (lowercase with underscores only) |
100-
| **label** | `string` | optional | Display label (plain string; i18n keys are auto-generated by the framework) |
101-
| **type** | `Enum<'text' \| 'textarea' \| 'email' \| 'url' \| 'phone' \| 'password' \| 'secret' \| 'markdown' \| 'html' \| 'richtext' \| 'number' \| 'currency' \| 'percent' \| 'date' \| 'datetime' \| 'time' \| 'boolean' \| 'toggle' \| 'select' \| 'multiselect' \| 'radio' \| 'checkboxes' \| 'lookup' \| 'master_detail' \| 'tree' \| 'user' \| 'image' \| 'file' \| 'avatar' \| 'video' \| 'audio' \| 'formula' \| 'summary' \| 'autonumber' \| 'composite' \| 'repeater' \| 'record' \| 'location' \| 'address' \| 'code' \| 'json' \| 'color' \| 'rating' \| 'slider' \| 'signature' \| 'qrcode' \| 'progress' \| 'tags' \| 'vector'>` | optional | |
102-
| **required** | `boolean` || |
103-
| **options** | `Object[]` | optional | |
104-
| **placeholder** | `string` | optional | |
105-
| **helpText** | `string` | optional | |
106-
| **defaultValue** | `any` | optional | |
107-
| **defaultFromRow** | `boolean` | optional | |
108-
109-
11089
---
11190

11291
## ActionType

packages/spec/api-surface.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1531,6 +1531,9 @@
15311531
"OpsPluginStructureSchema (const)",
15321532
"PROTOCOL_MAJOR (const)",
15331533
"PROTOCOL_VERSION (const)",
1534+
"PUBLIC_AUTH_CONFIG_NON_FLAG_KEYS (const)",
1535+
"PUBLIC_AUTH_FEATURES (const)",
1536+
"PUBLIC_AUTH_FEATURE_NAMES (const)",
15341537
"PackageArtifact (type)",
15351538
"PackageArtifactInput (type)",
15361539
"PackageArtifactSchema (const)",
@@ -1670,6 +1673,10 @@
16701673
"ProtocolReferenceSchema (const)",
16711674
"ProtocolVersion (type)",
16721675
"ProtocolVersionSchema (const)",
1676+
"PublicAuthFeatureEntry (type)",
1677+
"PublicAuthFeatureName (type)",
1678+
"PublicAuthFeatureSemantics (type)",
1679+
"PublicAuthFeatureSurface (type)",
16731680
"RealTimeNotificationConfig (type)",
16741681
"RealTimeNotificationConfigSchema (const)",
16751682
"RequiredAction (type)",
@@ -1759,12 +1766,14 @@
17591766
"evaluateLockForDelete (function)",
17601767
"evaluateLockForWrite (function)",
17611768
"extractProtection (function)",
1769+
"featureGatePredicate (function)",
17621770
"getMetadataCreateSeed (function)",
17631771
"getMetadataTypeActions (function)",
17641772
"getMetadataTypeSchema (function)",
17651773
"isConsumerInstallable (function)",
17661774
"listMetadataCreateSeedTypes (function)",
17671775
"listMetadataTypeSchemaTypes (function)",
1776+
"lowerRequiresFeature (function)",
17681777
"registerMetadataTypeActions (function)",
17691778
"registerMetadataTypeSchema (function)",
17701779
"resolveLockState (function)",

0 commit comments

Comments
 (0)