Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .changeset/eighty-donkeys-repeat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
"@objectstack/spec": patch
---

Reference docs: import examples are now spelled from the package's real export surface

`build-docs.ts` derived each page's "TypeScript Usage" block from the JSON Schema file
name — the value import verbatim, the `import type` line with a `Schema` suffix stripped —
and nothing verified either name existed. `check:docs` could not catch it: it diffs the
generator's output against the committed docs, so a name the generator invents stays "in
sync" with itself forever. 150 of the committed `import type` names did not compile, and
the `.parse()` example called a type rather than the schema const.

Both lines are now resolved against `api-surface.json`, the committed record of every
`name (kind)` per entry point: only names the entry really exports are emitted, and the
example parses with the actual schema const. A name that resolves to nothing is dropped
from the page and recorded in the new `docs-import-surface.baseline.json` — a shrink-only
ratchet, so removing a type alias while its schema keeps a reference page now turns
`check:docs` red instead of silently publishing a dead import.
6 changes: 3 additions & 3 deletions content/docs/references/ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ AI Model Configuration
## TypeScript Usage

```typescript
import { AIModelConfig, Agent, StructuredOutputConfig, StructuredOutputFormat, TransformPipelineStep } from '@objectstack/spec/ai';
import type { AIModelConfig, Agent, StructuredOutputConfig, StructuredOutputFormat, TransformPipelineStep } from '@objectstack/spec/ai';
import { AIModelConfigSchema, AgentSchema, StructuredOutputConfigSchema, StructuredOutputFormatSchema, TransformPipelineStepSchema } from '@objectstack/spec/ai';
import type { Agent, StructuredOutputConfig, StructuredOutputFormat, TransformPipelineStep } from '@objectstack/spec/ai';

// Validate data
const result = AIModelConfig.parse(data);
const result = AIModelConfigSchema.parse(data);
```

---
Expand Down
6 changes: 3 additions & 3 deletions content/docs/references/ai/conversation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Enables context preservation, conversation history, and token optimization.
## TypeScript Usage

```typescript
import { CodeContent, ConversationAnalytics, ConversationContext, ConversationMessage, ConversationSession, ConversationSummary, FileContent, FunctionCall, ImageContent, MessageContent, MessageContentType, MessagePruningEvent, MessageRole, TextContent, TokenBudgetConfig, TokenBudgetStrategy, TokenUsageStats, ToolCall } from '@objectstack/spec/ai';
import type { CodeContent, ConversationAnalytics, ConversationContext, ConversationMessage, ConversationSession, ConversationSummary, FileContent, FunctionCall, ImageContent, MessageContent, MessageContentType, MessagePruningEvent, MessageRole, TextContent, TokenBudgetConfig, TokenBudgetStrategy, TokenUsageStats, ToolCall } from '@objectstack/spec/ai';
import { CodeContentSchema, ConversationAnalyticsSchema, ConversationContextSchema, ConversationMessageSchema, ConversationSessionSchema, ConversationSummarySchema, FileContentSchema, FunctionCallSchema, ImageContentSchema, MessageContentSchema, MessageContentTypeSchema, MessagePruningEventSchema, MessageRoleSchema, TextContentSchema, TokenBudgetConfigSchema, TokenBudgetStrategySchema, TokenUsageStatsSchema, ToolCallSchema } from '@objectstack/spec/ai';
import type { ConversationAnalytics, ConversationContext, ConversationMessage, ConversationSession, ConversationSummary, FunctionCall, MessageContent, MessageContentType, MessagePruningEvent, MessageRole, TokenBudgetConfig, TokenBudgetStrategy, TokenUsageStats, ToolCall } from '@objectstack/spec/ai';

// Validate data
const result = CodeContent.parse(data);
const result = CodeContentSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/embedding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ vector primitives so any RAG strategy can be built on top.
## TypeScript Usage

```typescript
import { EmbeddingModel, VectorStore, VectorStoreProvider } from '@objectstack/spec/ai';
import { EmbeddingModelSchema, VectorStoreSchema, VectorStoreProviderSchema } from '@objectstack/spec/ai';
import type { EmbeddingModel, VectorStore, VectorStoreProvider } from '@objectstack/spec/ai';

// Validate data
const result = EmbeddingModel.parse(data);
const result = EmbeddingModelSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/knowledge-document.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ See `content/docs/protocol/knowledge.mdx` for the full design.
## TypeScript Usage

```typescript
import { KnowledgeChunk, KnowledgeDocument, KnowledgeHit } from '@objectstack/spec/ai';
import { KnowledgeChunkSchema, KnowledgeDocumentSchema, KnowledgeHitSchema } from '@objectstack/spec/ai';
import type { KnowledgeChunk, KnowledgeDocument, KnowledgeHit } from '@objectstack/spec/ai';

// Validate data
const result = KnowledgeChunk.parse(data);
const result = KnowledgeChunkSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/knowledge-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ See `content/docs/protocol/knowledge.mdx` for the full design.
## TypeScript Usage

```typescript
import { FileKnowledgeSource, HttpKnowledgeSource, KnowledgeRefreshPolicy, KnowledgeSource, KnowledgeSourceKind, ObjectKnowledgeSource } from '@objectstack/spec/ai';
import { FileKnowledgeSourceSchema, HttpKnowledgeSourceSchema, KnowledgeRefreshPolicySchema, KnowledgeSourceSchema, KnowledgeSourceKindSchema, ObjectKnowledgeSourceSchema } from '@objectstack/spec/ai';
import type { FileKnowledgeSource, HttpKnowledgeSource, KnowledgeRefreshPolicy, KnowledgeSource, KnowledgeSourceKind, ObjectKnowledgeSource } from '@objectstack/spec/ai';

// Validate data
const result = FileKnowledgeSource.parse(data);
const result = FileKnowledgeSourceSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ at runtime and does not need a metadata representation.
## TypeScript Usage

```typescript
import { MCPApprovalPolicy, MCPServerRef, MCPToolBinding, MCPTransport } from '@objectstack/spec/ai';
import { MCPApprovalPolicySchema, MCPServerRefSchema, MCPToolBindingSchema, MCPTransportSchema } from '@objectstack/spec/ai';
import type { MCPApprovalPolicy, MCPServerRef, MCPToolBinding, MCPTransport } from '@objectstack/spec/ai';

// Validate data
const result = MCPApprovalPolicy.parse(data);
const result = MCPApprovalPolicySchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/model-registry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Enables AI-powered ObjectStack applications to discover and use LLMs consistentl
## TypeScript Usage

```typescript
import { ModelCapability, ModelConfig, ModelLimits, ModelPricing, ModelProvider, ModelRegistry, ModelRegistryEntry, ModelSelectionCriteria, PromptTemplate, PromptVariable } from '@objectstack/spec/ai';
import { ModelCapabilitySchema, ModelConfigSchema, ModelLimitsSchema, ModelPricingSchema, ModelProviderSchema, ModelRegistrySchema, ModelRegistryEntrySchema, ModelSelectionCriteriaSchema, PromptTemplateSchema, PromptVariableSchema } from '@objectstack/spec/ai';
import type { ModelCapability, ModelConfig, ModelLimits, ModelPricing, ModelProvider, ModelRegistry, ModelRegistryEntry, ModelSelectionCriteria, PromptTemplate, PromptVariable } from '@objectstack/spec/ai';

// Validate data
const result = ModelCapability.parse(data);
const result = ModelCapabilitySchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/skill.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Allows context-aware activation based on object type, user role, etc.
## TypeScript Usage

```typescript
import { Skill, SkillTriggerCondition } from '@objectstack/spec/ai';
import { SkillSchema, SkillTriggerConditionSchema } from '@objectstack/spec/ai';
import type { Skill, SkillTriggerCondition } from '@objectstack/spec/ai';

// Validate data
const result = Skill.parse(data);
const result = SkillSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/solution-blueprint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ batch-draft. This is the safety valve for low-specificity input.
## TypeScript Usage

```typescript
import { BlueprintApp, BlueprintCondition, BlueprintDashboard, BlueprintField, BlueprintNavItem, BlueprintObject, BlueprintSeed, BlueprintSummaryOperations, BlueprintView, BlueprintWidgetCondition, SolutionBlueprint, SolutionBlueprintStrict } from '@objectstack/spec/ai';
import { BlueprintAppSchema, BlueprintConditionSchema, BlueprintDashboardSchema, BlueprintFieldSchema, BlueprintNavItemSchema, BlueprintObjectSchema, BlueprintSeedSchema, BlueprintSummaryOperationsSchema, BlueprintViewSchema, BlueprintWidgetConditionSchema, SolutionBlueprintSchema, SolutionBlueprintStrictSchema } from '@objectstack/spec/ai';
import type { BlueprintApp, BlueprintCondition, BlueprintDashboard, BlueprintField, BlueprintNavItem, BlueprintObject, BlueprintSeed, BlueprintSummaryOperations, BlueprintView, BlueprintWidgetCondition, SolutionBlueprint, SolutionBlueprintStrict } from '@objectstack/spec/ai';

// Validate data
const result = BlueprintApp.parse(data);
const result = BlueprintAppSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/tool.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ because the parse error is the one channel every consumer bumping
## TypeScript Usage

```typescript
import { Tool } from '@objectstack/spec/ai';
import { ToolSchema } from '@objectstack/spec/ai';
import type { Tool } from '@objectstack/spec/ai';

// Validate data
const result = Tool.parse(data);
const result = ToolSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/ai/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ is product policy that varies wildly between tenants.
## TypeScript Usage

```typescript
import { AIUsageRecord, TokenUsage } from '@objectstack/spec/ai';
import { AIUsageRecordSchema, TokenUsageSchema } from '@objectstack/spec/ai';
import type { AIUsageRecord, TokenUsage } from '@objectstack/spec/ai';

// Validate data
const result = AIUsageRecord.parse(data);
const result = AIUsageRecordSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Provides endpoints for executing analytical queries and discovering metadata.
## TypeScript Usage

```typescript
import { AnalyticsEndpoint, AnalyticsMetadataResponse, AnalyticsQueryRequest, AnalyticsResultResponse, AnalyticsSqlResponse, GetAnalyticsMetaRequest } from '@objectstack/spec/api';
import type { AnalyticsEndpoint, AnalyticsMetadataResponse, AnalyticsQueryRequest, AnalyticsResultResponse, AnalyticsSqlResponse, GetAnalyticsMetaRequest } from '@objectstack/spec/api';
import { AnalyticsEndpoint, AnalyticsMetadataResponseSchema, AnalyticsQueryRequestSchema, AnalyticsResultResponseSchema, AnalyticsSqlResponseSchema, GetAnalyticsMetaRequestSchema } from '@objectstack/spec/api';
import type { AnalyticsEndpoint, AnalyticsMetadataResponse, AnalyticsQueryRequest, AnalyticsSqlResponse } from '@objectstack/spec/api';

// Validate data
const result = AnalyticsEndpoint.parse(data);
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/auth-endpoints.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ the canonical API contract.
## TypeScript Usage

```typescript
import { AuthEndpoint, AuthFeaturesConfig, AuthProviderInfo, DeviceRequestResponse, DeviceTokenResponse, EmailPasswordConfigPublic, GetAuthConfigResponse } from '@objectstack/spec/api';
import { AuthEndpointSchema, AuthFeaturesConfigSchema, AuthProviderInfoSchema, DeviceRequestResponseSchema, DeviceTokenResponseSchema, EmailPasswordConfigPublicSchema, GetAuthConfigResponseSchema } from '@objectstack/spec/api';
import type { AuthEndpoint, AuthFeaturesConfig, AuthProviderInfo, DeviceRequestResponse, DeviceTokenResponse, EmailPasswordConfigPublic, GetAuthConfigResponse } from '@objectstack/spec/api';

// Validate data
const result = AuthEndpoint.parse(data);
const result = AuthEndpointSchema.parse(data);
```

---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/api/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ and Access Control.
## TypeScript Usage

```typescript
import { AuthProvider, LoginRequest, LoginType, RefreshTokenRequest, RegisterRequest, SessionResponse, SessionUser, UserProfileResponse } from '@objectstack/spec/api';
import { AuthProvider, LoginRequestSchema, LoginType, RefreshTokenRequestSchema, RegisterRequestSchema, SessionResponseSchema, SessionUserSchema, UserProfileResponseSchema } from '@objectstack/spec/api';
import type { AuthProvider, LoginRequest, LoginType, RefreshTokenRequest, RegisterRequest, SessionResponse, SessionUser, UserProfileResponse } from '@objectstack/spec/api';

// Validate data
Expand Down
2 changes: 1 addition & 1 deletion content/docs/references/api/automation-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ GET /api/automation/:name/runs/:runId — Get single execution run
## TypeScript Usage

```typescript
import { AutomationApiErrorCode, AutomationFlowPathParams, AutomationRunPathParams, CreateFlowRequest, CreateFlowResponse, DeleteFlowRequest, DeleteFlowResponse, FlowSummary, GetFlowRequest, GetFlowResponse, GetRunRequest, GetRunResponse, ListFlowsRequest, ListFlowsResponse, ListRunsRequest, ListRunsResponse, ToggleFlowRequest, ToggleFlowResponse, TriggerFlowRequest, TriggerFlowResponse, UpdateFlowRequest, UpdateFlowResponse } from '@objectstack/spec/api';
import { AutomationApiErrorCode, AutomationFlowPathParamsSchema, AutomationRunPathParamsSchema, CreateFlowRequestSchema, CreateFlowResponseSchema, DeleteFlowRequestSchema, DeleteFlowResponseSchema, FlowSummarySchema, GetFlowRequestSchema, GetFlowResponseSchema, GetRunRequestSchema, GetRunResponseSchema, ListFlowsRequestSchema, ListFlowsResponseSchema, ListRunsRequestSchema, ListRunsResponseSchema, ToggleFlowRequestSchema, ToggleFlowResponseSchema, TriggerFlowRequestSchema, TriggerFlowResponseSchema, UpdateFlowRequestSchema, UpdateFlowResponseSchema } from '@objectstack/spec/api';
import type { AutomationApiErrorCode, AutomationFlowPathParams, AutomationRunPathParams, CreateFlowRequest, CreateFlowResponse, DeleteFlowRequest, DeleteFlowResponse, FlowSummary, GetFlowRequest, GetFlowResponse, GetRunRequest, GetRunResponse, ListFlowsRequest, ListFlowsResponse, ListRunsRequest, ListRunsResponse, ToggleFlowRequest, ToggleFlowResponse, TriggerFlowRequest, TriggerFlowResponse, UpdateFlowRequest, UpdateFlowResponse } from '@objectstack/spec/api';

// Validate data
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/batch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Industry alignment: Salesforce Bulk API, Microsoft Dynamics Bulk Operations
## TypeScript Usage

```typescript
import { BatchConfig, BatchOperationResult, BatchOperationType, BatchOptions, BatchRecord, BatchUpdateRequest, BatchUpdateResponse, CrossObjectBatchDroppedFields, CrossObjectBatchOperation, CrossObjectBatchRequest, CrossObjectBatchResponse, DeleteManyRequest, UpdateManyRecord, UpdateManyRequest } from '@objectstack/spec/api';
import { BatchConfigSchema, BatchOperationResultSchema, BatchOperationType, BatchOptionsSchema, BatchRecordSchema, BatchUpdateRequestSchema, BatchUpdateResponseSchema, CrossObjectBatchDroppedFieldsSchema, CrossObjectBatchOperationSchema, CrossObjectBatchRequestSchema, CrossObjectBatchResponseSchema, DeleteManyRequestSchema, UpdateManyRecordSchema, UpdateManyRequestSchema } from '@objectstack/spec/api';
import type { BatchConfig, BatchOperationResult, BatchOperationType, BatchOptions, BatchRecord, BatchUpdateRequest, BatchUpdateResponse, CrossObjectBatchDroppedFields, CrossObjectBatchOperation, CrossObjectBatchRequest, CrossObjectBatchResponse, DeleteManyRequest, UpdateManyRecord, UpdateManyRequest } from '@objectstack/spec/api';

// Validate data
const result = BatchConfig.parse(data);
const result = BatchConfigSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/contract.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ invented codes instead of letting a new dialect grow (#3841).
## TypeScript Usage

```typescript
import { ApiError, BaseResponse, BatchLoadingStrategy, BulkRequest, BulkResponse, CreateRequest, DataLoaderConfig, DeleteResponse, ExportRequest, IdRequest, ListRecordResponse, ModificationResult, QueryOptimizationConfig, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api';
import { ApiErrorSchema, BaseResponseSchema, BatchLoadingStrategySchema, BulkRequestSchema, BulkResponseSchema, CreateRequestSchema, DataLoaderConfigSchema, DeleteResponseSchema, ExportRequestSchema, IdRequestSchema, ListRecordResponseSchema, ModificationResultSchema, QueryOptimizationConfigSchema, RecordDataSchema, SingleRecordResponseSchema, UpdateRequestSchema } from '@objectstack/spec/api';
import type { ApiError, BaseResponse, BatchLoadingStrategy, BulkRequest, BulkResponse, CreateRequest, DataLoaderConfig, DeleteResponse, ExportRequest, IdRequest, ListRecordResponse, ModificationResult, QueryOptimizationConfig, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api';

// Validate data
const result = ApiError.parse(data);
const result = ApiErrorSchema.parse(data);
```

---
Expand Down
6 changes: 3 additions & 3 deletions content/docs/references/api/discovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ not been verified (may 501 at runtime).
## TypeScript Usage

```typescript
import { ApiRoutes, Discovery, RouteHealthEntry, RouteHealthReport, ServiceInfo, ServiceSelfInfo, WellKnownCapabilities } from '@objectstack/spec/api';
import type { ApiRoutes, Discovery, RouteHealthEntry, RouteHealthReport, ServiceInfo, ServiceSelfInfo, WellKnownCapabilities } from '@objectstack/spec/api';
import { ApiRoutesSchema, DiscoverySchema, RouteHealthEntrySchema, RouteHealthReportSchema, ServiceInfoSchema, ServiceSelfInfoSchema, WellKnownCapabilitiesSchema } from '@objectstack/spec/api';
import type { ApiRoutes, RouteHealthEntry, RouteHealthReport, ServiceInfo, ServiceSelfInfo, WellKnownCapabilities } from '@objectstack/spec/api';

// Validate data
const result = ApiRoutes.parse(data);
const result = ApiRoutesSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/dispatcher.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Architecture alignment:
## TypeScript Usage

```typescript
import { DispatcherConfig, DispatcherErrorCode, DispatcherErrorResponse, DispatcherRoute } from '@objectstack/spec/api';
import { DispatcherConfigSchema, DispatcherErrorCode, DispatcherErrorResponseSchema, DispatcherRouteSchema } from '@objectstack/spec/api';
import type { DispatcherConfig, DispatcherErrorCode, DispatcherErrorResponse, DispatcherRoute } from '@objectstack/spec/api';

// Validate data
const result = DispatcherConfig.parse(data);
const result = DispatcherConfigSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ enableTryItOut: true
## TypeScript Usage

```typescript
import { ApiChangelogEntry, ApiDocumentationConfig, ApiTestCollection, ApiTestRequest, ApiTestingUiConfig, ApiTestingUiType, CodeGenerationTemplate, GeneratedApiDocumentation, OpenApiSecurityScheme, OpenApiServer, OpenApiSpec } from '@objectstack/spec/api';
import { ApiChangelogEntrySchema, ApiDocumentationConfigSchema, ApiTestCollectionSchema, ApiTestRequestSchema, ApiTestingUiConfigSchema, ApiTestingUiType, CodeGenerationTemplateSchema, GeneratedApiDocumentationSchema, OpenApiSecuritySchemeSchema, OpenApiServerSchema, OpenApiSpecSchema } from '@objectstack/spec/api';
import type { ApiChangelogEntry, ApiDocumentationConfig, ApiTestCollection, ApiTestRequest, ApiTestingUiConfig, ApiTestingUiType, CodeGenerationTemplate, GeneratedApiDocumentation, OpenApiSecurityScheme, OpenApiServer, OpenApiSpec } from '@objectstack/spec/api';

// Validate data
const result = ApiChangelogEntry.parse(data);
const result = ApiChangelogEntrySchema.parse(data);
```

---
Expand Down
6 changes: 3 additions & 3 deletions content/docs/references/api/endpoint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Transform input/output data.
## TypeScript Usage

```typescript
import { ApiEndpoint, ApiMapping } from '@objectstack/spec/api';
import type { ApiEndpoint, ApiMapping } from '@objectstack/spec/api';
import { ApiEndpointSchema, ApiMappingSchema } from '@objectstack/spec/api';
import type { ApiEndpoint } from '@objectstack/spec/api';

// Validate data
const result = ApiEndpoint.parse(data);
const result = ApiEndpointSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/errors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Industry alignment: Google Cloud Errors, AWS Error Codes, Stripe API Errors
## TypeScript Usage

```typescript
import { EnhancedApiError, ErrorCategory, ErrorResponse, FieldError, FieldErrorCode, RetryStrategy, StandardErrorCode } from '@objectstack/spec/api';
import { EnhancedApiErrorSchema, ErrorCategory, ErrorResponseSchema, FieldErrorSchema, FieldErrorCode, RetryStrategy, StandardErrorCode } from '@objectstack/spec/api';
import type { EnhancedApiError, ErrorCategory, ErrorResponse, FieldError, FieldErrorCode, RetryStrategy, StandardErrorCode } from '@objectstack/spec/api';

// Validate data
const result = EnhancedApiError.parse(data);
const result = EnhancedApiErrorSchema.parse(data);
```

---
Expand Down
4 changes: 2 additions & 2 deletions content/docs/references/api/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ Examples:
## TypeScript Usage

```typescript
import { DataEvent, DataEventType, MetadataEventType } from '@objectstack/spec/api';
import { DataEventSchema, DataEventType, MetadataEventType } from '@objectstack/spec/api';
import type { DataEvent, DataEventType, MetadataEventType } from '@objectstack/spec/api';

// Validate data
const result = DataEvent.parse(data);
const result = DataEventSchema.parse(data);
```

---
Expand Down
Loading
Loading