Skip to content

Commit 34e6afc

Browse files
hotlonghotlong
committed
Add JSON schema definitions for various components
- Created ResourceType.json for ResourceType definition - Created RuntimeConfig.json for RuntimeConfig definition - Created RuntimeMode.json for RuntimeMode definition - Created SandboxConfig.json for SandboxConfig definition - Created ScopeConfig.json for ScopeConfig definition - Created ScopeInfo.json for ScopeInfo definition - Created SecurityPolicy.json for SecurityPolicy definition - Created SecurityScanResult.json for SecurityScanResult definition - Created SecurityVulnerability.json for SecurityVulnerability definition - Created SemanticVersion.json for SemanticVersion definition - Created ServiceFactoryRegistration.json for ServiceFactoryRegistration definition - Created ServiceMetadata.json for ServiceMetadata definition - Created ServiceRegisteredEvent.json for ServiceRegisteredEvent definition - Created ServiceRegistryConfig.json for ServiceRegistryConfig definition - Created ServiceScopeType.json for ServiceScopeType definition - Created ServiceUnregisteredEvent.json for ServiceUnregisteredEvent definition - Created StartupOptions.json for StartupOptions definition - Created StartupOrchestrationResult.json for StartupOrchestrationResult definition - Created ValidationError.json for ValidationError definition - Created ValidationResult.json for ValidationResult definition - Created ValidationWarning.json for ValidationWarning definition - Created VersionConstraint.json for VersionConstraint definition - Created AuditPolicy.json for AuditPolicy definition - Created CriteriaSharingRule.json for CriteriaSharingRule definition - Created FieldPermission.json for FieldPermission definition - Created NetworkPolicy.json for NetworkPolicy definition - Created OWDModel.json for OWDModel definition - Created ObjectPermission.json for ObjectPermission definition - Created OwnerSharingRule.json for OwnerSharingRule definition - Created PasswordPolicy.json for PasswordPolicy definition - Created PermissionSet.json for PermissionSet definition - Created Policy.json for Policy definition - Created RLSConfig.json for RLSConfig definition - Created RLSEvaluationResult.json for RLSEvaluationResult definition - Created RLSOperation.json for RLSOperation definition - Created RLSUserContext.json for RLSUserContext definition - Created RowLevelSecurityPolicy.json for RowLevelSecurityPolicy definition - Created SessionPolicy.json for SessionPolicy definition - Created ShareRecipientType.json for ShareRecipientType definition - Created SharingLevel.json for SharingLevel definition - Created SharingRule.json for SharingRule definition - Created SharingRuleType.json for SharingRuleType definition - Created Territory.json for Territory definition - Created TerritoryModel.json for TerritoryModel definition - Created TerritoryType.json for TerritoryType definition - Created AuthConfig.json for AuthConfig definition - Created AuthPluginConfig.json for AuthPluginConfig definition - Created AuthProviderConfig.json for AuthProviderConfig definition - Created ChartAnnotation.json for ChartAnnotation definition - Created ChartAxis.json for ChartAxis definition - Created ChartInteraction.json for ChartInteraction definition - Created ChartSeries.json for ChartSeries definition - Created PageVariable.json for PageVariable definition - Created WidgetSource.json for WidgetSource definition
1 parent 8b9a416 commit 34e6afc

336 files changed

Lines changed: 598 additions & 1254 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/docs/references/ai/agent-action.mdx‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Agent Action protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { AgentActionSchema, AgentActionResultSchema, AgentActionSequenceSchema, AgentActionSequenceResultSchema, ComponentActionParamsSchema, ComponentActionTypeSchema, DataActionParamsSchema, DataActionTypeSchema, FormActionParamsSchema, FormActionTypeSchema, IntentActionMappingSchema, NavigationActionParamsSchema, NavigationActionTypeSchema, UIActionTypeSchema, ViewActionParamsSchema, ViewActionTypeSchema, WorkflowActionParamsSchema, WorkflowActionTypeSchema } from '@objectstack/spec/ai';
16-
import type { AgentAction, AgentActionResult, AgentActionSequence, AgentActionSequenceResult, ComponentActionParams, ComponentActionType, DataActionParams, DataActionType, FormActionParams, FormActionType, IntentActionMapping, NavigationActionParams, NavigationActionType, UIActionType, ViewActionParams, ViewActionType, WorkflowActionParams, WorkflowActionType } from '@objectstack/spec/ai';
15+
import { AgentActionSchema, AgentActionResultSchema, AgentActionSequenceSchema, AgentActionSequenceResultSchema, ComponentActionParamsSchema, ComponentActionTypeSchema, ComponentAgentActionSchema, DataActionParamsSchema, DataActionTypeSchema, DataAgentActionSchema, FormActionParamsSchema, FormActionTypeSchema, FormAgentActionSchema, IntentActionMappingSchema, NavigationActionParamsSchema, NavigationActionTypeSchema, NavigationAgentActionSchema, TypedAgentActionSchema, UIActionTypeSchema, ViewActionParamsSchema, ViewActionTypeSchema, ViewAgentActionSchema, WorkflowActionParamsSchema, WorkflowActionTypeSchema, WorkflowAgentActionSchema } from '@objectstack/spec/ai';
16+
import type { AgentAction, AgentActionResult, AgentActionSequence, AgentActionSequenceResult, ComponentActionParams, ComponentActionType, ComponentAgentAction, DataActionParams, DataActionType, DataAgentAction, FormActionParams, FormActionType, FormAgentAction, IntentActionMapping, NavigationActionParams, NavigationActionType, NavigationAgentAction, TypedAgentAction, UIActionType, ViewActionParams, ViewActionType, ViewAgentAction, WorkflowActionParams, WorkflowActionType, WorkflowAgentAction } from '@objectstack/spec/ai';
1717

1818
// Validate data
1919
const result = AgentActionSchema.parse(data);
@@ -45,6 +45,10 @@ const result = AgentActionSchema.parse(data);
4545

4646
---
4747

48+
## ComponentAgentAction
49+
50+
---
51+
4852
## DataActionParams
4953

5054
---
@@ -53,6 +57,10 @@ const result = AgentActionSchema.parse(data);
5357

5458
---
5559

60+
## DataAgentAction
61+
62+
---
63+
5664
## FormActionParams
5765

5866
---
@@ -61,6 +69,10 @@ const result = AgentActionSchema.parse(data);
6169

6270
---
6371

72+
## FormAgentAction
73+
74+
---
75+
6476
## IntentActionMapping
6577

6678
---
@@ -73,6 +85,14 @@ const result = AgentActionSchema.parse(data);
7385

7486
---
7587

88+
## NavigationAgentAction
89+
90+
---
91+
92+
## TypedAgentAction
93+
94+
---
95+
7696
## UIActionType
7797

7898
---
@@ -85,9 +105,17 @@ const result = AgentActionSchema.parse(data);
85105

86106
---
87107

108+
## ViewAgentAction
109+
110+
---
111+
88112
## WorkflowActionParams
89113

90114
---
91115

92116
## WorkflowActionType
93117

118+
---
119+
120+
## WorkflowAgentAction
121+

‎content/docs/references/ai/conversation.mdx‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,19 @@ description: Conversation protocol schemas
1212
## TypeScript Usage
1313

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

1818
// Validate data
19-
const result = ConversationAnalyticsSchema.parse(data);
19+
const result = CodeContentSchema.parse(data);
2020
```
2121

2222
---
2323

24+
## CodeContent
25+
26+
---
27+
2428
## ConversationAnalytics
2529

2630
---
@@ -41,10 +45,18 @@ const result = ConversationAnalyticsSchema.parse(data);
4145

4246
---
4347

48+
## FileContent
49+
50+
---
51+
4452
## FunctionCall
4553

4654
---
4755

56+
## ImageContent
57+
58+
---
59+
4860
## MessageContent
4961

5062
---
@@ -61,6 +73,10 @@ const result = ConversationAnalyticsSchema.parse(data);
6173

6274
---
6375

76+
## TextContent
77+
78+
---
79+
6480
## TokenBudgetConfig
6581

6682
---

‎content/docs/references/ai/rag-pipeline.mdx‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Rag Pipeline protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { ChunkingStrategySchema, DocumentChunkSchema, DocumentLoaderConfigSchema, DocumentMetadataSchema, EmbeddingModelSchema, RAGPipelineConfigSchema, RAGPipelineStatusSchema, RAGQueryRequestSchema, RAGQueryResponseSchema, RerankingConfigSchema, RetrievalStrategySchema, VectorStoreConfigSchema, VectorStoreProviderSchema } from '@objectstack/spec/ai';
16-
import type { ChunkingStrategy, DocumentChunk, DocumentLoaderConfig, DocumentMetadata, EmbeddingModel, RAGPipelineConfig, RAGPipelineStatus, RAGQueryRequest, RAGQueryResponse, RerankingConfig, RetrievalStrategy, VectorStoreConfig, VectorStoreProvider } from '@objectstack/spec/ai';
15+
import { ChunkingStrategySchema, DocumentChunkSchema, DocumentLoaderConfigSchema, DocumentMetadataSchema, EmbeddingModelSchema, FilterExpressionSchema, FilterGroupSchema, MetadataFilterSchema, RAGPipelineConfigSchema, RAGPipelineStatusSchema, RAGQueryRequestSchema, RAGQueryResponseSchema, RerankingConfigSchema, RetrievalStrategySchema, VectorStoreConfigSchema, VectorStoreProviderSchema } from '@objectstack/spec/ai';
16+
import type { ChunkingStrategy, DocumentChunk, DocumentLoaderConfig, DocumentMetadata, EmbeddingModel, FilterExpression, FilterGroup, MetadataFilter, RAGPipelineConfig, RAGPipelineStatus, RAGQueryRequest, RAGQueryResponse, RerankingConfig, RetrievalStrategy, VectorStoreConfig, VectorStoreProvider } from '@objectstack/spec/ai';
1717

1818
// Validate data
1919
const result = ChunkingStrategySchema.parse(data);
@@ -41,6 +41,18 @@ const result = ChunkingStrategySchema.parse(data);
4141

4242
---
4343

44+
## FilterExpression
45+
46+
---
47+
48+
## FilterGroup
49+
50+
---
51+
52+
## MetadataFilter
53+
54+
---
55+
4456
## RAGPipelineConfig
4557

4658
---

‎content/docs/references/api/contract.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Contract protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { ApiErrorSchema, BaseResponseSchema, BulkRequestSchema, BulkResponseSchema, CreateRequestSchema, DeleteResponseSchema, ExportRequestSchema, ListRecordResponseSchema, ModificationResultSchema, RecordDataSchema, SingleRecordResponseSchema, UpdateRequestSchema } from '@objectstack/spec/api';
16-
import type { ApiError, BaseResponse, BulkRequest, BulkResponse, CreateRequest, DeleteResponse, ExportRequest, ListRecordResponse, ModificationResult, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api';
15+
import { ApiErrorSchema, BaseResponseSchema, BulkRequestSchema, BulkResponseSchema, CreateRequestSchema, DeleteResponseSchema, ExportRequestSchema, IdRequestSchema, ListRecordResponseSchema, ModificationResultSchema, RecordDataSchema, SingleRecordResponseSchema, UpdateRequestSchema } from '@objectstack/spec/api';
16+
import type { ApiError, BaseResponse, BulkRequest, BulkResponse, CreateRequest, DeleteResponse, ExportRequest, IdRequest, ListRecordResponse, ModificationResult, RecordData, SingleRecordResponse, UpdateRequest } from '@objectstack/spec/api';
1717

1818
// Validate data
1919
const result = ApiErrorSchema.parse(data);
@@ -49,6 +49,10 @@ const result = ApiErrorSchema.parse(data);
4949

5050
---
5151

52+
## IdRequest
53+
54+
---
55+
5256
## ListRecordResponse
5357

5458
---

‎content/docs/references/api/index.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ description: Complete reference for all api protocol schemas
88
This section contains all protocol schemas for the api layer of ObjectStack.
99

1010
<Cards>
11+
<Card href="./analytics" title="Analytics" description="Source: packages/spec/src/api/analytics.zod.ts" />
12+
<Card href="./auth" title="Auth" description="Source: packages/spec/src/api/auth.zod.ts" />
1113
<Card href="./batch" title="Batch" description="Source: packages/spec/src/api/batch.zod.ts" />
1214
<Card href="./contract" title="Contract" description="Source: packages/spec/src/api/contract.zod.ts" />
1315
<Card href="./discovery" title="Discovery" description="Source: packages/spec/src/api/discovery.zod.ts" />
@@ -17,12 +19,14 @@ This section contains all protocol schemas for the api layer of ObjectStack.
1719
<Card href="./graphql" title="Graphql" description="Source: packages/spec/src/api/graphql.zod.ts" />
1820
<Card href="./http-cache" title="Http Cache" description="Source: packages/spec/src/api/http-cache.zod.ts" />
1921
<Card href="./hub" title="Hub" description="Source: packages/spec/src/api/hub.zod.ts" />
22+
<Card href="./metadata" title="Metadata" description="Source: packages/spec/src/api/metadata.zod.ts" />
2023
<Card href="./odata" title="Odata" description="Source: packages/spec/src/api/odata.zod.ts" />
2124
<Card href="./protocol" title="Protocol" description="Source: packages/spec/src/api/protocol.zod.ts" />
2225
<Card href="./realtime" title="Realtime" description="Source: packages/spec/src/api/realtime.zod.ts" />
2326
<Card href="./registry" title="Registry" description="Source: packages/spec/src/api/registry.zod.ts" />
2427
<Card href="./rest-server" title="Rest Server" description="Source: packages/spec/src/api/rest-server.zod.ts" />
2528
<Card href="./router" title="Router" description="Source: packages/spec/src/api/router.zod.ts" />
29+
<Card href="./storage" title="Storage" description="Source: packages/spec/src/api/storage.zod.ts" />
2630
<Card href="./websocket" title="Websocket" description="Source: packages/spec/src/api/websocket.zod.ts" />
2731
</Cards>
2832

‎content/docs/references/api/meta.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
{
22
"title": "API Protocol",
33
"pages": [
4+
"analytics",
5+
"auth",
46
"batch",
57
"contract",
68
"discovery",
@@ -10,12 +12,14 @@
1012
"graphql",
1113
"http-cache",
1214
"hub",
15+
"metadata",
1316
"odata",
1417
"protocol",
1518
"realtime",
1619
"registry",
1720
"rest-server",
1821
"router",
22+
"storage",
1923
"websocket"
2024
]
2125
}

‎content/docs/references/automation/connector.mdx‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Connector protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { AuthenticationSchema, ConflictResolutionSchema, ConnectorSchema, DataSyncConfigSchema } from '@objectstack/spec/automation';
16-
import type { Authentication, ConflictResolution, Connector, DataSyncConfig } from '@objectstack/spec/automation';
15+
import { AuthenticationSchema, ConflictResolutionSchema, ConnectorSchema, ConnectorTriggerSchema, DataSyncConfigSchema } from '@objectstack/spec/automation';
16+
import type { Authentication, ConflictResolution, Connector, ConnectorTrigger, DataSyncConfig } from '@objectstack/spec/automation';
1717

1818
// Validate data
1919
const result = AuthenticationSchema.parse(data);
@@ -33,5 +33,9 @@ const result = AuthenticationSchema.parse(data);
3333

3434
---
3535

36+
## ConnectorTrigger
37+
38+
---
39+
3640
## DataSyncConfig
3741

‎content/docs/references/automation/trigger-registry.mdx‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Trigger Registry protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { AuthFieldSchema, AuthenticationTypeSchema, ConnectorCategorySchema, ConnectorInstanceSchema, ConnectorOperationSchema, ConnectorTriggerSchema, OAuth2ConfigSchema, OperationParameterSchema, OperationTypeSchema } from '@objectstack/spec/automation';
16-
import type { AuthField, AuthenticationType, ConnectorCategory, ConnectorInstance, ConnectorOperation, ConnectorTrigger, OAuth2Config, OperationParameter, OperationType } from '@objectstack/spec/automation';
15+
import { AuthFieldSchema, AuthenticationTypeSchema, ConnectorCategorySchema, ConnectorInstanceSchema, ConnectorOperationSchema, OAuth2ConfigSchema, OperationParameterSchema, OperationTypeSchema } from '@objectstack/spec/automation';
16+
import type { AuthField, AuthenticationType, ConnectorCategory, ConnectorInstance, ConnectorOperation, OAuth2Config, OperationParameter, OperationType } from '@objectstack/spec/automation';
1717

1818
// Validate data
1919
const result = AuthFieldSchema.parse(data);
@@ -41,10 +41,6 @@ const result = AuthFieldSchema.parse(data);
4141

4242
---
4343

44-
## ConnectorTrigger
45-
46-
---
47-
4844
## OAuth2Config
4945

5046
---

‎content/docs/references/automation/workflow.mdx‎

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,19 @@ description: Workflow protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { CustomScriptActionSchema, EmailAlertActionSchema, FieldUpdateActionSchema, HttpCallActionSchema, PushNotificationActionSchema, SlackMessageActionSchema, SmsNotificationActionSchema, TaskCreationActionSchema, TeamsMessageActionSchema, TimeTriggerSchema, WebhookTriggerActionSchema, WorkflowActionSchema, WorkflowRuleSchema, WorkflowTriggerTypeSchema } from '@objectstack/spec/automation';
16-
import type { CustomScriptAction, EmailAlertAction, FieldUpdateAction, HttpCallAction, PushNotificationAction, SlackMessageAction, SmsNotificationAction, TaskCreationAction, TeamsMessageAction, TimeTrigger, WebhookTriggerAction, WorkflowAction, WorkflowRule, WorkflowTriggerType } from '@objectstack/spec/automation';
15+
import { ConnectorActionRefSchema, CustomScriptActionSchema, EmailAlertActionSchema, FieldUpdateActionSchema, HttpCallActionSchema, PushNotificationActionSchema, TaskCreationActionSchema, TimeTriggerSchema, WorkflowActionSchema, WorkflowRuleSchema, WorkflowTriggerTypeSchema } from '@objectstack/spec/automation';
16+
import type { ConnectorActionRef, CustomScriptAction, EmailAlertAction, FieldUpdateAction, HttpCallAction, PushNotificationAction, TaskCreationAction, TimeTrigger, WorkflowAction, WorkflowRule, WorkflowTriggerType } from '@objectstack/spec/automation';
1717

1818
// Validate data
19-
const result = CustomScriptActionSchema.parse(data);
19+
const result = ConnectorActionRefSchema.parse(data);
2020
```
2121

2222
---
2323

24+
## ConnectorActionRef
25+
26+
---
27+
2428
## CustomScriptAction
2529

2630
---
@@ -41,30 +45,14 @@ const result = CustomScriptActionSchema.parse(data);
4145

4246
---
4347

44-
## SlackMessageAction
45-
46-
---
47-
48-
## SmsNotificationAction
49-
50-
---
51-
5248
## TaskCreationAction
5349

5450
---
5551

56-
## TeamsMessageAction
57-
58-
---
59-
6052
## TimeTrigger
6153

6254
---
6355

64-
## WebhookTriggerAction
65-
66-
---
67-
6856
## WorkflowAction
6957

7058
---

‎content/docs/references/data/index.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ description: Complete reference for all data protocol schemas
88
This section contains all protocol schemas for the data layer of ObjectStack.
99

1010
<Cards>
11+
<Card href="./analytics" title="Analytics" description="Source: packages/spec/src/data/analytics.zod.ts" />
1112
<Card href="./data-engine" title="Data Engine" description="Source: packages/spec/src/data/data-engine.zod.ts" />
1213
<Card href="./dataset" title="Dataset" description="Source: packages/spec/src/data/dataset.zod.ts" />
14+
<Card href="./datasource" title="Datasource" description="Source: packages/spec/src/data/datasource.zod.ts" />
1315
<Card href="./document" title="Document" description="Source: packages/spec/src/data/document.zod.ts" />
1416
<Card href="./driver" title="Driver" description="Source: packages/spec/src/data/driver.zod.ts" />
1517
<Card href="./driver-nosql" title="Driver Nosql" description="Source: packages/spec/src/data/driver-nosql.zod.ts" />

0 commit comments

Comments
 (0)